@electroplix/components 0.3.1 → 0.5.0-alpha.10
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/CHANGELOG.md +144 -0
- package/LICENSE +21 -0
- package/README.md +130 -516
- package/SECURITY.md +19 -0
- package/cli.cjs +544 -485
- package/dist/config.d.ts +73 -0
- package/dist/config.esm.js +229 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.esm.js +11575 -9459
- package/dist/package.json +100 -0
- package/dist/src/components/blog/index.d.ts +21 -21
- package/dist/src/components/blog/index.d.ts.map +1 -1
- package/dist/src/components/buttons/index.d.ts +24 -25
- package/dist/src/components/buttons/index.d.ts.map +1 -1
- package/dist/src/components/content/BlockquoteTestimonial.d.ts +3 -5
- package/dist/src/components/content/BlockquoteTestimonial.d.ts.map +1 -1
- package/dist/src/components/content/CalloutBox.d.ts +4 -6
- package/dist/src/components/content/CalloutBox.d.ts.map +1 -1
- package/dist/src/components/content/HeadingSection.d.ts +4 -6
- package/dist/src/components/content/HeadingSection.d.ts.map +1 -1
- package/dist/src/components/content/InlineCodeText.d.ts +5 -6
- package/dist/src/components/content/InlineCodeText.d.ts.map +1 -1
- package/dist/src/components/content/ParagraphBlock.d.ts +5 -7
- package/dist/src/components/content/ParagraphBlock.d.ts.map +1 -1
- package/dist/src/components/content/RichMarkdown.d.ts +5 -6
- package/dist/src/components/content/RichMarkdown.d.ts.map +1 -1
- package/dist/src/components/content/TeamGrid.d.ts +4 -3
- package/dist/src/components/content/TeamGrid.d.ts.map +1 -1
- package/dist/src/components/content/index.d.ts +7 -7
- package/dist/src/components/content/index.d.ts.map +1 -1
- package/dist/src/components/data-display/Badge.d.ts +6 -5
- package/dist/src/components/data-display/Badge.d.ts.map +1 -1
- package/dist/src/components/data-display/BadgeGroup.d.ts +6 -4
- package/dist/src/components/data-display/BadgeGroup.d.ts.map +1 -1
- package/dist/src/components/data-display/BarChart.d.ts +3 -2
- package/dist/src/components/data-display/BarChart.d.ts.map +1 -1
- package/dist/src/components/data-display/CalendarGrid.d.ts +4 -3
- package/dist/src/components/data-display/CalendarGrid.d.ts.map +1 -1
- package/dist/src/components/data-display/DataTable.d.ts +5 -5
- package/dist/src/components/data-display/DataTable.d.ts.map +1 -1
- package/dist/src/components/data-display/LineChart.d.ts +3 -2
- package/dist/src/components/data-display/LineChart.d.ts.map +1 -1
- package/dist/src/components/data-display/PieChart.d.ts +3 -2
- package/dist/src/components/data-display/PieChart.d.ts.map +1 -1
- package/dist/src/components/data-display/ProgressBar.d.ts +3 -2
- package/dist/src/components/data-display/ProgressBar.d.ts.map +1 -1
- package/dist/src/components/data-display/RatingStars.d.ts +3 -2
- package/dist/src/components/data-display/RatingStars.d.ts.map +1 -1
- package/dist/src/components/data-display/Sparkline.d.ts +3 -2
- package/dist/src/components/data-display/Sparkline.d.ts.map +1 -1
- package/dist/src/components/data-display/Timeline.d.ts +4 -3
- package/dist/src/components/data-display/Timeline.d.ts.map +1 -1
- package/dist/src/components/data-display/index.d.ts +11 -11
- package/dist/src/components/data-display/index.d.ts.map +1 -1
- package/dist/src/components/ecommerce/index.d.ts +25 -22
- package/dist/src/components/ecommerce/index.d.ts.map +1 -1
- package/dist/src/components/forms/AddressAutocomplete.d.ts +2 -4
- package/dist/src/components/forms/AddressAutocomplete.d.ts.map +1 -1
- package/dist/src/components/forms/Captcha.d.ts +3 -5
- package/dist/src/components/forms/Captcha.d.ts.map +1 -1
- package/dist/src/components/forms/ContactForm.d.ts +2 -4
- package/dist/src/components/forms/ContactForm.d.ts.map +1 -1
- package/dist/src/components/forms/DateTimePicker.d.ts +3 -5
- package/dist/src/components/forms/DateTimePicker.d.ts.map +1 -1
- package/dist/src/components/forms/FileUploader.d.ts +2 -4
- package/dist/src/components/forms/FileUploader.d.ts.map +1 -1
- package/dist/src/components/forms/FormShell.d.ts +2 -5
- package/dist/src/components/forms/FormShell.d.ts.map +1 -1
- package/dist/src/components/forms/InputField.d.ts +2 -4
- package/dist/src/components/forms/InputField.d.ts.map +1 -1
- package/dist/src/components/forms/MultiStepWizard.d.ts +2 -4
- package/dist/src/components/forms/MultiStepWizard.d.ts.map +1 -1
- package/dist/src/components/forms/NewsletterSignup.d.ts +2 -4
- package/dist/src/components/forms/NewsletterSignup.d.ts.map +1 -1
- package/dist/src/components/forms/RadioGroup.d.ts +2 -4
- package/dist/src/components/forms/RadioGroup.d.ts.map +1 -1
- package/dist/src/components/forms/SelectDropdown.d.ts +2 -4
- package/dist/src/components/forms/SelectDropdown.d.ts.map +1 -1
- package/dist/src/components/forms/TextAreaField.d.ts +2 -4
- package/dist/src/components/forms/TextAreaField.d.ts.map +1 -1
- package/dist/src/components/forms/ToggleSwitch.d.ts +2 -4
- package/dist/src/components/forms/ToggleSwitch.d.ts.map +1 -1
- package/dist/src/components/forms/ValidationWrapper.d.ts +2 -4
- package/dist/src/components/forms/ValidationWrapper.d.ts.map +1 -1
- package/dist/src/components/forms/index.d.ts +28 -28
- package/dist/src/components/forms/index.d.ts.map +1 -1
- package/dist/src/components/hero/CTAOverlayHero.d.ts +2 -4
- package/dist/src/components/hero/CTAOverlayHero.d.ts.map +1 -1
- package/dist/src/components/hero/CarouselHero.d.ts +2 -4
- package/dist/src/components/hero/CarouselHero.d.ts.map +1 -1
- package/dist/src/components/hero/HeroShell.d.ts +2 -5
- package/dist/src/components/hero/HeroShell.d.ts.map +1 -1
- package/dist/src/components/hero/PatternedHero.d.ts +3 -5
- package/dist/src/components/hero/PatternedHero.d.ts.map +1 -1
- package/dist/src/components/hero/SplitHero.d.ts +2 -4
- package/dist/src/components/hero/SplitHero.d.ts.map +1 -1
- package/dist/src/components/hero/StaticHero.d.ts +3 -5
- package/dist/src/components/hero/StaticHero.d.ts.map +1 -1
- package/dist/src/components/hero/VideoHeaderHero.d.ts +2 -4
- package/dist/src/components/hero/VideoHeaderHero.d.ts.map +1 -1
- package/dist/src/components/hero/index.d.ts +14 -14
- package/dist/src/components/hero/index.d.ts.map +1 -1
- package/dist/src/components/lists-cards/index.d.ts +19 -22
- package/dist/src/components/lists-cards/index.d.ts.map +1 -1
- package/dist/src/components/marketing/index.d.ts +24 -24
- package/dist/src/components/marketing/index.d.ts.map +1 -1
- package/dist/src/components/media/index.d.ts +31 -33
- package/dist/src/components/media/index.d.ts.map +1 -1
- package/dist/src/components/miscellaneous/index.d.ts +18 -17
- package/dist/src/components/miscellaneous/index.d.ts.map +1 -1
- package/dist/src/components/modals/index.d.ts +23 -34
- package/dist/src/components/modals/index.d.ts.map +1 -1
- package/dist/src/components/navigation/AnchorLinks.d.ts +4 -6
- package/dist/src/components/navigation/AnchorLinks.d.ts.map +1 -1
- package/dist/src/components/navigation/Breadcrumbs.d.ts +3 -5
- package/dist/src/components/navigation/Breadcrumbs.d.ts.map +1 -1
- package/dist/src/components/navigation/Footer.d.ts +3 -4
- package/dist/src/components/navigation/Footer.d.ts.map +1 -1
- package/dist/src/components/navigation/LanguageSelector.d.ts +3 -5
- package/dist/src/components/navigation/LanguageSelector.d.ts.map +1 -1
- package/dist/src/components/navigation/MegaMenu.d.ts +3 -5
- package/dist/src/components/navigation/MegaMenu.d.ts.map +1 -1
- package/dist/src/components/navigation/Pagination.d.ts +3 -2
- package/dist/src/components/navigation/Pagination.d.ts.map +1 -1
- package/dist/src/components/navigation/PrimaryNav.d.ts +3 -2
- package/dist/src/components/navigation/PrimaryNav.d.ts.map +1 -1
- package/dist/src/components/navigation/SideDrawerNav.d.ts +5 -4
- package/dist/src/components/navigation/SideDrawerNav.d.ts.map +1 -1
- package/dist/src/components/navigation/SidebarMenu.d.ts +4 -3
- package/dist/src/components/navigation/SidebarMenu.d.ts.map +1 -1
- package/dist/src/components/navigation/Stepper.d.ts +4 -3
- package/dist/src/components/navigation/Stepper.d.ts.map +1 -1
- package/dist/src/components/navigation/Tabs.d.ts +5 -4
- package/dist/src/components/navigation/Tabs.d.ts.map +1 -1
- package/dist/src/components/navigation/index.d.ts +22 -22
- package/dist/src/components/navigation/index.d.ts.map +1 -1
- package/dist/src/components/onboarding/index.d.ts +17 -17
- package/dist/src/components/onboarding/index.d.ts.map +1 -1
- package/dist/src/components/search/index.d.ts +13 -12
- package/dist/src/components/search/index.d.ts.map +1 -1
- package/dist/src/components/site-identity/index.d.ts +14 -15
- package/dist/src/components/site-identity/index.d.ts.map +1 -1
- package/dist/src/components/social/index.d.ts +19 -18
- package/dist/src/components/social/index.d.ts.map +1 -1
- package/dist/src/components/user-accounts/index.d.ts +17 -17
- package/dist/src/components/user-accounts/index.d.ts.map +1 -1
- package/dist/src/core/config.d.ts +1 -1
- package/dist/src/core/config.d.ts.map +1 -1
- package/dist/src/core/icons.d.ts +1 -1
- package/dist/src/core/icons.d.ts.map +1 -1
- package/dist/src/core/index.d.ts +7 -7
- package/dist/src/core/index.d.ts.map +1 -1
- package/dist/src/core/provider.d.ts +20 -20
- package/dist/src/core/provider.d.ts.map +1 -1
- package/dist/src/core/styles.d.ts +2 -0
- package/dist/src/core/styles.d.ts.map +1 -0
- package/dist/src/core/types.d.ts +4 -4
- package/dist/src/core/types.d.ts.map +1 -1
- package/dist/src/core/utils.d.ts +1 -1
- package/dist/src/core/utils.d.ts.map +1 -1
- package/dist/src/index.d.ts +19 -19
- package/dist/src/index.d.ts.map +1 -1
- package/metadata/blog.json +807 -0
- package/metadata/buttons.json +2186 -0
- package/metadata/content.json +1152 -0
- package/metadata/data-display.json +822 -0
- package/metadata/ecommerce.json +1059 -0
- package/metadata/forms.json +2637 -0
- package/metadata/hero.json +1401 -0
- package/metadata/lists-cards.json +848 -0
- package/metadata/marketing.json +1235 -0
- package/metadata/media.json +800 -0
- package/metadata/miscellaneous.json +778 -0
- package/metadata/modals.json +954 -0
- package/metadata/navigation.json +1348 -0
- package/metadata/onboarding.json +615 -0
- package/metadata/search.json +559 -0
- package/metadata/site-identity.json +555 -0
- package/metadata/social.json +654 -0
- package/metadata/user-accounts.json +727 -0
- package/package.json +100 -85
- package/dist/README.md +0 -35
- package/dist/src/__tests__/test-utils.d.ts +0 -8
- package/dist/src/__tests__/test-utils.d.ts.map +0 -1
|
@@ -0,0 +1,1348 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "electroplix-component-metadata-v1",
|
|
3
|
+
"category": "navigation",
|
|
4
|
+
"label": "Navigation",
|
|
5
|
+
"description": "Components for site navigation, menus, breadcrumbs, tabs, steppers, and wayfinding elements",
|
|
6
|
+
"themeKey": "navigation",
|
|
7
|
+
"icon": "compass",
|
|
8
|
+
"sortOrder": 1,
|
|
9
|
+
"components": [
|
|
10
|
+
{
|
|
11
|
+
"id": "navigation.PrimaryNav",
|
|
12
|
+
"name": "PrimaryNav",
|
|
13
|
+
"description": "Main top-level navigation bar with logo, links, optional search and CTA button. Supports sticky positioning.",
|
|
14
|
+
"whenToUse": "Use as the primary navigation element at the top of every page. Essential for marketing sites, dashboards, blogs, and any web app requiring consistent top-level navigation.",
|
|
15
|
+
"isShell": false,
|
|
16
|
+
"props": [
|
|
17
|
+
{
|
|
18
|
+
"name": "logoText",
|
|
19
|
+
"type": "string",
|
|
20
|
+
"required": false,
|
|
21
|
+
"default": "\"MyBrand\"",
|
|
22
|
+
"description": "Brand/logo text displayed in the nav bar"
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"name": "links",
|
|
26
|
+
"type": "NavLink[]",
|
|
27
|
+
"required": false,
|
|
28
|
+
"default": "[]",
|
|
29
|
+
"description": "Array of navigation links: {label, href}"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"name": "showSearch",
|
|
33
|
+
"type": "boolean",
|
|
34
|
+
"required": false,
|
|
35
|
+
"default": "false",
|
|
36
|
+
"description": "Whether to display a search input in the nav"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "showCTA",
|
|
40
|
+
"type": "boolean",
|
|
41
|
+
"required": false,
|
|
42
|
+
"default": "false",
|
|
43
|
+
"description": "Whether to show the call-to-action button"
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"name": "ctaText",
|
|
47
|
+
"type": "string",
|
|
48
|
+
"required": false,
|
|
49
|
+
"default": "\"Get Started\"",
|
|
50
|
+
"description": "Text for the CTA button"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"name": "ctaHref",
|
|
54
|
+
"type": "string",
|
|
55
|
+
"required": false,
|
|
56
|
+
"default": "\"#\"",
|
|
57
|
+
"description": "URL for the CTA button"
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"name": "sticky",
|
|
61
|
+
"type": "boolean",
|
|
62
|
+
"required": false,
|
|
63
|
+
"default": "false",
|
|
64
|
+
"description": "Whether the nav sticks to the top on scroll"
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"name": "height",
|
|
68
|
+
"type": "number",
|
|
69
|
+
"required": false,
|
|
70
|
+
"default": "72",
|
|
71
|
+
"description": "Height of the navigation bar in pixels"
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
"name": "padding",
|
|
75
|
+
"type": "number",
|
|
76
|
+
"required": false,
|
|
77
|
+
"default": "24",
|
|
78
|
+
"description": "Horizontal padding in pixels"
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
"name": "bgColor",
|
|
82
|
+
"type": "string",
|
|
83
|
+
"required": false,
|
|
84
|
+
"default": "theme",
|
|
85
|
+
"description": "Background color override"
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"name": "textColor",
|
|
89
|
+
"type": "string",
|
|
90
|
+
"required": false,
|
|
91
|
+
"default": "theme",
|
|
92
|
+
"description": "Text color override"
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
"name": "accentColor",
|
|
96
|
+
"type": "string",
|
|
97
|
+
"required": false,
|
|
98
|
+
"default": "theme",
|
|
99
|
+
"description": "Accent/highlight color override"
|
|
100
|
+
},
|
|
101
|
+
{
|
|
102
|
+
"name": "borderColor",
|
|
103
|
+
"type": "string",
|
|
104
|
+
"required": false,
|
|
105
|
+
"default": "theme",
|
|
106
|
+
"description": "Border color override"
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
"name": "fontFamily",
|
|
110
|
+
"type": "string",
|
|
111
|
+
"required": false,
|
|
112
|
+
"default": "theme",
|
|
113
|
+
"description": "Font family override"
|
|
114
|
+
}
|
|
115
|
+
],
|
|
116
|
+
"themeTokens": [
|
|
117
|
+
"bgColor",
|
|
118
|
+
"textColor",
|
|
119
|
+
"accentColor",
|
|
120
|
+
"borderColor",
|
|
121
|
+
"fontFamily",
|
|
122
|
+
"radius",
|
|
123
|
+
"spacing",
|
|
124
|
+
"height",
|
|
125
|
+
"padding",
|
|
126
|
+
"sticky",
|
|
127
|
+
"showSearch",
|
|
128
|
+
"showCTA"
|
|
129
|
+
],
|
|
130
|
+
"aiHints": {
|
|
131
|
+
"pageTypes": [
|
|
132
|
+
"landing",
|
|
133
|
+
"marketing",
|
|
134
|
+
"dashboard",
|
|
135
|
+
"blog",
|
|
136
|
+
"ecommerce",
|
|
137
|
+
"portfolio",
|
|
138
|
+
"saas",
|
|
139
|
+
"restaurant",
|
|
140
|
+
"fitness",
|
|
141
|
+
"education",
|
|
142
|
+
"community",
|
|
143
|
+
"nonprofit",
|
|
144
|
+
"realestate",
|
|
145
|
+
"event",
|
|
146
|
+
"agency",
|
|
147
|
+
"health"
|
|
148
|
+
],
|
|
149
|
+
"placement": "header",
|
|
150
|
+
"priority": 10,
|
|
151
|
+
"sequenceOrder": 1,
|
|
152
|
+
"pairsWellWith": [
|
|
153
|
+
"hero.StaticHero",
|
|
154
|
+
"hero.SplitHero",
|
|
155
|
+
"hero.VideoHeaderHero",
|
|
156
|
+
"content.HeadingSection"
|
|
157
|
+
],
|
|
158
|
+
"maxPerPage": 1,
|
|
159
|
+
"isContainer": false
|
|
160
|
+
}
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
"id": "navigation.MegaMenu",
|
|
164
|
+
"name": "MegaMenu",
|
|
165
|
+
"description": "Multi-section dropdown menu with grouped links and optional descriptions. Great for sites with complex navigation hierarchies.",
|
|
166
|
+
"whenToUse": "Use when you have many navigation items organized into groups. Ideal for ecommerce sites with multiple product categories, enterprise dashboards, or documentation portals.",
|
|
167
|
+
"isShell": false,
|
|
168
|
+
"props": [
|
|
169
|
+
{
|
|
170
|
+
"name": "as",
|
|
171
|
+
"type": "ElementType",
|
|
172
|
+
"required": false,
|
|
173
|
+
"default": "\"div\"",
|
|
174
|
+
"description": "HTML element or component to render as"
|
|
175
|
+
},
|
|
176
|
+
{
|
|
177
|
+
"name": "label",
|
|
178
|
+
"type": "string",
|
|
179
|
+
"required": true,
|
|
180
|
+
"default": null,
|
|
181
|
+
"description": "The trigger label for the mega menu"
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"name": "sections",
|
|
185
|
+
"type": "MegaMenuSection[]",
|
|
186
|
+
"required": true,
|
|
187
|
+
"default": null,
|
|
188
|
+
"description": "Array of sections: {title, links: MenuLink[]{label, href, description?}}"
|
|
189
|
+
},
|
|
190
|
+
{
|
|
191
|
+
"name": "maxW",
|
|
192
|
+
"type": "number",
|
|
193
|
+
"required": false,
|
|
194
|
+
"default": "800",
|
|
195
|
+
"description": "Maximum width of the dropdown panel"
|
|
196
|
+
},
|
|
197
|
+
{
|
|
198
|
+
"name": "px",
|
|
199
|
+
"type": "number",
|
|
200
|
+
"required": false,
|
|
201
|
+
"default": "24",
|
|
202
|
+
"description": "Horizontal padding"
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
"name": "py",
|
|
206
|
+
"type": "number",
|
|
207
|
+
"required": false,
|
|
208
|
+
"default": "24",
|
|
209
|
+
"description": "Vertical padding"
|
|
210
|
+
},
|
|
211
|
+
{
|
|
212
|
+
"name": "radius",
|
|
213
|
+
"type": "number",
|
|
214
|
+
"required": false,
|
|
215
|
+
"default": "16",
|
|
216
|
+
"description": "Border radius"
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"name": "bgColor",
|
|
220
|
+
"type": "string",
|
|
221
|
+
"required": false,
|
|
222
|
+
"default": "theme",
|
|
223
|
+
"description": "Background color override"
|
|
224
|
+
},
|
|
225
|
+
{
|
|
226
|
+
"name": "textColor",
|
|
227
|
+
"type": "string",
|
|
228
|
+
"required": false,
|
|
229
|
+
"default": "theme",
|
|
230
|
+
"description": "Text color override"
|
|
231
|
+
},
|
|
232
|
+
{
|
|
233
|
+
"name": "accentColor",
|
|
234
|
+
"type": "string",
|
|
235
|
+
"required": false,
|
|
236
|
+
"default": "theme",
|
|
237
|
+
"description": "Accent color override"
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
"name": "borderColor",
|
|
241
|
+
"type": "string",
|
|
242
|
+
"required": false,
|
|
243
|
+
"default": "theme",
|
|
244
|
+
"description": "Border color override"
|
|
245
|
+
},
|
|
246
|
+
{
|
|
247
|
+
"name": "fontFamily",
|
|
248
|
+
"type": "string",
|
|
249
|
+
"required": false,
|
|
250
|
+
"default": "theme",
|
|
251
|
+
"description": "Font family override"
|
|
252
|
+
},
|
|
253
|
+
{
|
|
254
|
+
"name": "style",
|
|
255
|
+
"type": "CSSProperties",
|
|
256
|
+
"required": false,
|
|
257
|
+
"default": null,
|
|
258
|
+
"description": "Custom inline styles"
|
|
259
|
+
},
|
|
260
|
+
{
|
|
261
|
+
"name": "className",
|
|
262
|
+
"type": "string",
|
|
263
|
+
"required": false,
|
|
264
|
+
"default": null,
|
|
265
|
+
"description": "Custom CSS class"
|
|
266
|
+
}
|
|
267
|
+
],
|
|
268
|
+
"themeTokens": [
|
|
269
|
+
"bgColor",
|
|
270
|
+
"textColor",
|
|
271
|
+
"accentColor",
|
|
272
|
+
"borderColor",
|
|
273
|
+
"fontFamily",
|
|
274
|
+
"radius",
|
|
275
|
+
"spacing"
|
|
276
|
+
],
|
|
277
|
+
"aiHints": {
|
|
278
|
+
"pageTypes": ["enterprise", "ecommerce", "documentation", "marketplace", "agency"],
|
|
279
|
+
"placement": "header",
|
|
280
|
+
"priority": 7,
|
|
281
|
+
"sequenceOrder": 1,
|
|
282
|
+
"pairsWellWith": ["navigation.PrimaryNav", "navigation.Breadcrumbs"],
|
|
283
|
+
"maxPerPage": 1,
|
|
284
|
+
"isContainer": false
|
|
285
|
+
}
|
|
286
|
+
},
|
|
287
|
+
{
|
|
288
|
+
"id": "navigation.SidebarMenu",
|
|
289
|
+
"name": "SidebarMenu",
|
|
290
|
+
"description": "Vertical sidebar navigation with expandable child items. Supports icons and nested sub-menus.",
|
|
291
|
+
"whenToUse": "Use for dashboard applications, admin panels, or documentation sites that need persistent vertical navigation with nested items.",
|
|
292
|
+
"isShell": false,
|
|
293
|
+
"props": [
|
|
294
|
+
{
|
|
295
|
+
"name": "items",
|
|
296
|
+
"type": "SidebarItem[]",
|
|
297
|
+
"required": true,
|
|
298
|
+
"default": null,
|
|
299
|
+
"description": "Array of items: {label, href, icon?, children?: SidebarChild[]{label, href}}"
|
|
300
|
+
},
|
|
301
|
+
{
|
|
302
|
+
"name": "width",
|
|
303
|
+
"type": "number",
|
|
304
|
+
"required": false,
|
|
305
|
+
"default": "260",
|
|
306
|
+
"description": "Width of the sidebar in pixels"
|
|
307
|
+
},
|
|
308
|
+
{
|
|
309
|
+
"name": "padding",
|
|
310
|
+
"type": "number",
|
|
311
|
+
"required": false,
|
|
312
|
+
"default": "16",
|
|
313
|
+
"description": "Internal padding"
|
|
314
|
+
},
|
|
315
|
+
{
|
|
316
|
+
"name": "gap",
|
|
317
|
+
"type": "number",
|
|
318
|
+
"required": false,
|
|
319
|
+
"default": "4",
|
|
320
|
+
"description": "Gap between menu items"
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
"name": "radius",
|
|
324
|
+
"type": "number",
|
|
325
|
+
"required": false,
|
|
326
|
+
"default": "16",
|
|
327
|
+
"description": "Border radius of the sidebar"
|
|
328
|
+
},
|
|
329
|
+
{
|
|
330
|
+
"name": "bgColor",
|
|
331
|
+
"type": "string",
|
|
332
|
+
"required": false,
|
|
333
|
+
"default": "theme",
|
|
334
|
+
"description": "Background color override"
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
"name": "textColor",
|
|
338
|
+
"type": "string",
|
|
339
|
+
"required": false,
|
|
340
|
+
"default": "theme",
|
|
341
|
+
"description": "Text color override"
|
|
342
|
+
},
|
|
343
|
+
{
|
|
344
|
+
"name": "accentColor",
|
|
345
|
+
"type": "string",
|
|
346
|
+
"required": false,
|
|
347
|
+
"default": "theme",
|
|
348
|
+
"description": "Accent color override"
|
|
349
|
+
},
|
|
350
|
+
{
|
|
351
|
+
"name": "borderColor",
|
|
352
|
+
"type": "string",
|
|
353
|
+
"required": false,
|
|
354
|
+
"default": "theme",
|
|
355
|
+
"description": "Border color override"
|
|
356
|
+
},
|
|
357
|
+
{
|
|
358
|
+
"name": "fontFamily",
|
|
359
|
+
"type": "string",
|
|
360
|
+
"required": false,
|
|
361
|
+
"default": "theme",
|
|
362
|
+
"description": "Font family override"
|
|
363
|
+
}
|
|
364
|
+
],
|
|
365
|
+
"themeTokens": [
|
|
366
|
+
"bgColor",
|
|
367
|
+
"textColor",
|
|
368
|
+
"accentColor",
|
|
369
|
+
"borderColor",
|
|
370
|
+
"fontFamily",
|
|
371
|
+
"radius",
|
|
372
|
+
"spacing"
|
|
373
|
+
],
|
|
374
|
+
"aiHints": {
|
|
375
|
+
"pageTypes": ["dashboard", "admin", "documentation", "settings"],
|
|
376
|
+
"placement": "sidebar",
|
|
377
|
+
"priority": 8,
|
|
378
|
+
"sequenceOrder": 1,
|
|
379
|
+
"pairsWellWith": ["navigation.Breadcrumbs", "content.HeadingSection"],
|
|
380
|
+
"maxPerPage": 1,
|
|
381
|
+
"isContainer": false
|
|
382
|
+
}
|
|
383
|
+
},
|
|
384
|
+
{
|
|
385
|
+
"id": "navigation.Tabs",
|
|
386
|
+
"name": "Tabs",
|
|
387
|
+
"description": "Tabbed navigation for switching between content panels. Supports horizontal and vertical orientations with optional underline indicator.",
|
|
388
|
+
"whenToUse": "Use to organize related content into switchable panels. Ideal for settings pages, product details with multiple sections, or any UI requiring content segmentation.",
|
|
389
|
+
"isShell": false,
|
|
390
|
+
"props": [
|
|
391
|
+
{
|
|
392
|
+
"name": "tabs",
|
|
393
|
+
"type": "TabDef[]",
|
|
394
|
+
"required": true,
|
|
395
|
+
"default": null,
|
|
396
|
+
"description": "Array of tab definitions: {label, icon?, content: ReactNode}"
|
|
397
|
+
},
|
|
398
|
+
{
|
|
399
|
+
"name": "defaultTab",
|
|
400
|
+
"type": "number",
|
|
401
|
+
"required": false,
|
|
402
|
+
"default": "0",
|
|
403
|
+
"description": "Index of the initially active tab"
|
|
404
|
+
},
|
|
405
|
+
{
|
|
406
|
+
"name": "orientation",
|
|
407
|
+
"type": "\"horizontal\" | \"vertical\"",
|
|
408
|
+
"required": false,
|
|
409
|
+
"default": "\"horizontal\"",
|
|
410
|
+
"description": "Tab layout direction"
|
|
411
|
+
},
|
|
412
|
+
{
|
|
413
|
+
"name": "showUnderline",
|
|
414
|
+
"type": "boolean",
|
|
415
|
+
"required": false,
|
|
416
|
+
"default": "false",
|
|
417
|
+
"description": "Show underline indicator on active tab"
|
|
418
|
+
},
|
|
419
|
+
{
|
|
420
|
+
"name": "radius",
|
|
421
|
+
"type": "number",
|
|
422
|
+
"required": false,
|
|
423
|
+
"default": "14",
|
|
424
|
+
"description": "Border radius for tab buttons"
|
|
425
|
+
},
|
|
426
|
+
{
|
|
427
|
+
"name": "padding",
|
|
428
|
+
"type": "number",
|
|
429
|
+
"required": false,
|
|
430
|
+
"default": "12",
|
|
431
|
+
"description": "Padding inside tab buttons"
|
|
432
|
+
},
|
|
433
|
+
{
|
|
434
|
+
"name": "gap",
|
|
435
|
+
"type": "number",
|
|
436
|
+
"required": false,
|
|
437
|
+
"default": "8",
|
|
438
|
+
"description": "Gap between tab buttons"
|
|
439
|
+
},
|
|
440
|
+
{
|
|
441
|
+
"name": "bgColor",
|
|
442
|
+
"type": "string",
|
|
443
|
+
"required": false,
|
|
444
|
+
"default": "theme",
|
|
445
|
+
"description": "Background color override"
|
|
446
|
+
},
|
|
447
|
+
{
|
|
448
|
+
"name": "textColor",
|
|
449
|
+
"type": "string",
|
|
450
|
+
"required": false,
|
|
451
|
+
"default": "theme",
|
|
452
|
+
"description": "Text color override"
|
|
453
|
+
},
|
|
454
|
+
{
|
|
455
|
+
"name": "accentColor",
|
|
456
|
+
"type": "string",
|
|
457
|
+
"required": false,
|
|
458
|
+
"default": "theme",
|
|
459
|
+
"description": "Accent color override"
|
|
460
|
+
},
|
|
461
|
+
{
|
|
462
|
+
"name": "borderColor",
|
|
463
|
+
"type": "string",
|
|
464
|
+
"required": false,
|
|
465
|
+
"default": "theme",
|
|
466
|
+
"description": "Border color override"
|
|
467
|
+
},
|
|
468
|
+
{
|
|
469
|
+
"name": "fontFamily",
|
|
470
|
+
"type": "string",
|
|
471
|
+
"required": false,
|
|
472
|
+
"default": "theme",
|
|
473
|
+
"description": "Font family override"
|
|
474
|
+
}
|
|
475
|
+
],
|
|
476
|
+
"themeTokens": [
|
|
477
|
+
"bgColor",
|
|
478
|
+
"textColor",
|
|
479
|
+
"accentColor",
|
|
480
|
+
"borderColor",
|
|
481
|
+
"fontFamily",
|
|
482
|
+
"radius",
|
|
483
|
+
"spacing"
|
|
484
|
+
],
|
|
485
|
+
"aiHints": {
|
|
486
|
+
"pageTypes": ["dashboard", "settings", "ecommerce", "documentation", "blog"],
|
|
487
|
+
"placement": "body",
|
|
488
|
+
"priority": 7,
|
|
489
|
+
"sequenceOrder": 5,
|
|
490
|
+
"pairsWellWith": ["content.HeadingSection", "forms.FormShell", "dataDisplay.DataTable"],
|
|
491
|
+
"maxPerPage": 3,
|
|
492
|
+
"isContainer": true
|
|
493
|
+
}
|
|
494
|
+
},
|
|
495
|
+
{
|
|
496
|
+
"id": "navigation.Breadcrumbs",
|
|
497
|
+
"name": "Breadcrumbs",
|
|
498
|
+
"description": "Horizontal breadcrumb trail showing the current page's position in the site hierarchy. Includes optional home icon.",
|
|
499
|
+
"whenToUse": "Use on interior pages to show the user's location within the site structure. Essential for ecommerce category pages, documentation, and multi-level content sites.",
|
|
500
|
+
"isShell": false,
|
|
501
|
+
"props": [
|
|
502
|
+
{
|
|
503
|
+
"name": "as",
|
|
504
|
+
"type": "ElementType",
|
|
505
|
+
"required": false,
|
|
506
|
+
"default": "\"nav\"",
|
|
507
|
+
"description": "HTML element to render as"
|
|
508
|
+
},
|
|
509
|
+
{
|
|
510
|
+
"name": "items",
|
|
511
|
+
"type": "BreadcrumbItem[]",
|
|
512
|
+
"required": true,
|
|
513
|
+
"default": null,
|
|
514
|
+
"description": "Array of breadcrumb items: {label, href?}"
|
|
515
|
+
},
|
|
516
|
+
{
|
|
517
|
+
"name": "showHomeIcon",
|
|
518
|
+
"type": "boolean",
|
|
519
|
+
"required": false,
|
|
520
|
+
"default": "true",
|
|
521
|
+
"description": "Show a home icon for the first item"
|
|
522
|
+
},
|
|
523
|
+
{
|
|
524
|
+
"name": "separatorColor",
|
|
525
|
+
"type": "string",
|
|
526
|
+
"required": false,
|
|
527
|
+
"default": null,
|
|
528
|
+
"description": "Color of the separator between items"
|
|
529
|
+
},
|
|
530
|
+
{
|
|
531
|
+
"name": "maxW",
|
|
532
|
+
"type": "number",
|
|
533
|
+
"required": false,
|
|
534
|
+
"default": "1100",
|
|
535
|
+
"description": "Maximum width"
|
|
536
|
+
},
|
|
537
|
+
{
|
|
538
|
+
"name": "px",
|
|
539
|
+
"type": "number",
|
|
540
|
+
"required": false,
|
|
541
|
+
"default": "20",
|
|
542
|
+
"description": "Horizontal padding"
|
|
543
|
+
},
|
|
544
|
+
{
|
|
545
|
+
"name": "py",
|
|
546
|
+
"type": "number",
|
|
547
|
+
"required": false,
|
|
548
|
+
"default": "12",
|
|
549
|
+
"description": "Vertical padding"
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
"name": "radius",
|
|
553
|
+
"type": "number",
|
|
554
|
+
"required": false,
|
|
555
|
+
"default": "12",
|
|
556
|
+
"description": "Border radius"
|
|
557
|
+
},
|
|
558
|
+
{
|
|
559
|
+
"name": "gap",
|
|
560
|
+
"type": "number",
|
|
561
|
+
"required": false,
|
|
562
|
+
"default": "8",
|
|
563
|
+
"description": "Gap between items"
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
"name": "bgColor",
|
|
567
|
+
"type": "string",
|
|
568
|
+
"required": false,
|
|
569
|
+
"default": "theme",
|
|
570
|
+
"description": "Background color override"
|
|
571
|
+
},
|
|
572
|
+
{
|
|
573
|
+
"name": "textColor",
|
|
574
|
+
"type": "string",
|
|
575
|
+
"required": false,
|
|
576
|
+
"default": "theme",
|
|
577
|
+
"description": "Text color override"
|
|
578
|
+
},
|
|
579
|
+
{
|
|
580
|
+
"name": "accentColor",
|
|
581
|
+
"type": "string",
|
|
582
|
+
"required": false,
|
|
583
|
+
"default": "theme",
|
|
584
|
+
"description": "Accent color override"
|
|
585
|
+
},
|
|
586
|
+
{
|
|
587
|
+
"name": "borderColor",
|
|
588
|
+
"type": "string",
|
|
589
|
+
"required": false,
|
|
590
|
+
"default": "theme",
|
|
591
|
+
"description": "Border color override"
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
"name": "fontFamily",
|
|
595
|
+
"type": "string",
|
|
596
|
+
"required": false,
|
|
597
|
+
"default": "theme",
|
|
598
|
+
"description": "Font family override"
|
|
599
|
+
},
|
|
600
|
+
{
|
|
601
|
+
"name": "style",
|
|
602
|
+
"type": "CSSProperties",
|
|
603
|
+
"required": false,
|
|
604
|
+
"default": null,
|
|
605
|
+
"description": "Custom inline styles"
|
|
606
|
+
},
|
|
607
|
+
{
|
|
608
|
+
"name": "className",
|
|
609
|
+
"type": "string",
|
|
610
|
+
"required": false,
|
|
611
|
+
"default": null,
|
|
612
|
+
"description": "Custom CSS class"
|
|
613
|
+
}
|
|
614
|
+
],
|
|
615
|
+
"themeTokens": [
|
|
616
|
+
"bgColor",
|
|
617
|
+
"textColor",
|
|
618
|
+
"accentColor",
|
|
619
|
+
"borderColor",
|
|
620
|
+
"fontFamily",
|
|
621
|
+
"radius",
|
|
622
|
+
"spacing"
|
|
623
|
+
],
|
|
624
|
+
"aiHints": {
|
|
625
|
+
"pageTypes": ["ecommerce", "documentation", "blog", "portal", "dashboard"],
|
|
626
|
+
"placement": "body",
|
|
627
|
+
"priority": 6,
|
|
628
|
+
"sequenceOrder": 2,
|
|
629
|
+
"pairsWellWith": ["navigation.PrimaryNav", "content.HeadingSection"],
|
|
630
|
+
"maxPerPage": 1,
|
|
631
|
+
"isContainer": false
|
|
632
|
+
}
|
|
633
|
+
},
|
|
634
|
+
{
|
|
635
|
+
"id": "navigation.Pagination",
|
|
636
|
+
"name": "Pagination",
|
|
637
|
+
"description": "Page navigation control with numbered buttons, previous/next arrows, and optional first/last buttons.",
|
|
638
|
+
"whenToUse": "Use at the bottom of paginated content like search results, data tables, blog post lists, or product grids.",
|
|
639
|
+
"isShell": false,
|
|
640
|
+
"props": [
|
|
641
|
+
{
|
|
642
|
+
"name": "currentPage",
|
|
643
|
+
"type": "number",
|
|
644
|
+
"required": true,
|
|
645
|
+
"default": null,
|
|
646
|
+
"description": "Currently active page number"
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
"name": "totalPages",
|
|
650
|
+
"type": "number",
|
|
651
|
+
"required": true,
|
|
652
|
+
"default": null,
|
|
653
|
+
"description": "Total number of pages"
|
|
654
|
+
},
|
|
655
|
+
{
|
|
656
|
+
"name": "onPageChange",
|
|
657
|
+
"type": "(page: number) => void",
|
|
658
|
+
"required": true,
|
|
659
|
+
"default": null,
|
|
660
|
+
"description": "Callback when a page is selected"
|
|
661
|
+
},
|
|
662
|
+
{
|
|
663
|
+
"name": "maxVisible",
|
|
664
|
+
"type": "number",
|
|
665
|
+
"required": false,
|
|
666
|
+
"default": "5",
|
|
667
|
+
"description": "Maximum number of page buttons visible"
|
|
668
|
+
},
|
|
669
|
+
{
|
|
670
|
+
"name": "showFirstLast",
|
|
671
|
+
"type": "boolean",
|
|
672
|
+
"required": false,
|
|
673
|
+
"default": "true",
|
|
674
|
+
"description": "Show first/last page buttons"
|
|
675
|
+
},
|
|
676
|
+
{
|
|
677
|
+
"name": "showPrevNext",
|
|
678
|
+
"type": "boolean",
|
|
679
|
+
"required": false,
|
|
680
|
+
"default": "true",
|
|
681
|
+
"description": "Show previous/next buttons"
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
"name": "fontSize",
|
|
685
|
+
"type": "number",
|
|
686
|
+
"required": false,
|
|
687
|
+
"default": "14",
|
|
688
|
+
"description": "Font size for page numbers"
|
|
689
|
+
},
|
|
690
|
+
{
|
|
691
|
+
"name": "radius",
|
|
692
|
+
"type": "number",
|
|
693
|
+
"required": false,
|
|
694
|
+
"default": "10",
|
|
695
|
+
"description": "Border radius for buttons"
|
|
696
|
+
},
|
|
697
|
+
{
|
|
698
|
+
"name": "gap",
|
|
699
|
+
"type": "number",
|
|
700
|
+
"required": false,
|
|
701
|
+
"default": "8",
|
|
702
|
+
"description": "Gap between buttons"
|
|
703
|
+
},
|
|
704
|
+
{
|
|
705
|
+
"name": "bgColor",
|
|
706
|
+
"type": "string",
|
|
707
|
+
"required": false,
|
|
708
|
+
"default": "theme",
|
|
709
|
+
"description": "Background color override"
|
|
710
|
+
},
|
|
711
|
+
{
|
|
712
|
+
"name": "textColor",
|
|
713
|
+
"type": "string",
|
|
714
|
+
"required": false,
|
|
715
|
+
"default": "theme",
|
|
716
|
+
"description": "Text color override"
|
|
717
|
+
},
|
|
718
|
+
{
|
|
719
|
+
"name": "accentColor",
|
|
720
|
+
"type": "string",
|
|
721
|
+
"required": false,
|
|
722
|
+
"default": "theme",
|
|
723
|
+
"description": "Accent color override"
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
"name": "borderColor",
|
|
727
|
+
"type": "string",
|
|
728
|
+
"required": false,
|
|
729
|
+
"default": "theme",
|
|
730
|
+
"description": "Border color override"
|
|
731
|
+
},
|
|
732
|
+
{
|
|
733
|
+
"name": "fontFamily",
|
|
734
|
+
"type": "string",
|
|
735
|
+
"required": false,
|
|
736
|
+
"default": "theme",
|
|
737
|
+
"description": "Font family override"
|
|
738
|
+
}
|
|
739
|
+
],
|
|
740
|
+
"themeTokens": ["bgColor", "textColor", "accentColor", "borderColor", "fontFamily", "radius"],
|
|
741
|
+
"aiHints": {
|
|
742
|
+
"pageTypes": ["ecommerce", "blog", "search", "dashboard", "documentation"],
|
|
743
|
+
"placement": "body",
|
|
744
|
+
"priority": 6,
|
|
745
|
+
"sequenceOrder": 9,
|
|
746
|
+
"pairsWellWith": ["dataDisplay.DataTable", "ecommerce.ProductGrid", "search.SearchResults"],
|
|
747
|
+
"maxPerPage": 2,
|
|
748
|
+
"isContainer": false
|
|
749
|
+
}
|
|
750
|
+
},
|
|
751
|
+
{
|
|
752
|
+
"id": "navigation.Stepper",
|
|
753
|
+
"name": "Stepper",
|
|
754
|
+
"description": "Step indicator showing progress through a multi-step process. Supports horizontal and vertical orientations.",
|
|
755
|
+
"whenToUse": "Use for checkout flows, multi-step forms, onboarding wizards, or any process with defined sequential steps.",
|
|
756
|
+
"isShell": false,
|
|
757
|
+
"props": [
|
|
758
|
+
{
|
|
759
|
+
"name": "steps",
|
|
760
|
+
"type": "Step[]",
|
|
761
|
+
"required": true,
|
|
762
|
+
"default": null,
|
|
763
|
+
"description": "Array of steps: {label, description?}"
|
|
764
|
+
},
|
|
765
|
+
{
|
|
766
|
+
"name": "currentStep",
|
|
767
|
+
"type": "number",
|
|
768
|
+
"required": true,
|
|
769
|
+
"default": null,
|
|
770
|
+
"description": "Zero-based index of the active step"
|
|
771
|
+
},
|
|
772
|
+
{
|
|
773
|
+
"name": "orientation",
|
|
774
|
+
"type": "\"horizontal\" | \"vertical\"",
|
|
775
|
+
"required": false,
|
|
776
|
+
"default": "\"horizontal\"",
|
|
777
|
+
"description": "Layout direction"
|
|
778
|
+
},
|
|
779
|
+
{
|
|
780
|
+
"name": "showNumbers",
|
|
781
|
+
"type": "boolean",
|
|
782
|
+
"required": false,
|
|
783
|
+
"default": "true",
|
|
784
|
+
"description": "Show step numbers in the indicators"
|
|
785
|
+
},
|
|
786
|
+
{
|
|
787
|
+
"name": "bgColor",
|
|
788
|
+
"type": "string",
|
|
789
|
+
"required": false,
|
|
790
|
+
"default": "theme",
|
|
791
|
+
"description": "Background color override"
|
|
792
|
+
},
|
|
793
|
+
{
|
|
794
|
+
"name": "textColor",
|
|
795
|
+
"type": "string",
|
|
796
|
+
"required": false,
|
|
797
|
+
"default": "theme",
|
|
798
|
+
"description": "Text color override"
|
|
799
|
+
},
|
|
800
|
+
{
|
|
801
|
+
"name": "accentColor",
|
|
802
|
+
"type": "string",
|
|
803
|
+
"required": false,
|
|
804
|
+
"default": "theme",
|
|
805
|
+
"description": "Accent color override"
|
|
806
|
+
},
|
|
807
|
+
{
|
|
808
|
+
"name": "borderColor",
|
|
809
|
+
"type": "string",
|
|
810
|
+
"required": false,
|
|
811
|
+
"default": "theme",
|
|
812
|
+
"description": "Border color override"
|
|
813
|
+
},
|
|
814
|
+
{
|
|
815
|
+
"name": "fontFamily",
|
|
816
|
+
"type": "string",
|
|
817
|
+
"required": false,
|
|
818
|
+
"default": "theme",
|
|
819
|
+
"description": "Font family override"
|
|
820
|
+
}
|
|
821
|
+
],
|
|
822
|
+
"themeTokens": [
|
|
823
|
+
"bgColor",
|
|
824
|
+
"textColor",
|
|
825
|
+
"accentColor",
|
|
826
|
+
"borderColor",
|
|
827
|
+
"fontFamily",
|
|
828
|
+
"radius",
|
|
829
|
+
"spacing"
|
|
830
|
+
],
|
|
831
|
+
"aiHints": {
|
|
832
|
+
"pageTypes": ["ecommerce", "onboarding", "saas", "forms"],
|
|
833
|
+
"placement": "body",
|
|
834
|
+
"priority": 5,
|
|
835
|
+
"sequenceOrder": 3,
|
|
836
|
+
"pairsWellWith": [
|
|
837
|
+
"forms.MultiStepWizard",
|
|
838
|
+
"forms.FormShell",
|
|
839
|
+
"onboarding.OnboardingWizard"
|
|
840
|
+
],
|
|
841
|
+
"maxPerPage": 1,
|
|
842
|
+
"isContainer": false
|
|
843
|
+
}
|
|
844
|
+
},
|
|
845
|
+
{
|
|
846
|
+
"id": "navigation.AnchorLinks",
|
|
847
|
+
"name": "AnchorLinks",
|
|
848
|
+
"description": "In-page navigation anchors that scroll to sections. Supports horizontal and vertical orientations with smooth scrolling.",
|
|
849
|
+
"whenToUse": "Use for long-form pages like documentation, landing pages with multiple sections, or single-page applications needing section-based navigation.",
|
|
850
|
+
"isShell": false,
|
|
851
|
+
"props": [
|
|
852
|
+
{
|
|
853
|
+
"name": "as",
|
|
854
|
+
"type": "ElementType",
|
|
855
|
+
"required": false,
|
|
856
|
+
"default": "\"nav\"",
|
|
857
|
+
"description": "HTML element to render as"
|
|
858
|
+
},
|
|
859
|
+
{
|
|
860
|
+
"name": "items",
|
|
861
|
+
"type": "AnchorItem[]",
|
|
862
|
+
"required": true,
|
|
863
|
+
"default": null,
|
|
864
|
+
"description": "Array of anchor items: {label, targetId}"
|
|
865
|
+
},
|
|
866
|
+
{
|
|
867
|
+
"name": "orientation",
|
|
868
|
+
"type": "\"horizontal\" | \"vertical\"",
|
|
869
|
+
"required": false,
|
|
870
|
+
"default": "\"horizontal\"",
|
|
871
|
+
"description": "Layout direction"
|
|
872
|
+
},
|
|
873
|
+
{
|
|
874
|
+
"name": "offset",
|
|
875
|
+
"type": "number",
|
|
876
|
+
"required": false,
|
|
877
|
+
"default": "80",
|
|
878
|
+
"description": "Scroll offset in pixels (to account for sticky headers)"
|
|
879
|
+
},
|
|
880
|
+
{
|
|
881
|
+
"name": "maxW",
|
|
882
|
+
"type": "number",
|
|
883
|
+
"required": false,
|
|
884
|
+
"default": "1100",
|
|
885
|
+
"description": "Maximum width"
|
|
886
|
+
},
|
|
887
|
+
{
|
|
888
|
+
"name": "px",
|
|
889
|
+
"type": "number",
|
|
890
|
+
"required": false,
|
|
891
|
+
"default": "20",
|
|
892
|
+
"description": "Horizontal padding"
|
|
893
|
+
},
|
|
894
|
+
{
|
|
895
|
+
"name": "py",
|
|
896
|
+
"type": "number",
|
|
897
|
+
"required": false,
|
|
898
|
+
"default": "12",
|
|
899
|
+
"description": "Vertical padding"
|
|
900
|
+
},
|
|
901
|
+
{
|
|
902
|
+
"name": "radius",
|
|
903
|
+
"type": "number",
|
|
904
|
+
"required": false,
|
|
905
|
+
"default": "14",
|
|
906
|
+
"description": "Border radius"
|
|
907
|
+
},
|
|
908
|
+
{
|
|
909
|
+
"name": "gap",
|
|
910
|
+
"type": "number",
|
|
911
|
+
"required": false,
|
|
912
|
+
"default": "8",
|
|
913
|
+
"description": "Gap between items"
|
|
914
|
+
},
|
|
915
|
+
{
|
|
916
|
+
"name": "bgColor",
|
|
917
|
+
"type": "string",
|
|
918
|
+
"required": false,
|
|
919
|
+
"default": "theme",
|
|
920
|
+
"description": "Background color override"
|
|
921
|
+
},
|
|
922
|
+
{
|
|
923
|
+
"name": "textColor",
|
|
924
|
+
"type": "string",
|
|
925
|
+
"required": false,
|
|
926
|
+
"default": "theme",
|
|
927
|
+
"description": "Text color override"
|
|
928
|
+
},
|
|
929
|
+
{
|
|
930
|
+
"name": "accentColor",
|
|
931
|
+
"type": "string",
|
|
932
|
+
"required": false,
|
|
933
|
+
"default": "theme",
|
|
934
|
+
"description": "Accent color override"
|
|
935
|
+
},
|
|
936
|
+
{
|
|
937
|
+
"name": "borderColor",
|
|
938
|
+
"type": "string",
|
|
939
|
+
"required": false,
|
|
940
|
+
"default": "theme",
|
|
941
|
+
"description": "Border color override"
|
|
942
|
+
},
|
|
943
|
+
{
|
|
944
|
+
"name": "fontFamily",
|
|
945
|
+
"type": "string",
|
|
946
|
+
"required": false,
|
|
947
|
+
"default": "theme",
|
|
948
|
+
"description": "Font family override"
|
|
949
|
+
},
|
|
950
|
+
{
|
|
951
|
+
"name": "style",
|
|
952
|
+
"type": "CSSProperties",
|
|
953
|
+
"required": false,
|
|
954
|
+
"default": null,
|
|
955
|
+
"description": "Custom inline styles"
|
|
956
|
+
},
|
|
957
|
+
{
|
|
958
|
+
"name": "className",
|
|
959
|
+
"type": "string",
|
|
960
|
+
"required": false,
|
|
961
|
+
"default": null,
|
|
962
|
+
"description": "Custom CSS class"
|
|
963
|
+
}
|
|
964
|
+
],
|
|
965
|
+
"themeTokens": [
|
|
966
|
+
"bgColor",
|
|
967
|
+
"textColor",
|
|
968
|
+
"accentColor",
|
|
969
|
+
"borderColor",
|
|
970
|
+
"fontFamily",
|
|
971
|
+
"radius",
|
|
972
|
+
"spacing"
|
|
973
|
+
],
|
|
974
|
+
"aiHints": {
|
|
975
|
+
"pageTypes": ["landing", "documentation", "marketing", "blog"],
|
|
976
|
+
"placement": "body",
|
|
977
|
+
"priority": 5,
|
|
978
|
+
"sequenceOrder": 2,
|
|
979
|
+
"pairsWellWith": ["content.HeadingSection", "navigation.PrimaryNav"],
|
|
980
|
+
"maxPerPage": 1,
|
|
981
|
+
"isContainer": false
|
|
982
|
+
}
|
|
983
|
+
},
|
|
984
|
+
{
|
|
985
|
+
"id": "navigation.SideDrawerNav",
|
|
986
|
+
"name": "SideDrawerNav",
|
|
987
|
+
"description": "Slide-out drawer navigation with overlay. Supports left or right positioning. Ideal for mobile navigation.",
|
|
988
|
+
"whenToUse": "Use for mobile-responsive navigation or as a secondary navigation drawer on desktop. Great for apps that need off-canvas menus.",
|
|
989
|
+
"isShell": false,
|
|
990
|
+
"props": [
|
|
991
|
+
{
|
|
992
|
+
"name": "links",
|
|
993
|
+
"type": "DrawerLink[]",
|
|
994
|
+
"required": true,
|
|
995
|
+
"default": null,
|
|
996
|
+
"description": "Array of links: {label, href, icon?}"
|
|
997
|
+
},
|
|
998
|
+
{
|
|
999
|
+
"name": "width",
|
|
1000
|
+
"type": "number",
|
|
1001
|
+
"required": false,
|
|
1002
|
+
"default": "300",
|
|
1003
|
+
"description": "Width of the drawer"
|
|
1004
|
+
},
|
|
1005
|
+
{
|
|
1006
|
+
"name": "padding",
|
|
1007
|
+
"type": "number",
|
|
1008
|
+
"required": false,
|
|
1009
|
+
"default": "24",
|
|
1010
|
+
"description": "Internal padding"
|
|
1011
|
+
},
|
|
1012
|
+
{
|
|
1013
|
+
"name": "gap",
|
|
1014
|
+
"type": "number",
|
|
1015
|
+
"required": false,
|
|
1016
|
+
"default": "8",
|
|
1017
|
+
"description": "Gap between links"
|
|
1018
|
+
},
|
|
1019
|
+
{
|
|
1020
|
+
"name": "overlayColor",
|
|
1021
|
+
"type": "string",
|
|
1022
|
+
"required": false,
|
|
1023
|
+
"default": "\"rgba(0,0,0,0.8)\"",
|
|
1024
|
+
"description": "Overlay backdrop color"
|
|
1025
|
+
},
|
|
1026
|
+
{
|
|
1027
|
+
"name": "position",
|
|
1028
|
+
"type": "\"left\" | \"right\"",
|
|
1029
|
+
"required": false,
|
|
1030
|
+
"default": "\"left\"",
|
|
1031
|
+
"description": "Which side the drawer slides from"
|
|
1032
|
+
},
|
|
1033
|
+
{
|
|
1034
|
+
"name": "logoText",
|
|
1035
|
+
"type": "string",
|
|
1036
|
+
"required": false,
|
|
1037
|
+
"default": "\"Menu\"",
|
|
1038
|
+
"description": "Text shown at the top of the drawer"
|
|
1039
|
+
},
|
|
1040
|
+
{
|
|
1041
|
+
"name": "bgColor",
|
|
1042
|
+
"type": "string",
|
|
1043
|
+
"required": false,
|
|
1044
|
+
"default": "theme",
|
|
1045
|
+
"description": "Background color override"
|
|
1046
|
+
},
|
|
1047
|
+
{
|
|
1048
|
+
"name": "textColor",
|
|
1049
|
+
"type": "string",
|
|
1050
|
+
"required": false,
|
|
1051
|
+
"default": "theme",
|
|
1052
|
+
"description": "Text color override"
|
|
1053
|
+
},
|
|
1054
|
+
{
|
|
1055
|
+
"name": "accentColor",
|
|
1056
|
+
"type": "string",
|
|
1057
|
+
"required": false,
|
|
1058
|
+
"default": "theme",
|
|
1059
|
+
"description": "Accent color override"
|
|
1060
|
+
},
|
|
1061
|
+
{
|
|
1062
|
+
"name": "borderColor",
|
|
1063
|
+
"type": "string",
|
|
1064
|
+
"required": false,
|
|
1065
|
+
"default": "theme",
|
|
1066
|
+
"description": "Border color override"
|
|
1067
|
+
},
|
|
1068
|
+
{
|
|
1069
|
+
"name": "fontFamily",
|
|
1070
|
+
"type": "string",
|
|
1071
|
+
"required": false,
|
|
1072
|
+
"default": "theme",
|
|
1073
|
+
"description": "Font family override"
|
|
1074
|
+
}
|
|
1075
|
+
],
|
|
1076
|
+
"themeTokens": [
|
|
1077
|
+
"bgColor",
|
|
1078
|
+
"textColor",
|
|
1079
|
+
"accentColor",
|
|
1080
|
+
"borderColor",
|
|
1081
|
+
"fontFamily",
|
|
1082
|
+
"radius",
|
|
1083
|
+
"spacing"
|
|
1084
|
+
],
|
|
1085
|
+
"aiHints": {
|
|
1086
|
+
"pageTypes": ["landing", "marketing", "ecommerce", "blog", "portfolio"],
|
|
1087
|
+
"placement": "overlay",
|
|
1088
|
+
"priority": 6,
|
|
1089
|
+
"sequenceOrder": 1,
|
|
1090
|
+
"pairsWellWith": ["navigation.PrimaryNav"],
|
|
1091
|
+
"maxPerPage": 1,
|
|
1092
|
+
"isContainer": false
|
|
1093
|
+
}
|
|
1094
|
+
},
|
|
1095
|
+
{
|
|
1096
|
+
"id": "navigation.LanguageSelector",
|
|
1097
|
+
"name": "LanguageSelector",
|
|
1098
|
+
"description": "Dropdown for selecting the site's language/locale. Displays language labels with optional flag indicators.",
|
|
1099
|
+
"whenToUse": "Use on internationalized sites that support multiple languages. Typically placed in the header or footer.",
|
|
1100
|
+
"isShell": false,
|
|
1101
|
+
"props": [
|
|
1102
|
+
{
|
|
1103
|
+
"name": "as",
|
|
1104
|
+
"type": "ElementType",
|
|
1105
|
+
"required": false,
|
|
1106
|
+
"default": "\"div\"",
|
|
1107
|
+
"description": "HTML element to render as"
|
|
1108
|
+
},
|
|
1109
|
+
{
|
|
1110
|
+
"name": "languages",
|
|
1111
|
+
"type": "Language[]",
|
|
1112
|
+
"required": true,
|
|
1113
|
+
"default": null,
|
|
1114
|
+
"description": "Array of languages: {code, label, flag?}"
|
|
1115
|
+
},
|
|
1116
|
+
{
|
|
1117
|
+
"name": "current",
|
|
1118
|
+
"type": "string",
|
|
1119
|
+
"required": true,
|
|
1120
|
+
"default": null,
|
|
1121
|
+
"description": "Currently selected language code"
|
|
1122
|
+
},
|
|
1123
|
+
{
|
|
1124
|
+
"name": "onChange",
|
|
1125
|
+
"type": "(code: string) => void",
|
|
1126
|
+
"required": false,
|
|
1127
|
+
"default": null,
|
|
1128
|
+
"description": "Callback when language is changed"
|
|
1129
|
+
},
|
|
1130
|
+
{
|
|
1131
|
+
"name": "px",
|
|
1132
|
+
"type": "number",
|
|
1133
|
+
"required": false,
|
|
1134
|
+
"default": "14",
|
|
1135
|
+
"description": "Horizontal padding"
|
|
1136
|
+
},
|
|
1137
|
+
{
|
|
1138
|
+
"name": "py",
|
|
1139
|
+
"type": "number",
|
|
1140
|
+
"required": false,
|
|
1141
|
+
"default": "10",
|
|
1142
|
+
"description": "Vertical padding"
|
|
1143
|
+
},
|
|
1144
|
+
{
|
|
1145
|
+
"name": "radius",
|
|
1146
|
+
"type": "number",
|
|
1147
|
+
"required": false,
|
|
1148
|
+
"default": "12",
|
|
1149
|
+
"description": "Border radius"
|
|
1150
|
+
},
|
|
1151
|
+
{
|
|
1152
|
+
"name": "bgColor",
|
|
1153
|
+
"type": "string",
|
|
1154
|
+
"required": false,
|
|
1155
|
+
"default": "theme",
|
|
1156
|
+
"description": "Background color override"
|
|
1157
|
+
},
|
|
1158
|
+
{
|
|
1159
|
+
"name": "textColor",
|
|
1160
|
+
"type": "string",
|
|
1161
|
+
"required": false,
|
|
1162
|
+
"default": "theme",
|
|
1163
|
+
"description": "Text color override"
|
|
1164
|
+
},
|
|
1165
|
+
{
|
|
1166
|
+
"name": "accentColor",
|
|
1167
|
+
"type": "string",
|
|
1168
|
+
"required": false,
|
|
1169
|
+
"default": "theme",
|
|
1170
|
+
"description": "Accent color override"
|
|
1171
|
+
},
|
|
1172
|
+
{
|
|
1173
|
+
"name": "borderColor",
|
|
1174
|
+
"type": "string",
|
|
1175
|
+
"required": false,
|
|
1176
|
+
"default": "theme",
|
|
1177
|
+
"description": "Border color override"
|
|
1178
|
+
},
|
|
1179
|
+
{
|
|
1180
|
+
"name": "fontFamily",
|
|
1181
|
+
"type": "string",
|
|
1182
|
+
"required": false,
|
|
1183
|
+
"default": "theme",
|
|
1184
|
+
"description": "Font family override"
|
|
1185
|
+
},
|
|
1186
|
+
{
|
|
1187
|
+
"name": "style",
|
|
1188
|
+
"type": "CSSProperties",
|
|
1189
|
+
"required": false,
|
|
1190
|
+
"default": null,
|
|
1191
|
+
"description": "Custom inline styles"
|
|
1192
|
+
},
|
|
1193
|
+
{
|
|
1194
|
+
"name": "className",
|
|
1195
|
+
"type": "string",
|
|
1196
|
+
"required": false,
|
|
1197
|
+
"default": null,
|
|
1198
|
+
"description": "Custom CSS class"
|
|
1199
|
+
}
|
|
1200
|
+
],
|
|
1201
|
+
"themeTokens": ["bgColor", "textColor", "accentColor", "borderColor", "fontFamily", "radius"],
|
|
1202
|
+
"aiHints": {
|
|
1203
|
+
"pageTypes": ["landing", "marketing", "ecommerce", "saas", "documentation"],
|
|
1204
|
+
"placement": "header",
|
|
1205
|
+
"priority": 3,
|
|
1206
|
+
"sequenceOrder": 1,
|
|
1207
|
+
"pairsWellWith": ["navigation.PrimaryNav"],
|
|
1208
|
+
"maxPerPage": 1,
|
|
1209
|
+
"isContainer": false
|
|
1210
|
+
}
|
|
1211
|
+
},
|
|
1212
|
+
{
|
|
1213
|
+
"id": "navigation.Footer",
|
|
1214
|
+
"name": "Footer",
|
|
1215
|
+
"description": "Site-wide footer with link columns, social icons, brand logo, tagline, copyright, and optional children slot. Responsive multi-column layout.",
|
|
1216
|
+
"whenToUse": "Use on every page as the bottom-most section. Essential for navigation links, legal copy, social presence, and brand identity. Applies to all website types.",
|
|
1217
|
+
"isShell": false,
|
|
1218
|
+
"props": [
|
|
1219
|
+
{
|
|
1220
|
+
"name": "columns",
|
|
1221
|
+
"type": "FooterColumn[]",
|
|
1222
|
+
"required": false,
|
|
1223
|
+
"default": "[]",
|
|
1224
|
+
"description": "Array of link column groups: {title, links: FooterLink[]}"
|
|
1225
|
+
},
|
|
1226
|
+
{
|
|
1227
|
+
"name": "copyright",
|
|
1228
|
+
"type": "string",
|
|
1229
|
+
"required": false,
|
|
1230
|
+
"default": "auto",
|
|
1231
|
+
"description": "Copyright text displayed at the bottom. Auto-generates year if not provided"
|
|
1232
|
+
},
|
|
1233
|
+
{
|
|
1234
|
+
"name": "socialLinks",
|
|
1235
|
+
"type": "FooterSocialLink[]",
|
|
1236
|
+
"required": false,
|
|
1237
|
+
"default": "[]",
|
|
1238
|
+
"description": "Array of social media links: {icon, href, label?}"
|
|
1239
|
+
},
|
|
1240
|
+
{
|
|
1241
|
+
"name": "logo",
|
|
1242
|
+
"type": "string",
|
|
1243
|
+
"required": false,
|
|
1244
|
+
"default": null,
|
|
1245
|
+
"description": "URL or path to the brand logo image"
|
|
1246
|
+
},
|
|
1247
|
+
{
|
|
1248
|
+
"name": "logoAlt",
|
|
1249
|
+
"type": "string",
|
|
1250
|
+
"required": false,
|
|
1251
|
+
"default": "\"Logo\"",
|
|
1252
|
+
"description": "Alt text for the logo image"
|
|
1253
|
+
},
|
|
1254
|
+
{
|
|
1255
|
+
"name": "tagline",
|
|
1256
|
+
"type": "string",
|
|
1257
|
+
"required": false,
|
|
1258
|
+
"default": null,
|
|
1259
|
+
"description": "Short brand tagline displayed next to logo"
|
|
1260
|
+
},
|
|
1261
|
+
{
|
|
1262
|
+
"name": "children",
|
|
1263
|
+
"type": "ReactNode",
|
|
1264
|
+
"required": false,
|
|
1265
|
+
"default": null,
|
|
1266
|
+
"description": "Additional content rendered between columns and copyright"
|
|
1267
|
+
},
|
|
1268
|
+
{
|
|
1269
|
+
"name": "bgColor",
|
|
1270
|
+
"type": "string",
|
|
1271
|
+
"required": false,
|
|
1272
|
+
"default": "theme",
|
|
1273
|
+
"description": "Background color override"
|
|
1274
|
+
},
|
|
1275
|
+
{
|
|
1276
|
+
"name": "textColor",
|
|
1277
|
+
"type": "string",
|
|
1278
|
+
"required": false,
|
|
1279
|
+
"default": "theme",
|
|
1280
|
+
"description": "Text color override"
|
|
1281
|
+
},
|
|
1282
|
+
{
|
|
1283
|
+
"name": "accentColor",
|
|
1284
|
+
"type": "string",
|
|
1285
|
+
"required": false,
|
|
1286
|
+
"default": "theme",
|
|
1287
|
+
"description": "Accent color override"
|
|
1288
|
+
},
|
|
1289
|
+
{
|
|
1290
|
+
"name": "borderColor",
|
|
1291
|
+
"type": "string",
|
|
1292
|
+
"required": false,
|
|
1293
|
+
"default": "theme",
|
|
1294
|
+
"description": "Border color override"
|
|
1295
|
+
},
|
|
1296
|
+
{
|
|
1297
|
+
"name": "fontFamily",
|
|
1298
|
+
"type": "string",
|
|
1299
|
+
"required": false,
|
|
1300
|
+
"default": "theme",
|
|
1301
|
+
"description": "Font family override"
|
|
1302
|
+
}
|
|
1303
|
+
],
|
|
1304
|
+
"themeTokens": [
|
|
1305
|
+
"bgColor",
|
|
1306
|
+
"textColor",
|
|
1307
|
+
"accentColor",
|
|
1308
|
+
"borderColor",
|
|
1309
|
+
"fontFamily",
|
|
1310
|
+
"radius",
|
|
1311
|
+
"spacing"
|
|
1312
|
+
],
|
|
1313
|
+
"aiHints": {
|
|
1314
|
+
"pageTypes": [
|
|
1315
|
+
"landing",
|
|
1316
|
+
"marketing",
|
|
1317
|
+
"dashboard",
|
|
1318
|
+
"blog",
|
|
1319
|
+
"ecommerce",
|
|
1320
|
+
"portfolio",
|
|
1321
|
+
"saas",
|
|
1322
|
+
"restaurant",
|
|
1323
|
+
"fitness",
|
|
1324
|
+
"education",
|
|
1325
|
+
"event",
|
|
1326
|
+
"nonprofit",
|
|
1327
|
+
"realestate",
|
|
1328
|
+
"agency",
|
|
1329
|
+
"health",
|
|
1330
|
+
"community",
|
|
1331
|
+
"marketplace",
|
|
1332
|
+
"documentation"
|
|
1333
|
+
],
|
|
1334
|
+
"placement": "footer",
|
|
1335
|
+
"priority": 10,
|
|
1336
|
+
"sequenceOrder": 10,
|
|
1337
|
+
"pairsWellWith": [
|
|
1338
|
+
"navigation.PrimaryNav",
|
|
1339
|
+
"forms.NewsletterSignup",
|
|
1340
|
+
"social.SocialShareBar",
|
|
1341
|
+
"siteIdentity.LogoDisplay"
|
|
1342
|
+
],
|
|
1343
|
+
"maxPerPage": 1,
|
|
1344
|
+
"isContainer": true
|
|
1345
|
+
}
|
|
1346
|
+
}
|
|
1347
|
+
]
|
|
1348
|
+
}
|