{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"endDecorator": { "type": { "name": "node" } },
"onClick": { "type": { "name": "func" } },
"size": {
"type": {
"name": "union",
"description": "'lg'
| 'md'
| 'sm'
| string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ action?: func
| object, endDecorator?: func
| object, label?: func
| object, root?: func
| object, startDecorator?: func
| object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ action?: elementType, endDecorator?: elementType, label?: elementType, root?: elementType, startDecorator?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"startDecorator": { "type": { "name": "node" } },
"sx": {
"type": {
"name": "union",
"description": "Array<func
| object
| bool>
| func
| object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'
| 'plain'
| 'soft'
| 'solid'
| string"
},
"default": "'soft'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "Chip",
"imports": ["import Chip from '@mui/joy/Chip';", "import { Chip } from '@mui/joy';"],
"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"
},
{
"name": "action",
"description": "The component that renders the action.",
"default": "'button'",
"class": null
},
{
"name": "startDecorator",
"description": "The component that renders the start decorator.",
"default": "'span'",
"class": "MuiChip-startDecorator"
},
{
"name": "endDecorator",
"description": "The component that renders the end decorator.",
"default": "'span'",
"class": "MuiChip-endDecorator"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiChip-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiChip-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiChip-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiChip-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiChip-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiChip-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"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": "labelLg",
"className": "MuiChip-labelLg",
"description": "Class name applied to the label `span` element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "labelMd",
"className": "MuiChip-labelMd",
"description": "Class name applied to the label `span` element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "labelSm",
"className": "MuiChip-labelSm",
"description": "Class name applied to the label `span` element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiChip-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiChip-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiChip-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiChip-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiChip-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiChip-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiChip-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyChip",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Chip/Chip.tsx",
"inheritance": null,
"demos": "