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
91 lines
4.8 KiB
JSON
91 lines
4.8 KiB
JSON
{
|
|
"componentDescription": "",
|
|
"propDescriptions": {
|
|
"children": { "description": "The content of the component." },
|
|
"classes": { "description": "Override or extend the styles applied to the component." },
|
|
"color": {
|
|
"description": "The color of the button when it is selected. 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. This implies that all ToggleButton children will be disabled."
|
|
},
|
|
"exclusive": {
|
|
"description": "If <code>true</code>, only allow one of the child ToggleButton values to be selected."
|
|
},
|
|
"fullWidth": {
|
|
"description": "If <code>true</code>, the button group will take up the full width of its container."
|
|
},
|
|
"onChange": {
|
|
"description": "Callback fired when the value changes.",
|
|
"typeDescriptions": {
|
|
"event": { "name": "event", "description": "The event source of the callback." },
|
|
"value": {
|
|
"name": "value",
|
|
"description": "of the selected buttons. When <code>exclusive</code> is true this is a single value; when false an array of selected values. If no value is selected and <code>exclusive</code> is true the value is null; when false an empty array."
|
|
}
|
|
}
|
|
},
|
|
"orientation": { "description": "The component orientation (layout flow direction)." },
|
|
"size": { "description": "The size of the component." },
|
|
"sx": {
|
|
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
|
|
},
|
|
"value": {
|
|
"description": "The currently selected value within the group or an array of selected values when <code>exclusive</code> is false.<br>The value must have reference equality with the option in order to be selected."
|
|
}
|
|
},
|
|
"classDescriptions": {
|
|
"disabled": {
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>disabled={true}</code>"
|
|
},
|
|
"firstButton": {
|
|
"description": "Styles applied to {{nodeName}}.",
|
|
"nodeName": "the first button in the toggle button group"
|
|
},
|
|
"fullWidth": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>fullWidth={true}</code>"
|
|
},
|
|
"grouped": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the children" },
|
|
"groupedHorizontal": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>orientation=\"horizontal\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/toggle-button-group/#toggle-button-group-classes-MuiToggleButtonGroup-horizontal\">.MuiToggleButtonGroup-horizontal</a> and <a href=\"/material-ui/api/toggle-button-group/#toggle-button-group-classes-MuiToggleButtonGroup-grouped\">.MuiToggleButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedVertical": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>orientation=\"vertical\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/toggle-button-group/#toggle-button-group-classes-MuiToggleButtonGroup-vertical\">.MuiToggleButtonGroup-vertical</a> and <a href=\"/material-ui/api/toggle-button-group/#toggle-button-group-classes-MuiToggleButtonGroup-grouped\">.MuiToggleButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"horizontal": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>orientation=\"horizontal\"</code>"
|
|
},
|
|
"lastButton": {
|
|
"description": "Styles applied to {{nodeName}}.",
|
|
"nodeName": "the last button in the toggle button group"
|
|
},
|
|
"middleButton": {
|
|
"description": "Styles applied to {{nodeName}}.",
|
|
"nodeName": "buttons in the middle of the toggle button group"
|
|
},
|
|
"root": { "description": "Styles applied to the root element." },
|
|
"selected": {
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>selected={true}</code>"
|
|
},
|
|
"vertical": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>orientation=\"vertical\"</code>"
|
|
}
|
|
}
|
|
}
|