AppBar

Layout & Structure
stable

Sticky top-of-page header that integrates with the layout engine. Supports scroll-driven behaviours (hide, collapse, elevate, active) and forwards all Toolbar surface props.

Preview

Rendering the live preview…

default

Rendering the live preview…

flat

Rendering the live preview…

collapse

Structure

Anatomy

Visual breakdown of the component's internal structure with BEM class call-outs.

Anatomy of OrigamAppBarSchematic of the AppBar component with 4 numbered internal parts. 1 prepend 2 #default (title / nav) 3 append 4 #content slot (progress bar, custom content) origam-app-bar (header)
Anatomy of <origam-app-bar> — 4 zones: prepend ①, default content ②, append ③, and the optional content slot ④ below the main bar.
1.origam-bar__img / #prepend
Prepend area. Hosts navigation icon, logo, or optional background image via #img slot.
2#default
Main content area forwarded to OrigamToolbar. Typically holds title text and spacers.
3#append
Trailing zone. Action icons, account avatar, search trigger.
4#content
Optional full-width content slot rendered below the bar row (e.g. a progress indicator).

API

Props

All props accepted by this component, with their type, default value and description.

location
'top'
Edge the bar is docked to. Only top/bottom are handled by the layout engine.
image
IImgProps
Background image rendered inside the prepend slot via OrigamImg. Fades away when scrollBehavior includes "fade-image".
top
number | string
bottom
number | string
left
number | string
right
number | string
active
boolean | IStateEffectConfig
Forwarded to the inner Toolbar. When an object with surface props, they are applied once the page is scrolled (active scroll-behaviour only).
style
string | Array<string> | object | StyleValue
title
string
flat
boolean
false
Removes the box-shadow. Activated automatically by elevate scroll-behaviour while at the top.
id
string
class
string | Array<string> | object
height
number | string
56
Bar height. Drives the layout reservation so sibling regions offset correctly.
position
TPosition
maxHeight
number | string
minHeight
number | string
color
TColor
bgColor
TColor
border
boolean | number | string | TDirectionBoth | Array<TDirectionBoth>
borderColor
string
rounded
boolean | number | string | TRounded | null | undefined
elevation
TElevation
padding
boolean | number | string
margin
boolean | number | string
collapse
boolean
false
Forces collapsed state (forwarded to OrigamToolbar).
modelValue
boolean
true
Controls bar visibility. Set false to hide. Driven by hide scroll-behaviour automatically.
fontSize
TFontSize
fontWeight
TFontWeight
lineHeight
TLineHeight
letterSpacing
TLetterSpacing
tag
string
'header'
Root HTML element. Defaults to <header> for correct landmark semantics.
paddingTop
boolean | number | string
paddingLeft
boolean | number | string
paddingBottom
boolean | number | string
paddingRight
boolean | number | string
paddingBlock
boolean | number | string
paddingInline
boolean | number | string
paddingInlineStart
boolean | number | string
paddingInlineEnd
boolean | number | string
paddingBlockStart
boolean | number | string
paddingBlockEnd
boolean | number | string
marginTop
boolean | number | string
marginLeft
boolean | number | string
marginBottom
boolean | number | string
marginRight
boolean | number | string
marginBlock
boolean | number | string
marginInline
boolean | number | string
marginInlineStart
boolean | number | string
marginInlineEnd
boolean | number | string
marginBlockStart
boolean | number | string
marginBlockEnd
boolean | number | string
borderTop
boolean | number | string
borderInlineStart
boolean | number | string
borderInlineEnd
boolean | number | string
borderInlineStartColor
TColor
borderInlineEndColor
TColor
borderLeft
boolean | number | string
borderBottom
boolean | number | string
borderRight
boolean | number | string
borderBlock
boolean | number | string
borderInline
boolean | number | string
borderBlockStart
boolean | number | string
borderBlockEnd
boolean | number | string
borderStyle
string
borderTopColor
TColor
borderRightColor
TColor
borderBottomColor
TColor
borderLeftColor
TColor
borderBlockStartColor
TColor
borderBlockEndColor
TColor
roundedStartStart
boolean | number | string
roundedStartEnd
boolean | number | string
roundedEndStart
boolean | number | string
roundedEndEnd
boolean | number | string
roundedTopRight
boolean | number | string
roundedTopLeft
boolean | number | string
roundedBottomLeft
boolean | number | string
roundedBottomRight
boolean | number | string
hover
boolean | IStateEffectConfig
density
TDensity
activeClass
string
hoverClass
string
name
string
Layout item id. Required when multiple layout items share the same edge to control stacking order.
order
string | number
0
Layout stacking order. Lower values register first and reserve space first.
scrollBehavior
TScrollBehavior | TAnyString
Space-separated behaviour tokens: hide, inverted, collapse, elevate, active, fade-image.
scrollTarget
string
scrollThreshold
string | number
300
Pixel distance from top before scroll behaviours engage.

API

Slots

Content slots exposed by this component.

#append
Trailing area — action icons, account avatar, search trigger.
#prepend
Leading area — navigation icon, back button or brand logo.
#img
Replaces the default OrigamImg background. Only rendered when the image prop is set or this slot is used.
#title
#content
Full-width content override — bypasses the inner Toolbar layout (useful for a custom progress bar below the bar).
#default
Main toolbar content area (title, nav items, spacer…).

API

Emits

Events emitted by this component.

@update:modelValue
any

API

Exposed members

Properties and methods accessible via template ref (defineExpose). Use them for programmatic control.

<T extends object>(props: T, exclude?: string[]) => Partial<T>
Forwards a filtered subset of props to a child (e.g. the inner OrigamToolbar).
Ref<string>
Reactive CSS string from useStyle.
string
Unique style-sheet ID for this instance.
() => void
Injects the computed style sheet into the document.
() => void
Removes the injected style sheet.
Ref<boolean>
True once the style sheet has been injected into the DOM.

Customisation

CSS variables

CSS custom properties exposed by this component. Override them to customise the component without losing theme compatibility.

Bar background. Resolves to the raised surface token.
Bar foreground text and icon color.
Default bar height as defined in the token file. The height prop overrides this at runtime.
Bar elevation. Removed when flat=true or elevate scroll-behaviour is at top.
Stacking context z-index. Keeps the bar above page content.
Duration of hide/show and elevation transitions.

Inclusion

Accessibility

ARIA roles, keyboard navigation and focus management. Sourced from the real component template.

ARIA roles

banner

Keyboard interactions

Keyboard interactions
KeyAction
TabMoves focus through interactive elements inside the bar (prepend icons, title link, append icons).

Notes

  • Default tag is <header>, which has the implicit role="banner" at document level. Provides the primary page navigation landmark.
  • All scroll-behaviour transitions (hide/show, collapse) respect prefers-reduced-motion: reduce.

Foundation

Design tokens

Excerpt from this component's token declarations — the --origam-<component>---<property> variables, declared in its hand-maintained token sheet with no build step.

Source
color
var(--origam-color__surface---raised)
Default bar background.
dimension
64px
Default bar height registered with the layout engine.
shadow
var(--origam-shadow---sm)
Resting elevation.
number
var(--origam-zIndex---fixed)
Z-index above page content.
duration
var(--origam-motion__duration---medium)
Duration of scroll-driven animations.

Interactive

Playground

Edit props live and see the component update in real time. The generated code snippet updates as you change values.

Rendering the live preview…

Usage

Examples

Ready-to-paste code snippets for your templates.

Basic app bar

vue

Scroll behaviours

vue

Ecosystem

Family

Components from the same folder that share conventions and often compose together.