pejay-ui 1.3.3 → 1.3.4

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.
Files changed (2) hide show
  1. package/README.md +44 -132
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,165 +1,77 @@
1
- # pejay-ui CLI Commands
1
+ # pejay-ui
2
2
 
3
3
  A lightweight CLI tool to initialize, add, and remove React UI components in your projects.
4
4
 
5
- ## Commands
5
+ ## Core Commands
6
6
 
7
7
  ### 1. Initialize Configuration
8
- Initialize the configuration file `pejay-ui.json` in the root of your project.
9
8
  ```bash
10
9
  npx pejay-ui init
11
10
  ```
12
11
 
13
12
  ### 2. Add Component
14
- Download and install a component, automatically setting up its utilities (like `cn`) and resolving component-to-component dependencies.
15
13
  ```bash
16
14
  npx pejay-ui add <component-name>
17
15
  ```
18
- *Example:* `npx pejay-ui add button` or `npx pejay-ui add form/date-picker`
19
16
 
20
17
  ### 3. Remove Component
21
- Safely delete a component's files, and clean up any unused utilities or package dependencies that were installed with it.
22
18
  ```bash
23
19
  npx pejay-ui remove <component-name>
24
20
  ```
25
- *Example:* `npx pejay-ui remove button`
26
21
 
27
22
  ---
28
23
 
29
- ## Available Components
30
-
31
- Below is the list of components you can add. Each has a copyable command block with a working native copy button on GitHub and NPM:
24
+ ## Available Components & Scaffolds
32
25
 
33
26
  ### Buttons
34
-
35
- * **`button`**: Premium interactive button supporting multiple variants (solid, soft, ghost), loaders, and custom hover tooltips.
36
- ```bash
37
- npx pejay-ui add button
38
- ```
27
+ ```bash
28
+ npx pejay-ui add button
29
+ ```
39
30
 
40
31
  ### Form Inputs
41
-
42
- * **`form/input`**: Standard text input field with validation, labels, and error messaging.
43
- ```bash
44
- npx pejay-ui add form/input
45
- ```
46
- * **`form/amount-input`**: Numeric input configured for currency entry with symbol prefixes and formatting.
47
- ```bash
48
- npx pejay-ui add form/amount-input
49
- ```
50
- * **`form/checkbox`**: Styled single checkbox input.
51
- ```bash
52
- npx pejay-ui add form/checkbox
53
- ```
54
- * **`form/checkbox-group`**: Group of checkboxes managing single or multiple selection states with item indices.
55
- ```bash
56
- npx pejay-ui add form/checkbox-group
57
- ```
58
- * **`form/email-input`**: Dedicated input for email addresses with prefix icon.
59
- ```bash
60
- npx pejay-ui add form/email-input
61
- ```
62
- * **`form/file-input`**: Premium dropzone-style file upload component supporting drag-and-drop and progress/preview states.
63
- ```bash
64
- npx pejay-ui add form/file-input
65
- ```
66
- * **`form/number-input`**: Input field for numerical values with increment/decrement steppers.
67
- ```bash
68
- npx pejay-ui add form/number-input
69
- ```
70
- * **`form/password-input`**: Secure text input with eye icon toggle to show/hide the password.
71
- ```bash
72
- npx pejay-ui add form/password-input
73
- ```
74
- * **`form/phone-input`**: Formatted input field for telephone numbers.
75
- ```bash
76
- npx pejay-ui add form/phone-input
77
- ```
78
- * **`form/radio`**: Styled radio selection dot.
79
- ```bash
80
- npx pejay-ui add form/radio
81
- ```
82
- * **`form/radio-group`**: Group of mutually exclusive radio options.
83
- ```bash
84
- npx pejay-ui add form/radio-group
85
- ```
86
- * **`form/range-slider`**: Slider controls for choosing values from a numeric range.
87
- ```bash
88
- npx pejay-ui add form/range-slider
89
- ```
90
- * **`form/switch`**: Styled toggle switch representing boolean options.
91
- ```bash
92
- npx pejay-ui add form/switch
93
- ```
94
- * **`form/textarea`**: Multiline text area input with character counter/limit indicators.
95
- ```bash
96
- npx pejay-ui add form/textarea
97
- ```
98
- * **`form/url-input`**: Styled input field specifically formatted for web addresses/links.
99
- ```bash
100
- npx pejay-ui add form/url-input
101
- ```
32
+ ```bash
33
+ npx pejay-ui add form/input
34
+ npx pejay-ui add form/amount-input
35
+ npx pejay-ui add form/checkbox
36
+ npx pejay-ui add form/checkbox-group
37
+ npx pejay-ui add form/email-input
38
+ npx pejay-ui add form/file-input
39
+ npx pejay-ui add form/number-input
40
+ npx pejay-ui add form/password-input
41
+ npx pejay-ui add form/phone-input
42
+ npx pejay-ui add form/radio
43
+ npx pejay-ui add form/radio-group
44
+ npx pejay-ui add form/range-slider
45
+ npx pejay-ui add form/switch
46
+ npx pejay-ui add form/textarea
47
+ npx pejay-ui add form/url-input
48
+ ```
102
49
 
103
50
  ### Date & Time Pickers
104
-
105
- * **`form/date-picker`**: Calendar-based date selector popover with inline month/year dropdowns.
106
- ```bash
107
- npx pejay-ui add form/date-picker
108
- ```
109
- * **`form/date-range-picker`**: Date range selector to pick start and end dates with highlight ranges.
110
- ```bash
111
- npx pejay-ui add form/date-range-picker
112
- ```
113
- * **`form/time-picker`**: Dropdown component for picking specific hours, minutes, and AM/PM.
114
- ```bash
115
- npx pejay-ui add form/time-picker
116
- ```
117
- * **`form/time-range-picker`**: Popover time selector for configuring custom duration intervals.
118
- ```bash
119
- npx pejay-ui add form/time-range-picker
120
- ```
51
+ ```bash
52
+ npx pejay-ui add form/date-picker
53
+ npx pejay-ui add form/date-range-picker
54
+ npx pejay-ui add form/time-picker
55
+ npx pejay-ui add form/time-range-picker
56
+ ```
121
57
 
122
58
  ### Dropdowns & Selects
123
-
124
- * **`dropdown/select-input`**: Elegant single-select searchable dropdown input.
125
- ```bash
126
- npx pejay-ui add dropdown/select-input
127
- ```
128
- * **`dropdown/multiselect-input`**: Searchable multiselect dropdown which renders selected options as dismissible tag pills.
129
- ```bash
130
- npx pejay-ui add dropdown/multiselect-input
131
- ```
59
+ ```bash
60
+ npx pejay-ui add dropdown/select-input
61
+ npx pejay-ui add dropdown/multiselect-input
62
+ ```
132
63
 
133
64
  ### Layouts
134
-
135
- * **`layouts/lv1`**: A responsive, collapsible sidebar-based application layout.
136
- ```bash
137
- npx pejay-ui add layouts/lv1
138
- ```
65
+ ```bash
66
+ npx pejay-ui add layouts/lv1
67
+ ```
139
68
 
140
69
  ### Scaffolds & Templates
141
-
142
- * **`tanstack-query-client`**: Bare-bone TanStack Query client and context provider setup, copied directly into your project's `src/tanstack-query/`.
143
- ```bash
144
- npx pejay-ui add tanstack-query-client
145
- ```
146
- * **`react-router-client`**: Bare-bone React Router client layout, routing structure, and route guard setup, copied into `src/react-router/`.
147
- ```bash
148
- npx pejay-ui add react-router-client
149
- ```
150
- * **`tanstack-router-client`**: TanStack Router setup with layouts, route guards, and file-based route stubs, copied into `src/tanstack-router/`.
151
- ```bash
152
- npx pejay-ui add tanstack-router-client
153
- ```
154
- * **`axios-client`**: Axios instance with interceptors, request helpers, and a sample API module, copied into `src/axios/`.
155
- ```bash
156
- npx pejay-ui add axios-client
157
- ```
158
- * **`redux-store-client`**: Redux Toolkit store setup with `redux-persist`, reducers, slices, and selectors, copied into `src/redux-store/`.
159
- ```bash
160
- npx pejay-ui add redux-store-client
161
- ```
162
- * **`rtk-query-client`**: RTK Query base API with `fetchBaseQuery`, tag management, middleware, and a sample endpoint, copied into `src/rtk-query/`.
163
- ```bash
164
- npx pejay-ui add rtk-query-client
165
- ```
70
+ ```bash
71
+ npx pejay-ui add tanstack-query-client
72
+ npx pejay-ui add react-router-client
73
+ npx pejay-ui add tanstack-router-client
74
+ npx pejay-ui add axios-client
75
+ npx pejay-ui add redux-store-client
76
+ npx pejay-ui add rtk-query-client
77
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pejay-ui",
3
- "version": "1.3.3",
3
+ "version": "1.3.4",
4
4
  "type": "module",
5
5
  "description": "react ui components",
6
6
  "bin": {