ChipDelete API

API reference docs for the React ChipDelete component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

import ChipDelete from '@mui/material/ChipDelete';
// or
import { ChipDelete } from '@mui/material';

A chip-aware delete button, designed to be used as an adornment of Chip.

When rendered inside a Chip, it inherits disabled, color, size, and variant from the chip context. Local props override context values.

Props of the native component are also available.

Name	Type	Default	Description
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
component	element type	-	The component used for the root node. Either a string to use a HTML element or a component. This needs to be able to hold a ref.
disabled	bool	false	If `true`, the component is disabled. When inside a `Chip`, inherits the chip's `disabled` state.
focusableWhenDisabled	bool	true	If `true`, the disabled delete button can receive focus.
icon	element	-	Override the default delete icon element.
label	string	'Remove'	The accessible label for the delete button.
nativeButton	bool	-	If `true`, the component is expected to resolve to a native `<button>` element. When omitted, native button semantics are inferred when `component` is `'button'` or absent. Set explicitly when using a custom `component` that resolves to a native `<button>`.
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.

The component cannot hold a ref.

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.Mui-disabled		State class applied to the root element if `disabled={true}`.
.Mui-focusVisible		State class applied when the delete button is keyboard-focused.
.MuiChipDelete-colorDefault	colorDefault	Styles applied to the root element if `color="default"`.
.MuiChipDelete-colorError	colorError	Styles applied to the root element if `color="error"`.
.MuiChipDelete-colorInfo	colorInfo	Styles applied to the root element if `color="info"`.
.MuiChipDelete-colorPrimary	colorPrimary	Styles applied to the root element if `color="primary"`.
.MuiChipDelete-colorSecondary	colorSecondary	Styles applied to the root element if `color="secondary"`.
.MuiChipDelete-colorSuccess	colorSuccess	Styles applied to the root element if `color="success"`.
.MuiChipDelete-colorWarning	colorWarning	Styles applied to the root element if `color="warning"`.
.MuiChipDelete-filled	filled	Styles applied to the root element if `variant="filled"`.
.MuiChipDelete-outlined	outlined	Styles applied to the root element if `variant="outlined"`.
.MuiChipDelete-root	root	Styles applied to the root element.
.MuiChipDelete-sizeMedium	sizeMedium	Styles applied to the root element if `size="medium"`.
.MuiChipDelete-sizeSmall	sizeSmall	Styles applied to the root element if `size="small"`.

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.

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.