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

ToolbarFrame

data class ToolbarFrame(val isVisible: Boolean = true, val height: Dp = 56.dp, val position: ToolbarPosition = ToolbarPosition.Top, val title: String? = null, val navigationIcon: ToolbarIcon = ToolbarIcon.None, val navigationContentDescription: String? = null, val insets: ToolbarInsets = ToolbarInsets.StatusBars)

Frame-level toolbar state — visual chrome that's independent of which items are shown. Splitting this from ToolbarItems means changing frame colors doesn't recompose item rows, and vice-versa (loophole P1-13).

Pre-Phase 0 scaffolding.

Constructors

constructor(isVisible: Boolean = true, height: Dp = 56.dp, position: ToolbarPosition = ToolbarPosition.Top, title: String? = null, navigationIcon: ToolbarIcon = ToolbarIcon.None, navigationContentDescription: String? = null, insets: ToolbarInsets = ToolbarInsets.StatusBars)

Types

object Companion

Factory holder for common ToolbarFrame values.

Properties

Height of the toolbar bar.

val insets: ToolbarInsets

Window insets the toolbar reserves for its content. Defaults to ToolbarInsets.StatusBars (correct for the SDK's edge-to-edge top mounting). Set via com.pspdfkit.compose.toolbar.adapter.ToolbarCoordinator.setMainToolbarInsets.

val isVisible: Boolean

Whether the toolbar is shown at all.

navigationContentDescription

val navigationContentDescription: String?

Accessibility label of navigationIcon, or null for the renderer's default ("Navigate up").

val navigationIcon: ToolbarIcon

The navigation (up / back) icon at the toolbar's leading edge, or ToolbarIcon.None (the default) for no navigation affordance. Tapping it dispatches ToolbarAction.NavigationClicked. Set via com.pspdfkit.compose.toolbar.adapter.ToolbarCoordinator.setMainToolbarNavigationIcon.

val position: ToolbarPosition

Where the toolbar is anchored on screen.

val title: String?

Optional title rendered in the toolbar, or null for no title.