Files
react-test/docs/pages/material-ui/api/chip.json

371 lines
12 KiB
JSON
Raw Normal View History

2025-12-12 14:26:25 +09:00
{
"props": {
"avatar": { "type": { "name": "element" } },
"children": { "type": { "name": "custom", "description": "unsupportedProp" } },
"classes": { "type": { "name": "object" }, "additionalInfo": { "cssApi": true } },
"clickable": { "type": { "name": "bool" } },
"color": {
"type": {
"name": "union",
"description": "'default'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'secondary'<br>&#124;&nbsp;'error'<br>&#124;&nbsp;'info'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'default'"
},
"component": { "type": { "name": "elementType" } },
"deleteIcon": { "type": { "name": "element" } },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"icon": { "type": { "name": "element" } },
"label": { "type": { "name": "node" } },
"onDelete": { "type": { "name": "func" } },
"size": {
"type": {
"name": "union",
"description": "'medium'<br>&#124;&nbsp;'small'<br>&#124;&nbsp;string"
},
"default": "'medium'"
},
"skipFocusWhenDisabled": { "type": { "name": "bool" }, "default": "false" },
"slotProps": {
"type": {
"name": "shape",
"description": "{ label?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ label?: elementType, root?: elementType }" },
"default": "{}"
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'filled'<br>&#124;&nbsp;'outlined'<br>&#124;&nbsp;string"
},
"default": "'filled'"
}
},
"name": "Chip",
"imports": ["import Chip from '@mui/material/Chip';", "import { Chip } from '@mui/material';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "div",
"class": "MuiChip-root"
},
{
"name": "label",
"description": "The component that renders the label.",
"default": "span",
"class": "MuiChip-label"
}
],
"classes": [
{
"key": "avatar",
"className": "MuiChip-avatar",
"description": "Styles applied to the avatar element.",
"isGlobal": false
},
{
"key": "avatarColorPrimary",
"className": "MuiChip-avatarColorPrimary",
"description": "Styles applied to the avatar element if `color=\"primary\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "avatarColorSecondary",
"className": "MuiChip-avatarColorSecondary",
"description": "Styles applied to the avatar element if `color=\"secondary\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "avatarMedium",
"className": "MuiChip-avatarMedium",
"description": "Styles applied to the avatar element if `size=\"medium\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "avatarSmall",
"className": "MuiChip-avatarSmall",
"description": "Styles applied to the avatar element if `size=\"small\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "clickable",
"className": "MuiChip-clickable",
"description": "Styles applied to the root element if `onClick` is defined or `clickable={true}`.",
"isGlobal": false
},
{
"key": "clickableColorPrimary",
"className": "MuiChip-clickableColorPrimary",
"description": "Styles applied to the root element if `onClick` and `color=\"primary\"` is defined or `clickable={true}`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "clickableColorSecondary",
"className": "MuiChip-clickableColorSecondary",
"description": "Styles applied to the root element if `onClick` and `color=\"secondary\"` is defined or `clickable={true}`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "colorDefault",
"className": "MuiChip-colorDefault",
"description": "Styles applied to the root element if `color=\"default\"`.",
"isGlobal": false
},
{
"key": "colorError",
"className": "MuiChip-colorError",
"description": "Styles applied to the root element if `color=\"error\"`.",
"isGlobal": false
},
{
"key": "colorInfo",
"className": "MuiChip-colorInfo",
"description": "Styles applied to the root element if `color=\"info\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiChip-colorPrimary",
"description": "Styles applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSecondary",
"className": "MuiChip-colorSecondary",
"description": "Styles applied to the root element if `color=\"secondary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiChip-colorSuccess",
"description": "Styles applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiChip-colorWarning",
"description": "Styles applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "deletable",
"className": "MuiChip-deletable",
"description": "Styles applied to the root element if `onDelete` is defined.",
"isGlobal": false
},
{
"key": "deletableColorPrimary",
"className": "MuiChip-deletableColorPrimary",
"description": "Styles applied to the root element if `onDelete` and `color=\"primary\"` is defined.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "deletableColorSecondary",
"className": "MuiChip-deletableColorSecondary",
"description": "Styles applied to the root element if `onDelete` and `color=\"secondary\"` is defined.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "deleteIcon",
"className": "MuiChip-deleteIcon",
"description": "Styles applied to the deleteIcon element.",
"isGlobal": false
},
{
"key": "deleteIconColorPrimary",
"className": "MuiChip-deleteIconColorPrimary",
"description": "Styles applied to the deleteIcon element if `color=\"primary\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "deleteIconColorSecondary",
"className": "MuiChip-deleteIconColorSecondary",
"description": "Styles applied to the deleteIcon element if `color=\"secondary\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "deleteIconFilledColorPrimary",
"className": "MuiChip-deleteIconFilledColorPrimary",
"description": "Styles applied to the deleteIcon element if `color=\"primary\"` and `variant=\"filled\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "deleteIconFilledColorSecondary",
"className": "MuiChip-deleteIconFilledColorSecondary",
"description": "Styles applied to the deleteIcon element if `color=\"secondary\"` and `variant=\"filled\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "deleteIconMedium",
"className": "MuiChip-deleteIconMedium",
"description": "Styles applied to the deleteIcon element if `size=\"medium\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "deleteIconOutlinedColorPrimary",
"className": "MuiChip-deleteIconOutlinedColorPrimary",
"description": "Styles applied to the deleteIcon element if `color=\"primary\"` and `variant=\"outlined\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "deleteIconOutlinedColorSecondary",
"className": "MuiChip-deleteIconOutlinedColorSecondary",
"description": "Styles applied to the deleteIcon element if `color=\"secondary\"` and `variant=\"outlined\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "deleteIconSmall",
"className": "MuiChip-deleteIconSmall",
"description": "Styles applied to the deleteIcon element if `size=\"small\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "filled",
"className": "MuiChip-filled",
"description": "Styles applied to the root element if `variant=\"filled\"`.",
"isGlobal": false
},
{
"key": "filledPrimary",
"className": "MuiChip-filledPrimary",
"description": "Styles applied to the root element if `variant=\"filled\"` and `color=\"primary\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "filledSecondary",
"className": "MuiChip-filledSecondary",
"description": "Styles applied to the root element if `variant=\"filled\"` and `color=\"secondary\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "focusVisible",
"className": "Mui-focusVisible",
"description": "State class applied to the root element if keyboard focused.",
"isGlobal": true
},
{
"key": "icon",
"className": "MuiChip-icon",
"description": "Styles applied to the icon element.",
"isGlobal": false
},
{
"key": "iconColorPrimary",
"className": "MuiChip-iconColorPrimary",
"description": "Styles applied to the icon element if `color=\"primary\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "iconColorSecondary",
"className": "MuiChip-iconColorSecondary",
"description": "Styles applied to the icon element if `color=\"secondary\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "iconMedium",
"className": "MuiChip-iconMedium",
"description": "Styles applied to the icon element if `size=\"medium\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "iconSmall",
"className": "MuiChip-iconSmall",
"description": "Styles applied to the icon element if `size=\"small\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "labelMedium",
"className": "MuiChip-labelMedium",
"description": "Styles applied to the label `span` element if `size=\"medium\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "labelSmall",
"className": "MuiChip-labelSmall",
"description": "Styles applied to the label `span` element if `size=\"small\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "outlined",
"className": "MuiChip-outlined",
"description": "Styles applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "outlinedPrimary",
"className": "MuiChip-outlinedPrimary",
"description": "Styles applied to the root element if `variant=\"outlined\"` and `color=\"primary\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "outlinedSecondary",
"className": "MuiChip-outlinedSecondary",
"description": "Styles applied to the root element if `variant=\"outlined\"` and `color=\"secondary\"`.",
"isGlobal": false,
"isDeprecated": true
},
{
"key": "sizeMedium",
"className": "MuiChip-sizeMedium",
"description": "Styles applied to the root element if `size=\"medium\"`.",
"isGlobal": false
},
{
"key": "sizeSmall",
"className": "MuiChip-sizeSmall",
"description": "Styles applied to the root element if `size=\"small\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "MuiChip",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-material/src/Chip/Chip.js",
"inheritance": null,
"demos": "<ul><li><a href=\"/material-ui/react-chip/\">Chip</a></li></ul>",
"cssComponent": false
}