Rich Text Toolbar Button Group | Components | Lightning Component Reference

lightning-rich-text-toolbar-button-group

Creates a custom button group in lightning-input-rich-text.

For Use In

Lightning Experience, Experience Builder Sites, Salesforce Mobile App, Lightning Out (Beta), Standalone Lightning App

The lightning-rich-text-toolbar-button-group component is a container component for custom buttons in lightning-input-rich-text. The component is used in a named slot.

Place the lightning-rich-text-toolbar-button-group component inside lightning-input-rich-text and specify the attribute slot="toolbar" to create a group for custom buttons. The group is displayed on the end of the toolbar.

Place lightning-rich-text-toolbar-button components inside lightning-rich-text-toolbar-button-group to define custom buttons.

A group is required for custom buttons, even if there is only one custom button.

You can include multiple custom button groups in lightning-input-rich-text and include multiple custom buttons in each lightning-rich-text-toolbar-button-group.

This example shows basic usage for two button groups, each using the toolbar slot.

For more information about custom buttons, see lightning-rich-text-toolbar-button documentation.

Specify the attribute aria-label to provide a label to inform assistive device users about the button group.

Use the Tab key to navigate to the buttons, and then use Left and Right arrow keys to navigate among the buttons until you reach the custom button group.