Theme

npm_versionnpm Paragon package page

Wraps a set of IconButton or IconButtonWithTooltip components in a group and marks as active only one at a time. The IconButton with a value matching the 'activeValue' is set to be in the active state. When one presses on one of the buttons, that button is set to active state, and the callback passed to onChange is called with that value. You can pass a tooltip if you use the IconButtonWithTooltip subcomponent.

Basic Usage

Any Paragon component or export may be added to the code example.

Basic Usage (with tooltips)

Any Paragon component or export may be added to the code example.

Props API#

IconButtonToggle Props API
  • activeValue string

    value to use to check which button to set to active

  • onChange func

    handler that is passed the currently active button's value when a button is selected

    Default() => {}
  • children node Required

    child nodes of type IconButton (or its subcomponents) to be rendered within toggle group