{
"props": {
"classes": { "type": { "name": "object" }, "additionalInfo": { "cssApi": true } },
"component": { "type": { "name": "elementType" } },
"defaultValue": { "type": { "name": "number" }, "default": "null" },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"emptyIcon": { "type": { "name": "node" }, "default": "slotProps.icon.component instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details."
},
"max": { "type": { "name": "number" }, "default": "5" },
"name": { "type": { "name": "string" } },
"onChange": {
"type": { "name": "func" },
"signature": {
"type": "function(event: React.SyntheticEvent, value: number | null) => void",
"describedArgs": ["event", "value"]
}
},
"onChangeActive": {
"type": { "name": "func" },
"signature": {
"type": "function(event: React.SyntheticEvent, value: number) => void",
"describedArgs": ["event", "value"]
}
},
"precision": { "type": { "name": "custom", "description": "number" }, "default": "1" },
"readOnly": { "type": { "name": "bool" }, "default": "false" },
"size": {
"type": {
"name": "union",
"description": "'small'
| 'medium'
| 'large'
| string"
},
"default": "'medium'"
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ decimal?: func
| object, icon?: func
| object, label?: func
| object, root?: func
| object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ decimal?: elementType, icon?: elementType, label?: elementType, root?: elementType }"
},
"default": "{}"
},
"sx": {
"type": {
"name": "union",
"description": "Array<func
| object
| bool>
| func
| object"
},
"additionalInfo": { "sx": true }
},
"value": { "type": { "name": "number" } }
},
"name": "Rating",
"imports": [
"import Rating from '@mui/material/Rating';",
"import { Rating } from '@mui/material';"
],
"slots": [
{
"name": "root",
"description": "The component used for the root slot.",
"default": "'span'",
"class": "MuiRating-root"
},
{
"name": "label",
"description": "The component used for the label slot.",
"default": "'label'",
"class": "MuiRating-label"
},
{
"name": "icon",
"description": "The component used for the icon slot.",
"default": "'span'",
"class": "MuiRating-icon"
},
{
"name": "decimal",
"description": "The component used for the decimal slot.",
"default": "'span'",
"class": "MuiRating-decimal"
}
],
"classes": [
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "focusVisible",
"className": "Mui-focusVisible",
"description": "State class applied to the root element if keyboard focused.",
"isGlobal": true
},
{
"key": "iconActive",
"className": "MuiRating-iconActive",
"description": "Styles applied to the icon wrapping elements when active.",
"isGlobal": false
},
{
"key": "iconEmpty",
"className": "MuiRating-iconEmpty",
"description": "Styles applied to the icon wrapping elements when empty.",
"isGlobal": false
},
{
"key": "iconFilled",
"className": "MuiRating-iconFilled",
"description": "Styles applied to the icon wrapping elements when filled.",
"isGlobal": false
},
{
"key": "iconFocus",
"className": "MuiRating-iconFocus",
"description": "Styles applied to the icon wrapping elements when focus.",
"isGlobal": false
},
{
"key": "iconHover",
"className": "MuiRating-iconHover",
"description": "Styles applied to the icon wrapping elements when hover.",
"isGlobal": false
},
{
"key": "labelEmptyValueActive",
"className": "MuiRating-labelEmptyValueActive",
"description": "Styles applied to the label of the \"no value\" input when it is active.",
"isGlobal": false
},
{
"key": "readOnly",
"className": "Mui-readOnly",
"description": "Styles applied to the root element if `readOnly={true}`.",
"isGlobal": true
},
{
"key": "sizeLarge",
"className": "MuiRating-sizeLarge",
"description": "Styles applied to the root element if `size=\"large\"`.",
"isGlobal": false
},
{
"key": "sizeMedium",
"className": "MuiRating-sizeMedium",
"description": "Styles applied to the root element if `size=\"medium\"`.",
"isGlobal": false
},
{
"key": "sizeSmall",
"className": "MuiRating-sizeSmall",
"description": "Styles applied to the root element if `size=\"small\"`.",
"isGlobal": false
},
{
"key": "visuallyHidden",
"className": "MuiRating-visuallyHidden",
"description": "Visually hide an element.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "MuiRating",
"forwardsRefTo": "HTMLSpanElement",
"filename": "/packages/mui-material/src/Rating/Rating.js",
"inheritance": null,
"demos": "