Chip API
API documentation for the React Chip component. Learn about the available props and the CSS API.
Import
import Chip from '@mui/material/Chip';
// or
import { Chip } from '@mui/material';
Chips represent complex entities in small blocks, such as a contact.
Component name
The nameMuiChip
can be used when providing default props or style overrides in the theme.Props
Props of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
avatar | element | The Avatar element to display. | |
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 | false | 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 appear 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. Note: this controls the UI and does not affect the onClick event. |
color | 'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'default' | The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. |
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 component is disabled. |
icon | element | Icon element. | |
label | node | The content of the component. | |
onDelete | func | Callback fired when the delete icon is clicked. If set, the delete icon will be shown. | |
size | 'medium' | 'small' | string | 'medium' | The size of the component. |
sx | Array<func | object | bool> | func | object | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. | |
variant | 'filled' | 'outlined' | string | 'filled' | The variant to use. |
The
ref
is forwarded to the root 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" . |
sizeMedium | .MuiChip-sizeMedium | Styles applied to the root element if size="medium" . |
colorError | .MuiChip-colorError | Styles applied to the root element if color="error" . |
colorInfo | .MuiChip-colorInfo | Styles applied to the root element if color="info" . |
colorPrimary | .MuiChip-colorPrimary | Styles applied to the root element if color="primary" . |
colorSecondary | .MuiChip-colorSecondary | Styles applied to the root element if color="secondary" . |
colorSuccess | .MuiChip-colorSuccess | Styles applied to the root element if color="success" . |
colorWarning | .MuiChip-colorWarning | Styles applied to the root element if color="warning" . |
disabled | .Mui-disabled | State 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" . |
filled | .MuiChip-filled | Styles applied to the root element if variant="filled" . |
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" . |
filledPrimary | .MuiChip-filledPrimary | Styles applied to the root element if variant="filled" and color="primary" . |
filledSecondary | .MuiChip-filledSecondary | Styles applied to the root element if variant="filled" and color="secondary" . |
avatar | .MuiChip-avatar | Styles applied to the avatar element. |
avatarSmall | .MuiChip-avatarSmall | Styles applied to the avatar element if size="small" . |
avatarMedium | .MuiChip-avatarMedium | Styles applied to the avatar element if size="medium" . |
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" . |
iconMedium | .MuiChip-iconMedium | Styles applied to the icon element if size="medium" . |
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" . |
labelMedium | .MuiChip-labelMedium | Styles applied to the label `span` element if size="medium" . |
deleteIcon | .MuiChip-deleteIcon | Styles applied to the deleteIcon element. |
deleteIconSmall | .MuiChip-deleteIconSmall | Styles applied to the deleteIcon element if size="small" . |
deleteIconMedium | .MuiChip-deleteIconMedium | Styles applied to the deleteIcon element if size="medium" . |
deleteIconColorPrimary | .MuiChip-deleteIconColorPrimary | Styles applied to the deleteIcon element if color="primary" and variant="filled" . |
deleteIconColorSecondary | .MuiChip-deleteIconColorSecondary | Styles applied to the deleteIcon element if color="secondary" and variant="filled" . |
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" . |
deleteIconFilledColorPrimary | .MuiChip-deleteIconFilledColorPrimary | Styles applied to the deleteIcon element if color="primary" and variant="filled" . |
deleteIconFilledColorSecondary | .MuiChip-deleteIconFilledColorSecondary | Styles applied to the deleteIcon element if color="secondary" and variant="filled" . |
focusVisible | .Mui-focusVisible | State class applied to the root element if keyboard focused. |
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.