Skip to content

Chip API

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

Component demos

Import

import Chip from '@mui/joy/Chip';
// or
import { Chip } from '@mui/joy';
Learn about the difference by reading this guide on minimizing bundle size.

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

Props

Props of the native component are also available.

children

The content of the component.

Type:node

color

The color of the component. It supports those theme colors that make sense for this component.

To learn how to add your own colors, check out Themed components—Extend colors.

Type:'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string

Default:'neutral'

component

The component used for the root node. Either a string to use a HTML element or a component.

Type:elementType

disabled

If true, the component is disabled.

Type:bool

Default:false

endDecorator

Element placed after the children.

Type:node

onClick

Element action click handler.

Type:func

size

The size of the component. It accepts theme values between 'sm' and 'lg'.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

Type:'lg'
| 'md'
| 'sm'
| string

Default:'md'

slotProps

The props used for each slot inside.

Type:{ action?: func
| object, endDecorator?: func
| object, label?: func
| object, root?: func
| object, startDecorator?: func
| object }

Default:{}

slots

The components used for each slot inside.

See Slots API below for more details.

Type:{ action?: elementType, endDecorator?: elementType, label?: elementType, root?: elementType, startDecorator?: elementType }

Default:{}

startDecorator

Element placed before the children.

Type:node

sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func
| object
| bool>
| func
| object

variant

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

Type:'outlined'
| 'plain'
| 'soft'
| 'solid'
| string

Default:'soft'

The ref is forwarded to the root element.

Theme default props

You can use JoyChip to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

root

The component that renders the root.

Global class: .MuiChip-root

Default: 'div'

label

The component that renders the label.

Global class: .MuiChip-label

Default: 'span'

action

The component that renders the action.

Default: 'button'

startDecorator

The component that renders the start decorator.

Global class: .MuiChip-startDecorator

Default: 'span'

endDecorator

The component that renders the end decorator.

Global class: .MuiChip-endDecorator

Default: 'span'

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

.Mui-disabledSTATE

State class applied to the root element if disabled={true}.

.Mui-focusVisibleSTATE

State class applied to the root element if keyboard focused.

.MuiChip-colorContext

Class name applied to the root element when color inversion is triggered.

.MuiChip-colorDanger

Class name applied to the root element if color="danger".

.MuiChip-colorNeutral

Class name applied to the root element if color="neutral".

.MuiChip-colorPrimary

Class name applied to the root element if color="primary".

.MuiChip-colorSuccess

Class name applied to the root element if color="success".

.MuiChip-colorWarning

Class name applied to the root element if color="warning".

.MuiChip-labelLg

Class name applied to the label span element if size="lg".

.MuiChip-labelMd

Class name applied to the label span element if size="md".

.MuiChip-labelSm

Class name applied to the label span element if size="sm".

.MuiChip-sizeLg

Class name applied to the root element if size="lg".

.MuiChip-sizeMd

Class name applied to the root element if size="md".

.MuiChip-sizeSm

Class name applied to the root element if size="sm".

.MuiChip-variantOutlined

Class name applied to the root element if variant="outlined".

.MuiChip-variantPlain

Class name applied to the root element if variant="plain".

.MuiChip-variantSoft

Class name applied to the root element if variant="soft".

.MuiChip-variantSolid

Class name applied to the root element if variant="solid".