ActionGroup

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

install	`yarn add @react-spectrum/actiongroup`
version	3.0.0-alpha.1
usage	`import {ActionGroup} from '@react-spectrum/actiongroup'`

View repository

GitHub

View package

NPM

Example#

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

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

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

Content#

ActionGroups accepts a list of children, each with a key prop. It is required that the children are Item components from the @react-stately/collections library.

However, a function that returns Item components is also accepted.

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

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

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

Each item needs to have a key prop so it can be identified when actioned upon by a user.

See Events for more information.

Value#

ActionGroups are uncontrolled by default.

Use defaultSelectedKeys to provide a default set of selected items. The value of the selected keys must match the key prop of the items.

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

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

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

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

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

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

<ActionGroup
  selectedKeys={[
    'delete'
  ]}>
  <Item key="add">
    Add
  </Item>
  <Item key="delete">
    Delete
  </Item>
  <Item key="edit">
    Edit
  </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 strings of all child items should be localized.

Events#

Use the onSelectionChange prop as a callback to handle press events on items. The key prop from the selected item will be passed into the callback.

The following example uses the onSelectionChange prop to update a string stored in React state.

function Example() {
  let [lastKey, setLastKey] = React.useState(new Set());
  return (
    <div>
      <ActionGroup onSelectionChange={setLastKey}>
        <Item key="add">Add</Item>
        <Item key="delete">Delete</Item>
        <Item key="edit">Edit</Item>
      </ActionGroup>
      <p>Current selection: {lastKey}</p>
    </div>
  );
}

function Example() {
  let [lastKey, setLastKey] = React.useState(new Set());
  return (
    <div>
      <ActionGroup onSelectionChange={setLastKey}>
        <Item key="add">Add</Item>
        <Item key="delete">Delete</Item>
        <Item key="edit">Edit</Item>
      </ActionGroup>
      <p>Current selection: {lastKey}</p>
    </div>
  );
}

function Example() {
  let [
    lastKey,
    setLastKey
  ] = React.useState(
    new Set()
  );
  return (
    <div>
      <ActionGroup
        onSelectionChange={
          setLastKey
        }>
        <Item key="add">
          Add
        </Item>
        <Item key="delete">
          Delete
        </Item>
        <Item key="edit">
          Edit
        </Item>
      </ActionGroup>
      <p>
        Current
        selection:{' '}
        {lastKey}
      </p>
    </div>
  );
}

For multiple selections, use the selectionMode prop with the multiple value.

function Example() {
  let [selectedKeys, setSelectedKeys] = React.useState(new Set());
  return (
    <div>
      <ActionGroup selectionMode="multiple" onSelectionChange={setSelectedKeys}>
        <Item key="add">Add</Item>
        <Item key="delete">Delete</Item>
        <Item key="edit">Edit</Item>
      </ActionGroup>
      <p>Selected: {[...selectedKeys].toString()}</p>
    </div>
  );
}

function Example() {
  let [selectedKeys, setSelectedKeys] = React.useState(
    new Set()
  );
  return (
    <div>
      <ActionGroup
        selectionMode="multiple"
        onSelectionChange={setSelectedKeys}>
        <Item key="add">Add</Item>
        <Item key="delete">Delete</Item>
        <Item key="edit">Edit</Item>
      </ActionGroup>
      <p>Selected: {[...selectedKeys].toString()}</p>
    </div>
  );
}

function Example() {
  let [
    selectedKeys,
    setSelectedKeys
  ] = React.useState(
    new Set()
  );
  return (
    <div>
      <ActionGroup
        selectionMode="multiple"
        onSelectionChange={
          setSelectedKeys
        }>
        <Item key="add">
          Add
        </Item>
        <Item key="delete">
          Delete
        </Item>
        <Item key="edit">
          Edit
        </Item>
      </ActionGroup>
      <p>
        Selected:{' '}
        {[
          ...selectedKeys
        ].toString()}
      </p>
    </div>
  );
}

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

function Example() {
  let [actedKey, setActedKey] = React.useState('');
  return (
    <div>
      <ActionGroup selectionMode="none" onAction={setActedKey}>
        <Item key="add">Add</Item>
        <Item key="delete">Delete</Item>
        <Item key="edit">Edit</Item>
      </ActionGroup>
      <p>Last action: {actedKey}</p>
    </div>
  );
}

function Example() {
  let [actedKey, setActedKey] = React.useState('');
  return (
    <div>
      <ActionGroup
        selectionMode="none"
        onAction={setActedKey}>
        <Item key="add">Add</Item>
        <Item key="delete">Delete</Item>
        <Item key="edit">Edit</Item>
      </ActionGroup>
      <p>Last action: {actedKey}</p>
    </div>
  );
}

function Example() {
  let [
    actedKey,
    setActedKey
  ] = React.useState('');
  return (
    <div>
      <ActionGroup
        selectionMode="none"
        onAction={
          setActedKey
        }>
        <Item key="add">
          Add
        </Item>
        <Item key="delete">
          Delete
        </Item>
        <Item key="edit">
          Edit
        </Item>
      </ActionGroup>
      <p>
        Last action:{' '}
        {actedKey}
      </p>
    </div>
  );
}

Props#

Name	Type	Default	Description
`isEmphasized`	`boolean`	—	Whether the ActionButtons should be displayed with a emphasized style.
`density`	`'compact' \| 'regular'`	`'regular'`	Sets the amount of space between buttons.
`isJustified`	`boolean`	—	Whether the ActionButtons should be justified in their container.
`isQuiet`	`boolean`	—	Whether ActionButtons should use the quiet style.
`orientation`	`Orientation`	`'horizontal'`	The axis the ActionGroup should align with.
`children`	`ItemElement<T> \| ItemElement<T>[] \| ItemRenderer<T>`	—	An list of `Item` elements or an `ItemRenderer`. If the latter, a list of items must be provided as an separate prop.
`items`	`Iterable<T>`	—	A list of items to iterate through and display as children. Must be used with an `ItemRenderer` as the sole child.
`disabledKeys`	`Iterable<Key>`	—	A list of keys to disable.
`isDisabled`	`boolean`	—	Whether the ActionGroup is disabled. Shows that a selection exists, but is not available in that circumstance.
`selectionMode`	`SelectionMode`	—	The type of selection that is allowed in the collection.
`disallowEmptySelection`	`boolean`	—	Whether 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

Name	Type	Default	Description
`onAction`	`( (key: Key )) => void`	—	Invoked 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 )) => any`	—	Handler that is called when the selection changes.

Layout

Name	Type	Default	Description
`flex`	`string \| number \| boolean`	—	When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
`flexGrow`	`number`	—	When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
`flexShrink`	`number`	—	When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
`flexBasis`	`number \| string`	—	When 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.
`order`	`number`	—	The layout order for the element within a flex or grid container. See MDN.
`gridArea`	`string`	—	When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
`gridColumn`	`string`	—	When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
`gridRow`	`string`	—	When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
`gridColumnStart`	`string`	—	When used in a grid layout, specifies the starting column to span within the grid. See MDN.
`gridColumnEnd`	`string`	—	When used in a grid layout, specifies the ending column to span within the grid. See MDN.
`gridRowStart`	`string`	—	When used in a grid layout, specifies the starting row to span within the grid. See MDN.
`gridRowEnd`	`string`	—	When used in a grid layout, specifies the ending row to span within the grid. See MDN.

Spacing

Name	Type	Default	Description
`margin`	`DimensionValue`	—	The margin for all four sides of the element. See MDN.
`marginTop`	`DimensionValue`	—	The margin for the top side of the element. See MDN.
`marginBottom`	`DimensionValue`	—	The margin for the bottom side of the element. See MDN.
`marginStart`	`DimensionValue`	—	The margin for the logical start side of the element, depending on layout direction. See MDN.
`marginEnd`	`DimensionValue`	—	The margin for the logical end side of an element, depending on layout direction. See MDN.
`marginX`	`DimensionValue`	—	The margin for both the left and right sides of the element. See MDN.
`marginY`	`DimensionValue`	—	The margin for both the top and bottom sides of the element. See MDN.

Sizing

Name	Type	Default	Description
`width`	`DimensionValue`	—	The width of the element. See MDN.
`minWidth`	`DimensionValue`	—	The minimum width of the element. See MDN.
`maxWidth`	`DimensionValue`	—	The maximum width of the element. See MDN.
`height`	`DimensionValue`	—	The height of the element. See MDN.
`minHeight`	`DimensionValue`	—	The minimum height of the element. See MDN.
`maxHeight`	`DimensionValue`	—	The maximum height of the element. See MDN.

Positioning

Name	Type	Default	Description
`position`	`'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky'`	—	Specifies how the element is positioned. See MDN.
`top`	`DimensionValue`	—	The top position for the element. See MDN.
`bottom`	`DimensionValue`	—	The bottom position for the element. See MDN.
`left`	`DimensionValue`	—	The left position for the element. See MDN. Consider using `start` instead for RTL support.
`right`	`DimensionValue`	—	The right position for the element. See MDN. Consider using `start` instead for RTL support.
`start`	`DimensionValue`	—	The logical start position for the element, depending on layout direction. See MDN.
`end`	`DimensionValue`	—	The logical end position for the element, depending on layout direction. See MDN.
`zIndex`	`number`	—	The stacking order for the element. See MDN.
`isHidden`	`boolean`	—	Hides the element.

Accessibility

Name	Type	Default	Description
`id`	`string`	—
`aria-label`	`string`	—	Defines a string value that labels the current element.
`aria-labelledby`	`string`	—	Identifies the element (or elements) that labels the current element.
`aria-describedby`	`string`	—	Identifies the element (or elements) that describes the object.
`aria-details`	`string`	—	Identifies the element (or elements) that provide a detailed, extended description for the object.

Advanced

Name	Type	Default	Description
`UNSAFE_className`	`string`	—	Sets the CSS className for the element. Only use as a last resort. Use style props instead.
`UNSAFE_style`	`CSSProperties`	—	Sets 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>

Emphasis#

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

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

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

<ActionGroup
  isEmphasized
  defaultSelectedKeys={[
    'add'
  ]}>
  <Item key="add">
    Add
  </Item>
  <Item key="delete">
    Delete
  </Item>
  <Item key="edit">
    Edit
  </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" maxWidth="32px">
  <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" maxWidth="32px">
  <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"
  maxWidth="32px">
  <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>

Item<T>(
  (props: ItemProps<T>
)): ReactElement

Name	Type	Description
`children`	`ReactNode`	Rendered contents of the item or child items.
`title`	`ReactNode`	Rendered contents of the item if `children` contains child items.
`textValue`	`string`	A string representation of the item's contents, used for features like typeahead.
`aria-label`	`string`	An accessibility label for this item.
`childItems`	`Iterable<T>`	A list of child item objects. Used for dynamic collections.
`hasChildItems`	`boolean`	Whether this item has children, even if not loaded yet.

'horizontal' | 'vertical'

ReactElement<ItemProps<T>>

(
  (item: T
)) => ItemElement<T>

'none' | 'single' | 'multiple'

'all' | Set<Key>

See the Styling docs for a visualization of these values.

'size-0'
  | 'size-10'
  | 'size-25'
  | 'size-40'
  | 'size-50'
  | 'size-65'
  | 'size-75'
  | 'size-85'
  | 'size-100'
  | 'size-115'
  | 'size-125'
  | 'size-130'
  | 'size-150'
  | 'size-160'
  | 'size-175'
  | 'size-200'
  | 'size-225'
  | 'size-250'
  | 'size-300'
  | 'size-350'
  | 'size-400'
  | 'size-450'
  | 'size-500'
  | 'size-550'
  | 'size-600'
  | 'size-675'
  | 'size-700'
  | 'size-800'
  | 'size-900'
  | 'size-1000'
  | 'size-1200'
  | 'size-1250'
  | 'size-1600'
  | 'size-1700'
  | 'size-2000'
  | 'size-2400'
  | 'size-3000'
  | 'size-3400'
  | 'size-3600'
  | 'size-4600'
  | 'size-5000'
  | 'size-6000'
  | 'static-size-0'
  | 'static-size-10'
  | 'static-size-25'
  | 'static-size-50'
  | 'static-size-40'
  | 'static-size-65'
  | 'static-size-100'
  | 'static-size-115'
  | 'static-size-125'
  | 'static-size-150'
  | 'static-size-175'
  | 'static-size-200'
  | 'static-size-225'
  | 'static-size-250'
  | 'static-size-300'
  | 'static-size-400'
  | 'static-size-450'
  | 'static-size-500'
  | 'static-size-550'
  | 'static-size-600'
  | 'static-size-700'
  | 'static-size-800'
  | 'static-size-900'
  | 'static-size-1000'
  | 'static-size-1200'
  | 'static-size-1700'
  | 'static-size-2400'
  | 'static-size-2600'
  | 'static-size-3400'
  | 'static-size-3600'
  | 'static-size-4600'
  | 'static-size-5000'
  | 'static-size-6000'
  | 'single-line-height'
  | 'single-line-width'
  | string & {}
  | number