ActionGroup

An ActionGroup is a grouping of ActionButtons that are related to one another.

installyarn add @adobe/react-spectrum
version3.1.0
usageimport {ActionGroup, Item} from '@adobe/react-spectrum'

Example#


function Example() {
  let [action, setAction] = React.useState();

  return (
    <>
      <ActionGroup onAction={setAction}>
        <Item key="add">Add</Item>
        <Item key="delete">Delete</Item>
        <Item key="edit">Edit</Item>
      </ActionGroup>
      <p>Action: {action}</p>
    </>
  );
}
function Example() {
  let [action, setAction] = React.useState();

  return (
    <>
      <ActionGroup onAction={setAction}>
        <Item key="add">Add</Item>
        <Item key="delete">Delete</Item>
        <Item key="edit">Edit</Item>
      </ActionGroup>
      <p>Action: {action}</p>
    </>
  );
}
function Example() {
  let [
    action,
    setAction
  ] = React.useState();

  return (
    <>
      <ActionGroup
        onAction={
          setAction
        }>
        <Item key="add">
          Add
        </Item>
        <Item key="delete">
          Delete
        </Item>
        <Item key="edit">
          Edit
        </Item>
      </ActionGroup>
      <p>
        Action: {action}
      </p>
    </>
  );
}

Content#


ActionGroups accept a list of Item elements as children, each with a key prop. Alternatively, a function that returns Item elements is also supported. See the collection components docs for more details about this API.

const items = [
  {label: 'React', name: 'React'},
  {label: 'Add', name: 'Add'},
  {label: 'Delete', name: 'Delete'}
];

<ActionGroup items={items}>
  {(item) => <Item key={item.name}>{item.label}</Item>}
</ActionGroup>
const items = [
  {label: 'React', name: 'React'},
  {label: 'Add', name: 'Add'},
  {label: 'Delete', name: 'Delete'}
];

<ActionGroup items={items}>
  {(item) => <Item key={item.name}>{item.label}</Item>}
</ActionGroup>
const items = [
  {
    label: 'React',
    name: 'React'
  },
  {
    label: 'Add',
    name: 'Add'
  },
  {
    label: 'Delete',
    name: 'Delete'
  }
];

<ActionGroup
  items={items}>
  {(item) => (
    <Item
      key={item.name}>
      {item.label}
    </Item>
  )}
</ActionGroup>

Accessibility#

If no visible label is provided (e.g. an icon only) to each item, an alternative text label must be provided to identify the control for accessibility. This should be added using the aria-label prop to each Item.

<ActionGroup>
  <Item key="brush" aria-label="Brush">
    <Brush />
  </Item>
  <Item key="select" aria-label="Select">
    <Select />
  </Item>
  <Item key="regionSelect" aria-label="Select Region">
    <RegionSelect />
  </Item>
</ActionGroup>
<ActionGroup>
  <Item key="brush" aria-label="Brush">
    <Brush />
  </Item>
  <Item key="select" aria-label="Select">
    <Select />
  </Item>
  <Item key="regionSelect" aria-label="Select Region">
    <RegionSelect />
  </Item>
</ActionGroup>
<ActionGroup>
  <Item
    key="brush"
    aria-label="Brush">
    <Brush />
  </Item>
  <Item
    key="select"
    aria-label="Select">
    <Select />
  </Item>
  <Item
    key="regionSelect"
    aria-label="Select Region">
    <RegionSelect />
  </Item>
</ActionGroup>

Internationalization#

In order to internationalize an ActionGroup, the content provided to all child items should be localized.

Selection#


ActionGroup supports multiple selection modes. By default, selection is disabled, however this can be changed using the selectionMode prop. Use defaultSelectedKeys to provide a default set of selected items (uncontrolled) and selectedKeys to set the selected items (controlled). The value of the selected keys must match the key prop of the items.

<ActionGroup selectionMode="single" defaultSelectedKeys={['list']}>
  <Item key="grid">Grid view</Item>
  <Item key="list">List view</Item>
  <Item key="gallery">Gallery view</Item>
</ActionGroup>
<ActionGroup
  selectionMode="single"
  defaultSelectedKeys={['list']}>
  <Item key="grid">Grid view</Item>
  <Item key="list">List view</Item>
  <Item key="gallery">Gallery view</Item>
</ActionGroup>
<ActionGroup
  selectionMode="single"
  defaultSelectedKeys={[
    'list'
  ]}>
  <Item key="grid">
    Grid view
  </Item>
  <Item key="list">
    List view
  </Item>
  <Item key="gallery">
    Gallery view
  </Item>
</ActionGroup>

The selectedKeys prop can be used to make the selected state controlled.

function Example() {
  let [selected, setSelected] = React.useState(new Set(['list']));

  return (
    <>
      <ActionGroup
        selectionMode="single"
        selectedKeys={selected}
        onSelectionChange={setSelected}>
        <Item key="grid">Grid view</Item>
        <Item key="list">List view</Item>
        <Item key="gallery">Gallery view</Item>
      </ActionGroup>
      <p>Current selection (controlled): {[...selected]}</p>
    </>
  );
}
function Example() {
  let [selected, setSelected] = React.useState(
    new Set(['list'])
  );

  return (
    <>
      <ActionGroup
        selectionMode="single"
        selectedKeys={selected}
        onSelectionChange={setSelected}>
        <Item key="grid">Grid view</Item>
        <Item key="list">List view</Item>
        <Item key="gallery">Gallery view</Item>
      </ActionGroup>
      <p>Current selection (controlled): {[...selected]}</p>
    </>
  );
}
function Example() {
  let [
    selected,
    setSelected
  ] = React.useState(
    new Set(['list'])
  );

  return (
    <>
      <ActionGroup
        selectionMode="single"
        selectedKeys={
          selected
        }
        onSelectionChange={
          setSelected
        }>
        <Item key="grid">
          Grid view
        </Item>
        <Item key="list">
          List view
        </Item>
        <Item key="gallery">
          Gallery view
        </Item>
      </ActionGroup>
      <p>
        Current selection
        (controlled):{' '}
        {[...selected]}
      </p>
    </>
  );
}

Set selectionMode prop to multiple to allow more than one selection.

function Example() {
  let [selected, setSelected] = React.useState(new Set(['list']));

  return (
    <>
      <ActionGroup
        selectionMode="multiple"
        selectedKeys={selected}
        onSelectionChange={setSelected}>
        <Item key="grid">Grid view</Item>
        <Item key="list">List view</Item>
        <Item key="gallery">Gallery view</Item>
      </ActionGroup>
      <p>Current selections (controlled): {[...selected].join(', ')}</p>
    </>
  );
}
function Example() {
  let [selected, setSelected] = React.useState(
    new Set(['list'])
  );

  return (
    <>
      <ActionGroup
        selectionMode="multiple"
        selectedKeys={selected}
        onSelectionChange={setSelected}>
        <Item key="grid">Grid view</Item>
        <Item key="list">List view</Item>
        <Item key="gallery">Gallery view</Item>
      </ActionGroup>
      <p>
        Current selections (controlled):{' '}
        {[...selected].join(', ')}
      </p>
    </>
  );
}
function Example() {
  let [
    selected,
    setSelected
  ] = React.useState(
    new Set(['list'])
  );

  return (
    <>
      <ActionGroup
        selectionMode="multiple"
        selectedKeys={
          selected
        }
        onSelectionChange={
          setSelected
        }>
        <Item key="grid">
          Grid view
        </Item>
        <Item key="list">
          List view
        </Item>
        <Item key="gallery">
          Gallery view
        </Item>
      </ActionGroup>
      <p>
        Current
        selections
        (controlled):{' '}
        {[
          ...selected
        ].join(', ')}
      </p>
    </>
  );
}

Events#


Use the onSelectionChange prop as a callback to handle press events on items when selectionMode is either single or multiple. The key prop from the selected item will be passed into the callback.

To continue to capturing actions when selectionMode is none, utilize the onAction prop.

function Example() {
  let [actionKey, setActionKey] = React.useState('');
  return (
    <>
      <ActionGroup onAction={setActionKey}>
        <Item key="add">Add</Item>
        <Item key="delete">Delete</Item>
        <Item key="edit">Edit</Item>
      </ActionGroup>
      <p>Action: {actionKey}</p>
    </>
  );
}
function Example() {
  let [actionKey, setActionKey] = React.useState('');
  return (
    <>
      <ActionGroup onAction={setActionKey}>
        <Item key="add">Add</Item>
        <Item key="delete">Delete</Item>
        <Item key="edit">Edit</Item>
      </ActionGroup>
      <p>Action: {actionKey}</p>
    </>
  );
}
function Example() {
  let [
    actionKey,
    setActionKey
  ] = React.useState('');
  return (
    <>
      <ActionGroup
        onAction={
          setActionKey
        }>
        <Item key="add">
          Add
        </Item>
        <Item key="delete">
          Delete
        </Item>
        <Item key="edit">
          Edit
        </Item>
      </ActionGroup>
      <p>
        Action:{' '}
        {actionKey}
      </p>
    </>
  );
}

Props#


NameTypeDefaultDescription
childrenItemElement<T>ItemElement<T>[]ItemRenderer<T>An list of Item elements or a function. If the latter, a list of items must be provided using the items prop.
isEmphasizedbooleanWhether the ActionButtons should be displayed with a emphasized style.
density'compact''regular''regular'Sets the amount of space between buttons.
isJustifiedbooleanWhether the ActionButtons should be justified in their container.
isQuietbooleanWhether ActionButtons should use the quiet style.
orientationOrientation'horizontal'The axis the ActionGroup should align with.
itemsIterable<T>A list of items to display as children. Must be used with a function as the sole child.
disabledKeysIterable<Key>A list of keys to disable.
isDisabledbooleanWhether the ActionGroup is disabled. Shows that a selection exists, but is not available in that circumstance.
selectionModeSelectionModeThe type of selection that is allowed in the collection.
disallowEmptySelectionbooleanWhether the collection allows empty selection.
selectedKeys'all'Iterable<Key>The currently selected keys in the collection (controlled).
defaultSelectedKeys'all'Iterable<Key>The initial selected keys in the collection (uncontrolled).
Events
NameTypeDefaultDescription
onAction( (key: Key )) => voidInvoked when an action is taken on a child. Especially useful when selectionMode is none. The sole argument key is the key for the item.
onSelectionChange( (keys: Selection )) => anyHandler that is called when the selection changes.
Layout
NameTypeDefaultDescription
flexstringnumberbooleanWhen used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrownumberWhen used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinknumberWhen used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisnumberstringWhen used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelf'auto''normal''start''end''center''flex-start''flex-end''self-start''self-end''stretch'Overrides the alignItems property of a flex or grid container. See MDN.
justifySelf'auto''normal''start''end''flex-start''flex-end''self-start''self-end''center''left''right''stretch'Specifies how the element is justified inside a flex or grid container. See MDN.
ordernumberThe layout order for the element within a flex or grid container. See MDN.
gridAreastringWhen used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnstringWhen used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowstringWhen used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartstringWhen used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndstringWhen used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartstringWhen used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndstringWhen used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDefaultDescription
marginDimensionValueThe margin for all four sides of the element. See MDN.
marginTopDimensionValueThe margin for the top side of the element. See MDN.
marginBottomDimensionValueThe margin for the bottom side of the element. See MDN.
marginStartDimensionValueThe margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndDimensionValueThe margin for the logical end side of an element, depending on layout direction. See MDN.
marginXDimensionValueThe margin for both the left and right sides of the element. See MDN.
marginYDimensionValueThe margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthDimensionValueThe width of the element. See MDN.
minWidthDimensionValueThe minimum width of the element. See MDN.
maxWidthDimensionValueThe maximum width of the element. See MDN.
heightDimensionValueThe height of the element. See MDN.
minHeightDimensionValueThe minimum height of the element. See MDN.
maxHeightDimensionValueThe maximum height of the element. See MDN.
Positioning
NameTypeDefaultDescription
position'static''relative''absolute''fixed''sticky'Specifies how the element is positioned. See MDN.
topDimensionValueThe top position for the element. See MDN.
bottomDimensionValueThe bottom position for the element. See MDN.
leftDimensionValueThe left position for the element. See MDN. Consider using start instead for RTL support.
rightDimensionValueThe right position for the element. See MDN. Consider using start instead for RTL support.
startDimensionValueThe logical start position for the element, depending on layout direction. See MDN.
endDimensionValueThe logical end position for the element, depending on layout direction. See MDN.
zIndexnumberThe stacking order for the element. See MDN.
isHiddenbooleanHides the element.
Accessibility
NameTypeDefaultDescription
idstringThe element's unique identifier. See MDN.
aria-labelstringDefines a string value that labels the current element.
aria-labelledbystringIdentifies the element (or elements) that labels the current element.
aria-describedbystringIdentifies the element (or elements) that describes the object.
aria-detailsstringIdentifies the element (or elements) that provide a detailed, extended description for the object.
Advanced
NameTypeDefaultDescription
UNSAFE_classNamestringSets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSPropertiesSets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#


Quiet#

<ActionGroup isQuiet>
  <Item key="add">Add</Item>
  <Item key="delete">Delete</Item>
  <Item key="edit">Edit</Item>
</ActionGroup>
<ActionGroup isQuiet>
  <Item key="add">Add</Item>
  <Item key="delete">Delete</Item>
  <Item key="edit">Edit</Item>
</ActionGroup>
<ActionGroup isQuiet>
  <Item key="add">
    Add
  </Item>
  <Item key="delete">
    Delete
  </Item>
  <Item key="edit">
    Edit
  </Item>
</ActionGroup>

Emphasize#

The additional styling provided by the isEmphasized prop is only applied when items are selected.

<ActionGroup
  isEmphasized
  selectionMode="single"
  defaultSelectedKeys={['list']}>
  <Item key="grid">Grid view</Item>
  <Item key="list">List view</Item>
  <Item key="gallery">Gallery view</Item>
</ActionGroup>
<ActionGroup
  isEmphasized
  selectionMode="single"
  defaultSelectedKeys={['list']}>
  <Item key="grid">Grid view</Item>
  <Item key="list">List view</Item>
  <Item key="gallery">Gallery view</Item>
</ActionGroup>
<ActionGroup
  isEmphasized
  selectionMode="single"
  defaultSelectedKeys={[
    'list'
  ]}>
  <Item key="grid">
    Grid view
  </Item>
  <Item key="list">
    List view
  </Item>
  <Item key="gallery">
    Gallery view
  </Item>
</ActionGroup>

Disabled#

To disable the entire ActionGroup, use the isDisabled prop on the root.

<ActionGroup isDisabled>
  <Item key="add">Add</Item>
  <Item key="delete">Delete</Item>
  <Item key="edit">Edit</Item>
</ActionGroup>
<ActionGroup isDisabled>
  <Item key="add">Add</Item>
  <Item key="delete">Delete</Item>
  <Item key="edit">Edit</Item>
</ActionGroup>
<ActionGroup
  isDisabled>
  <Item key="add">
    Add
  </Item>
  <Item key="delete">
    Delete
  </Item>
  <Item key="edit">
    Edit
  </Item>
</ActionGroup>

To disable individual items, a list of disabledKeys can be provided.

<ActionGroup disabledKeys={['add', 'delete']}>
  <Item key="add">Add</Item>
  <Item key="delete">Delete</Item>
  <Item key="edit">Edit</Item>
</ActionGroup>
<ActionGroup disabledKeys={['add', 'delete']}>
  <Item key="add">Add</Item>
  <Item key="delete">Delete</Item>
  <Item key="edit">Edit</Item>
</ActionGroup>
<ActionGroup
  disabledKeys={[
    'add',
    'delete'
  ]}>
  <Item key="add">
    Add
  </Item>
  <Item key="delete">
    Delete
  </Item>
  <Item key="edit">
    Edit
  </Item>
</ActionGroup>

Orientation#

Using the orientation prop with value vertical changes the alignment of the items to follow the y-axis.

<ActionGroup orientation="vertical">
  <Item key="brush" aria-label="Brush">
    <Brush />
  </Item>
  <Item key="select" aria-label="Select">
    <Select />
  </Item>
  <Item key="regionSelect" aria-label="Select Region">
    <RegionSelect />
  </Item>
</ActionGroup>
<ActionGroup orientation="vertical">
  <Item key="brush" aria-label="Brush">
    <Brush />
  </Item>
  <Item key="select" aria-label="Select">
    <Select />
  </Item>
  <Item key="regionSelect" aria-label="Select Region">
    <RegionSelect />
  </Item>
</ActionGroup>
<ActionGroup orientation="vertical">
  <Item
    key="brush"
    aria-label="Brush">
    <Brush />
  </Item>
  <Item
    key="select"
    aria-label="Select">
    <Select />
  </Item>
  <Item
    key="regionSelect"
    aria-label="Select Region">
    <RegionSelect />
  </Item>
</ActionGroup>

Density#

Using the density prop with value compact changes the margins between the buttons. In the default case, this merges the borders of neighboring ActionButtons. In the quiet case, it just reduces the margin size between the buttons.

<ActionGroup density="compact">
  <Item key="brush" aria-label="Brush">
    <Brush />
  </Item>
  <Item key="select" aria-label="Select">
    <Select />
  </Item>
  <Item key="regionSelect" aria-label="Select Region">
    <RegionSelect />
  </Item>
</ActionGroup>
<ActionGroup density="compact">
  <Item key="brush" aria-label="Brush">
    <Brush />
  </Item>
  <Item key="select" aria-label="Select">
    <Select />
  </Item>
  <Item key="regionSelect" aria-label="Select Region">
    <RegionSelect />
  </Item>
</ActionGroup>
<ActionGroup density="compact">
  <Item
    key="brush"
    aria-label="Brush">
    <Brush />
  </Item>
  <Item
    key="select"
    aria-label="Select">
    <Select />
  </Item>
  <Item
    key="regionSelect"
    aria-label="Select Region">
    <RegionSelect />
  </Item>
</ActionGroup>
<ActionGroup isQuiet density="compact">
  <Item key="brush" aria-label="Brush">
    <Brush />
  </Item>
  <Item key="select" aria-label="Select">
    <Select />
  </Item>
  <Item key="regionSelect" aria-label="Select Region">
    <RegionSelect />
  </Item>
</ActionGroup>
<ActionGroup isQuiet density="compact">
  <Item key="brush" aria-label="Brush">
    <Brush />
  </Item>
  <Item key="select" aria-label="Select">
    <Select />
  </Item>
  <Item key="regionSelect" aria-label="Select Region">
    <RegionSelect />
  </Item>
</ActionGroup>
<ActionGroup
  isQuiet
  density="compact">
  <Item
    key="brush"
    aria-label="Brush">
    <Brush />
  </Item>
  <Item
    key="select"
    aria-label="Select">
    <Select />
  </Item>
  <Item
    key="regionSelect"
    aria-label="Select Region">
    <RegionSelect />
  </Item>
</ActionGroup>

Justified#

The isJustified prop will divide all available horizontal space evenly among the buttons.

<Flex width="size-2000" direction="column">
  <ActionGroup isJustified>
    <Item key="brush" aria-label="Brush">
      <Brush />
    </Item>
    <Item key="select" aria-label="Select">
      <Select />
    </Item>
    <Item key="regionSelect" aria-label="Select Region">
      <RegionSelect />
    </Item>
  </ActionGroup>
</Flex>
<Flex width="size-2000" direction="column">
  <ActionGroup isJustified>
    <Item key="brush" aria-label="Brush">
      <Brush />
    </Item>
    <Item key="select" aria-label="Select">
      <Select />
    </Item>
    <Item key="regionSelect" aria-label="Select Region">
      <RegionSelect />
    </Item>
  </ActionGroup>
</Flex>
<Flex
  width="size-2000"
  direction="column">
  <ActionGroup
    isJustified>
    <Item
      key="brush"
      aria-label="Brush">
      <Brush />
    </Item>
    <Item
      key="select"
      aria-label="Select">
      <Select />
    </Item>
    <Item
      key="regionSelect"
      aria-label="Select Region">
      <RegionSelect />
    </Item>
  </ActionGroup>
</Flex>