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

Toolbar

Extends:

Feature → Toolbar

Toolbar UI component

Constructor Summary

Public Constructor
public

Create an instance of Toolbar

Member Summary

Public Members
public

Css class for middle inner container DOM element

public

Css class for toolbar's container DOM element

public
public
public

Css class for left-side inner container DOM element

public

Css class for right-side inner container DOM element

public

Toolbar's custom container ID

Method Summary

Public Methods
public

container(position: String, el: DOMElement): DOMElement

Return the container based on requested position inside the toolbar

public

Destroy Toolbar instance

public

init(isExternal: Boolean)

Initialize toolbar components

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

Create an instance of Toolbar

Override:

Feature#constructor

Params:

NameTypeAttributeDescription
tf TableFilter

TableFilter instance

Public Members

public cContCssClass: String source

Css class for middle inner container DOM element

public contCssClass: String source

Css class for toolbar's container DOM element

public enabled: boolean source

Override:

Feature#enabled

public initialized: boolean source

Override:

Feature#initialized

public lContCssClass: String source

Css class for left-side inner container DOM element

public rContCssClass: String source

Css class for right-side inner container DOM element

public tgtId: String source

Toolbar's custom container ID

Public Methods

public container(position: String, el: DOMElement): DOMElement source

Return the container based on requested position inside the toolbar

Params:

NameTypeAttributeDescription
position String
  • optional
  • default: RIGHT

3 possible positions: 'left', 'center', 'right'

el DOMElement

optional DOM element to be inserter in container

Return:

DOMElement

public destroy() source

Destroy Toolbar instance

Override:

Feature#destroy

public init(isExternal: Boolean) source

Initialize toolbar components

Override:

Feature#init

Params:

NameTypeAttributeDescription
isExternal Boolean

initialize only if component belongs to toolbar