WindowItem
A single pane inside an OrigamWindow. Holds the content for one window value and animates in/out with the window transition (per-item override possible).
Structure
Anatomy
Visual breakdown of the component's internal structure with BEM class call-outs.
<origam-window-item> — the parent Window ① mounts only the active item ② and animates it with the window transition.- 1.origam-window (parent)
- Parent OrigamWindow. Provides the group context and the active value.
- 2.origam-window-item
- The pane itself (flex: 1 1 auto). Rendered only while active; transitions via the x/y transition tokens.
API
Props
All props accepted by this component, with their type, default value and description.
- transitionboolean | string
- Overrides the parent Window transition for this pane when entering in the forward direction.
- reverseTransitionboolean | string
- Overrides the transition used when this pane enters in the reverse direction.
- idstring
- classstring | Array<string> | object
- stylestring | Array<string> | object | StyleValue
- eagerboolean
- valueany
- Identifier for this pane. The parent Window shows the item whose value matches its modelValue.
- disabledbooleanfalse
- Prevents this pane from becoming active via navigation.
- selectedClassstring
- Class applied to the item while it is the active pane.
API
Slots
Content slots exposed by this component.
- #default
- Pane content shown while this item is active.
API
Emits
Events emitted by this component.
- @group:selected{ value: boolean }
- Fired by the group machinery when this item becomes the active pane.
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>
- Utility to forward a filtered subset of props to a child component.
- Ref<string>
- Reactive scoped CSS string generated for this item.
- 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.
- Duration of the horizontal slide transition.
- Easing curve of the horizontal slide transition.
- Duration of the vertical slide transition.
- Easing curve of the vertical slide transition.
Inclusion
Accessibility
ARIA roles, keyboard navigation and focus management. Sourced from the real component template.
Notes
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.
- durationvar(--origam-motion__duration---slow)
- Horizontal transition duration.
- durationvar(--origam-motion__duration---slow)
- Vertical transition duration.
Interactive
Playground
Edit props live and see the component update in real time. The generated code snippet updates as you change values.
This is an internal sub-part: it is injected by its parent component and cannot render on its own. See the parent component page for a live example.
Rendering the live preview…
Ecosystem
Family
Components from the same folder that share conventions and often compose together.