Class BasePlugin<Signature>Abstract

If your table plugin is a class, you may extend from BasePlugin, which provides small utility methods and properties for getting the metadata for your plugin for the table and each column

One instance of a plugin exists per table

Type Parameters

  • Signature = unknown

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

[___Signature__] meta? name table features? requires?

Methods

forColumn with

Constructors

constructor

Properties

Private[___Signature__]

"[___Signature__]": Signature

(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

Optionalmeta

meta?: {
    column?: Constructor<ColumnMetaFor<Signature>>;
    row?: Constructor<RowMetaFor<Signature>>;
    table?: Constructor<TableMetaFor<Signature>>;
}

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.

Abstractname

name: string

Unique name for the plugin.

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

Protectedtable

table: Table

Static Optionalfeatures

features?: string[]

Static Optionalrequires

requires?: string[]

Methods

StaticforColumn

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

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

    Type Parameters

    Parameters

    • this: Constructor<T>
    • configFn: () => ColumnOptionsFor<SignatureFrom<T>>

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

Staticwith

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

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

    Type Parameters

    Parameters

    • this: Constructor<T>
    • configFn: () => OptionsFor<SignatureFrom<T>>

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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods