IGroupItemProvide
interface
Group & Selection
Runtime injection provided by each item component to its descendants — exposes identity, selection state, toggle and a back-reference to the parent group.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- idrequirednumber
- Unique numeric id assigned by the parent group on registration.
- isSelectedrequiredRef<boolean>
- Reactive flag — true when this item is in the group selection.
- togglerequired() => void
- Toggles the selected state of this item inside the group.
- selectrequired(value: boolean) => void
- Explicitly sets the selected state to the given boolean.
- selectedClassrequiredRef<Array<(string | undefined)> | false>
- Resolved CSS class list to apply when selected, or false when not selected.
- valuerequiredRef<unknown>
- Reactive ref wrapping the item value (mirrors the value prop).
- disabledrequiredRef<boolean | undefined>
- Reactive disabled state — true prevents selection.
- grouprequiredIGroupProvide
- Back-reference to the parent group provide object.
Usage
Examples
Ready-to-paste code snippets using this interface.
Injecting the group-item provide in a child component