VirtualScrollItem

Data Display
stable

Per-item wrapper used by OrigamVirtualScroll — attaches a ResizeObserver to measure its height and emits update:height so the virtual engine can recalculate padding spacers.

Structure

Anatomie

Décomposition visuelle de la structure interne du composant avec les appels de classes BEM.

Anatomy of OrigamVirtualScrollItemSchematic of the VirtualScrollItem component with 2 numbered modes. renderless=false #default slot renderless=true #renderless slot { itemRef } 1 2 ResizeObserver on resizeRef in both modes — emits update:height on height change
Anatomy of <origam-virtual-scroll-item> — 2 render modes. In wrapper mode (①) the component renders a .origam-virtual-scroll-item div with the default slot. In renderless mode (②) no root element is rendered — the consumer binds itemRef to its own element.
1.origam-virtual-scroll-item
Wrapper div rendered when renderless=false (default). Observed by ResizeObserver via the resizeRef binding. Emits update:height on any height change.
2#renderless slot
When renderless=true no wrapper is rendered. The itemRef slot prop must be bound to the consumer element so ResizeObserver can observe it.

API

Props

Toutes les props acceptées par ce composant, avec leur type, valeur par défaut et description.

renderless
boolean
false
When true the component renders no wrapper element — instead it exposes a renderless slot with an itemRef binding for the consumer's root element to be observed by ResizeObserver.

API

Slots

Emplacements de contenu exposés par ce composant.

#default
Item content rendered inside the wrapper div (non-renderless mode). The wrapper div itself is observed by ResizeObserver.
#renderless
Only available when renderless=true. Provides the itemRef template-ref callback that must be bound to the consumer's root element so ResizeObserver can observe it.

API

Emits

Événements émis par ce composant.

@update:height
number
Fired whenever the ResizeObserver detects a height change on the item element. The virtual engine uses this value to update its intrinsic-size cache.

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>
Utility to forward a filtered subset of props to a child component.
Ref<string>
Reactive CSS string generated by 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.

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.

Estimated item height used by the virtual engine for initial layout. Overridden at runtime via the update:height event.
Duration for item appear/disappear transitions. Fast to avoid jank during rapid scrolling.

Inclusion

Accessibilité

Rôles ARIA, navigation clavier et gestion du focus. Sourcé depuis le template réel du composant.

Notes

  • OrigamVirtualScrollItem has no ARIA role — it is a transparent measurement wrapper. ARIA semantics are entirely determined by the consuming content in the default/renderless slot.
  • In renderless mode the component renders no DOM element — the consumer's own element carries all semantic roles. This makes renderless mode the preferred approach for accessible list items (use a native <li> as the observed element).

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.

Source
dimension
48px
Default estimated item height used by the virtual engine for initial layout.
duration
{motion.duration.fast}
Duration for item transitions.
cubicBezier
{motion.easing.standard}
Easing for virtual scroll item transitions.

Usage

Exemples

Extraits de code prêts à coller dans vos templates.

Within a VirtualScroll (internal usage)

vue

Renderless mode (advanced)

vue

Écosystème

Famille

Composants du même dossier qui partagent les conventions et se composent souvent ensemble.