Chip API
Demos
For examples and details on the usage of this React component, visit the component demo pages:
Import
import Chip from '@mui/joy/Chip';
// or
import { Chip } from '@mui/joy';
Chips represent complex entities in small blocks, such as a contact.
Props
Props of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
children | node | The content of the component. | |
color | 'danger' | 'info' | 'neutral' | 'primary' | 'success' | 'warning' | string | 'primary' | 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. |
disabled | bool | false | If true , the component is disabled. |
endDecorator | node | Element placed after the children. | |
onClick | func | Element action click handler. | |
size | 'lg' | 'md' | 'sm' | string | 'md' | 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. |
startDecorator | node | Element placed before the children. | |
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 | 'outlined' | 'plain' | 'soft' | 'solid' | string | 'solid' | The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants. |
The
ref
is forwarded to the root element.Theme default props
You can useJoyChip
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.
Name | Default class | Default HTML tag | Description |
---|---|---|---|
root | .MuiChip-root | 'div' | The component that renders the root. |
label | .MuiChip-label | 'span' | The component that renders the label. |
action | 'button' | The component that renders the action. | |
startDecorator | .MuiChip-startDecorator | 'span' | The component that renders the start decorator. |
endDecorator | .MuiChip-endDecorator | 'span' | The component that renders the end decorator. |
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.