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

BasePlugin

Implements

Plugin<Signature>

Index

Constructors

constructor

new BasePlugin<Signature>(table: Table<unknown>): BasePlugin<Signature>
Type Parameters
- Signature = unknown
Parameters
- table: Table<unknown>
Returns BasePlugin<Signature>
- Defined in ember-headless-table/src/plugins/-private/base.ts:88

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

`Optional` meta

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

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

Optional column?: Constructor<ColumnMetaFor<Signature>, any[]>
Optional row?: Constructor<RowMetaFor<Signature>, any[]>
Optional table?: Constructor<TableMetaFor<Signature>, any[]>

`Abstract` name

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

`Protected` table

table: Table<unknown>

`Static` `Optional` features

features?: string[]

`Static` `Optional` requires

requires?: string[]

Methods

`Static` forColumn

forColumn<T>(this: Constructor<T, any[]>, configFn: (() => ColumnOptionsFor<SignatureFrom<T>>)): [Constructor<T, any[]>, (() => ColumnOptionsFor<SignatureFrom<T>>)]
Helper for specifying column-level configurations for a plugin on headlessTable's columns option
Type Parameters
- T extends BasePlugin<any, T>
Parameters
- this: Constructor<T, any[]>
- configFn: (() => ColumnOptionsFor<SignatureFrom<T>>)
  - - (): ColumnOptionsFor<SignatureFrom<T>>
    - Returns ColumnOptionsFor<SignatureFrom<T>>
Returns [Constructor<T, any[]>, (() => ColumnOptionsFor<SignatureFrom<T>>)]
- Defined in ember-headless-table/src/plugins/-private/base.ts:115

`Static` with

with<T>(this: Constructor<T, any[]>, configFn: (() => OptionsFor<SignatureFrom<T>>)): [Constructor<T, any[]>, (() => OptionsFor<SignatureFrom<T>>)]
Helper for specifying plugins on headlessTable with the plugin-level options
Type Parameters
- T extends BasePlugin<any, T>
Parameters
- this: Constructor<T, any[]>
- configFn: (() => OptionsFor<SignatureFrom<T>>)
  - - (): OptionsFor<SignatureFrom<T>>
    - Returns OptionsFor<SignatureFrom<T>>
Returns [Constructor<T, any[]>, (() => OptionsFor<SignatureFrom<T>>)]
- Defined in ember-headless-table/src/plugins/-private/base.ts:104

Class BasePlugin<Signature>Abstract

Type Parameters

Signature = unknown

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Signature = unknown

Parameters

table: Table<unknown>

Returns BasePlugin<Signature>

Properties

Private [___Signature__]

Optional meta

Type declaration

Optional column?: Constructor<ColumnMetaFor<Signature>, any[]>

Optional row?: Constructor<RowMetaFor<Signature>, any[]>

Optional table?: Constructor<TableMetaFor<Signature>, any[]>

Abstract name

Protected table

Static Optional features

Static Optional requires

Methods

Static forColumn

Type Parameters

T extends BasePlugin<any, T>

Parameters

this: Constructor<T, any[]>

configFn: (() => ColumnOptionsFor<SignatureFrom<T>>)

Returns ColumnOptionsFor<SignatureFrom<T>>

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

Static with

Type Parameters

T extends BasePlugin<any, T>

Parameters

this: Constructor<T, any[]>

configFn: (() => OptionsFor<SignatureFrom<T>>)

Returns OptionsFor<SignatureFrom<T>>

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

Settings

Member Visibility

Theme

Class BasePlugin<Signature>`Abstract`

`Private` [_Signature]

`Optional` meta

`Optional` column?: Constructor<ColumnMetaFor<Signature>, any[]>

`Optional` row?: Constructor<RowMetaFor<Signature>, any[]>

`Optional` table?: Constructor<TableMetaFor<Signature>, any[]>

`Abstract` name

`Protected` table

`Static` `Optional` features

`Static` `Optional` requires

`Static` forColumn

`Static` with