Class StickyColumns

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

Hierarchy

Constructors

constructor

Properties

[___Signature__] meta name table features? requires

Methods

cellModifier conditionallyRemoveStyles headerCellModifier 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

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

  • column: typeof ColumnMeta
  • table: typeof TableMeta

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.

Methods

cellModifier

conditionallyRemoveStyles

headerCellModifier

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

Generated using TypeDoc