UNPKG

materialuiupgraded

Version:

Material-UI's workspace package

64 lines (44 loc) 3.18 kB
--- filename: /packages/material-ui/src/IconButton/IconButton.js title: IconButton API --- <!--- This documentation is automatically generated, do not try to edit it. --> # IconButton <p class="description">The API documentation of the IconButton React component. Learn more about the properties and the CSS customization points.</p> ```js import IconButton from '@material-ui/core/IconButton'; ``` Refer to the [Icons](/style/icons/) section of the documentation regarding the available icon options. ## Props | Name | Type | Default | Description | |:-----|:-----|:--------|:------------| | <span class="prop-name">children</span> | <span class="prop-type">node |   | The icon element. | | <span class="prop-name">classes</span> | <span class="prop-type">object |   | Override or extend the styles applied to the component. See [CSS API](#css-api) below for more details. | | <span class="prop-name">color</span> | <span class="prop-type">enum:&nbsp;'default'&nbsp;&#124;<br>&nbsp;'inherit'&nbsp;&#124;<br>&nbsp;'primary'&nbsp;&#124;<br>&nbsp;'secondary'<br> | <span class="prop-default">'default'</span> | The color of the component. It supports those theme colors that make sense for this component. | | <span class="prop-name">disabled</span> | <span class="prop-type">bool | <span class="prop-default">false</span> | If `true`, the button will be disabled. | | <span class="prop-name">disableRipple</span> | <span class="prop-type">bool |   | If `true`, the ripple will be disabled. | Any other properties supplied will be spread to the root element ([ButtonBase](/api/button-base/)). ## 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 | |:-----|:------------| | <span class="prop-name">root</span> | Styles applied to the root element. | <span class="prop-name">colorInherit</span> | Styles applied to the root element if `color="inherit"`. | <span class="prop-name">colorPrimary</span> | Styles applied to the root element if `color="primary"`. | <span class="prop-name">colorSecondary</span> | Styles applied to the root element if `color="secondary"`. | <span class="prop-name">disabled</span> | Styles applied to the root element if `disabled={true}`. | <span class="prop-name">label</span> | Styles applied to the children container element. 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/IconButton/IconButton.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: `MuiIconButton`. ## Inheritance The properties of the [ButtonBase](/api/button-base/) component are also available. You can take advantage of this behavior to [target nested components](/guides/api/#spread). ## Demos - [Buttons](/demos/buttons/) - [Grid List](/demos/grid-list/)