Class Table<DataType>

Type Parameters

  • DataType = unknown

Hierarchy

  • Resource<Signature<DataType>>
    • Table

Constructors

constructor

Properties

[TABLE_KEY] args columns modifiers preferences rows scrollContainerElement? scrollContainerHeight? scrollContainerWidth?

Accessors

config plugins

Methods

modify pluginOf resetScrollContainer resetToDefaults

Constructors

constructor

  • Type Parameters

    • DataType = unknown

    Parameters

    • owner: unknown

    Returns Table<DataType>

Properties

Private [TABLE_KEY]

[TABLE_KEY]: string = ...

Private args

args: {
    named: TableConfig<DataType>;
}

Lazy way to delay consuming arguments until they are needed.

Type declaration

columns

columns: MappedArray<Column<DataType>> = ...

modifiers

modifiers: {
    columnHeader: FunctionBasedModifier<{}>;
    container: FunctionBasedModifier<{}>;
    row: FunctionBasedModifier<{}>;
} = ...

Collection of utility modifiers that are the result of composing modifiers from plugins.

Using this is optional, and you can "just" use modifiers from specific plugins in specific places if you wish -- but these exists as a "convenience".

These are all no-use, no-cost utilities

Type declaration

  • columnHeader: FunctionBasedModifier<{}>
  • container: FunctionBasedModifier<{}>
  • row: FunctionBasedModifier<{}>

preferences

preferences: TablePreferences

Interact with, save, modify, etc the preferences for the table, plugins, columns, etc

rows

rows: MappedArray<Row<DataType>> = ...

Optional Private scrollContainerElement

scrollContainerElement?: HTMLElement

Optional Private scrollContainerHeight

scrollContainerHeight?: number

Unused for now, may be used in the future. This data is collected along with the scrollContainerWidth, (which is currently in use)

Optional Private scrollContainerWidth

scrollContainerWidth?: number

Used to help determine how much space we can give to columns. As we generate widths for columns, the columns' widths must add up to about this number.

Accessors

config

plugins

  • get plugins(): Plugin<unknown>[]
  • Private

    For all configured plugins, instantiates each one. If the plugins argument changes to the Table (either directly or through headlessTable, all state is lost and re-created)

    Returns Plugin<unknown>[]

Methods

Private modify

pluginOf

  • Get the active plugin instance for the given plugin class

    Type Parameters

    Parameters

    • klass: Class<Instance>

    Returns undefined | Instance

Private resetScrollContainer

resetToDefaults

Settings

Member Visibility

Theme

Generated using TypeDoc