IconButton
Basic Usage with Paragon Icon
With tooltips
Active State
isActive=true with inverted colors
Inverted Colors
Sizes
- className
string
RequiredA custom class name.
- iconAs
elementType
RequiredComponent that renders the icon, currently defaults to
FontAwesomeIcon
, but is going to be deprecated soon, please use Paragon's icons instead. - src
element
Required |func
Required RequiredDefaultnullAn icon component to render. Example import of a Paragon icon component:
import { Check } from '@edx/paragon/dist/icon';
- alt
string
Required RequiredAlt 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. - invertColors
bool
RequiredDefaultfalseChanges icon styles for dark background
- icon
shape
Required {prefix:string
,iconName:string
,icon:}array
,Accepts a React fontawesome icon. https://fontawesome.com/how-to-use/on-the-web/using-with/react
- iconClassNames
string
RequiredExtra class names that will be added to the icon
- onClick
func
RequiredDefault() => {}Click handler for the button
- variant
enum
Required'primary' | 'secondary' | 'success' | 'warning' | 'danger' | 'light' | 'dark' | 'black' | 'brand'Default'primary'Type of button (uses Bootstrap options)
- size
enum
Required'sm' | 'md' | 'inline'Default'md'size of button to render
- isActive
bool
RequiredDefaultfalsewhether to show the
IconButton
in an active state, whose styling is distinct from default state
- tooltipPlacement
string
RequiredDefault'top'tooltip placement can be top, left, right etc, per https://popper.js.org/docs/v2/constructors/#options
- tooltipContent
node
Required Requiredany valid JSX or text to be rendered as tooltip contents
- variant
enum
Required'primary' | 'secondary' | 'success' | 'warning' | 'danger' | 'light' | 'dark' | 'black' | 'brand'Default'primary'Type of button (uses Bootstrap options)
- invertColors
bool
RequiredDefaultfalseChanges icon styles for dark background