OptionalBadgeOptional badge count or text (e.g. "v3", 5).
OptionalCssOptional custom CSS class name to append to the button element.
OptionalDescriptionTooltip text shown on hover when enabled.
OptionalDisabledWhether the button is disabled. Can be:
boolean: true = disabled, false = enabledstring: disabled, and the string is used as the tooltip explaining why (e.g. "Save draft changes first")predicate function: returning boolean or reason string
Default: false.OptionalIconFontAwesome icon class (e.g. "fa-solid fa-check-double", "fa-solid fa-calculator").
OptionalIsWhether to display a loading spinner on the button while an operation is in progress.
Unique identifier for this toolbar item (e.g. 'confirm-order', 'post', 'edit').
OptionalMenuLabel for the item in the toolbar's More menu. Defaults to Text, then Description.
OptionalModeIn which mode(s) this button should appear. Default: 'read'.
OptionalOnHandler function invoked when the button is clicked.
OptionalOrderNumeric sort order within its placement group. Lower numbers appear first. Standard built-in items default to:
In read mode the toolbar renders inline items (Edit and non-pinnable custom items) first, in
Order, then the user's pinned items in the order they were pinned; Order also sorts the
More menu. So a custom inline item with the default 100 sits after Edit and before the pins.
OptionalPinnableWhether the item takes part in per-user pinning: shown as a button only when the user pins
it, otherwise listed in the More menu. Built-in items (except Edit) are pinnable. Custom
items default to false and always render inline, so app-specific actions stay in view.
Inline items render before pinned ones regardless of Order (see Order).
OptionalPlacementPlacement group in the toolbar. Default: 'actions'.
OptionalTextOptional button label text (e.g. "Confirm Order").
OptionalVariantVisual styling variant. Default: 'default' (or 'primary' for key actions).
OptionalVisibleWhether the button is visible. Can be a boolean or a reactive predicate function. Default: true.
Configuration for registering or customizing a form toolbar item (action button).
Supports dynamic predicates for visibility, enabled/disabled state (with optional disabled reason tooltips), badges, and async click handlers.