Some checks failed
No response / noResponse (push) Has been cancelled
CI / Continuous releases (push) Has been cancelled
CI / test-dev (macos-latest) (push) Has been cancelled
CI / test-dev (ubuntu-latest) (push) Has been cancelled
CI / test-dev (windows-latest) (push) Has been cancelled
Maintenance / main (push) Has been cancelled
Scorecards supply-chain security / Scorecards analysis (push) Has been cancelled
CodeQL / Analyze (push) Has been cancelled
120 lines
5.3 KiB
JSON
120 lines
5.3 KiB
JSON
{
|
|
"componentDescription": "",
|
|
"propDescriptions": {
|
|
"action": {
|
|
"description": "A ref for imperative actions. It currently only supports <code>focusVisible()</code> action."
|
|
},
|
|
"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."
|
|
},
|
|
"disabled": { "description": "If <code>true</code>, the component is disabled." },
|
|
"focusVisibleClassName": {
|
|
"description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the <a href=\"https://drafts.csswg.org/selectors-4/#the-focus-visible-pseudo\">CSS :focus-visible selector</a>. The rationale for using this feature <a href=\"https://github.com/WICG/focus-visible/blob/HEAD/explainer.md\">is explained here</a>. A <a href=\"https://github.com/WICG/focus-visible\">polyfill can be used</a> to apply a <code>focus-visible</code> class to other components if needed."
|
|
},
|
|
"loading": {
|
|
"description": "If <code>true</code>, the loading indicator is shown and the icon button becomes disabled."
|
|
},
|
|
"loadingIndicator": {
|
|
"description": "The node should contain an element with <code>role="progressbar"</code> with an accessible name. By default we render a <code>CircularProgress</code> that is labelled by the button itself."
|
|
},
|
|
"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." },
|
|
"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>"
|
|
},
|
|
"disabled": {
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>disabled={true}</code>"
|
|
},
|
|
"focusVisible": {
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "the button is keyboard focused"
|
|
},
|
|
"loading": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>loading={true}</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": {
|
|
"loadingIndicator": "The component that renders the loading indicator.",
|
|
"root": "The component that renders the root."
|
|
}
|
|
}
|