IDataTableSortItem

interface
Component Props

A single sort descriptor in the sortBy array — pairs a column key with an optional sort direction. Used by both the sort props and the provide/inject sort contract.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

key
required
string
The column key to sort by — must match a key in the headers array.
order
boolean | TSortDirection
Sort direction: 'asc', 'desc', true (= 'asc') or false (= 'desc'). Omit to infer ascending.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Initial multi-column sort

vue