‹ Toolbar and FAB

Options

Options

The options of toolbar and fab.

SectionToolbar and FABDraftDocumented, not reviewed yet: the API can change.

Options

Every key, with the platforms it works on. A dashed platform means the key does nothing there.

Filter options

Deprecated

5 options shown

toolbarOptionsToolbar

The toolbar at the bottom of a screen in a stack.

iOSiPadOSAndroid (not supported)Showcase 5.1 ›Showcase 5.2 ›Showcase 5.3 ›

visibleboolean= true

Whether the toolbar shows. It applies when the screen appears and on mergeOptions, animated. A toolbar without buttons is always hidden.

iOSiPadOSAndroid (not supported)Showcase 5.3 ›

buttons(OptionsTopBarButton | OptionsToolbarSpace | OptionsToolbarSearchField)[]

The buttons from the leading edge, in the format of the bar buttons: text, icon, SF Symbol, systemItem, a component (drawn before the screen shows), enabled, color, style, menu (it opens upward), toggle, showText, group; also spaces and the search field. A press sends a button press. The color of a side doesn't apply to them, and badges are not drawn. With the glass design (iOS 26+, see UIDesignRequiresCompatibility) each button has its own capsule, neighbor icons with the same group share one (the toolbar has no real groups, so text buttons never share), and a zero-width space is put between neighbors of different groups unless an explicit space is there. The list is replaced as a whole; mergeOptions animates it.

iOSiPadOSAndroid (not supported)Showcase 5.1 ›

testIDstring

The identifier tests find the toolbar by.

iOSiPadOSAndroid (not supported)

fabOptionsFab

The floating action button of the screen.

Type: OptionsFab ›

iOS (not supported)iPadOS (not supported)AndroidShowcase 5.4 ›

Generated from the types and their comments. Edit the source ↗