99 lines
3.5 KiB
JSON
99 lines
3.5 KiB
JSON
{
|
|
"name": "BlogCardSix",
|
|
"description": "Blog section with separate media and card layout, featuring tags and arrow navigation.",
|
|
"constraints": {
|
|
"textRules": {
|
|
"title": {
|
|
"required": true,
|
|
"example": "Recent articles",
|
|
"minChars": 2,
|
|
"maxChars": 50
|
|
},
|
|
"description": {
|
|
"required": true,
|
|
"example": "Stay updated with the latest trends and insights",
|
|
"minChars": 5,
|
|
"maxChars": 300
|
|
},
|
|
"tag": {
|
|
"required": false,
|
|
"example": "Blog",
|
|
"minChars": 2,
|
|
"maxChars": 30
|
|
}
|
|
},
|
|
"blogRules": {
|
|
"id": {
|
|
"required": true,
|
|
"example": "1",
|
|
"note": "Unique identifier for the blog post"
|
|
},
|
|
"title": {
|
|
"required": true,
|
|
"example": "Discover the essential features of our app",
|
|
"minChars": 10,
|
|
"maxChars": 100
|
|
},
|
|
"tags": {
|
|
"required": true,
|
|
"minItems": 1,
|
|
"maxItems": 4,
|
|
"structure": "string[]",
|
|
"example": "['Features', 'Jan 29, 2025']",
|
|
"note": "Array of tag strings displayed using Tag component"
|
|
},
|
|
"imageSrc": {
|
|
"required": false,
|
|
"example": "/blog-1.jpg",
|
|
"note": "Either imageSrc or videoSrc should be provided"
|
|
},
|
|
"videoSrc": {
|
|
"required": false,
|
|
"example": "/blog-1.mp4",
|
|
"note": "Either imageSrc or videoSrc should be provided"
|
|
},
|
|
"imageAlt": {
|
|
"required": false,
|
|
"example": "Blog post preview image",
|
|
"note": "Falls back to blog title if not provided"
|
|
},
|
|
"videoAriaLabel": {
|
|
"required": false,
|
|
"example": "Blog post video",
|
|
"note": "Falls back to blog title if not provided"
|
|
}
|
|
}
|
|
},
|
|
"propsSchema": {
|
|
"blogs": "Array<{ id: string, title: string, tags: string[], imageSrc?: string, videoSrc?: string, imageAlt?: string, videoAriaLabel?: string, onBlogClick?: () => void }>",
|
|
"animationType": "'none' | 'opacity' | 'slide-up' | 'scale-rotate' | 'blur-reveal' (required)",
|
|
"title": "string",
|
|
"titleSegments?": "Array<{ type: 'text', content: string } | { type: 'image', src: string, alt?: string }> - For inline images in title",
|
|
"description": "string",
|
|
"textboxLayout": "'default' | 'split' | 'split-actions' | 'split-description' | 'inline-image' (required)",
|
|
"useInvertedBackground": "'noInvert' | 'invertDefault'",
|
|
"tag?": "string",
|
|
"tagIcon?": "LucideIcon",
|
|
"buttons?": "Array<{text: string, onClick?: () => void, href?: string}>",
|
|
"carouselMode?": "'auto' | 'buttons' (default: 'buttons')",
|
|
"uniformGridCustomHeightClasses?": "string",
|
|
"ariaLabel?": "string (default: 'Blog section')",
|
|
"className?": "string"
|
|
},
|
|
"usageExample": "<BlogCardSix blogs={[{ id: '1', title: 'Discover the essential features of our app', tags: ['Features', 'Jan 29, 2025'], imageSrc: '/blog1.jpg' }, { id: '2', title: 'How to organize your tasks effectively', tags: ['Guides', 'Feb 03, 2025'], imageSrc: '/blog2.jpg' }]} animationType=\"slide-up\" title=\"Recent articles\" description=\"Stay updated with the latest trends and insights\" textboxLayout=\"default\" useInvertedBackground=\"noInvert\" />",
|
|
"do": [
|
|
"Use for blog listings",
|
|
"Use for article grids",
|
|
"Requires blogs[]",
|
|
"Requires titleSegments?[]",
|
|
"Requires buttons?[]"
|
|
],
|
|
"dont": [
|
|
"Do not use more than 4 items"
|
|
],
|
|
"editRules": {
|
|
"textOnly": true,
|
|
"layoutLocked": true,
|
|
"styleLocked": true
|
|
}
|
|
} |