Chip
Show compact entities, filters or removable selections.
This guide covers Material UI Core with the default Emotion engine; extensions and additional demos are explicitly classified.
Use case and business boundary
Deletable Chips require onDelete and host state updates; they are not text inputs or persistence services.
Native composition and scope
Chip
Preserve native Material UI composition and types; do not substitute JGuang UI/Base UI/Radix APIs. Example entries are not extra components.
Native installation and initialization
npm install @mui/material@9.4.0 @emotion/react@11.14.0 @emotion/styled@11.14.1
Use native npm and Emotion, not an invented JGuang UI Registry URL. Place examples inside native ThemeProvider; choose CssBaseline or ScopedCssBaseline for the project. Inspect React, existing providers, lockfile and SSR first. Never overwrite files or conceal peer conflicts. This batch verified React 19.2.8; React 18 and below require matching react-is. See the included bilingual setup guide.
Practical native parameters
These selected parameters are not a flattened universal API. Preserve the native declaring owner, slot structure, nullable values and generics.
| Owner.prop | Practical role | Declaration source |
|---|---|---|
Chip.label | Native visible label/content; not necessarily the underlying value. | Chip |
Chip.onDelete | Native Chip removal request; the host removes the corresponding data item. | Chip |
Chip.onClick | Native activation handler; connect a real action without overriding disabled behavior. | React.HTMLAttributes |
Chip.clickable | Make Chip present an interactive affordance; it does not supply business logic. | Chip |
Chip.disabled | Native disabled interaction state; not an authorization check. | Chip |
Runnable native examples
Machine keys select example entries, not universal variant props. Native demo JSX/data stay unchanged; JGuang-authored acceptance fixtures are explicitly labelled.
- Basic chip ·
BasicChips· upstream native demo - Clickable ·
ClickableChips· upstream native demo - Deletable ·
DeletableChips· upstream native demo - Clickable and deletable ·
ClickableAndDeletableChips· upstream native demo - Clickable link ·
ClickableLinkChips· upstream native demo - Custom delete icon ·
CustomDeleteIconChips· upstream native demo - Avatar chip ·
AvatarChips· upstream native demo - Icon chip ·
IconChips· upstream native demo - Color chip ·
ColorChips· upstream native demo - Sizes chip ·
SizesChips· upstream native demo - Multiline chip ·
MultilineChips· upstream native demo - Chip array ·
ChipsArray· upstream native demo
Explicitly unsupported additional examples
These remain in the upstream inventory, not silently skipped or presented as working previews. Additional dependency/framework acceptance is required.
- Chip playground ·
ChipsPlayground:@mui/internal-core-docs/HighlightedCode
Actual usage example
Unmodified pinned native demo; copy its required local helper files together.
import Chip from '@mui/material/Chip';
import Stack from '@mui/material/Stack';
export default function BasicChips() {
return (
<Stack direction="row" spacing={1}>
<Chip label="Chip Filled" />
<Chip label="Chip Outlined" variant="outlined" />
</Stack>
);
}
Example dependency boundaries
@mui/material/Chip, @mui/material/Stack, @mui/icons-material/Done, @mui/icons-material/Delete, @mui/material/Avatar, @mui/icons-material/Face, @mui/material/Box, react, @mui/material/styles, @mui/material/Paper, @mui/icons-material/TagFaces
Direct Icons/System/Utils example imports require their matching 9.4.0 packages. Relative data/helpers are part of the example closure, not extra components. Remote images and simulated operations do not supply a backend.
Pinned upstream API metadata reference
These tables retain the upstream metadata, not a newly inferred generic type system. Conditional generics, inherited props and callback details are defined by the source declarations below. Theme defaults may override metadata defaults.
Chip
import Chip from '@mui/material/Chip';
import { Chip } from '@mui/material';
| Prop | Required | Upstream metadata type / constraint | Metadata default |
|---|---|---|---|
avatar | no | element | — |
children | no | unsupportedProp | — |
classes | no | object | — |
clickable | no | bool | — |
color | no | 'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'default' |
component | no | elementType | — |
deleteIcon | no | element | — |
disabled | no | bool | false |
icon | no | element | — |
label | no | node | — |
nativeButton | no | bool | — |
onDelete | no | func | — |
size | no | 'medium' | 'small' | string | 'medium' |
skipFocusWhenDisabled | no | bool | false |
slotProps | no | { label?: func | object, root?: func | object } | {} |
slots | no | { label?: elementType, root?: elementType } | {} |
sx | no | Array<func | object | bool> | func | object | — |
variant | no | 'filled' | 'outlined' | string | 'filled' |
Native source declarations
Declarations/imports are extracted from pinned source without flattening unions or external inheritance. Original English comments/types are source reference, not a claim of translated upstream prose. Shared types stay in their native packages.
vendor/src/Chip/Chip.d.ts
import * as React from 'react';
import { OverridableStringUnion } from '@mui/types';
import { SxProps } from '@mui/system';
import { CreateSlotsAndSlotProps, SlotProps } from '../utils/types';
import { Theme } from '../styles';
import { OverridableComponent, OverrideProps } from '../OverridableComponent';
import { ChipClasses } from './chipClasses';
export interface ChipSlots {
/**
* The component that renders the root.
* @default div
*/
root: React.ElementType;
/**
* The component that renders the label.
* @default span
*/
label: React.ElementType;
}
export type ChipSlotsAndSlotProps = CreateSlotsAndSlotProps<
ChipSlots,
{
/**
* Props forwarded to the root slot.
* By default, the available props are based on the div element.
*/
root: SlotProps<'div', {}, ChipOwnerState>;
/**
* Props forwarded to the label slot.
* By default, the available props are based on the span element.
*/
label: SlotProps<'span', {}, ChipOwnerState>;
}
>;
export interface ChipOwnerState extends Omit<ChipProps, 'slots' | 'slotProps'> {}
export interface ChipPropsVariantOverrides {}
export interface ChipPropsSizeOverrides {}
export interface ChipPropsColorOverrides {}
export interface ChipOwnProps {
/**
* The Avatar element to display.
*/
avatar?: React.ReactElement<unknown> | undefined;
/**
* This prop isn't supported.
* Use the `component` prop if you need to change the children structure.
*/
children?: null | undefined;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<ChipClasses> | undefined;
/**
* 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.
*/
clickable?: boolean | undefined;
/**
* The color of the component.
* It supports both default and custom theme colors, which can be added as shown in the
* [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).
* @default 'default'
*/
color?:
| OverridableStringUnion<
'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning',
ChipPropsColorOverrides
>
| undefined;
/**
* Override the default delete icon element. Shown only if `onDelete` is set.
*/
deleteIcon?: React.ReactElement<unknown> | undefined;
/**
* If `true`, the component is disabled.
* @default false
*/
disabled?: boolean | undefined;
/**
* Icon element.
*/
icon?: React.ReactElement<unknown> | undefined;
/**
* The content of the component.
*/
label?: React.ReactNode;
/**
* Callback fired when the delete icon is clicked.
* If set, the delete icon will be shown.
*/
onDelete?: React.EventHandler<any> | undefined;
/**
* The size of the component.
* @default 'medium'
*/
size?: OverridableStringUnion<'small' | 'medium', ChipPropsSizeOverrides> | undefined;
/**
* If `true`, the component is expected to resolve to a native `<button>` element.
* When omitted, custom components inherit the default button semantics of the current wrapper.
* Set to `true` when a custom component resolves to a native `<button>`, or `false`
* when it resolves to a non-button host.
*/
nativeButton?: boolean | undefined;
/**
* If `true`, allows the disabled chip to escape focus.
* If `false`, allows the disabled chip to receive focus.
* @default false
*/
skipFocusWhenDisabled?: boolean | undefined;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme> | undefined;
/**
* @ignore
*/
tabIndex?: number | undefined;
/**
* The variant to use.
* @default 'filled'
*/
variant?: OverridableStringUnion<'filled' | 'outlined', ChipPropsVariantOverrides> | undefined;
}
export interface ChipTypeMap<
AdditionalProps = {},
RootComponent extends React.ElementType = 'div',
> {
props: AdditionalProps & ChipOwnProps & ChipSlotsAndSlotProps;
defaultComponent: RootComponent;
}
declare const Chip: OverridableComponent<ChipTypeMap>;
export type ChipProps<
RootComponent extends React.ElementType = ChipTypeMap['defaultComponent'],
AdditionalProps = {},
> = OverrideProps<ChipTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
component?: React.ElementType | undefined;
};
Post-install acceptance
Run strict types, production build and real interactions. Check keyboard labels/focus, disabled/error/read-only semantics where natively supported, both themes, narrow screens and reduced motion. Verify callbacks against the real host data; do not declare installation complete from copying a prompt. Initialization fixtures also require server HTML and warning-free hydration.
Source and license
https://github.com/mui/material-ui/tree/809a7717b4c050ba3f69b75300689f07c050a16e
MIT · @mui/material@9.4.0. Vendor originals and license are preserved. Full original upstream prose remains in vendor/docs and is not represented as fully translated.