<IconButtonDocs />

IconButton is an accessible action element represented by an icon.

Usage

Use the variant prop to switch between button styles.

variant

filled

Outlined

base

hover

active

disabled

<IconButton icon={<Icon id='settings' />} />

Props

Name
Description
color

"primary"
disabled

boolean
fullWidth

boolean
href

string
icon

string | ReactElement
size

"small" | "large"
variant

"filled" | "outlined"

TypeScript customization

You can use module augmentation to customize the TypeScript types for any of IconButton's props:

declare module 'componentry/types/components/IconButton/IconButton' { interface IconButtonPropsOverrides { // ... overwrite any types for IconButton props ... } }

See the for more information.

StylingIconButton styles

Class
Description
.C9Y-IconButton-base
.C9Y-IconButton-filled
.C9Y-IconButton-largeSize
.C9Y-IconButton-outlined
.C9Y-IconButton-smallSize