Class Sorting

Manages basic data-sorting behaviors. Ascending -> Descending -> None

This plugin requires a table plugin configuration, onSort for handling how sorting happens. communicating back to the table that sorting has succeeded can be done by setting the sorts property in the table plugin configuration.

Note that this plugin doesn't actually sort the data, as data management is not the responsibility of the table, but of the surrounding context providing the data to the table. So sorting can happen client-side still, just in a component -- much the same way you'd handel sorting via API requests.

This plugin is for conveying what the current sorts are, rather than doing the sorting.

Hierarchy

  • BasePlugin<Meta["column"], Meta["table"], Options, ColumnOptions>
    • Sorting

Constructors

constructor

Properties

meta name table features? requires?

Accessors

#self options

Methods

getColumnMeta getColumnOptions getTableMeta headerCellModifier forColumn with

Constructors

constructor

Properties

meta

meta: {
    column: typeof ColumnMeta;
    table: typeof TableMeta;
} = ...

Optional state that this plugin may or may not choose to use

columns will each have an instance of meta.column. the table will have only one instance of meta.table.

Type declaration

name

name: string = 'data-sorting'

Unique name for the plugin.

  • only one plugin of the same name is allowed
  • the name is used for storing preferences / serializable information

Protected table

table: Table<unknown>

Static Optional features

features?: string[]

Static Optional requires

requires?: string[]

Accessors

Private #self

options

  • get options(): undefined | Options

  • Utility property that returns the resulting options passed during table creation for this specific plugin.

    Returns undefined | Options

Methods

getColumnMeta

getColumnOptions

getTableMeta

headerCellModifier

Static forColumn

  • Helper for specifying column-level configurations for a plugin on headlessTable's columns option

    Type Parameters

    • T extends BasePlugin<unknown, unknown, unknown, unknown, T>

    Parameters

    • this: Constructor<T, any[]>
    • configFn: (() => ReturnType<InstanceOf<T>["getColumnOptions"]>)
        • (): ReturnType<InstanceOf<T>["getColumnOptions"]>

        • Returns ReturnType<InstanceOf<T>["getColumnOptions"]>

    Returns [Constructor<T, any[]>, (() => ReturnType<InstanceOf<T>["getColumnOptions"]>)]

Static with

  • Helper for specifying plugins on headlessTable with the plugin-level options

    Type Parameters

    • T extends BasePlugin<unknown, unknown, unknown, unknown, T>

    Parameters

    • this: Constructor<T, any[]>
    • configFn: (() => OptionsFor<T>)
        • (): OptionsFor<T>

        • Returns OptionsFor<T>

    Returns [Constructor<T, any[]>, (() => OptionsFor<T>)]

Settings

Member Visibility

Theme

Generated using TypeDoc