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
197 lines
16 KiB
JSON
197 lines
16 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 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>."
|
|
},
|
|
"component": {
|
|
"description": "The component used for the root node. Either a string to use a HTML element or a component."
|
|
},
|
|
"disabled": { "description": "If <code>true</code>, the component is disabled." },
|
|
"disableElevation": { "description": "If <code>true</code>, no elevation is used." },
|
|
"disableFocusRipple": {
|
|
"description": "If <code>true</code>, the button keyboard focus ripple is disabled."
|
|
},
|
|
"disableRipple": {
|
|
"description": "If <code>true</code>, the button ripple effect is disabled."
|
|
},
|
|
"fullWidth": {
|
|
"description": "If <code>true</code>, the buttons will take up the full width of its container."
|
|
},
|
|
"orientation": { "description": "The component orientation (layout flow direction)." },
|
|
"size": {
|
|
"description": "The size of the component. <code>small</code> is equivalent to the dense button styling."
|
|
},
|
|
"sx": {
|
|
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
|
|
},
|
|
"variant": { "description": "The variant to use." }
|
|
},
|
|
"classDescriptions": {
|
|
"colorPrimary": {
|
|
"description": "Styles applied to the root element if <code>color="primary"</code>"
|
|
},
|
|
"colorSecondary": {
|
|
"description": "Styles applied to the root element if <code>color="secondary"</code>"
|
|
},
|
|
"contained": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"contained\"</code>"
|
|
},
|
|
"disabled": {
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the child elements",
|
|
"conditions": "<code>disabled={true}</code>"
|
|
},
|
|
"disableElevation": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>disableElevation={true}</code>"
|
|
},
|
|
"firstButton": {
|
|
"description": "Styles applied to {{nodeName}}.",
|
|
"nodeName": "the first button in the 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" },
|
|
"groupedContained": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>variant=\"contained\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-contained\">.MuiButtonGroup-contained</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedContainedHorizontal": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>variant=\"contained\"</code> and <code>orientation=\"horizontal\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-contained\">.MuiButtonGroup-contained</a> , <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-horizontal\">.MuiButtonGroup-horizontal</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedContainedPrimary": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>variant=\"contained\"</code> and <code>color=\"primary\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-contained\">.MuiButtonGroup-contained</a> , <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-colorPrimary\">.MuiButtonGroup-colorPrimary</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedContainedSecondary": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>variant=\"contained\"</code> and <code>color=\"secondary\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-contained\">.MuiButtonGroup-contained</a> , <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-colorSecondary\">.MuiButtonGroup-colorSecondary</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedContainedVertical": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>variant=\"contained\"</code> and <code>orientation=\"vertical\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-contained\">.MuiButtonGroup-contained</a> , <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-vertical\">.MuiButtonGroup-vertical</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedHorizontal": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>orientation=\"horizontal\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-horizontal\">.MuiButtonGroup-horizontal</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedOutlined": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>variant=\"outlined\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-outlined\">.MuiButtonGroup-outlined</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedOutlinedHorizontal": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>variant=\"outlined\"</code> and <code>orientation=\"horizontal\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-outlined\">.MuiButtonGroup-outlined</a> , <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-horizontal\">.MuiButtonGroup-horizontal</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedOutlinedPrimary": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>variant=\"outlined\"</code> and <code>color=\"primary\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-outlined\">.MuiButtonGroup-outlined</a> , <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-colorPrimary\">.MuiButtonGroup-colorPrimary</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedOutlinedSecondary": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>variant=\"outlined\"</code> and <code>color=\"secondary\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-outlined\">.MuiButtonGroup-outlined</a> , <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-colorSecondary\">.MuiButtonGroup-colorSecondary</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedOutlinedVertical": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>variant=\"outlined\"</code> and <code>orientation=\"vertical\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-outlined\">.MuiButtonGroup-outlined</a> , <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-vertical\">.MuiButtonGroup-vertical</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedText": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>variant=\"text\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-text\">.MuiButtonGroup-text</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedTextHorizontal": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>variant=\"text\"</code> and <code>orientation=\"horizontal\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-text\">.MuiButtonGroup-text</a> , <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-horizontal\">.MuiButtonGroup-horizontal</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedTextPrimary": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>variant=\"text\"</code> and <code>color=\"primary\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-text\">.MuiButtonGroup-text</a> , <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-colorPrimary\">.MuiButtonGroup-colorPrimary</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedTextSecondary": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>variant=\"text\"</code> and <code>color=\"secondary\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-text\">.MuiButtonGroup-text</a> , <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-colorSecondary\">.MuiButtonGroup-colorSecondary</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-grouped</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"groupedTextVertical": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the children",
|
|
"conditions": "<code>variant=\"text\"</code> and <code>orientation=\"vertical\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-text\">.MuiButtonGroup-text</a> , <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-vertical\">.MuiButtonGroup-vertical</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-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/button-group/#button-group-classes-MuiButtonGroup-vertical\">.MuiButtonGroup-vertical</a> and <a href=\"/material-ui/api/button-group/#button-group-classes-MuiButtonGroup-grouped\">.MuiButtonGroup-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 button group"
|
|
},
|
|
"middleButton": {
|
|
"description": "Styles applied to {{nodeName}}.",
|
|
"nodeName": "buttons in the middle of the button group"
|
|
},
|
|
"outlined": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"outlined\"</code>"
|
|
},
|
|
"root": { "description": "Styles applied to the root element." },
|
|
"text": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"text\"</code>"
|
|
},
|
|
"vertical": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>orientation=\"vertical\"</code>"
|
|
}
|
|
}
|
|
}
|