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
Anatomie
Décomposition visuelle de la structure interne du composant avec les appels de classes BEM.
<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
Toutes les props acceptées par ce composant, avec leur type, valeur par défaut et 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
Emplacements de contenu exposés par ce composant.
- #default
- Main application content. Everything placed here inherits the color / bgColor cascade.
API
Membres exposés
Propriétés et méthodes accessibles via ref template (defineExpose). Utilisés pour le contrôle programmatique.
- <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.
Personnalisation
Variables CSS
Propriétés CSS personnalisées exposées par ce composant. Surchargez-les pour personnaliser sans perdre la compatibilité avec le thème.
- 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
Accessibilité
Rôles ARIA, navigation clavier et gestion du focus. Sourcé depuis le template réel du composant.
Interactions clavier
| Touche | 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.
Fondation
Design tokens
Extrait des tokens de ce composant — les variables --origam-<composant>---<propriété>, déclarées dans sa feuille de tokens tenue à la main, sans étape de build.
- 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.
Interactif
Playground
Modifiez les props en direct et observez le composant se mettre à jour. Le snippet de code généré suit vos changements.
Rendu de l’aperçu en cours…
Usage
Exemples
Extraits de code prêts à coller dans vos templates.
Basic shell
Dark themed shell
Écosystème
Famille
Composants du même dossier qui partagent les conventions et se composent souvent ensemble.