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
73 lines
3.4 KiB
JSON
73 lines
3.4 KiB
JSON
{
|
|
"componentDescription": "",
|
|
"propDescriptions": {
|
|
"checked": { "description": "If <code>true</code>, the component is checked." },
|
|
"checkedIcon": { "description": "The icon to display when the component is checked." },
|
|
"classes": { "description": "Override or extend the styles applied to the component." },
|
|
"color": {
|
|
"description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the <a href=\"https://mui.com/material-ui/customization/palette/#custom-colors\">palette customization guide</a>."
|
|
},
|
|
"disabled": { "description": "If <code>true</code>, the component is disabled." },
|
|
"disableRipple": { "description": "If <code>true</code>, the ripple effect is disabled." },
|
|
"icon": { "description": "The icon to display when the component is unchecked." },
|
|
"id": { "description": "The id of the <code>input</code> element." },
|
|
"inputProps": {
|
|
"description": "<a href=\"https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#attributes\">Attributes</a> applied to the <code>input</code> element."
|
|
},
|
|
"inputRef": { "description": "Pass a ref to the <code>input</code> element." },
|
|
"name": { "description": "Name attribute of the <code>input</code> element." },
|
|
"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 value by accessing <code>event.target.value</code> (string). You can pull out the new checked state by accessing <code>event.target.checked</code> (boolean)."
|
|
}
|
|
}
|
|
},
|
|
"required": {
|
|
"description": "If <code>true</code>, the <code>input</code> element is required."
|
|
},
|
|
"size": {
|
|
"description": "The size of the component. <code>small</code> is equivalent to the dense radio styling."
|
|
},
|
|
"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. The DOM API casts this to a string." }
|
|
},
|
|
"classDescriptions": {
|
|
"checked": {
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>checked={true}</code>"
|
|
},
|
|
"colorPrimary": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>color=\"primary\"</code>"
|
|
},
|
|
"colorSecondary": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>color=\"secondary\"</code>"
|
|
},
|
|
"disabled": {
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>disabled={true}</code>"
|
|
},
|
|
"sizeSmall": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>size=\"small\"</code>"
|
|
}
|
|
},
|
|
"slotDescriptions": {
|
|
"input": "The component that renders the input slot.",
|
|
"root": "The component that renders the root slot."
|
|
}
|
|
}
|