@manidecp/nagp-stencil-ui-kit 1.0.0 → 1.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 +44 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# NAGP Stencil UI Kit
|
|
2
|
+
|
|
3
|
+
A Stencil component library for recipe-related UI elements, including cards, badges, ratings, meal slots, and modals.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- `recipe-card`
|
|
8
|
+
- `recipe-badge`
|
|
9
|
+
- `recipe-rating`
|
|
10
|
+
- `meal-slot-card`
|
|
11
|
+
- `custom-modal`
|
|
12
|
+
|
|
13
|
+
## Getting started
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install
|
|
17
|
+
npm run build
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Development
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm start
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
This starts the Stencil build in watch mode with a local dev server.
|
|
27
|
+
|
|
28
|
+
## Production build
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
npm run build
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Package usage
|
|
35
|
+
|
|
36
|
+
```html
|
|
37
|
+
<script type="module" src="./dist/nagp-stencil-ui-kit.esm.js"></script>
|
|
38
|
+
<recipe-card recipe-title="Pasta" image-url="https://example.com/pasta.jpg" prep-time="25" is-favorite="true"></recipe-card>
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Notes
|
|
42
|
+
|
|
43
|
+
- The project uses Stencil with Shadow DOM enabled.
|
|
44
|
+
- Components are published as standard web components and can be consumed in any framework or vanilla HTML.
|