IDataTableSelectProps
interface
Component Props
Props that enable and configure row selection in <OrigamDataTable> — controls the checkbox column visibility, the selection strategy, the v-model array and the equality comparator.
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.
- showSelectboolean
- Renders a checkbox column in the header and each row when true.
- selectStrategyTDataTableSelectStrategy
- Strategy object (or "single" | "page" | "all") controlling how select-all and individual selects interact.
- modelValueArray<any>
- Array of selected item keys (or full objects when returnObject is true). Bind with v-model.
- valueComparator(a: any, b: any) => boolean
- Custom equality function used to determine if two item values are the same — defaults to strict equality.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Multi-row selection with v-model