33 lines
1.5 KiB
JSON
33 lines
1.5 KiB
JSON
|
{
|
||
|
|
"componentDescription": "",
|
||
|
|
"propDescriptions": {
|
||
|
|
"children": { "description": "The content of the component." },
|
||
|
|
"classes": { "description": "Override or extend the styles applied to the component." },
|
||
|
|
"component": {
|
||
|
|
"description": "The component used for the root node. Either a string to use a HTML element or a component."
|
||
|
|
},
|
||
|
|
"image": {
|
||
|
|
"description": "Image to be displayed as a background image. Either <code>image</code> or <code>src</code> prop must be specified. Note that caller must specify height otherwise the image will not be visible."
|
||
|
|
},
|
||
|
|
"src": {
|
||
|
|
"description": "An alias for <code>image</code> property. Available only with media components. Media components: <code>video</code>, <code>audio</code>, <code>picture</code>, <code>iframe</code>, <code>img</code>."
|
||
|
|
},
|
||
|
|
"sx": {
|
||
|
|
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"classDescriptions": {
|
||
|
|
"img": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>component=\"picture or img\"</code>"
|
||
|
|
},
|
||
|
|
"media": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>component=\"video, audio, picture, iframe, or img\"</code>"
|
||
|
|
},
|
||
|
|
"root": { "description": "Styles applied to the root element." }
|
||
|
|
}
|
||
|
|
}
|