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

Toggle

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).

Constructors

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

Properties

open override val actionId: String

Stable string identifier used for action dispatch and state save/restore.

contentDescription

open override val contentDescription: String

Accessibility label and overflow-menu text for this item.

open override val icon: ToolbarIcon

How this item renders its icon.

@get:IdRes

open override val id: Int

Resource id (R.id.pspdf__menu_option_*) preserving the legacy test identity of this item.

overflowBehavior

open override val overflowBehavior: ToolbarItem.OverflowBehavior

Whether this item shows in the row, collapses into overflow, or is always pinned to overflow.

open override val position: ToolbarItem.ItemEdge

Which edge of the toolbar this item is grouped against.

open override val state: ToolbarItemState

Per-item dynamic state (enabled / selected / visible).