Class ColumnResizing

One instance of a plugin exists per table but a plugin can have a "Meta" for each column

Hierarchy

Constructors

constructor

Properties

[___Signature__] containerModifier meta name table features requires?

Methods

headerCellModifier reset 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

containerModifier

containerModifier: ((element: HTMLElement, table: Table<unknown>) => (() => void)) = resizeObserver

Type declaration

    • (element: HTMLElement, table: Table<unknown>): (() => void)
    • Private

      included in the same file as the plugin due to circular dependency

      This goes on the containing element

      Example

       <div {{resizeObserver @table}}>
         <table>

      Parameters

      • element: HTMLElement
      • table: Table<unknown>

      Returns (() => void)

        • (): void

        • Returns void

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 = 'column-resizing'

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 features

features: string[] = ...

Static Optional requires

requires?: string[]

Methods

headerCellModifier

reset

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