@vaneui/ui 0.3.1-alpha.20251117134835.2318245 → 0.3.1-alpha.20251129115555.bcd1100
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/dist/components/ui/badge.d.ts +187 -0
- package/dist/components/ui/badge.d.ts.map +1 -1
- package/dist/components/ui/button.d.ts +187 -0
- package/dist/components/ui/button.d.ts.map +1 -1
- package/dist/components/ui/docs/propDocs.d.ts +151 -0
- package/dist/components/ui/docs/propDocs.d.ts.map +1 -0
- package/dist/index.esm.js +374 -0
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +374 -0
- package/dist/index.js.map +1 -1
- package/dist/ui.css +36 -0
- package/package.json +4 -2
|
@@ -1,3 +1,190 @@
|
|
|
1
1
|
import { BadgeProps } from './props';
|
|
2
|
+
/**
|
|
3
|
+
* Badge - A small label for status, categories, counts, or notifications
|
|
4
|
+
*
|
|
5
|
+
* @example
|
|
6
|
+
* ```tsx
|
|
7
|
+
* // Basic badge
|
|
8
|
+
* <Badge>New</Badge>
|
|
9
|
+
*
|
|
10
|
+
* // Status badge with appearance and variant
|
|
11
|
+
* <Badge success filled pill>Active</Badge>
|
|
12
|
+
*
|
|
13
|
+
* // Count badge
|
|
14
|
+
* <Badge danger filled>3</Badge>
|
|
15
|
+
*
|
|
16
|
+
* // As a link
|
|
17
|
+
* <Badge href="/notifications" primary outlined>5 New</Badge>
|
|
18
|
+
* ```
|
|
19
|
+
*
|
|
20
|
+
* @param props - Badge props
|
|
21
|
+
* @param props.children - Badge content
|
|
22
|
+
* @param props.className - Additional CSS classes to merge with theme classes
|
|
23
|
+
*
|
|
24
|
+
|
|
25
|
+
* SIZE PROPS:
|
|
26
|
+
* @param props.xs - Extra small size
|
|
27
|
+
* @param props.sm - Small size
|
|
28
|
+
* @param props.md - Medium size (default)
|
|
29
|
+
* @param props.lg - Large size
|
|
30
|
+
* @param props.xl - Extra large size
|
|
31
|
+
*
|
|
32
|
+
|
|
33
|
+
* ALIGNMENT PROPS (Cross-axis):
|
|
34
|
+
* @param props.itemsStart - Align items to start (top/left)
|
|
35
|
+
* @param props.itemsEnd - Align items to end (bottom/right)
|
|
36
|
+
* @param props.itemsCenter - Align items to center
|
|
37
|
+
* @param props.itemsBaseline - Align items to baseline
|
|
38
|
+
* @param props.itemsStretch - Stretch items to fill container
|
|
39
|
+
*
|
|
40
|
+
|
|
41
|
+
* ALIGNMENT PROPS (Main-axis):
|
|
42
|
+
* @param props.justifyStart - Justify content to start
|
|
43
|
+
* @param props.justifyEnd - Justify content to end
|
|
44
|
+
* @param props.justifyCenter - Justify content to center
|
|
45
|
+
* @param props.justifyBetween - Space between items
|
|
46
|
+
* @param props.justifyAround - Space around items
|
|
47
|
+
* @param props.justifyEvenly - Space evenly between items
|
|
48
|
+
*
|
|
49
|
+
|
|
50
|
+
* POSITION PROPS:
|
|
51
|
+
* @param props.relative - Relative positioning
|
|
52
|
+
* @param props.absolute - Absolute positioning
|
|
53
|
+
* @param props.fixed - Fixed positioning
|
|
54
|
+
* @param props.sticky - Sticky positioning
|
|
55
|
+
* @param props.static - Static positioning
|
|
56
|
+
*
|
|
57
|
+
|
|
58
|
+
* DISPLAY PROPS:
|
|
59
|
+
* @param props.flex - Display as flex container
|
|
60
|
+
* @param props.block - Display as block
|
|
61
|
+
* @param props.inline - Display as inline
|
|
62
|
+
* @param props.inlineBlock - Display as inline-block
|
|
63
|
+
* @param props.inlineFlex - Display as inline-flex
|
|
64
|
+
* @param props.grid - Display as grid
|
|
65
|
+
* @param props.inlineGrid - Display as inline-grid
|
|
66
|
+
* @param props.contents - Display as contents
|
|
67
|
+
* @param props.hidden - Hide element (display: none)
|
|
68
|
+
*
|
|
69
|
+
|
|
70
|
+
* OVERFLOW PROPS:
|
|
71
|
+
* @param props.overflowAuto - Auto overflow on both axes
|
|
72
|
+
* @param props.overflowHidden - Hidden overflow on both axes
|
|
73
|
+
* @param props.overflowVisible - Visible overflow on both axes
|
|
74
|
+
* @param props.overflowScroll - Scrollable overflow on both axes
|
|
75
|
+
* @param props.overflowXAuto - Auto overflow on X axis
|
|
76
|
+
* @param props.overflowYAuto - Auto overflow on Y axis
|
|
77
|
+
* @param props.overflowXHidden - Hidden overflow on X axis
|
|
78
|
+
* @param props.overflowYHidden - Hidden overflow on Y axis
|
|
79
|
+
*
|
|
80
|
+
|
|
81
|
+
* FLEXBOX PROPS:
|
|
82
|
+
* @param props.wrap - Enable flex wrap
|
|
83
|
+
* @param props.reverse - Reverse the order of children
|
|
84
|
+
*
|
|
85
|
+
|
|
86
|
+
* LAYOUT PROPS:
|
|
87
|
+
* @param props.gap - Enable gap spacing between children
|
|
88
|
+
* @param props.noGap - Disable gap spacing
|
|
89
|
+
* @param props.padding - Enable internal padding
|
|
90
|
+
* @param props.noPadding - Disable internal padding
|
|
91
|
+
*
|
|
92
|
+
|
|
93
|
+
* FLEXBOX DIRECTION PROPS:
|
|
94
|
+
* @param props.row - Flex direction row (horizontal)
|
|
95
|
+
* @param props.column - Flex direction column (vertical)
|
|
96
|
+
* @param props.rowReverse - Flex direction row-reverse
|
|
97
|
+
* @param props.columnReverse - Flex direction column-reverse
|
|
98
|
+
*
|
|
99
|
+
|
|
100
|
+
* APPEARANCE PROPS:
|
|
101
|
+
* @param props.default - Default color appearance
|
|
102
|
+
* @param props.primary - Primary color appearance (blue)
|
|
103
|
+
* @param props.secondary - Secondary color appearance (gray)
|
|
104
|
+
* @param props.tertiary - Tertiary color appearance
|
|
105
|
+
* @param props.accent - Accent color appearance (rose)
|
|
106
|
+
* @param props.success - Success color appearance (green)
|
|
107
|
+
* @param props.danger - Danger color appearance (red)
|
|
108
|
+
* @param props.warning - Warning color appearance (amber)
|
|
109
|
+
* @param props.info - Info color appearance (cyan)
|
|
110
|
+
* @param props.link - Link color appearance
|
|
111
|
+
*
|
|
112
|
+
|
|
113
|
+
* BORDER PROPS:
|
|
114
|
+
* @param props.border - Enable border on all sides
|
|
115
|
+
* @param props.borderT - Enable border on top
|
|
116
|
+
* @param props.borderB - Enable border on bottom
|
|
117
|
+
* @param props.borderL - Enable border on left
|
|
118
|
+
* @param props.borderR - Enable border on right
|
|
119
|
+
* @param props.borderX - Enable border on left and right
|
|
120
|
+
* @param props.borderY - Enable border on top and bottom
|
|
121
|
+
* @param props.noBorder - Disable all borders
|
|
122
|
+
*
|
|
123
|
+
|
|
124
|
+
* VISUAL DECORATION PROPS:
|
|
125
|
+
* @param props.shadow - Enable drop shadow
|
|
126
|
+
* @param props.noShadow - Disable drop shadow
|
|
127
|
+
* @param props.ring - Enable focus ring
|
|
128
|
+
* @param props.noRing - Disable focus ring
|
|
129
|
+
* @param props.focusVisible - Enable focus-visible outline
|
|
130
|
+
* @param props.noFocusVisible - Disable focus-visible outline
|
|
131
|
+
*
|
|
132
|
+
|
|
133
|
+
* SHAPE PROPS:
|
|
134
|
+
* @param props.rounded - Medium rounded corners (default)
|
|
135
|
+
* @param props.pill - Fully rounded corners (circular)
|
|
136
|
+
* @param props.sharp - No rounded corners (square)
|
|
137
|
+
*
|
|
138
|
+
|
|
139
|
+
* FONT WEIGHT PROPS:
|
|
140
|
+
* @param props.thin - Thin font weight (100)
|
|
141
|
+
* @param props.extralight - Extra light font weight (200)
|
|
142
|
+
* @param props.light - Light font weight (300)
|
|
143
|
+
* @param props.normal - Normal font weight (400)
|
|
144
|
+
* @param props.medium - Medium font weight (500)
|
|
145
|
+
* @param props.semibold - Semibold font weight (600)
|
|
146
|
+
* @param props.bold - Bold font weight (700)
|
|
147
|
+
* @param props.extrabold - Extra bold font weight (800)
|
|
148
|
+
* @param props.black - Black font weight (900)
|
|
149
|
+
*
|
|
150
|
+
|
|
151
|
+
* FONT STYLE PROPS:
|
|
152
|
+
* @param props.italic - Italic font style
|
|
153
|
+
* @param props.notItalic - Not italic (normal) font style
|
|
154
|
+
*
|
|
155
|
+
|
|
156
|
+
* TEXT DECORATION PROPS:
|
|
157
|
+
* @param props.underline - Underline text decoration
|
|
158
|
+
* @param props.lineThrough - Line-through text decoration
|
|
159
|
+
* @param props.noUnderline - No text decoration
|
|
160
|
+
*
|
|
161
|
+
|
|
162
|
+
* TEXT TRANSFORM PROPS:
|
|
163
|
+
* @param props.uppercase - Transform text to uppercase
|
|
164
|
+
* @param props.lowercase - Transform text to lowercase
|
|
165
|
+
* @param props.capitalize - Capitalize first letter of each word
|
|
166
|
+
* @param props.normalCase - Normal text case (no transformation)
|
|
167
|
+
*
|
|
168
|
+
|
|
169
|
+
* FONT FAMILY PROPS:
|
|
170
|
+
* @param props.sans - Sans-serif font family (default)
|
|
171
|
+
* @param props.serif - Serif font family
|
|
172
|
+
* @param props.mono - Monospace font family
|
|
173
|
+
*
|
|
174
|
+
|
|
175
|
+
* TEXT ALIGNMENT PROPS:
|
|
176
|
+
* @param props.textLeft - Align text to left
|
|
177
|
+
* @param props.textCenter - Align text to center
|
|
178
|
+
* @param props.textRight - Align text to right
|
|
179
|
+
* @param props.textJustify - Justify text
|
|
180
|
+
*
|
|
181
|
+
|
|
182
|
+
* VARIANT PROPS:
|
|
183
|
+
* @param props.filled - Filled variant with solid background
|
|
184
|
+
* @param props.outlined - Outlined variant with border only
|
|
185
|
+
* @param props.ghost - Ghost variant with minimal styling
|
|
186
|
+
*
|
|
187
|
+
* @see {@link BadgeProps} for the complete type definition
|
|
188
|
+
*/
|
|
2
189
|
export declare const Badge: import("react").ForwardRefExoticComponent<BadgeProps & import("react").RefAttributes<HTMLSpanElement>>;
|
|
3
190
|
//# sourceMappingURL=badge.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"badge.d.ts","sourceRoot":"","sources":["../../../src/components/ui/badge.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAIrC,eAAO,MAAM,KAAK,wGAKjB,CAAA"}
|
|
1
|
+
{"version":3,"file":"badge.d.ts","sourceRoot":"","sources":["../../../src/components/ui/badge.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAIrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0LG;AACH,eAAO,MAAM,KAAK,wGAKjB,CAAA"}
|
|
@@ -1,3 +1,190 @@
|
|
|
1
1
|
import { ButtonProps } from './props';
|
|
2
|
+
/**
|
|
3
|
+
* Button - A clickable button element with customizable appearance and behavior
|
|
4
|
+
*
|
|
5
|
+
* @example
|
|
6
|
+
* ```tsx
|
|
7
|
+
* // Basic button
|
|
8
|
+
* <Button>Click me</Button>
|
|
9
|
+
*
|
|
10
|
+
* // With size, appearance, and variant
|
|
11
|
+
* <Button lg primary filled>Submit</Button>
|
|
12
|
+
*
|
|
13
|
+
* // Outlined button
|
|
14
|
+
* <Button outlined secondary>Cancel</Button>
|
|
15
|
+
*
|
|
16
|
+
* // As a link
|
|
17
|
+
* <Button href="/about">Learn More</Button>
|
|
18
|
+
* ```
|
|
19
|
+
*
|
|
20
|
+
* @param props - Button props
|
|
21
|
+
* @param props.children - Button content
|
|
22
|
+
* @param props.className - Additional CSS classes to merge with theme classes
|
|
23
|
+
*
|
|
24
|
+
|
|
25
|
+
* SIZE PROPS:
|
|
26
|
+
* @param props.xs - Extra small size
|
|
27
|
+
* @param props.sm - Small size
|
|
28
|
+
* @param props.md - Medium size (default)
|
|
29
|
+
* @param props.lg - Large size
|
|
30
|
+
* @param props.xl - Extra large size
|
|
31
|
+
*
|
|
32
|
+
|
|
33
|
+
* ALIGNMENT PROPS (Cross-axis):
|
|
34
|
+
* @param props.itemsStart - Align items to start (top/left)
|
|
35
|
+
* @param props.itemsEnd - Align items to end (bottom/right)
|
|
36
|
+
* @param props.itemsCenter - Align items to center
|
|
37
|
+
* @param props.itemsBaseline - Align items to baseline
|
|
38
|
+
* @param props.itemsStretch - Stretch items to fill container
|
|
39
|
+
*
|
|
40
|
+
|
|
41
|
+
* ALIGNMENT PROPS (Main-axis):
|
|
42
|
+
* @param props.justifyStart - Justify content to start
|
|
43
|
+
* @param props.justifyEnd - Justify content to end
|
|
44
|
+
* @param props.justifyCenter - Justify content to center
|
|
45
|
+
* @param props.justifyBetween - Space between items
|
|
46
|
+
* @param props.justifyAround - Space around items
|
|
47
|
+
* @param props.justifyEvenly - Space evenly between items
|
|
48
|
+
*
|
|
49
|
+
|
|
50
|
+
* POSITION PROPS:
|
|
51
|
+
* @param props.relative - Relative positioning
|
|
52
|
+
* @param props.absolute - Absolute positioning
|
|
53
|
+
* @param props.fixed - Fixed positioning
|
|
54
|
+
* @param props.sticky - Sticky positioning
|
|
55
|
+
* @param props.static - Static positioning
|
|
56
|
+
*
|
|
57
|
+
|
|
58
|
+
* DISPLAY PROPS:
|
|
59
|
+
* @param props.flex - Display as flex container
|
|
60
|
+
* @param props.block - Display as block
|
|
61
|
+
* @param props.inline - Display as inline
|
|
62
|
+
* @param props.inlineBlock - Display as inline-block
|
|
63
|
+
* @param props.inlineFlex - Display as inline-flex
|
|
64
|
+
* @param props.grid - Display as grid
|
|
65
|
+
* @param props.inlineGrid - Display as inline-grid
|
|
66
|
+
* @param props.contents - Display as contents
|
|
67
|
+
* @param props.hidden - Hide element (display: none)
|
|
68
|
+
*
|
|
69
|
+
|
|
70
|
+
* OVERFLOW PROPS:
|
|
71
|
+
* @param props.overflowAuto - Auto overflow on both axes
|
|
72
|
+
* @param props.overflowHidden - Hidden overflow on both axes
|
|
73
|
+
* @param props.overflowVisible - Visible overflow on both axes
|
|
74
|
+
* @param props.overflowScroll - Scrollable overflow on both axes
|
|
75
|
+
* @param props.overflowXAuto - Auto overflow on X axis
|
|
76
|
+
* @param props.overflowYAuto - Auto overflow on Y axis
|
|
77
|
+
* @param props.overflowXHidden - Hidden overflow on X axis
|
|
78
|
+
* @param props.overflowYHidden - Hidden overflow on Y axis
|
|
79
|
+
*
|
|
80
|
+
|
|
81
|
+
* FLEXBOX PROPS:
|
|
82
|
+
* @param props.wrap - Enable flex wrap
|
|
83
|
+
* @param props.reverse - Reverse the order of children
|
|
84
|
+
*
|
|
85
|
+
|
|
86
|
+
* LAYOUT PROPS:
|
|
87
|
+
* @param props.gap - Enable gap spacing between children
|
|
88
|
+
* @param props.noGap - Disable gap spacing
|
|
89
|
+
* @param props.padding - Enable internal padding
|
|
90
|
+
* @param props.noPadding - Disable internal padding
|
|
91
|
+
*
|
|
92
|
+
|
|
93
|
+
* FLEXBOX DIRECTION PROPS:
|
|
94
|
+
* @param props.row - Flex direction row (horizontal)
|
|
95
|
+
* @param props.column - Flex direction column (vertical)
|
|
96
|
+
* @param props.rowReverse - Flex direction row-reverse
|
|
97
|
+
* @param props.columnReverse - Flex direction column-reverse
|
|
98
|
+
*
|
|
99
|
+
|
|
100
|
+
* APPEARANCE PROPS:
|
|
101
|
+
* @param props.default - Default color appearance
|
|
102
|
+
* @param props.primary - Primary color appearance (blue)
|
|
103
|
+
* @param props.secondary - Secondary color appearance (gray)
|
|
104
|
+
* @param props.tertiary - Tertiary color appearance
|
|
105
|
+
* @param props.accent - Accent color appearance (rose)
|
|
106
|
+
* @param props.success - Success color appearance (green)
|
|
107
|
+
* @param props.danger - Danger color appearance (red)
|
|
108
|
+
* @param props.warning - Warning color appearance (amber)
|
|
109
|
+
* @param props.info - Info color appearance (cyan)
|
|
110
|
+
* @param props.link - Link color appearance
|
|
111
|
+
*
|
|
112
|
+
|
|
113
|
+
* BORDER PROPS:
|
|
114
|
+
* @param props.border - Enable border on all sides
|
|
115
|
+
* @param props.borderT - Enable border on top
|
|
116
|
+
* @param props.borderB - Enable border on bottom
|
|
117
|
+
* @param props.borderL - Enable border on left
|
|
118
|
+
* @param props.borderR - Enable border on right
|
|
119
|
+
* @param props.borderX - Enable border on left and right
|
|
120
|
+
* @param props.borderY - Enable border on top and bottom
|
|
121
|
+
* @param props.noBorder - Disable all borders
|
|
122
|
+
*
|
|
123
|
+
|
|
124
|
+
* VISUAL DECORATION PROPS:
|
|
125
|
+
* @param props.shadow - Enable drop shadow
|
|
126
|
+
* @param props.noShadow - Disable drop shadow
|
|
127
|
+
* @param props.ring - Enable focus ring
|
|
128
|
+
* @param props.noRing - Disable focus ring
|
|
129
|
+
* @param props.focusVisible - Enable focus-visible outline
|
|
130
|
+
* @param props.noFocusVisible - Disable focus-visible outline
|
|
131
|
+
*
|
|
132
|
+
|
|
133
|
+
* SHAPE PROPS:
|
|
134
|
+
* @param props.rounded - Medium rounded corners (default)
|
|
135
|
+
* @param props.pill - Fully rounded corners (circular)
|
|
136
|
+
* @param props.sharp - No rounded corners (square)
|
|
137
|
+
*
|
|
138
|
+
|
|
139
|
+
* FONT WEIGHT PROPS:
|
|
140
|
+
* @param props.thin - Thin font weight (100)
|
|
141
|
+
* @param props.extralight - Extra light font weight (200)
|
|
142
|
+
* @param props.light - Light font weight (300)
|
|
143
|
+
* @param props.normal - Normal font weight (400)
|
|
144
|
+
* @param props.medium - Medium font weight (500)
|
|
145
|
+
* @param props.semibold - Semibold font weight (600)
|
|
146
|
+
* @param props.bold - Bold font weight (700)
|
|
147
|
+
* @param props.extrabold - Extra bold font weight (800)
|
|
148
|
+
* @param props.black - Black font weight (900)
|
|
149
|
+
*
|
|
150
|
+
|
|
151
|
+
* FONT STYLE PROPS:
|
|
152
|
+
* @param props.italic - Italic font style
|
|
153
|
+
* @param props.notItalic - Not italic (normal) font style
|
|
154
|
+
*
|
|
155
|
+
|
|
156
|
+
* TEXT DECORATION PROPS:
|
|
157
|
+
* @param props.underline - Underline text decoration
|
|
158
|
+
* @param props.lineThrough - Line-through text decoration
|
|
159
|
+
* @param props.noUnderline - No text decoration
|
|
160
|
+
*
|
|
161
|
+
|
|
162
|
+
* TEXT TRANSFORM PROPS:
|
|
163
|
+
* @param props.uppercase - Transform text to uppercase
|
|
164
|
+
* @param props.lowercase - Transform text to lowercase
|
|
165
|
+
* @param props.capitalize - Capitalize first letter of each word
|
|
166
|
+
* @param props.normalCase - Normal text case (no transformation)
|
|
167
|
+
*
|
|
168
|
+
|
|
169
|
+
* FONT FAMILY PROPS:
|
|
170
|
+
* @param props.sans - Sans-serif font family (default)
|
|
171
|
+
* @param props.serif - Serif font family
|
|
172
|
+
* @param props.mono - Monospace font family
|
|
173
|
+
*
|
|
174
|
+
|
|
175
|
+
* TEXT ALIGNMENT PROPS:
|
|
176
|
+
* @param props.textLeft - Align text to left
|
|
177
|
+
* @param props.textCenter - Align text to center
|
|
178
|
+
* @param props.textRight - Align text to right
|
|
179
|
+
* @param props.textJustify - Justify text
|
|
180
|
+
*
|
|
181
|
+
|
|
182
|
+
* VARIANT PROPS:
|
|
183
|
+
* @param props.filled - Filled variant with solid background
|
|
184
|
+
* @param props.outlined - Outlined variant with border only
|
|
185
|
+
* @param props.ghost - Ghost variant with minimal styling
|
|
186
|
+
*
|
|
187
|
+
* @see {@link ButtonProps} for the complete type definition
|
|
188
|
+
*/
|
|
2
189
|
export declare const Button: import("react").ForwardRefExoticComponent<ButtonProps & import("react").RefAttributes<HTMLButtonElement>>;
|
|
3
190
|
//# sourceMappingURL=button.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"button.d.ts","sourceRoot":"","sources":["../../../src/components/ui/button.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAItC,eAAO,MAAM,MAAM,2GAKlB,CAAC"}
|
|
1
|
+
{"version":3,"file":"button.d.ts","sourceRoot":"","sources":["../../../src/components/ui/button.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAItC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0LG;AACH,eAAO,MAAM,MAAM,2GAKlB,CAAC"}
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Reusable JSDoc documentation blocks for component props.
|
|
3
|
+
*
|
|
4
|
+
* This file provides pre-written JSDoc sections that can be composed
|
|
5
|
+
* into component documentation, eliminating copy-paste duplication.
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* import { SIZE_PROPS, APPEARANCE_PROPS_UI, VARIANT_PROPS } from './docs/propDocs';
|
|
9
|
+
*
|
|
10
|
+
* // Then use in template literals when building JSDoc
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Common props documentation
|
|
14
|
+
*/
|
|
15
|
+
export declare const COMMON_PROPS = "\n * @param props - Component props\n * @param props.children - Component content\n * @param props.className - Additional CSS classes to merge with theme classes";
|
|
16
|
+
/**
|
|
17
|
+
* Size props documentation (xs, sm, md, lg, xl)
|
|
18
|
+
*/
|
|
19
|
+
export declare const SIZE_PROPS = "\n * SIZE PROPS:\n * @param props.xs - Extra small size\n * @param props.sm - Small size\n * @param props.md - Medium size (default)\n * @param props.lg - Large size\n * @param props.xl - Extra large size";
|
|
20
|
+
/**
|
|
21
|
+
* Appearance props for UI components (primary, secondary, etc.)
|
|
22
|
+
*/
|
|
23
|
+
export declare const APPEARANCE_PROPS_UI = "\n * APPEARANCE PROPS:\n * @param props.default - Default color appearance\n * @param props.primary - Primary color appearance (blue)\n * @param props.secondary - Secondary color appearance (gray)\n * @param props.tertiary - Tertiary color appearance\n * @param props.accent - Accent color appearance (rose)\n * @param props.success - Success color appearance (green)\n * @param props.danger - Danger color appearance (red)\n * @param props.warning - Warning color appearance (amber)\n * @param props.info - Info color appearance (cyan)\n * @param props.link - Link color appearance";
|
|
24
|
+
/**
|
|
25
|
+
* Appearance props for layout components (background only)
|
|
26
|
+
*/
|
|
27
|
+
export declare const APPEARANCE_PROPS_LAYOUT = "\n * APPEARANCE PROPS (Background):\n * @param props.default - Default background color\n * @param props.primary - Primary background color\n * @param props.secondary - Secondary background color\n * @param props.tertiary - Tertiary background color";
|
|
28
|
+
/**
|
|
29
|
+
* Appearance props for typography (text color)
|
|
30
|
+
*/
|
|
31
|
+
export declare const APPEARANCE_PROPS_TEXT = "\n * APPEARANCE PROPS (Text Color):\n * @param props.default - Default text color (gray-900)\n * @param props.primary - Primary text color (blue-600)\n * @param props.secondary - Secondary text color (gray-600)\n * @param props.tertiary - Tertiary text color (gray-500)\n * @param props.accent - Accent text color (rose-700)\n * @param props.success - Success text color (emerald-600)\n * @param props.danger - Danger text color (red-600)\n * @param props.warning - Warning text color (amber-600)\n * @param props.info - Info text color (cyan-600)\n * @param props.link - Link text color (blue-600)";
|
|
32
|
+
/**
|
|
33
|
+
* Variant props (filled, outlined, ghost)
|
|
34
|
+
*/
|
|
35
|
+
export declare const VARIANT_PROPS = "\n * VARIANT PROPS:\n * @param props.filled - Filled variant with solid background\n * @param props.outlined - Outlined variant with border only\n * @param props.ghost - Ghost variant with minimal styling";
|
|
36
|
+
/**
|
|
37
|
+
* Shape props (rounded, pill, sharp)
|
|
38
|
+
*/
|
|
39
|
+
export declare const SHAPE_PROPS = "\n * SHAPE PROPS:\n * @param props.rounded - Medium rounded corners (default)\n * @param props.pill - Fully rounded corners (circular)\n * @param props.sharp - No rounded corners (square)";
|
|
40
|
+
/**
|
|
41
|
+
* Font family props
|
|
42
|
+
*/
|
|
43
|
+
export declare const FONT_FAMILY_PROPS = "\n * FONT FAMILY PROPS:\n * @param props.sans - Sans-serif font family (default)\n * @param props.serif - Serif font family\n * @param props.mono - Monospace font family";
|
|
44
|
+
/**
|
|
45
|
+
* Font weight props
|
|
46
|
+
*/
|
|
47
|
+
export declare const FONT_WEIGHT_PROPS = "\n * FONT WEIGHT PROPS:\n * @param props.thin - Thin font weight (100)\n * @param props.extralight - Extra light font weight (200)\n * @param props.light - Light font weight (300)\n * @param props.normal - Normal font weight (400)\n * @param props.medium - Medium font weight (500)\n * @param props.semibold - Semibold font weight (600)\n * @param props.bold - Bold font weight (700)\n * @param props.extrabold - Extra bold font weight (800)\n * @param props.black - Black font weight (900)";
|
|
48
|
+
/**
|
|
49
|
+
* Font style props
|
|
50
|
+
*/
|
|
51
|
+
export declare const FONT_STYLE_PROPS = "\n * FONT STYLE PROPS:\n * @param props.italic - Italic font style\n * @param props.notItalic - Not italic (normal) font style";
|
|
52
|
+
/**
|
|
53
|
+
* Text decoration props
|
|
54
|
+
*/
|
|
55
|
+
export declare const TEXT_DECORATION_PROPS = "\n * TEXT DECORATION PROPS:\n * @param props.underline - Underline text decoration\n * @param props.lineThrough - Line-through text decoration\n * @param props.noUnderline - No text decoration";
|
|
56
|
+
/**
|
|
57
|
+
* Text transform props
|
|
58
|
+
*/
|
|
59
|
+
export declare const TEXT_TRANSFORM_PROPS = "\n * TEXT TRANSFORM PROPS:\n * @param props.uppercase - Transform text to uppercase\n * @param props.lowercase - Transform text to lowercase\n * @param props.capitalize - Capitalize first letter of each word\n * @param props.normalCase - Normal text case (no transformation)";
|
|
60
|
+
/**
|
|
61
|
+
* Text alignment props
|
|
62
|
+
*/
|
|
63
|
+
export declare const TEXT_ALIGN_PROPS = "\n * TEXT ALIGNMENT PROPS:\n * @param props.textLeft - Align text to left\n * @param props.textCenter - Align text to center\n * @param props.textRight - Align text to right\n * @param props.textJustify - Justify text";
|
|
64
|
+
/**
|
|
65
|
+
* Visual decoration props (shadow, ring, focus)
|
|
66
|
+
*/
|
|
67
|
+
export declare const VISUAL_DECORATION_PROPS = "\n * VISUAL DECORATION PROPS:\n * @param props.shadow - Enable drop shadow\n * @param props.noShadow - Disable drop shadow\n * @param props.ring - Enable focus ring\n * @param props.noRing - Disable focus ring\n * @param props.focusVisible - Enable focus-visible outline\n * @param props.noFocusVisible - Disable focus-visible outline";
|
|
68
|
+
/**
|
|
69
|
+
* Layout props (gap, padding)
|
|
70
|
+
*/
|
|
71
|
+
export declare const LAYOUT_PROPS = "\n * LAYOUT PROPS:\n * @param props.gap - Enable gap spacing between children\n * @param props.noGap - Disable gap spacing\n * @param props.padding - Enable internal padding\n * @param props.noPadding - Disable internal padding";
|
|
72
|
+
/**
|
|
73
|
+
* Flexbox direction props
|
|
74
|
+
*/
|
|
75
|
+
export declare const FLEX_DIRECTION_PROPS = "\n * FLEXBOX DIRECTION PROPS:\n * @param props.row - Flex direction row (horizontal)\n * @param props.column - Flex direction column (vertical)\n * @param props.rowReverse - Flex direction row-reverse\n * @param props.columnReverse - Flex direction column-reverse";
|
|
76
|
+
/**
|
|
77
|
+
* Flexbox props (wrap, reverse)
|
|
78
|
+
*/
|
|
79
|
+
export declare const FLEX_PROPS = "\n * FLEXBOX PROPS:\n * @param props.wrap - Enable flex wrap\n * @param props.reverse - Reverse the order of children";
|
|
80
|
+
/**
|
|
81
|
+
* Alignment props (items)
|
|
82
|
+
*/
|
|
83
|
+
export declare const ITEMS_PROPS = "\n * ALIGNMENT PROPS (Cross-axis):\n * @param props.itemsStart - Align items to start (top/left)\n * @param props.itemsEnd - Align items to end (bottom/right)\n * @param props.itemsCenter - Align items to center\n * @param props.itemsBaseline - Align items to baseline\n * @param props.itemsStretch - Stretch items to fill container";
|
|
84
|
+
/**
|
|
85
|
+
* Alignment props (justify)
|
|
86
|
+
*/
|
|
87
|
+
export declare const JUSTIFY_PROPS = "\n * ALIGNMENT PROPS (Main-axis):\n * @param props.justifyStart - Justify content to start\n * @param props.justifyEnd - Justify content to end\n * @param props.justifyCenter - Justify content to center\n * @param props.justifyBetween - Space between items\n * @param props.justifyAround - Space around items\n * @param props.justifyEvenly - Space evenly between items";
|
|
88
|
+
/**
|
|
89
|
+
* Responsive breakpoint props
|
|
90
|
+
*/
|
|
91
|
+
export declare const BREAKPOINT_PROPS = "\n * RESPONSIVE BREAKPOINT PROPS:\n * @param props.mobileCol - Switch to column layout on mobile and below (max-mobile: 40rem)\n * @param props.tabletCol - Switch to column layout on tablet and below (max-tablet: 48rem)\n * @param props.laptopCol - Switch to column layout on laptop and below (max-laptop: 64rem)\n * @param props.desktopCol - Switch to column layout on desktop and below (max-desktop: 80rem)";
|
|
92
|
+
/**
|
|
93
|
+
* Border props
|
|
94
|
+
*/
|
|
95
|
+
export declare const BORDER_PROPS = "\n * BORDER PROPS:\n * @param props.border - Enable border on all sides\n * @param props.borderT - Enable border on top\n * @param props.borderB - Enable border on bottom\n * @param props.borderL - Enable border on left\n * @param props.borderR - Enable border on right\n * @param props.borderX - Enable border on left and right\n * @param props.borderY - Enable border on top and bottom\n * @param props.noBorder - Disable all borders";
|
|
96
|
+
/**
|
|
97
|
+
* Display props
|
|
98
|
+
*/
|
|
99
|
+
export declare const DISPLAY_PROPS = "\n * DISPLAY PROPS:\n * @param props.flex - Display as flex container\n * @param props.block - Display as block\n * @param props.inline - Display as inline\n * @param props.inlineBlock - Display as inline-block\n * @param props.inlineFlex - Display as inline-flex\n * @param props.grid - Display as grid\n * @param props.inlineGrid - Display as inline-grid\n * @param props.contents - Display as contents\n * @param props.hidden - Hide element (display: none)";
|
|
100
|
+
/**
|
|
101
|
+
* Position props
|
|
102
|
+
*/
|
|
103
|
+
export declare const POSITION_PROPS = "\n * POSITION PROPS:\n * @param props.relative - Relative positioning\n * @param props.absolute - Absolute positioning\n * @param props.fixed - Fixed positioning\n * @param props.sticky - Sticky positioning\n * @param props.static - Static positioning";
|
|
104
|
+
/**
|
|
105
|
+
* Overflow props
|
|
106
|
+
*/
|
|
107
|
+
export declare const OVERFLOW_PROPS = "\n * OVERFLOW PROPS:\n * @param props.overflowAuto - Auto overflow on both axes\n * @param props.overflowHidden - Hidden overflow on both axes\n * @param props.overflowVisible - Visible overflow on both axes\n * @param props.overflowScroll - Scrollable overflow on both axes\n * @param props.overflowXAuto - Auto overflow on X axis\n * @param props.overflowYAuto - Auto overflow on Y axis\n * @param props.overflowXHidden - Hidden overflow on X axis\n * @param props.overflowYHidden - Hidden overflow on Y axis";
|
|
108
|
+
/**
|
|
109
|
+
* Link/Tag polymorphism props
|
|
110
|
+
*/
|
|
111
|
+
export declare const LINK_TAG_PROPS = "\n * LINK & TAG PROPS:\n * @param props.href - URL to navigate to (renders component as anchor tag)\n * @param props.tag - Custom HTML tag or React component to render as";
|
|
112
|
+
/**
|
|
113
|
+
* Tag only props (for components without link mode)
|
|
114
|
+
*/
|
|
115
|
+
export declare const TAG_PROPS = "\n * TAG PROPS:\n * @param props.tag - Custom HTML tag to render as";
|
|
116
|
+
/**
|
|
117
|
+
* Transparent props
|
|
118
|
+
*/
|
|
119
|
+
export declare const TRANSPARENT_PROPS = "\n * TRANSPARENCY PROPS:\n * @param props.transparent - Transparent background/border";
|
|
120
|
+
/**
|
|
121
|
+
* List style props
|
|
122
|
+
*/
|
|
123
|
+
export declare const LIST_STYLE_PROPS = "\n * LIST STYLE PROPS:\n * @param props.disc - Bullet point list style\n * @param props.decimal - Numbered list style";
|
|
124
|
+
/**
|
|
125
|
+
* Visibility props (hide at breakpoints)
|
|
126
|
+
*/
|
|
127
|
+
export declare const VISIBILITY_PROPS = "\n * VISIBILITY PROPS:\n * @param props.xsHide - Hide on extra small screens\n * @param props.smHide - Hide on small screens\n * @param props.mdHide - Hide on medium screens\n * @param props.lgHide - Hide on large screens\n * @param props.xlHide - Hide on extra large screens";
|
|
128
|
+
/**
|
|
129
|
+
* Commonly used prop combinations
|
|
130
|
+
*/
|
|
131
|
+
export declare const TYPOGRAPHY_STYLE_PROPS: string;
|
|
132
|
+
export declare const ALIGNMENT_PROPS: string;
|
|
133
|
+
export declare const COMPLETE_FLEX_PROPS: string;
|
|
134
|
+
/**
|
|
135
|
+
* Helper function to build component JSDoc from sections
|
|
136
|
+
*/
|
|
137
|
+
export declare function buildComponentDoc(config: {
|
|
138
|
+
name: string;
|
|
139
|
+
description: string;
|
|
140
|
+
examples: string[];
|
|
141
|
+
propSections: string[];
|
|
142
|
+
propsType: string;
|
|
143
|
+
notes?: string[];
|
|
144
|
+
}): string;
|
|
145
|
+
/**
|
|
146
|
+
* Pre-configured documentation builders for common component types
|
|
147
|
+
*/
|
|
148
|
+
export declare const UI_COMPONENT_SECTIONS: string[];
|
|
149
|
+
export declare const LAYOUT_COMPONENT_SECTIONS: string[];
|
|
150
|
+
export declare const TYPOGRAPHY_COMPONENT_SECTIONS: string[];
|
|
151
|
+
//# sourceMappingURL=propDocs.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"propDocs.d.ts","sourceRoot":"","sources":["../../../../src/components/ui/docs/propDocs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH;;GAEG;AACH,eAAO,MAAM,YAAY,sKAGsD,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,UAAU,iNAMe,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,mBAAmB,2kBAWa,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,uBAAuB,8PAKiB,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,qBAAqB,2lBAWgB,CAAC;AAEnD;;GAEG;AACH,eAAO,MAAM,aAAa,iNAIiC,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,WAAW,gMAI4B,CAAC;AAErD;;GAEG;AACH,eAAO,MAAM,iBAAiB,8KAIe,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,iBAAiB,+eAUkB,CAAC;AAEjD;;GAEG;AACH,eAAO,MAAM,gBAAgB,mIAG8B,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,qBAAqB,qMAIe,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,oBAAoB,uRAKiC,CAAC;AAEnE;;GAEG;AACH,eAAO,MAAM,gBAAgB,8NAKc,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,uBAAuB,mVAO2B,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,YAAY,wOAK4B,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,oBAAoB,4QAK6B,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,UAAU,0HAGiC,CAAC;AAEzD;;GAEG;AACH,eAAO,MAAM,WAAW,iVAMuC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,aAAa,qXAOiC,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,gBAAgB,6ZAKkE,CAAC;AAEhG;;GAEG;AACH,eAAO,MAAM,YAAY,wbASsB,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,aAAa,gdAU4B,CAAC;AAEvD;;GAEG;AACH,eAAO,MAAM,cAAc,gQAMiB,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,cAAc,mgBASiC,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,cAAc,+KAG2C,CAAC;AAEvE;;GAEG;AACH,eAAO,MAAM,SAAS,wEAE6B,CAAC;AAEpD;;GAEG;AACH,eAAO,MAAM,iBAAiB,0FAE8B,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,gBAAgB,0HAGiB,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,gBAAgB,wRAMwB,CAAC;AAEtD;;GAEG;AAGH,eAAO,MAAM,sBAAsB,QAOnB,CAAC;AAGjB,eAAO,MAAM,eAAe,QAA8C,CAAC;AAG3E,eAAO,MAAM,mBAAmB,QAKhB,CAAC;AAEjB;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,GAAG,MAAM,CA4BT;AAED;;GAEG;AAEH,eAAO,MAAM,qBAAqB,UAUjC,CAAC;AAEF,eAAO,MAAM,yBAAyB,UASrC,CAAC;AAEF,eAAO,MAAM,6BAA6B,UAKzC,CAAC"}
|