99 lines
3.9 KiB
JSON
99 lines
3.9 KiB
JSON
|
{
|
||
|
|
"componentDescription": "",
|
||
|
|
"propDescriptions": {
|
||
|
|
"color": {
|
||
|
|
"description": "The color of the component. It supports those theme colors that make sense for this component."
|
||
|
|
},
|
||
|
|
"component": {
|
||
|
|
"description": "The component used for the root node. Either a string to use a HTML element or a component."
|
||
|
|
},
|
||
|
|
"endDecorator": { "description": "Element placed after the children." },
|
||
|
|
"invertedColors": {
|
||
|
|
"description": "If <code>true</code>, the children with an implicit color prop invert their colors to match the component's variant and color."
|
||
|
|
},
|
||
|
|
"role": { "description": "The ARIA role attribute of the element." },
|
||
|
|
"size": { "description": "The size of the component." },
|
||
|
|
"slotProps": { "description": "The props used for each slot inside." },
|
||
|
|
"slots": { "description": "The components used for each slot inside." },
|
||
|
|
"startDecorator": { "description": "Element placed before the children." },
|
||
|
|
"sx": {
|
||
|
|
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
|
||
|
|
},
|
||
|
|
"variant": {
|
||
|
|
"description": "The <a href=\"https://mui.com/joy-ui/main-features/global-variants/\">global variant</a> to use."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"classDescriptions": {
|
||
|
|
"colorContext": {
|
||
|
|
"description": "Class name applied to {{nodeName}} when {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "color inversion is triggered"
|
||
|
|
},
|
||
|
|
"colorDanger": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>color=\"danger\"</code>"
|
||
|
|
},
|
||
|
|
"colorNeutral": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>color=\"neutral\"</code>"
|
||
|
|
},
|
||
|
|
"colorPrimary": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>color=\"primary\"</code>"
|
||
|
|
},
|
||
|
|
"colorSuccess": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>color=\"success\"</code>"
|
||
|
|
},
|
||
|
|
"colorWarning": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>color=\"warning\"</code>"
|
||
|
|
},
|
||
|
|
"sizeLg": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>size=\"lg\"</code>"
|
||
|
|
},
|
||
|
|
"sizeMd": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>size=\"md\"</code>"
|
||
|
|
},
|
||
|
|
"sizeSm": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>size=\"sm\"</code>"
|
||
|
|
},
|
||
|
|
"variantOutlined": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>variant=\"outlined\"</code>"
|
||
|
|
},
|
||
|
|
"variantPlain": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>variant=\"plain\"</code>"
|
||
|
|
},
|
||
|
|
"variantSoft": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>variant=\"soft\"</code>"
|
||
|
|
},
|
||
|
|
"variantSolid": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>variant=\"solid\"</code>"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"slotDescriptions": {
|
||
|
|
"endDecorator": "The component that renders the end decorator.",
|
||
|
|
"root": "The component that renders the root.",
|
||
|
|
"startDecorator": "The component that renders the start decorator."
|
||
|
|
}
|
||
|
|
}
|