ListGroupActivator

Data Display
stable

Internal wrapper component that registers the nested group activator context via useNestedGroupActivator. Consumed internally by OrigamListGroup to wire the toggle header to the expand/collapse mechanism.

Structure

Anatomy

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

Anatomy of OrigamListGroupActivatorSchematic showing the activator wrapper element wrapping the header slot content. 1 #default slot — ListItem / custom activator header 2
Anatomy of <origam-list-group-activator> — a transparent wrapper ① rendered as the tag prop value (default: <div>). The default slot ② holds the activator header content (typically a ListItem).
1.origam-list-group-activator
Root element. Rendered via — defaults to
. Registers the nested group activator context via useNestedGroupActivator() on mount.
2#default slot
Default slot content — the interactive header element (usually an OrigamListItem) that the user clicks to expand/collapse the ListGroup.

API

Props

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

tag
string
'div'
HTML element rendered at the root. Defaults to div; can be set to any valid HTML tag by the parent (e.g. header).

API

Slots

Content slots exposed by this component.

#default
Content of the activator header — typically a ListItem with the group title and expand icon.

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 child components.
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.

Inclusion

Accessibility

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

Notes

  • OrigamListGroupActivator is a context-only wrapper — it has no ARIA role or keyboard contract of its own. The slotted content (OrigamListItem) owns the interactive surface with the correct aria-expanded and role="button" attributes.
  • The component renders a plain <div> (or tag prop value) with no ARIA attributes added at this level. It is transparent to the accessibility tree.

Usage

Examples

Ready-to-paste code snippets for your templates.

Implicit usage via ListGroup

vue