nutrient/com.pspdfkit.compose.toolbar.state/ToolbarItem

ToolbarItem

sealed interface ToolbarItem

One toolbar entry. Fully immutable; safe for Compose stability.

The id preserves the existing R.id.pspdf__menu_option_* identity used by customers' Espresso/UIAutomator tests (loophole P1-12). The testTag is auto-derived from this id at render time.

The actionId is a stable string used for action dispatch and state save/restore (ADR-Toolbar-4). Action lambdas are never persisted; saved state is keyed by actionId so it survives process death even if id (an R.id integer) changes across SDK versions. Producers should derive actionId from the resource entry name of id (e.g. "pspdf__menu_option_search") or from a namespaced custom string (e.g. "my.app.sign").

Pre-Phase 0 scaffolding (loophole P1-13).

Inheritors

Button

Toggle

Submenu

Types

Button

@Immutable

data class Button(val actionId: String, val id: Int, val contentDescription: String, val icon: ToolbarIcon = ToolbarIcon.None, val state: ToolbarItemState = ToolbarItemState.Default, val position: ToolbarItem.ItemEdge = ItemEdge.End, val overflowBehavior: ToolbarItem.OverflowBehavior = OverflowBehavior.IfRoom) : ToolbarItem

A simple tappable toolbar button.

ItemEdge

enum ItemEdge : Enum<ToolbarItem.ItemEdge>

The toolbar edge an item is aligned to.

OverflowBehavior

enum OverflowBehavior : Enum<ToolbarItem.OverflowBehavior>

Where an item is allowed to appear, making each ToolbarItem self-describe its placement rather than the grouping layer reading the legacy Menu's showAsAction. Mirrors the AppCompat SHOW_AS_ACTION_* semantics the View toolbar used.

Submenu

@Immutable

data class Submenu(val actionId: String, val id: Int, val contentDescription: String, val icon: ToolbarIcon = ToolbarIcon.None, val state: ToolbarItemState = ToolbarItemState.Default, val position: ToolbarItem.ItemEdge = ItemEdge.Start, val overflowBehavior: ToolbarItem.OverflowBehavior = OverflowBehavior.IfRoom, val children: PersistentList<ToolbarItem> = persistentListOf(), val closesSubmenuOnChildClick: Boolean = true, val opensSubmenuOnClick: Boolean = false, val runsSoleEnabledChildOnClick: Boolean = false, val showsSubmenuIndicator: Boolean = true) : ToolbarItem

A toolbar item that opens a submenu of nested children when tapped.

Toggle

@Immutable

data class Toggle(val actionId: String, val id: Int, val contentDescription: String, val icon: ToolbarIcon = ToolbarIcon.None, val state: ToolbarItemState = ToolbarItemState.Default, val position: ToolbarItem.ItemEdge = ItemEdge.Start, val overflowBehavior: ToolbarItem.OverflowBehavior = OverflowBehavior.IfRoom) : ToolbarItem

A toolbar button that reflects a selected/unselected state (e.g. an annotation tool).