Radio API
API documentation for the React Radio component. Learn about the available props, and the CSS API.
Import
import Radio from '@material-ui/core/Radio';
// или
import { Radio } from '@material-ui/core';
Component name
The nameMuiRadio
can be used when providing default props or style overrides in the theme.Props
Имя | Тип | По-умолчанию | Описание |
---|---|---|---|
checked | bool | false | If true , the component is checked. |
checkedIcon | node | The icon to display when the component is checked. | |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
color | 'default' | 'primary' | 'secondary' | string | 'primary' | The color of the component. It supports those theme colors that make sense for this component. |
disabled | bool | false | If true , the accordion is displayed in a disabled state. |
disableRipple | bool | false | If true , the ripple effect is disabled. |
icon | node | The icon to display when the component is unchecked. | |
id | string | The id of the input element. | |
inputProps | object | Attributes applied to the input element. | |
inputRef | ref | Pass a ref to the input element. | |
name | string | Name attribute of the input element. | |
onChange | func | Callback fired when the state is changed. Signature: function(event: object) => void event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean). | |
required | bool | false | If true , the input element is required. |
size | 'medium' | 'small' | string | 'medium' | The size of the radio. small is equivalent to the dense radio styling. |
sx | object | ||
value | any | The value of the component. The DOM API casts this to a string. |
The
ref
is forwarded to the root element.Any other props supplied will be provided to the root element (IconButton).
Inheritance
While not explicitly documented above, the props of the IconButton component are also available on Radio. You can take advantage of this to target nested components.CSS
Rule name | Global class | Описание |
---|---|---|
root | .MuiRadio-root | Styles applied to the root element. |
checked | .Mui-checked | Pseudo-class applied to the root element if checked={true} . |
disabled | .Mui-disabled | Pseudo-class applied to the root element if disabled={true} . |
colorPrimary | .MuiRadio-colorPrimary | Styles applied to the root element if color="primary" . |
colorSecondary | .MuiRadio-colorSecondary | Styles applied to the root element if color="secondary" . |
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.