This page was printed on Oct 15, 2019. For the current version, visit https://help.shopify.com/en/api/embedded-apps/app-bridge/actions/buttongroup.
The ButtonGroup action set is used to group together Button action set instances.
The ButtonGroup action set can be passed into your app’s TitleBar action set.
Create an app and import the Button and ButtonGroup modules from @shopify/app-bridge/actions. Note that we'll be referring to this sample application throughout the examples below.
Create a button group
Generate a primary button with the label More actions and two buttons with the label Settings and Help:
Subscribe to updates
You can subscribe to the button group update action by calling subscribe. This returns a function that you can call to unsubscribe from the action:
You call unsubscribe to remove all subscriptions on the button group and its children:
Unsubscribe from button group actions only
You call unsubscribe with false to remove only button group subscriptions while leaving child subscriptions intact. For example, you might want to unsubscribe from the button group but keep button listeners so that the buttons can be reused in a different actions (such as a modal).
You can call the set method with partial button group options to update the options of an existing button group. This automatically triggers the update action on the button group and merges the new given options with existing options.
You can update buttons attached to a button group. Any updates made to the button group's children automatically trigger an update action on the button group.