@gilav21/shadcn-angular 0.0.19 → 0.0.21

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
@@ -23,12 +23,20 @@ This will:
23
23
  3. Add a `cn` utility for class merging.
24
24
  4. Create a `components.json` configuration file.
25
25
 
26
+ ### `init` Options
27
+
28
+ | Flag | Description |
29
+ |------|-------------|
30
+ | `-y, --yes` | Skip confirmation prompt |
31
+ | `-d, --defaults` | Use default configuration |
32
+ | `-b, --branch <branch>` | GitHub branch to fetch from (default: `master`) |
33
+
26
34
  ## Usage
27
35
 
28
36
  Use the `add` command to add components to your project:
29
37
 
30
38
  ```bash
31
- npx @gilav21/shadcn-angular add [component]
39
+ npx @gilav21/shadcn-angular add [component...]
32
40
  ```
33
41
 
34
42
  Example:
@@ -37,18 +45,49 @@ Example:
37
45
  npx @gilav21/shadcn-angular add button
38
46
  ```
39
47
 
40
- You can also run the command without arguments to select from a list:
48
+ You can add multiple components at once:
49
+
50
+ ```bash
51
+ npx @gilav21/shadcn-angular add button card dialog
52
+ ```
53
+
54
+ Or run without arguments to select from a list:
41
55
 
42
56
  ```bash
43
57
  npx @gilav21/shadcn-angular add
44
58
  ```
45
59
 
60
+ ### `add` Options
61
+
62
+ | Flag | Description |
63
+ |------|-------------|
64
+ | `-y, --yes` | Skip all prompts (no optional deps, no overwrite) |
65
+ | `-o, --overwrite` | Overwrite existing files that differ from the registry |
66
+ | `-a, --all` | Install every available component |
67
+ | `-p, --path <path>` | Custom install directory (overrides `components.json`) |
68
+ | `--remote` | Force fetch from GitHub (skip local registry) |
69
+ | `-b, --branch <branch>` | GitHub branch to fetch from (default: `master`) |
70
+
71
+ ## Optional Dependencies
72
+
73
+ Some components offer companion components that enhance their functionality. When you add such a component, the CLI will prompt you to optionally install them.
74
+
75
+ For example, `data-table` offers `context-menu` for right-click menus on rows and headers. `tree` also offers `context-menu` for right-click menus on tree nodes.
76
+
77
+ Behavior with flags:
78
+ - **Interactive (default)** — you pick which optional companions to include
79
+ - **`--yes`** — skips optional dependencies entirely (useful in CI)
80
+ - **`--all`** — automatically includes all optional dependencies
81
+
46
82
  ## Available Components
47
83
 
84
+ ### UI Components
85
+
48
86
  - Accordion
49
87
  - Alert
50
88
  - Alert Dialog
51
89
  - Aspect Ratio
90
+ - Autocomplete
52
91
  - Avatar
53
92
  - Badge
54
93
  - Breadcrumb
@@ -57,21 +96,31 @@ npx @gilav21/shadcn-angular add
57
96
  - Calendar
58
97
  - Card
59
98
  - Carousel
99
+ - Chat
60
100
  - Checkbox
61
101
  - Chip List
102
+ - Code Block
62
103
  - Collapsible
104
+ - Color Picker
63
105
  - Command
106
+ - Confetti
64
107
  - Context Menu
108
+ - Data Table
65
109
  - Date Picker
66
110
  - Dialog
111
+ - Dock
67
112
  - Drawer
68
113
  - Dropdown Menu
69
114
  - Emoji Picker
70
115
  - Empty State
71
116
  - Field
117
+ - File Upload
118
+ - File Viewer
72
119
  - Hover Card
120
+ - Icon
73
121
  - Input
74
122
  - Input Group
123
+ - Input Mask
75
124
  - Input OTP
76
125
  - Kbd (Keyboard Key)
77
126
  - Label
@@ -82,6 +131,7 @@ npx @gilav21/shadcn-angular add
82
131
  - Popover
83
132
  - Progress
84
133
  - Radio Group
134
+ - Rating
85
135
  - Resizable
86
136
  - Rich Text Editor
87
137
  - Scroll Area
@@ -93,14 +143,63 @@ npx @gilav21/shadcn-angular add
93
143
  - Slider
94
144
  - Speed Dial
95
145
  - Spinner
146
+ - Split Button
147
+ - Stepper
148
+ - Streaming Text
96
149
  - Switch
97
150
  - Table
98
151
  - Tabs
99
152
  - Textarea
153
+ - Timeline
100
154
  - Toast
101
155
  - Toggle
102
156
  - Toggle Group
103
157
  - Tooltip
158
+ - Tree
159
+ - Tree Select
160
+ - Virtual Scroll
161
+
162
+ ### Chart Components
163
+
164
+ - Bar Chart
165
+ - Bar Chart Drilldown
166
+ - Bar Race Chart
167
+ - Column Range Chart
168
+ - Org Chart
169
+ - Pie Chart
170
+ - Pie Chart Drilldown
171
+ - Stacked Bar Chart
172
+
173
+ ### Layout & Page Building
174
+
175
+ - Bento Grid
176
+ - Page Builder
177
+
178
+ ### Animation Components
179
+
180
+ - Blur Fade
181
+ - Flip Text
182
+ - Gradient Text
183
+ - Magnetic
184
+ - Marquee
185
+ - Meteors
186
+ - Morphing Text
187
+ - Number Ticker
188
+ - Orbit
189
+ - Particles
190
+ - Ripple
191
+ - Scroll Progress
192
+ - Shine Border
193
+ - Sparkles
194
+ - Stagger Children
195
+ - Text Reveal
196
+ - Typing Animation
197
+ - Wobble Card
198
+ - Word Rotate
199
+
200
+ ### Kanban
201
+
202
+ - Kanban
104
203
 
105
204
  ## Documentation
106
205
 
@@ -1,9 +1,13 @@
1
+ import { type ComponentName } from '../registry/index.js';
1
2
  interface AddOptions {
2
3
  yes?: boolean;
3
4
  overwrite?: boolean;
4
5
  all?: boolean;
5
6
  path?: string;
6
7
  remote?: boolean;
8
+ branch: string;
7
9
  }
10
+ export declare function resolveDependencies(names: ComponentName[]): Set<ComponentName>;
11
+ export declare function promptOptionalDependencies(resolved: Set<ComponentName>, options: AddOptions): Promise<ComponentName[]>;
8
12
  export declare function add(components: string[], options: AddOptions): Promise<void>;
9
13
  export {};