Class Plugin<DataType, Key>

This plugin provides a means of managing selection of a single row in a table.

The state of what is actually selected is managed by you, but this plugin will wire up the click listeners as well as let you know which data is clicked.

Type Parameters

  • DataType = any

  • Key = DataType

Hierarchy

Constructors

constructor

Properties

[___Signature__] meta name table features? requires?

Methods

#clickHandler rowModifier forColumn with

Constructors

constructor

Properties

Private [___Signature__]

[___Signature__]: Signature<DataType, Key>

(secret)

Because classes are kind of like interfaces, we need "something" to help TS know what a Resource is.

This isn't a real API, but does help with type inference with the SignatureFrom utility above

meta

meta: {
    row: typeof RowMeta;
    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

  • row: typeof RowMeta
  • table: typeof TableMeta

name

name: string = 'row-selection'

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[]

Methods

Private #clickHandler

rowModifier

Static forColumn

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

    Type Parameters

    Parameters

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

        • Returns ColumnOptionsFor<SignatureFrom<T>>

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

Static with

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

    Type Parameters

    Parameters

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

        • Returns OptionsFor<SignatureFrom<T>>

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc