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
137 lines
5.6 KiB
JSON
137 lines
5.6 KiB
JSON
{
|
|
"componentDescription": "",
|
|
"propDescriptions": {
|
|
"align": { "description": "Set the text-align on the component." },
|
|
"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."
|
|
},
|
|
"gutterBottom": { "description": "If <code>true</code>, the text will have a bottom margin." },
|
|
"noWrap": {
|
|
"description": "If <code>true</code>, the text will not wrap, but instead will truncate with a text overflow ellipsis.<br>Note that text overflow can only happen with block or inline-block level elements (the element needs to have a width in order to overflow)."
|
|
},
|
|
"paragraph": {
|
|
"description": "If <code>true</code>, the element will be a paragraph element."
|
|
},
|
|
"sx": {
|
|
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
|
|
},
|
|
"variant": { "description": "Applies the theme typography styles." },
|
|
"variantMapping": {
|
|
"description": "The component maps the variant prop to a range of different HTML element types. For instance, subtitle1 to <code><h6></code>. If you wish to change that mapping, you can provide your own. Alternatively, you can use the <code>component</code> prop."
|
|
}
|
|
},
|
|
"classDescriptions": {
|
|
"alignCenter": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>align=\"center\"</code>"
|
|
},
|
|
"alignJustify": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>align=\"justify\"</code>"
|
|
},
|
|
"alignLeft": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>align=\"left\"</code>"
|
|
},
|
|
"alignRight": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>align=\"right\"</code>"
|
|
},
|
|
"body1": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"body1\"</code>"
|
|
},
|
|
"body2": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"body2\"</code>"
|
|
},
|
|
"button": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"button\"</code>"
|
|
},
|
|
"caption": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"caption\"</code>"
|
|
},
|
|
"gutterBottom": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>gutterBottom={true}</code>"
|
|
},
|
|
"h1": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"h1\"</code>"
|
|
},
|
|
"h2": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"h2\"</code>"
|
|
},
|
|
"h3": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"h3\"</code>"
|
|
},
|
|
"h4": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"h4\"</code>"
|
|
},
|
|
"h5": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"h5\"</code>"
|
|
},
|
|
"h6": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"h6\"</code>"
|
|
},
|
|
"inherit": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"inherit\"</code>"
|
|
},
|
|
"noWrap": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>nowrap={true}</code>"
|
|
},
|
|
"overline": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"overline\"</code>"
|
|
},
|
|
"paragraph": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>paragraph={true}</code>"
|
|
},
|
|
"root": { "description": "Styles applied to the root element." },
|
|
"subtitle1": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"subtitle1\"</code>"
|
|
},
|
|
"subtitle2": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"subtitle2\"</code>"
|
|
}
|
|
}
|
|
}
|