materialuiupgraded

Version:

Material-UI's workspace package

82 lines (64 loc) • 6.3 kB

Markdown

--- filename: /packages/material-ui/src/Chip/Chip.js title: Chip API ---  # Chip The API documentation of the Chip React component. Learn more about the properties and the CSS customization points. ```js import Chip from '@material-ui/core/Chip'; ``` Chips represent complex entities in small blocks, such as a contact. ## Props | Name | Type | Default | Description | |:-----|:-----|:--------|:------------| | avatar | element | | Avatar element. | | children | unsupportedProp | | This property isn't supported. Use the `component` property if you need to change the children structure. | | classes | object | | Override or extend the styles applied to the component. See [CSS API](#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 property is not defined. This can be used, for example, along with the component property to indicate an anchor Chip is clickable. | | color | enum: 'default' |  'primary' |  'secondary' | 'default' | The color of the component. It supports those theme colors that make sense for this component. | | component | union: string |  func |  object | 'div' | The component used for the root node. Either a string to use a DOM element or a component. | | deleteIcon | element | | Override the default delete icon element. Shown only if `onDelete` is set. | | icon | element | | Icon element. | | label | node | | The content of the label. | | onDelete | func | | Callback function fired when the delete icon is clicked. If set, the delete icon will be shown. | | variant | enum: 'default' |  'outlined' | 'default' | The variant to use. | Any other properties supplied will be spread to the root element (native element). ## CSS API You can override all the class names injected by Material-UI thanks to the `classes` property. This property accepts the following keys: | Name | Description | |:-----|:------------| | root | Styles applied to the root element. | colorPrimary | Styles applied to the root element if `color="primary"`. | colorSecondary | Styles applied to the root element if `color="secondary"`. | clickable | Styles applied to the root element if `onClick` is defined or `clickable={true}`. | clickableColorPrimary | | clickableColorSecondary | | deletable | Styles applied to the root element if `onDelete` is defined. | deletableColorPrimary | Styles applied to the root element if `onDelete` and `color="primary"` is defined. | deletableColorSecondary | Styles applied to the root element if `onDelete` and `color="secondary"` is defined. | outlined | Styles applied to the root element if `variant="outlined"`. | outlinedPrimary | Styles applied to the root element if `variant="outlined"` and `color="primary"`. | outlinedSecondary | Styles applied to the root element if `variant="outlined"` and `color="secondary"`. | avatar | Styles applied to the `avatar` element. | avatarColorPrimary | Styles applied to the `avatar` element if `color="primary"` | avatarColorSecondary | Styles applied to the `avatar` element if `color="secondary"` | avatarChildren | Styles applied to the `avatar` elements children. | icon | Styles applied to the `icon` element. | iconColorPrimary | Styles applied to the `icon` element if `color="primary"` | iconColorSecondary | Styles applied to the `icon` element if `color="secondary"` | label | Styles applied to the label `span` element`. | deleteIcon | Styles applied to the `deleteIcon` element. | deleteIconColorPrimary | Styles applied to the deleteIcon element if `color="primary"` and `variant="default"`. | deleteIconColorSecondary | Styles applied to the deleteIcon element if `color="secondary"` and `variant="default"`. | deleteIconOutlinedColorPrimary | Styles applied to the deleteIcon element if `color="primary"` and `variant="outlined"`. | deleteIconOutlinedColorSecondary | Styles applied to the deleteIcon element if `color="secondary"` and `variant="outlined"`. Have a look at [overriding with classes](/customization/overrides/#overriding-with-classes) section and the [implementation of the component](https://github.com/mui-org/material-ui/tree/master/packages/material-ui/src/Chip/Chip.js) for more detail. If using the `overrides` key of the theme as documented [here](/customization/themes/#customizing-all-instances-of-a-component-type), you need to use the following style sheet name: `MuiChip`. ## Demos - [Chips](/demos/chips/)