Skip to content

OrigamToolbar ​

<OrigamToolbar> is a horizontal layout band typically placed at the top of a view. It exposes prepend, title, content, and append regions and inherits the full set of color, elevation, border, rounding, density, and positioning composables.

Basic usage ​

vue
<template>
    <OrigamToolbar title="My App" />
</template>

Color ​

vue
<template>
    <OrigamToolbar title="Primary" bg-color="primary" color="white" />
</template>

Elevation ​

vue
<template>
    <OrigamToolbar title="Elevated" :elevation="4" />
</template>

Flat ​

Remove the shadow.

vue
<template>
    <OrigamToolbar title="Flat" flat />
</template>

Collapse ​

Collapses the toolbar to icon-only mode (max-width 112px, title hidden).

vue
<template>
    <OrigamToolbar title="Collapsible" :collapse="collapsed" />
</template>

Floating ​

Renders inline (display: inline-flex) rather than stretching full width.

vue
<template>
    <OrigamToolbar title="Floating" floating />
</template>

Density ​

vue
<template>
    <OrigamToolbar title="Compact" density="compact" />
</template>

Rounded ​

vue
<template>
    <OrigamToolbar title="Rounded" rounded="medium" />
</template>

Border ​

vue
<template>
    <OrigamToolbar title="Bordered" border />
</template>

Slots ​

SlotDescription
defaultFull override of the wrapper content.
prependLeading area (icon buttons, hamburger menu, …).
titleTitle region — falls back to OrigamTitle when the title prop is set.
contentGrows to fill all remaining space between prepend/append.
appendTrailing area (action buttons, avatars, …).

Props — Typography (title) ​

These props override the matching --origam-toolbar__title---* CSS variable via an inline custom property on div.origam-toolbar__title. The .origam-title inside that div reads the vars so all four props have a real visual effect. fontFamily was removed from IToolbarProps (issue #501) — no font-family rule in __title .origam-title. fontFamily is a project-level setting configured once on OrigamApp.

PropTypeValuesCSS variable overridden
fontSizeTFontSizexs · sm · md · lg · xl · 2xl · 3xl · 4xl · 5xl--origam-toolbar__title---font-size
fontWeightTFontWeightregular · medium · semibold · bold · extrabold · black--origam-toolbar__title---font-weight
letterSpacingTLetterSpacingtight · normal · wide · wider · widest--origam-toolbar__title---letter-spacing
lineHeightTLineHeightnone · tight · snug · normal · relaxed · loose--origam-toolbar__title---line-height

Design tokens ​

CSS variableDescription
--origam-toolbar---backgroundToolbar background.
--origam-toolbar---colorToolbar text color.
--origam-toolbar---box-shadowShadow.
--origam-toolbar---heightToolbar height.
--origam-toolbar---border-start-start-radiusTop-inline-start corner radius. There is no border-radius shorthand token — the component reads the four logical longhands (border-{start-start,start-end,end-start,end-end}-radius) individually, so override the corner you need.
--origam-toolbar---border-start-end-radiusTop-inline-end corner radius.
--origam-toolbar---border-end-start-radiusBottom-inline-start corner radius.
--origam-toolbar---border-end-end-radiusBottom-inline-end corner radius.
--origam-toolbar---z-indexZ-index.
--origam-toolbar__wrapper---displayWrapper flex layout.
--origam-toolbar__content---flex-growContent flex-grow.
--origam-toolbar__title---font-sizeTitle font size.

Accessibility ​

  • Renders as <header> by default (override via tag prop).
  • Use the prepend slot for skip-navigation links or hamburger triggers.
  • The content slot occupies the landmark center; keep it focused.