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

ToolbarAction

One-way event emitted by a toolbar composable.

Composables never call back into the coordinator directly — they emit a ToolbarAction, the coordinator routes it. This keeps composables pure, makes every interaction testable without UI, and lets the legacy OnMenuItemClickListener bridge attach at one well-defined point.

Pre-Phase 0 scaffolding.

Inheritors

Types

ItemClicked

@Immutable

data class ItemClicked @JvmOverloads constructor(@IdRes val id: Int, val kind: ContextualToolbarKind? = null) : ToolbarAction

A toolbar item was tapped.

ItemLongClicked

@Immutable

data class ItemLongClicked @JvmOverloads constructor(@IdRes val id: Int, val kind: ContextualToolbarKind? = null) : ToolbarAction

A toolbar item was long-pressed.

NavigationClicked

@Immutable

data object NavigationClicked : ToolbarAction

The toolbar navigation (up/back) affordance was tapped.

OverflowToggled

@Immutable

data class OverflowToggled(val expanded: Boolean) : ToolbarAction

The overflow menu was expanded or collapsed.

PositionRequested

@Immutable

data class PositionRequested(val position: ToolbarPosition) : ToolbarAction

A change of the toolbar's screen position was requested.

SubmenuChildClicked

@Immutable

data class SubmenuChildClicked @JvmOverloads constructor(@IdRes val parentId: Int, @IdRes val childId: Int, val kind: ContextualToolbarKind? = null) : ToolbarAction

A child inside a submenu was tapped.

Functions

withContextualKind

fun ToolbarAction.withContextualKind(kind: ContextualToolbarKind): ToolbarAction

Returns this action stamped with the contextual toolbar kind it originated from. Non-click actions (overflow, navigation, position) pass through unchanged — they are frame-level and carry no per-item source.