@popgrids/ui 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +79 -0
- package/dist/index.cjs +2015 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +659 -0
- package/dist/index.d.ts +659 -0
- package/dist/index.js +2015 -0
- package/dist/index.js.map +1 -0
- package/dist/popgrids-logomark-letter-2GC4ZJAT.png +0 -0
- package/dist/squircle-L5LSRL2K.gif +0 -0
- package/package.json +53 -0
package/README.md
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# @popgrids/ui
|
|
2
|
+
|
|
3
|
+
A modern, reusable UI component library built with Lit for Popgrids applications.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @popgrids/ui
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
Import the package to register all components:
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import "@popgrids/ui";
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Then use the components in your HTML:
|
|
20
|
+
|
|
21
|
+
```html
|
|
22
|
+
<pop-button>Click me</pop-button>
|
|
23
|
+
<pop-icon name="star"></pop-icon>
|
|
24
|
+
<pop-toast message="Hello!"></pop-toast>
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Available Components
|
|
28
|
+
|
|
29
|
+
The library includes the following components:
|
|
30
|
+
|
|
31
|
+
- `<pop-button>` - Standard button component
|
|
32
|
+
- `<pop-button-vertical>` - Vertical button variant
|
|
33
|
+
- `<pop-button-link>` - Button that acts as a link
|
|
34
|
+
- `<pop-code-input-field>` - Input field for code entry
|
|
35
|
+
- `<pop-comment-avatar>` - Avatar component for comments
|
|
36
|
+
- `<pop-comment-icon>` - Icon component for comments
|
|
37
|
+
- `<pop-element>` - Base element component
|
|
38
|
+
- `<pop-focus-indicator>` - Focus indicator component
|
|
39
|
+
- `<pop-form-input-simple>` - Simple form input component
|
|
40
|
+
- `<pop-icon>` - Icon component
|
|
41
|
+
- `<pop-loader>` - Loading indicator component
|
|
42
|
+
- `<pop-logo>` - Logo component
|
|
43
|
+
- `<pop-sum>` - Sum display component
|
|
44
|
+
- `<pop-timestamp-countdown>` - Countdown timer component
|
|
45
|
+
- `<pop-toast>` - Toast notification component
|
|
46
|
+
|
|
47
|
+
## Development
|
|
48
|
+
|
|
49
|
+
### Prerequisites
|
|
50
|
+
|
|
51
|
+
- Node.js
|
|
52
|
+
- npm
|
|
53
|
+
|
|
54
|
+
### Scripts
|
|
55
|
+
|
|
56
|
+
- `npm run build` - Build the package
|
|
57
|
+
- `npm run dev` - Watch mode for development
|
|
58
|
+
- `npm run clean` - Clean build artifacts
|
|
59
|
+
- `npm run lint` - Run ESLint
|
|
60
|
+
- `npm run test` - Run tests
|
|
61
|
+
- `npm run generate:component` - Generate a new component
|
|
62
|
+
- `npm run check-types` - Check TypeScript types
|
|
63
|
+
|
|
64
|
+
### Adding New Components
|
|
65
|
+
|
|
66
|
+
To add a new component, use the generator:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
npm run generate:component
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Dependencies
|
|
73
|
+
|
|
74
|
+
- [Lit](https://lit.dev/) - Web Components library
|
|
75
|
+
- [@popgrids/theme](https://github.com/popgrids/popgrids-turborepo) - Theme package
|
|
76
|
+
|
|
77
|
+
## License
|
|
78
|
+
|
|
79
|
+
Private - All rights reserved
|