App
Application shell root. Thin wrapper over OrigamLayout that sets the page background and default text colour; all descendant components inherit the colour cascade.
Structure
Anatomy
Visual breakdown of the component's internal structure with BEM class call-outs.
<origam-app> — 2 parts. The root ① delegates to OrigamLayout ② which receives color/bgColor/fullHeight/overlaps as forwarded props.- 1.origam-app
- Root element. Applies RTL utility classes and forwards all props to the inner OrigamLayout.
- 2origam-layout (inner)
- Internal OrigamLayout receiving color, bgColor, fullHeight and overlaps. Hosts the default slot.
API
Props
All props accepted by this component, with their type, default value and description.
- fullHeightbooleantrue
- Stretches the layout to fill the full viewport (100vw / 100vh). Default true.
- overlapsArray<string>
- IDs of layout items allowed to overlap each other. Forwarded to the underlying OrigamLayout.
- idstring
- classstring | Array<string> | object
- stylestring | Array<string> | object | StyleValue
- color
- Root text colour. CSS-inherited by all descendants — sets the default foreground for the entire app.
- bgColor
- Application surface background colour. Maps to --origam-app---background-color. Accepts semantic intents or a CSS colour value.
API
Slots
Content slots exposed by this component.
- #default
- Main application content. Everything placed here inherits the color / bgColor cascade.
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>
- Filters and forwards a subset of props to child components.
- Ref<string>
- Reactive CSS string generated by useStyle from the computed appStyles.
- string
- Unique style-sheet ID for this instance.
- () => void
- Injects the computed style sheet into the document. Called automatically on mount.
- () => void
- Removes the injected style sheet. Called automatically on unmount.
- 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.
- Application surface background. Defaults to the semantic surface token.
- Root foreground colour, inherited by all descendants.
- Minimum height ensuring the shell fills the viewport.
- Display mode — always flex column so children stack vertically.
Inclusion
Accessibility
ARIA roles, keyboard navigation and focus management. Sourced from the real component template.
Keyboard interactions
| Key | Action |
|---|---|
| Tab | Moves focus through interactive children inside the app shell. |
Notes
- App is a structural shell — it does not carry an ARIA role itself. Place semantic landmarks (<header>, <main>, <nav>, <footer>) inside the default slot.
- The color prop sets the root text colour via CSS inheritance. Ensure sufficient contrast between the chosen color and bgColor values.
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.
- colorvar(--origam-color__surface---default)
- Default app background. References the semantic surface default.
- colorvar(--origam-color__text---primary)
- Root text colour inherited by all descendants.
- dimension100vh
- Minimum viewport height for the shell.
- otherflex
- Always flex so the layout renders as a column.
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 shell
Dark themed shell
Ecosystem
Family
Components from the same folder that share conventions and often compose together.