Home Reference Source Repository
import {Help} from 'tablefilter/src/modules/help.js'
public class | source

Help

Extends:

Feature → Help

Help UI component

Constructor Summary

Public Constructor
public

Creates an instance of Help

Member Summary

Public Members
public

btn: DOMElement

Button DOM element

public

Css class for help button

public

Custom help button HTML

public

Help button text ('?')

public

cont: DOMElement

Help container DOM element

public

Css class for help container element

public

ID of custom container element for instructions

public

Default HTML appended to instructions text

public
public

Instructions HTML

public

Instructions text (accepts HTML)

public

ID of main custom container element

public

Default position in toolbar ('left'|'center'|'right')

Method Summary

Public Methods
public

Remove help UI

public

init()

Initialise Help instance

public

toggle()

Toggle help pop-up

Inherited Summary

From class Feature
public

TableFilter configuration

public

TableFilter emitter instance

public

TableFilter feature setting

public

Feature name

public

Field indicating whether Feature is initialized

public

TableFilter instance

public

Destroy the feature

public

Disable the feature

public

enable()

Enable the feature

public

init()

Initialize the feature

public

Indicate whether the feature is enabled or not

public

reset()

Reset the feature after being disabled

Public Constructors

public constructor(tf: TableFilter) source

Creates an instance of Help

Override:

Feature#constructor

Params:

NameTypeAttributeDescription
tf TableFilter

TableFilter instance

Public Members

public btn: DOMElement source

Button DOM element

public btnCssClass: String source

Css class for help button

public btnHtml: String source

Custom help button HTML

public btnText: String source

Help button text ('?')

public cont: DOMElement source

Help container DOM element

public contCssClass: String source

Css class for help container element

public contTgtId: String source

ID of custom container element for instructions

public defaultHtml: String source

Default HTML appended to instructions text

public initialized: boolean source

Override:

Feature#initialized

public instrHtml: String source

Instructions HTML

public instrText: String source

Instructions text (accepts HTML)

public tgtId: String source

ID of main custom container element

public toolbarPosition: String source

Default position in toolbar ('left'|'center'|'right')

Public Methods

public destroy() source

Remove help UI

Override:

Feature#destroy

public init() source

Initialise Help instance

Override:

Feature#init

public toggle() source

Toggle help pop-up