yudu-component-kit 0.0.15 → 0.0.16
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 +30 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,39 +3,57 @@
|
|
|
3
3
|
src="./projects/yudu-component-kit/assets/logo-fine-dev.png"
|
|
4
4
|
alt="Logo Fine Dev"
|
|
5
5
|
width="250"
|
|
6
|
-
style="border-radius:
|
|
6
|
+
style="border-radius: 100%;"
|
|
7
7
|
/>
|
|
8
8
|
</p>
|
|
9
9
|
<h1 align="center">
|
|
10
10
|
YuduComponentKit
|
|
11
11
|
</h1>
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
|
|
14
14
|
|
|
15
|
+
## ⚠️ **This library is currently under construction.**
|
|
15
16
|
- Some features, components, and styles may change in future versions.
|
|
16
17
|
|
|
17
|
-
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
## Table of contents
|
|
21
|
+
- [Features](#features)
|
|
22
|
+
- [Components list](#components-list)
|
|
23
|
+
- [Status](#status)
|
|
24
|
+
- [Quick start](#quick-start)
|
|
25
|
+
|
|
26
|
+
## Features
|
|
18
27
|
- ⚡ Built for Angular **v20+**
|
|
19
28
|
- 🧱 Atomic and modular architecture
|
|
20
29
|
- 🌗 Supports **Dark / Light** themes
|
|
21
30
|
- 🧩 Reusable UI components (Buttons, Cards, Modals, etc.)
|
|
22
31
|
- 🧪 100% compatible with **Angular CLI**, **Standalone Components**, and **SSR**
|
|
23
32
|
|
|
24
|
-
## Components
|
|
33
|
+
## Components list
|
|
25
34
|
- Button ✅
|
|
26
|
-
- Chip
|
|
35
|
+
- Chip ✅
|
|
36
|
+
- Icons ✅
|
|
37
|
+
- Input 👷🏾
|
|
27
38
|
- Header 👷🏾
|
|
28
39
|
- Footer 👷🏾
|
|
29
40
|
- Sidebar 👷🏾
|
|
30
41
|
|
|
31
|
-
##
|
|
42
|
+
## Status
|
|
43
|
+
<!--  -->
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
32
49
|
|
|
50
|
+
## Quick start
|
|
51
|
+
Install with npm:
|
|
33
52
|
```bash
|
|
34
53
|
npm i yudu-component-kit
|
|
35
54
|
```
|
|
36
55
|
|
|
37
|
-
|
|
38
|
-
## ⚠️ Important
|
|
56
|
+
### Configuration
|
|
39
57
|
Before using the UI components, you must initialize the theme service.
|
|
40
58
|
This library includes a service called `LocalStorageStore` that:
|
|
41
59
|
|
|
@@ -61,10 +79,9 @@ export class AppComponent {
|
|
|
61
79
|
|
|
62
80
|
Important: if you don’t inject the service, the theme classes won’t be applied and the global styles may not look as expected.
|
|
63
81
|
|
|
64
|
-
## ✍🏾 Register styles
|
|
65
82
|
YuduComponentKit ships a design-system stylesheet with tokens (CSS variables), base rules, and theme selectors. You must include it in your app.
|
|
66
|
-
```angular.json```
|
|
67
|
-
```
|
|
83
|
+
```angular.json``` this line: ```"node_modules/yudu-component-kit/src/lib/styles/index.design-system.scss"```
|
|
84
|
+
```json
|
|
68
85
|
{
|
|
69
86
|
"projects": {
|
|
70
87
|
"my-app": {
|
|
@@ -84,6 +101,6 @@ YuduComponentKit ships a design-system stylesheet with tokens (CSS variables), b
|
|
|
84
101
|
```
|
|
85
102
|
---
|
|
86
103
|
<p align="center">
|
|
87
|
-
Made with ❤️ by "Fine Yudu"
|
|
88
|
-
This project
|
|
104
|
+
Made with ❤️ by "Fine Yudu" 2025<br/>
|
|
105
|
+
This project uses Angular CLI version 20.3.8
|
|
89
106
|
</p>
|