import {Toolbar} from 'tablefilter/src/modules/toolbar.js'

public class | source

Toolbar

Extends:

Feature → Toolbar

Toolbar UI component

Constructor Summary

Public Constructor
public	constructor(tf: TableFilter) Create an instance of Toolbar

Member Summary

Public Members
public	cContCssClass: String Css class for middle inner container DOM element
public	contCssClass: String Css class for toolbar's container DOM element
public	enabled: boolean
public	initialized: boolean
public	lContCssClass: String Css class for left-side inner container DOM element
public	rContCssClass: String Css class for right-side inner container DOM element
public	tgtId: String 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() Destroy Toolbar instance
public	init(isExternal: Boolean) Initialize toolbar components

Inherited Summary

From class Feature
public	config: Object TableFilter configuration
public	emitter: Emitter TableFilter emitter instance
public	enabled: Boolean TableFilter feature setting
public	feature: String Feature name is the camelised class name as per TableFilter's convention
public	initialized: Boolean Field indicating whether Feature is initialized
public	tf: TableFilter TableFilter instance
public	destroy() Destroy the feature
public	disable() Disable the feature
public	enable() Enable the feature
public	init() Initialize the feature
public	isEnabled(): Boolean 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:

Name	Type	Attribute	Description
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

TableFilter feature setting

Override:

Feature#enabled

public initialized: boolean source

Field indicating whether Feature is initialized

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:

Name	Type	Attribute	Description
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:

Name	Type	Attribute	Description
isExternal	Boolean		initialize only if component belongs to toolbar