005cf56baf
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
81 lines
3.5 KiB
JSON
81 lines
3.5 KiB
JSON
{
|
|
"componentDescription": "Drop-in replacement of the `Radio`, `Switch` and `Checkbox` component.\nUse this component if you want to display an extra label.",
|
|
"propDescriptions": {
|
|
"checked": { "description": "If <code>true</code>, the component appears selected." },
|
|
"classes": { "description": "Override or extend the styles applied to the component." },
|
|
"componentsProps": { "description": "The props used for each slot inside." },
|
|
"control": {
|
|
"description": "A control element. For instance, it can be a <code>Radio</code>, a <code>Switch</code> or a <code>Checkbox</code>."
|
|
},
|
|
"disabled": { "description": "If <code>true</code>, the control is disabled." },
|
|
"disableTypography": {
|
|
"description": "If <code>true</code>, the label is rendered as it is passed without an additional typography node."
|
|
},
|
|
"inputRef": { "description": "Pass a ref to the <code>input</code> element." },
|
|
"label": { "description": "A text or an element to be used in an enclosing label element." },
|
|
"labelPlacement": { "description": "The position of the label." },
|
|
"onChange": {
|
|
"description": "Callback fired when the state is changed.",
|
|
"typeDescriptions": {
|
|
"event": {
|
|
"name": "event",
|
|
"description": "The event source of the callback. You can pull out the new checked state by accessing <code>event.target.checked</code> (boolean)."
|
|
}
|
|
}
|
|
},
|
|
"required": {
|
|
"description": "If <code>true</code>, the label will indicate that the <code>input</code> is required."
|
|
},
|
|
"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."
|
|
},
|
|
"value": { "description": "The value of the component." }
|
|
},
|
|
"classDescriptions": {
|
|
"asterisk": {
|
|
"description": "Styles applied to {{nodeName}}.",
|
|
"nodeName": "the asterisk element"
|
|
},
|
|
"disabled": {
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>disabled={true}</code>"
|
|
},
|
|
"error": {
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>error={true}</code>"
|
|
},
|
|
"label": {
|
|
"description": "Styles applied to {{nodeName}}.",
|
|
"nodeName": "the label's Typography component"
|
|
},
|
|
"labelPlacementBottom": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>labelPlacement=\"bottom\"</code>"
|
|
},
|
|
"labelPlacementStart": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>labelPlacement=\"start\"</code>"
|
|
},
|
|
"labelPlacementTop": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>labelPlacement=\"top\"</code>"
|
|
},
|
|
"required": {
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>required={true}</code>"
|
|
},
|
|
"root": { "description": "Styles applied to the root element." }
|
|
},
|
|
"slotDescriptions": {
|
|
"typography": "The component that renders the label. This is unused if <code>disableTypography</code> is true."
|
|
}
|
|
}
|