IRichToolbarProps

interface
Form & Input

Props for the internal <OrigamRichToolbar> sub-component of OrigamTextareaField. Kept package-private so the API can evolve without breaking external consumers. Exposes the command list, current active-format state, optional position, and disabled flag.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

items
required
ReadonlyArray<TTextareaToolbarCommand>
Ordered list of toolbar command identifiers to render as buttons. Passed down from the parent TextareaField.
active
required
ITextareaRichActiveState
Map of currently active formatting states (bold, italic, link, …) — drives the pressed/active visual on each button.
position
TTextareaToolbarPosition
Vertical placement of the toolbar relative to the textarea — "top" or "bottom". Default "top".
disabled
boolean
Disables all toolbar buttons when the parent TextareaField is disabled.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Rendering the rich toolbar with a custom command set

html