@kiranshub/dashboard-ui 0.0.1 → 0.0.3
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
CHANGED
|
@@ -1,13 +1,171 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @kiranshub/dashboard-ui
|
|
2
2
|
|
|
3
3
|
Angular UI component library featuring a dashboard layout with sidebar navigation, buttons, icons, and more.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install
|
|
8
|
+
npm install @kiranshub/dashboard-ui
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
+
Include the theme styles and override as you see fit for your app
|
|
12
|
+
|
|
13
|
+
```css
|
|
14
|
+
|
|
15
|
+
@import url('https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap');
|
|
16
|
+
|
|
17
|
+
:root {
|
|
18
|
+
/* ===========================================
|
|
19
|
+
Typography
|
|
20
|
+
=========================================== */
|
|
21
|
+
--font-family:
|
|
22
|
+
'Inter', system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
|
|
23
|
+
|
|
24
|
+
/* Font sizes */
|
|
25
|
+
--font-size-xs: 0.75rem;
|
|
26
|
+
--font-size-sm: 0.875rem;
|
|
27
|
+
--font-size-base: 1rem;
|
|
28
|
+
--font-size-lg: 1.25rem;
|
|
29
|
+
|
|
30
|
+
/* ===========================================
|
|
31
|
+
Breakpoints
|
|
32
|
+
=========================================== */
|
|
33
|
+
--breakpoint-mobile: 768px;
|
|
34
|
+
|
|
35
|
+
/* ===========================================
|
|
36
|
+
Spacing
|
|
37
|
+
=========================================== */
|
|
38
|
+
--spacing-xs: 0.25rem;
|
|
39
|
+
--spacing-sm: 0.5rem;
|
|
40
|
+
--spacing-md: 1rem;
|
|
41
|
+
--spacing-lg: 1.5rem;
|
|
42
|
+
--spacing-xl: 2rem;
|
|
43
|
+
|
|
44
|
+
/* ===========================================
|
|
45
|
+
Grid
|
|
46
|
+
=========================================== */
|
|
47
|
+
--grid-gap-xs: 0.25rem;
|
|
48
|
+
--grid-gap-sm: 0.5rem;
|
|
49
|
+
--grid-gap-md: 1rem;
|
|
50
|
+
--grid-gap-lg: 2rem;
|
|
51
|
+
--grid-gap-xl: 4rem;
|
|
52
|
+
|
|
53
|
+
/* ===========================================
|
|
54
|
+
Layout
|
|
55
|
+
=========================================== */
|
|
56
|
+
--sidebar-width: 15.625rem;
|
|
57
|
+
--header-height: 3.75rem;
|
|
58
|
+
|
|
59
|
+
/* ===========================================
|
|
60
|
+
Border Radius
|
|
61
|
+
=========================================== */
|
|
62
|
+
--radius-sm: 0.25rem;
|
|
63
|
+
--radius-md: 0.375rem;
|
|
64
|
+
--radius-lg: 0.5rem;
|
|
65
|
+
|
|
66
|
+
/* ===========================================
|
|
67
|
+
Button Padding
|
|
68
|
+
=========================================== */
|
|
69
|
+
--padding-button-sm-x: 0.5rem;
|
|
70
|
+
--padding-button-sm-y: 0.25rem;
|
|
71
|
+
--padding-button-md-x: 0.75rem;
|
|
72
|
+
--padding-button-md-y: 0.5rem;
|
|
73
|
+
--padding-button-lg-x: 1rem;
|
|
74
|
+
--padding-button-lg-y: 0.75rem;
|
|
75
|
+
|
|
76
|
+
/* ===========================================
|
|
77
|
+
Colors - Primary
|
|
78
|
+
=========================================== */
|
|
79
|
+
--color-primary: #fdb5ce;
|
|
80
|
+
--color-primary-hover: #f5a3c0;
|
|
81
|
+
--color-primary-foreground: #333333;
|
|
82
|
+
--color-btn-text: #333333;
|
|
83
|
+
|
|
84
|
+
/* ===========================================
|
|
85
|
+
Colors - Secondary
|
|
86
|
+
=========================================== */
|
|
87
|
+
--color-secondary: #333333;
|
|
88
|
+
--color-secondary-hover: #4a4a4a;
|
|
89
|
+
--color-secondary-foreground: #ffffff;
|
|
90
|
+
--color-btn-secondary-text: #ffffff;
|
|
91
|
+
|
|
92
|
+
/* ===========================================
|
|
93
|
+
Colors - Outline
|
|
94
|
+
=========================================== */
|
|
95
|
+
--color-outline: #fdb5ce;
|
|
96
|
+
--color-outline-foreground: #333333;
|
|
97
|
+
|
|
98
|
+
/* ===========================================
|
|
99
|
+
Colors - Neutrals
|
|
100
|
+
=========================================== */
|
|
101
|
+
|
|
102
|
+
/* ===========================================
|
|
103
|
+
Colors - Background
|
|
104
|
+
=========================================== */
|
|
105
|
+
--color-bg: #fff1f6;
|
|
106
|
+
--color-bg-sidebar: #ffffff;
|
|
107
|
+
--color-bg-sidebar-nav: #ffffff;
|
|
108
|
+
--color-bg-card: #ffffff;
|
|
109
|
+
|
|
110
|
+
/* ===========================================
|
|
111
|
+
Colors - Sidebar
|
|
112
|
+
=========================================== */
|
|
113
|
+
--color-sidebar-text: #333333;
|
|
114
|
+
--color-sidebar-text-hover: #555555;
|
|
115
|
+
--color-sidebar-hover: rgba(0, 0, 0, 0.05);
|
|
116
|
+
--color-sidebar-border: #e5e5e5;
|
|
117
|
+
|
|
118
|
+
/* ===========================================
|
|
119
|
+
Colors - Text
|
|
120
|
+
=========================================== */
|
|
121
|
+
--color-text: #333333;
|
|
122
|
+
--color-text-muted: #666666;
|
|
123
|
+
|
|
124
|
+
/* ===========================================
|
|
125
|
+
Colors - Border
|
|
126
|
+
=========================================== */
|
|
127
|
+
--color-border: #e5e5e5;
|
|
128
|
+
|
|
129
|
+
/* ===========================================
|
|
130
|
+
Transitions
|
|
131
|
+
=========================================== */
|
|
132
|
+
--transition-fast: 150ms ease;
|
|
133
|
+
--transition-normal: 200ms ease;
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
/* Dark mode - controlled via data-theme attribute */
|
|
137
|
+
[data-theme='dark'] {
|
|
138
|
+
/* Primary, Secondary, Outline */
|
|
139
|
+
--color-primary: #fdb5ce;
|
|
140
|
+
--color-primary-hover: #f5a3c0;
|
|
141
|
+
--color-primary-foreground: #333333;
|
|
142
|
+
--color-btn-text: #333333;
|
|
143
|
+
--color-secondary: #333333;
|
|
144
|
+
--color-secondary-hover: #4a4a4a;
|
|
145
|
+
--color-secondary-foreground: #ffffff;
|
|
146
|
+
--color-btn-secondary-text: #ffffff;
|
|
147
|
+
--color-outline: #fdb5ce;
|
|
148
|
+
--color-outline-foreground: #333333;
|
|
149
|
+
|
|
150
|
+
--color-bg: #1a1a1a;
|
|
151
|
+
--color-bg-card: #252525;
|
|
152
|
+
--color-bg-sidebar: #141414;
|
|
153
|
+
--color-bg-sidebar-nav: #141414;
|
|
154
|
+
--color-text: #fdb5ce;
|
|
155
|
+
--color-text-muted: #b08fa0;
|
|
156
|
+
--color-border: #3a3a3a;
|
|
157
|
+
--color-sidebar-text: #fdb5ce;
|
|
158
|
+
--color-sidebar-text-hover: #ffc5e0;
|
|
159
|
+
--color-sidebar-hover: rgba(255, 255, 255, 0.08);
|
|
160
|
+
--color-sidebar-border: #2a2a2a;
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
11
169
|
## Components
|
|
12
170
|
|
|
13
171
|
### Dashboard
|
|
@@ -15,7 +173,7 @@ npm install particle-ui
|
|
|
15
173
|
A full dashboard layout with collapsible sidebar, theme toggle, and user dropdown menu.
|
|
16
174
|
|
|
17
175
|
```typescript
|
|
18
|
-
import { DashboardComponent, type NavListItem } from '
|
|
176
|
+
import { DashboardComponent, type NavListItem } from '@kiranshub/dashboard-ui';
|
|
19
177
|
|
|
20
178
|
@Component({
|
|
21
179
|
imports: [DashboardComponent],
|
|
@@ -63,7 +221,7 @@ Available icons: `menu`, `chevron-left`, `chevron-right`, `xmark`, `home`, `char
|
|
|
63
221
|
## Button
|
|
64
222
|
|
|
65
223
|
```typescript
|
|
66
|
-
import { ParticleButton, type ButtonVariant, type ButtonSize } from '
|
|
224
|
+
import { ParticleButton, type ButtonVariant, type ButtonSize } from '@kiranshub/dashboard-ui';
|
|
67
225
|
|
|
68
226
|
@Component({
|
|
69
227
|
imports: [ParticleButton],
|
|
@@ -82,7 +240,7 @@ export class AppComponent {
|
|
|
82
240
|
## Icon
|
|
83
241
|
|
|
84
242
|
```typescript
|
|
85
|
-
import { ParticleIcon, type IconName } from '
|
|
243
|
+
import { ParticleIcon, type IconName } from '@kiranshub/dashboard-ui';
|
|
86
244
|
|
|
87
245
|
@Component({
|
|
88
246
|
imports: [ParticleIcon],
|