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

StatusBar

Extends:

Feature → StatusBar

Status bar UI component

Constructor Summary

Public Constructor
public

Creates an instance of StatusBar

Member Summary

Public Members
public

Css class for container element

public
public

Message appearing when a pagination page is changed

public

Message appearing when the page length is changed

public

Message appearing when filters are cleared

public

Message appearing upon filtering

public

Message appearing when extensions are loading

public

Message appearing when themes are loading

public

Message appearing when a drop-down filter is populated

public

Message appearing when a checklist filter is populated

public

Message appearing when the page is re-set

public

Message appearing when the page length is re-set

public

Message appearing upon column sorting

public

Callback fired after the message is displayed

public

Callback fired before the message is displayed

public

ID of custom container element

public

Text preceding status message

public

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

Method Summary

Public Methods
public

Destroy StatusBar instance

public

init()

Initializes StatusBar instance

public

Display status message

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 StatusBar

Override:

Feature#constructor

Params:

NameTypeAttributeDescription
tf TableFilter

TableFilter instance

Public Members

public cssClass: String source

Css class for container element

public initialized: boolean source

Override:

Feature#initialized

public msgChangePage: String source

Message appearing when a pagination page is changed

public msgChangeResults: String source

Message appearing when the page length is changed

public msgClear: String source

Message appearing when filters are cleared

public msgFilter: String source

Message appearing upon filtering

public msgLoadExtensions: String source

Message appearing when extensions are loading

public msgLoadThemes: String source

Message appearing when themes are loading

public msgPopulate: String source

Message appearing when a drop-down filter is populated

public msgPopulateCheckList: String source

Message appearing when a checklist filter is populated

public msgResetPage: String source

Message appearing when the page is re-set

public msgResetPageLength: String source

Message appearing when the page length is re-set

public msgSort: String source

Message appearing upon column sorting

public onAfterShowMsg: Function source

Callback fired after the message is displayed

public onBeforeShowMsg: Function source

Callback fired before the message is displayed

public targetId: String source

ID of custom container element

public text: String source

Text preceding status message

public toolbarPosition: String source

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

Public Methods

public destroy() source

Destroy StatusBar instance

Override:

Feature#destroy

public init() source

Initializes StatusBar instance

Override:

Feature#init

public message(t: String) source

Display status message

Params:

NameTypeAttributeDescription
t String
  • optional
  • default: ''

Message to be displayed