nutrient/com.pspdfkit.compose.toolbar.adapter/ToolbarCoordinator

ToolbarCoordinator

class ToolbarCoordinator(scope: CoroutineScope, initialFrame: ToolbarFrame = ToolbarFrame.Default, initialItems: ToolbarItems = ToolbarItems.Empty, restoreSnapshot: Map<String, Any>? = null)

Host-agnostic toolbar state container.

No Android imports allowed in this file or in any file under compose/toolbar/state/ and compose/toolbar/adapter/. The ToolbarSharedPackageLeak lint rule (MOD-4) enforces this at build time. Keeping this surface pure Kotlin is what gives us:

Three lifecycle bindings (Activity, Fragment, Composable) on top of one coordinator (ADR-Toolbar-3).
KMP-readiness at near-zero cost.
Unit-testability without Robolectric — just inject a TestScope.

Owners:

ComponentActivity.nutrientToolbarCoordinator() (fragment flavor)
Fragment.nutrientToolbarCoordinator() (fragment flavor)
rememberNutrientToolbarCoordinator() (compose, shared)

Pre-Phase 0 scaffolding (ADR-Toolbar-3, loophole P0-3).

Constructors

ToolbarCoordinator

constructor(scope: CoroutineScope, initialFrame: ToolbarFrame = ToolbarFrame.Default, initialItems: ToolbarItems = ToolbarItems.Empty, restoreSnapshot: Map<String, Any>? = null)

Properties

activeWriter

var activeWriter: Any?

Identity of the binder currently authorized to write through this coordinator. null means no binder is bound — actions registered in that state are unbound and survive writer swaps (used for test setup and pipeline-stage registrations).

frame

val frame: StateFlow<ToolbarFrame>

Observable frame-level toolbar state (visibility, height, position, title).

items

val items: StateFlow<ToolbarItems>

Observable, pre-grouped collection of visible and overflow toolbar items.

Functions

acquireWriter

fun acquireWriter(writerId: Any)

Claim the active-writer slot for writerId. Last-acquirer wins: any actions registered by the previous writer are evicted from the registry. Unbound registrations survive.

addActionListener

fun addActionListener(listener: (ToolbarAction) -> Unit): ToolbarSubscription

fun close()

Tear down the coordinator. After close the scope is no longer used, all listeners are cleared, and any further dispatch call is a no-op.

dispatch

fun dispatch(action: ToolbarAction)

Composable-facing: emit a user-initiated action.

dispatchAction

fun dispatchAction(actionId: String)

Invoke the lambda registered for actionId, if any. Silent no-op when no registration exists — pipeline stages can fire actions during initial render before binders have registered, and that must not crash.

registerAction

fun registerAction(actionId: String, action: () -> Unit): ToolbarSubscription

releaseWriter

fun releaseWriter(writerId: Any)

Release the active-writer slot iff writerId is currently the active writer. Calls from non-active writers (a stale PdfFragment binder that already lost its slot to a swap) are silent no-ops.

restoreState

fun restoreState(state: Map<String, Any>)

Counterpart to saveState.

saveState

fun saveState(): Map<String, Any>

Snapshot for process-death restoration.

updateFrame

fun updateFrame(transform: (ToolbarFrame) -> ToolbarFrame)

Producer-facing: replace the current frame.

updateItems

fun updateItems(transform: (ToolbarItems) -> ToolbarItems)

Producer-facing: replace the current items.