InfiniteScrollIntersect

Data Display
stable

Low-level sentinel element used by InfiniteScroll to detect when the scroll boundary enters the viewport via IntersectionObserver.

Structure

Anatomy

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

Anatomy of OrigamInfiniteScrollIntersectSchematic of the InfiniteScrollIntersect sentinel element with 1 numbered part. height: 1px (invisible sentinel) 1 origam-infinite-scroll-intersect
Anatomy of <origam-infinite-scroll-intersect> — a single invisible sentinel <div> observed by an IntersectionObserver.
1.origam-infinite-scroll-intersect
Root element. A minimal <div> containing a non-breaking space (&nbsp;) to ensure the browser paints it. Observed by useIntersectionObserver and fires the intersect emit on visibility change.

API

Props

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

Identifies whether this sentinel monitors the top or bottom boundary. Passed back verbatim in the intersect emit payload.
rootRef
HTMLElement
—
Reference to the scroll container used as the IntersectionObserver root. Required.
margin
string
CSS rootMargin passed to IntersectionObserver. Allows early or late triggering relative to the viewport edge.
id
string
class
string | Array<string> | object
style
string | Array<string> | object | StyleValue

API

Emits

Events emitted by this component.

@intersect
{ isIntersecting: boolean, side: TInfiniteScrollSide }
Fired each time the sentinel's IntersectionObserver entry changes. Carries the side and the current isIntersecting state.

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.

Customisation

CSS variables

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

Color of the loading spinner in the parent InfiniteScroll loader slot.
Gap between the loader and adjacent elements in the side zone.

Inclusion

Accessibility

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

Notes

  • The sentinel is a non-interactive, invisible element with no ARIA role. Screen readers ignore it. Announce newly loaded content via a live region on the parent component.

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__action--primary---bg)
Color passed to the OrigamProgress spinner in the loading slot.
dimension
var(--origam-space---3)
Gap between loader and adjacent elements within the side zone.
color
var(--origam-color__text---secondary)
Text color for the empty-state message shown when no more items are available.

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.

Manual sentinel usage

vue

Ecosystem

Family

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