IToolbarProps

interface
Component Props

Full props contract for <OrigamToolbar>. Horizontal action bar with collapse, flat, floating, and sticky modes, plus the full color/border/elevation/spacing surface.

TypeScript

Definition

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

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

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

collapse
boolean
Collapse the toolbar to its minimum width (icon-only mode). Useful for side navigation headers.
flat
boolean
Remove the elevation shadow to visually merge the toolbar into the page background.
floating
boolean
Detach the toolbar from the viewport edge so it floats above content.
title
string
Text rendered as the toolbar heading/label. Shorthand for the #title slot.
modelValue
boolean
Controls the visible / expanded state of the toolbar via v-model.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Elevated floating toolbar

vue