Class StickyColumns

Table plugins are stateless objects that optionally provide hooks based on what the plugin wishes to modify.

A Plugin may either be a class or plain object

If state is desired, Metadata classes may be provided to manage that state. As a convenience, when the meta classes are instantiated, they'll be given the same owner as everything else in the application, so service injection will be available within the meta class instances.

A plugin can provide components that the consuming Table can opt in to rendering. (though, often these components will be required to be rendered for the plugin to work)

a Plugin has three type arguments:

  • ColumnMeta - optional state for storing and managing information per column

  • TableMeta - optional state for storing and managing information about the table

    Any particular plugin instantiation will have at most 1 instance of their TableMeta and n instances of their ColumnMeta, where n is at most the number of columns.

Hierarchy

Implements

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 = 'sticky-columns'

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 requires

requires: string[] = ...

This plugin requires that the resizing plugin be present, because the resizing plugin is what manages the base width of the columns.

Other width-management plugins can be used instead of ColumnResizing, but they must declare that they manage the width of the columns.

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

  • Kind

    Column property

    Specify a modifier setup/teardown function to attach to each of the header cells

    Can be used to add / remove attributes, event listeners, etc

    Parameters

    Returns void

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