97 lines
5.1 KiB
JSON
97 lines
5.1 KiB
JSON
{
|
|
"name": "HeroBillboardDashboard",
|
|
"description": "Full-width hero section with centered text content and an interactive Dashboard component below instead of a static image/video.",
|
|
"constraints": {
|
|
"textRules": {
|
|
"title": {
|
|
"required": true,
|
|
"example": "Real-Time On-Chain Intelligence",
|
|
"minChars": 2,
|
|
"maxChars": 36
|
|
},
|
|
"description": {
|
|
"required": true,
|
|
"example": "Monitor protocol revenue, trading volume, and wallet activity.",
|
|
"minChars": 5,
|
|
"maxChars": 200
|
|
},
|
|
"tag": {
|
|
"required": false,
|
|
"example": "Live Analytics",
|
|
"minChars": 2,
|
|
"maxChars": 30
|
|
}
|
|
},
|
|
"buttonRules": {
|
|
"maxButtons": 2,
|
|
"structure": {
|
|
"text": "string - Button label",
|
|
"href": "string - Link destination (optional). External URLs (https://, http://, www.) open in new tab. Internal values (e.g., 'about', 'contact') scroll to #about, #contact sections",
|
|
"onClick": "() => void - Additional click handler (optional)",
|
|
"props": "Partial<ButtonPropsForVariant> - Additional button props like className, textClassName (optional)"
|
|
},
|
|
"examples": [
|
|
"{ text: 'Get Started', href: 'https://example.com' }",
|
|
"{ text: 'Learn More', href: 'about' }"
|
|
],
|
|
"note": "Button variant is controlled by ThemeProvider's defaultButtonVariant. Border radius is controlled by ThemeProvider's borderRadius (options: 'sharp', 'rounded', 'soft', 'pill'). All sections should be wrapped in a single ThemeProvider at the app/page level to maintain consistent styling across the entire site."
|
|
},
|
|
"dashboardRules": {
|
|
"title": {
|
|
"required": true,
|
|
"example": "Analytics Dashboard"
|
|
},
|
|
"stats": {
|
|
"required": true,
|
|
"note": "Exactly 3 stat cards with animated number cycling (values rotate every 3s via TextNumberCount)"
|
|
},
|
|
"sidebarItems": {
|
|
"required": true,
|
|
"note": "Array of sidebar navigation items with icons"
|
|
},
|
|
"listItems": {
|
|
"required": true,
|
|
"note": "Array of list items for the auto-scrolling list section"
|
|
}
|
|
}
|
|
},
|
|
"propsSchema": {
|
|
"title": "string",
|
|
"description": "string",
|
|
"background": "{ variant: 'plain' | 'animated-grid' | 'canvas-reveal' | 'cell-wave' | 'downward-rays-animated' | 'downward-rays-animated-grid' | 'downward-rays-static' | 'downward-rays-static-grid' | 'gradient-bars' | 'radial-gradient' | 'rotated-rays-animated' | 'rotated-rays-animated-grid' | 'rotated-rays-static' | 'rotated-rays-static-grid' | 'sparkles-gradient' }",
|
|
"tag?": "string",
|
|
"tagIcon?": "LucideIcon",
|
|
"tagAnimation?": "'none' | 'opacity' | 'slide-up' | 'blur-reveal'",
|
|
"buttons?": "Array<{text: string, onClick?: () => void, href?: string}>",
|
|
"buttonAnimation?": "'none' | 'opacity' | 'slide-up' | 'blur-reveal'",
|
|
"dashboard": "{title: string, stats: [DashboardStat, DashboardStat, DashboardStat], logoIcon: LucideIcon, sidebarItems: DashboardSidebarItem[], searchPlaceholder?: string, buttons: ButtonConfig[], chartTitle?: string, chartData?: ChartDataItem[], listItems: DashboardListItem[], listTitle?: string, imageSrc: string, videoSrc?: string, imageAlt?: string, videoAriaLabel?: string, className?: string, containerClassName?: string, sidebarClassName?: string, statClassName?: string, chartClassName?: string, listClassName?: string}",
|
|
"ariaLabel?": "string (default: 'Hero section')",
|
|
"className?": "string",
|
|
"containerClassName?": "string",
|
|
"textBoxClassName?": "string",
|
|
"titleClassName?": "string",
|
|
"descriptionClassName?": "string",
|
|
"tagClassName?": "string",
|
|
"buttonContainerClassName?": "string",
|
|
"buttonClassName?": "string",
|
|
"buttonTextClassName?": "string",
|
|
"dashboardClassName?": "string"
|
|
},
|
|
"usageExample": "<ThemeProvider defaultButtonVariant=\"icon-arrow\" defaultTextAnimation=\"background-highlight\" borderRadius=\"rounded\">\n <HeroBillboardDashboard\n title=\"Real-Time On-Chain Intelligence\"\n description=\"Monitor protocol revenue, trading volume, and wallet activity.\"\n tag=\"Live Analytics\"\n tagIcon={Activity}\n background={{ variant: 'plain' }}\n buttons={[{ text: 'Start Building', href: '#' }]}\n dashboard={{\n title: 'Analytics',\n logoIcon: Zap,\n sidebarItems: [{ icon: LayoutDashboard, label: 'Dashboard' }],\n buttons: [{ text: 'Export' }],\n stats: [\n { label: 'Revenue', values: ['$1.2M', '$1.5M'] },\n { label: 'Users', values: ['50K', '75K'] },\n { label: 'Growth', values: ['+25%', '+30%'] }\n ],\n chartData: [...],\n listItems: [...],\n imageSrc: '/dashboard.jpg'\n }}\n />\n</ThemeProvider>",
|
|
"do": [
|
|
"Use for SaaS landing pages",
|
|
"Use for analytics/dashboard product showcases",
|
|
"Use for data visualization platforms",
|
|
"Requires dashboard prop with all nested properties"
|
|
],
|
|
"dont": [
|
|
"Do not use without dashboard data",
|
|
"Do not use for simple hero sections without interactive elements"
|
|
],
|
|
"editRules": {
|
|
"textOnly": true,
|
|
"layoutLocked": true,
|
|
"styleLocked": true
|
|
}
|
|
}
|