IconButton
Basic Usage with Paragon Icon
With tooltips
Active State
isActive=true with inverted colors
Inverted Colors
Sizes
- classNamestringA custom class name. 
- iconAselementTypeComponent that renders the icon, currently defaults to FontAwesomeIcon, but is going to be deprecated soon, please use Paragon's icons instead.
- srcelement|funcDefaultnullAn icon component to render. Example import of a Paragon icon component: import { Check } from '@edx/paragon/dist/icon';
- altstringRequiredAlt text for your icon. For best practice, avoid using alt text to describe the image in the IconButton. Instead, we recommend describing the function of the button.
- invertColorsboolDefaultfalseChanges icon styles for dark background 
- iconshape{prefix:string,iconName:string,icon:}array,Accepts a React fontawesome icon. https://fontawesome.com/how-to-use/on-the-web/using-with/react 
- iconClassNamesstringExtra class names that will be added to the icon 
- onClickfuncDefault() => {}Click handler for the button 
- variantenum'primary' | 'secondary' | 'success' | 'warning' | 'danger' | 'light' | 'dark' | 'black' | 'brand'Default'primary'Type of button (uses Bootstrap options) 
- sizeenum'sm' | 'md' | 'inline'Default'md'size of button to render 
- isActiveboolDefaultfalsewhether to show the IconButtonin an active state, whose styling is distinct from default state
- tooltipPlacementstringDefault'top'tooltip placement can be top, left, right etc, per https://popper.js.org/docs/v2/constructors/#options 
- tooltipContentnodeRequiredany valid JSX or text to be rendered as tooltip contents 
- variantenum'primary' | 'secondary' | 'success' | 'warning' | 'danger' | 'light' | 'dark' | 'black' | 'brand'Default'primary'Type of button (uses Bootstrap options) 
- invertColorsboolDefaultfalseChanges icon styles for dark background