{
"props": {
"checked": { "type": { "name": "bool" } },
"checkedIcon": { "type": { "name": "node" } },
"className": { "type": { "name": "string" } },
"color": {
"type": {
"name": "union",
"description": "'danger'
| 'primary'
| 'success'
| 'warning'
| string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"defaultChecked": { "type": { "name": "bool" } },
"disabled": { "type": { "name": "bool" } },
"disableIcon": { "type": { "name": "bool" }, "default": "false" },
"label": { "type": { "name": "node" } },
"name": { "type": { "name": "string" } },
"onChange": {
"type": { "name": "func" },
"signature": {
"type": "function(event: React.ChangeEvent) => void",
"describedArgs": ["event"]
}
},
"overlay": { "type": { "name": "bool" }, "default": "false" },
"readOnly": { "type": { "name": "bool" } },
"required": { "type": { "name": "bool" } },
"size": {
"type": {
"name": "union",
"description": "'sm'
| 'md'
| 'lg'
| string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ action?: func
| object, icon?: func
| object, input?: func
| object, label?: func
| object, radio?: func
| object, root?: func
| object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ action?: elementType, icon?: elementType, input?: elementType, label?: elementType, radio?: elementType, root?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array<func
| object
| bool>
| func
| object"
},
"additionalInfo": { "sx": true }
},
"uncheckedIcon": { "type": { "name": "node" } },
"value": { "type": { "name": "any" } },
"variant": {
"type": {
"name": "union",
"description": "'outlined'
| 'plain'
| 'soft'
| 'solid'
| string"
},
"default": "'outlined'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "Radio",
"imports": ["import Radio from '@mui/joy/Radio';", "import { Radio } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'span'",
"class": "MuiRadio-root"
},
{
"name": "radio",
"description": "The component that renders the radio.",
"default": "'span'",
"class": "MuiRadio-radio"
},
{
"name": "icon",
"description": "The component that renders the icon.",
"default": "'span'",
"class": "MuiRadio-icon"
},
{
"name": "action",
"description": "The component that renders the action.",
"default": "'span'",
"class": "MuiRadio-action"
},
{
"name": "input",
"description": "The component that renders the input.",
"default": "'input'",
"class": "MuiRadio-input"
},
{
"name": "label",
"description": "The component that renders the label.",
"default": "'label'",
"class": "MuiRadio-label"
}
],
"classes": [
{
"key": "checked",
"className": "Mui-checked",
"description": "State class applied to the root, action slots if `checked`.",
"isGlobal": true
},
{
"key": "colorContext",
"className": "MuiRadio-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiRadio-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiRadio-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiRadio-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiRadio-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiRadio-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the root, action slots if `disabled`.",
"isGlobal": true
},
{
"key": "focusVisible",
"className": "Mui-focusVisible",
"description": "Class name applied to the root element if the switch has visible focus",
"isGlobal": true
},
{
"key": "sizeLg",
"className": "MuiRadio-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiRadio-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiRadio-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiRadio-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiRadio-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiRadio-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": false,
"themeDefaultProps": true,
"muiName": "JoyRadio",
"forwardsRefTo": "HTMLSpanElement",
"filename": "/packages/mui-joy/src/Radio/Radio.tsx",
"inheritance": null,
"demos": "",
"cssComponent": false
}