98 lines
3.7 KiB
JSON
98 lines
3.7 KiB
JSON
{
|
|
"name": "FaqSplitMedia",
|
|
"description": "FAQ section with split layout featuring media (image/video) on one side and accordion list on the other.",
|
|
"constraints": {
|
|
"textRules": {
|
|
"title": {
|
|
"required": true,
|
|
"example": "Frequently Asked Questions",
|
|
"minChars": 2,
|
|
"maxChars": 50
|
|
},
|
|
"description": {
|
|
"required": true,
|
|
"example": "Find answers to common questions about our products and services",
|
|
"minChars": 5,
|
|
"maxChars": 250
|
|
},
|
|
"tag": {
|
|
"required": false,
|
|
"example": "Help",
|
|
"minChars": 2,
|
|
"maxChars": 30
|
|
}
|
|
},
|
|
"faqRules": {
|
|
"faqs": {
|
|
"required": true,
|
|
"minItems": 1,
|
|
"example": "[{\"id\": \"1\", \"title\": \"What is your return policy?\", \"content\": \"We offer a 30-day money-back guarantee.\"}]",
|
|
"note": "Array of FAQ items. Each item requires unique id, title (question), and content (answer with HTML support)."
|
|
},
|
|
"animationType": {
|
|
"required": false,
|
|
"default": "smooth",
|
|
"options": [
|
|
"smooth",
|
|
"instant"
|
|
],
|
|
"note": "Animation type for accordion open/close. 'smooth' uses height transition, 'instant' shows/hides immediately."
|
|
},
|
|
"mediaPosition": {
|
|
"required": false,
|
|
"default": "left",
|
|
"options": [
|
|
"left",
|
|
"right"
|
|
],
|
|
"note": "Position of media relative to FAQ list."
|
|
}
|
|
},
|
|
"mediaRules": {
|
|
"imageSrc": {
|
|
"required": false,
|
|
"note": "Path to image file. Either imageSrc or videoSrc should be provided."
|
|
},
|
|
"videoSrc": {
|
|
"required": false,
|
|
"note": "Path to video file. Either imageSrc or videoSrc should be provided."
|
|
}
|
|
}
|
|
},
|
|
"propsSchema": {
|
|
"faqs": "Array<{ id: string, title: string, content: string }> - FAQ items",
|
|
"imageSrc?": "string",
|
|
"videoSrc?": "string",
|
|
"imageAlt?": "string (default: '')",
|
|
"videoAriaLabel?": "string (default: 'FAQ section video')",
|
|
"mediaPosition?": "'left' | 'right' (default: 'left')",
|
|
"title": "string",
|
|
"titleSegments?": "Array<{ type: 'text', content: string } | { type: 'image', src: string, alt?: string }> - For inline images in title",
|
|
"description": "string",
|
|
"tag?": "string",
|
|
"tagIcon?": "LucideIcon",
|
|
"buttons?": "Array<{text: string, onClick?: () => void, href?: string}>",
|
|
"textboxLayout": "'default' | 'split' | 'split-actions' | 'split-description' | 'inline-image' (required - 'inline-image' uses titleSegments for rich text with images)",
|
|
"useInvertedBackground": "'noInvert' | 'invertDefault'",
|
|
"animationType?": "'smooth' | 'instant' (default: 'smooth')",
|
|
"showCard?": "boolean (default: true)",
|
|
"ariaLabel?": "string (default: 'FAQ section')",
|
|
"className?": "string"
|
|
},
|
|
"usageExample": "<FaqSplitMedia faqs={[{id: '1', title: 'What is your return policy?', content: 'We offer a 30-day money-back guarantee on all our products.'}, {id: '2', title: 'How long does shipping take?', content: 'Standard shipping typically takes 5-7 business days.'}]} imageSrc=\"/images/faq-hero.jpg\" imageAlt=\"Customer support representative\" title=\"Frequently Asked Questions\" description=\"Find answers to common questions\" textboxLayout=\"default\" useInvertedBackground={\"noInvert\"} mediaPosition=\"left\" />",
|
|
"do": [
|
|
"Use for help pages",
|
|
"Use for support sections",
|
|
"Requires faqs[]",
|
|
"Requires titleSegments?[]",
|
|
"Requires buttons?[]"
|
|
],
|
|
"dont": [
|
|
"Do not use more than 4 items"
|
|
],
|
|
"editRules": {
|
|
"textOnly": true,
|
|
"layoutLocked": true,
|
|
"styleLocked": true
|
|
}
|
|
} |