跳转到内容

🎉 v5 beta is out! Head to the v5 documentation to get started.

Chip API

The API documentation of the Chip React component. Learn more about the props and the CSS customization points.

Import

import Chip from '@material-ui/core/Chip';
// or
import { Chip } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Chips represent complex entities in small blocks, such as a contact.

Component name

The MuiChip name can be used for providing default props or style overrides at the theme level.

Props

Name Type Default Description
avatar element Avatar element.
children unsupportedProp This prop isn't supported. Use the component prop if you need to change the children structure.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
clickable bool If true, the chip will appear clickable, and will raise when pressed, even if the onClick prop is not defined. If false, the chip will not be clickable, even if onClick prop is defined. This can be used, for example, along with the component prop to indicate an anchor Chip is clickable.
color 'default'
| 'primary'
| 'secondary'
'default' The color of the component. It supports those theme colors that make sense for this component.
component elementType The component used for the root node. Either a string to use a HTML element or a component.
deleteIcon element Override the default delete icon element. Shown only if onDelete is set.
disabled bool false If true, the chip should be displayed in a disabled state.
icon element Icon element.
label node The content of the label.
onDelete func Callback function fired when the delete icon is clicked. If set, the delete icon will be shown.
size 'medium'
| 'small'
'medium' The size of the chip.
variant 'default'
| 'outlined'
'default' The variant to use.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

Rule name Global class Description
root .MuiChip-root Styles applied to the root element.
sizeSmall .MuiChip-sizeSmall Styles applied to the root element if size="small".
colorPrimary .MuiChip-colorPrimary Styles applied to the root element if color="primary".
colorSecondary .MuiChip-colorSecondary Styles applied to the root element if color="secondary".
disabled .Mui-disabled Pseudo-class applied to the root element if disabled={true}.
clickable .MuiChip-clickable Styles applied to the root element if onClick is defined or clickable={true}.
clickableColorPrimary .MuiChip-clickableColorPrimary Styles applied to the root element if onClick and color="primary" is defined or clickable={true}.
clickableColorSecondary .MuiChip-clickableColorSecondary Styles applied to the root element if onClick and color="secondary" is defined or clickable={true}.
deletable .MuiChip-deletable Styles applied to the root element if onDelete is defined.
deletableColorPrimary .MuiChip-deletableColorPrimary Styles applied to the root element if onDelete and color="primary" is defined.
deletableColorSecondary .MuiChip-deletableColorSecondary Styles applied to the root element if onDelete and color="secondary" is defined.
outlined .MuiChip-outlined Styles applied to the root element if variant="outlined".
outlinedPrimary .MuiChip-outlinedPrimary Styles applied to the root element if variant="outlined" and color="primary".
outlinedSecondary .MuiChip-outlinedSecondary Styles applied to the root element if variant="outlined" and color="secondary".
avatar .MuiChip-avatar Styles applied to the avatar element.
avatarSmall .MuiChip-avatarSmall Styles applied to the avatar element if size="small".
avatarColorPrimary .MuiChip-avatarColorPrimary Styles applied to the avatar element if color="primary".
avatarColorSecondary .MuiChip-avatarColorSecondary Styles applied to the avatar element if color="secondary".
icon .MuiChip-icon Styles applied to the icon element.
iconSmall .MuiChip-iconSmall Styles applied to the icon element if size="small".
iconColorPrimary .MuiChip-iconColorPrimary Styles applied to the icon element if color="primary".
iconColorSecondary .MuiChip-iconColorSecondary Styles applied to the icon element if color="secondary".
label .MuiChip-label Styles applied to the label span element.
labelSmall .MuiChip-labelSmall Styles applied to the label span element if size="small".
deleteIcon .MuiChip-deleteIcon Styles applied to the deleteIcon element.
deleteIconSmall .MuiChip-deleteIconSmall Styles applied to the deleteIcon element if size="small".
deleteIconColorPrimary .MuiChip-deleteIconColorPrimary Styles applied to the deleteIcon element if color="primary" and variant="default".
deleteIconColorSecondary .MuiChip-deleteIconColorSecondary Styles applied to the deleteIcon element if color="secondary" and variant="default".
deleteIconOutlinedColorPrimary .MuiChip-deleteIconOutlinedColorPrimary Styles applied to the deleteIcon element if color="primary" and variant="outlined".
deleteIconOutlinedColorSecondary .MuiChip-deleteIconOutlinedColorSecondary Styles applied to the deleteIcon element if color="secondary" and variant="outlined".

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Demos