Class BarItem

Anything that can go into a toolbar, including actions, tools, toggles, widgets etc.

Hierarchy (View Summary)

KeybindItem
- BarItem
  - Action
  - Widget

Index

Constructors

Properties

category? condition? description icon? id keybind name node nodes plugin? variations? constructing?

Methods

addLabel conditionMet delete dispatchEvent getNode on once pushToolbar removeListener toElement

Constructors

constructor

new BarItem(id: string, options: BarItemOptions): BarItem
Parameters
- id: string
- options: BarItemOptions
Returns BarItem
Overrides KeybindItem.constructor
- Defined in types/custom/action.d.ts:169
new BarItem(id: string, options: BarItemOptions): BarItem
Parameters
- id: string
- options: BarItemOptions
Returns BarItem
Overrides KeybindItem.constructor
- Defined in types/custom/action.d.ts:213

Properties

`Optional`category

category?: string

`Optional`condition

condition?: any

description

description: string

`Optional`icon

icon?: string

id

id: string

keybind

keybind: Keybind

name

name: string

node

node: HTMLElement

nodes

nodes: HTMLElement[]

`Optional`plugin

plugin?: string

The ID of the plugin that created the object

`Optional`variations

variations?: { [key: string]: { description?: string; name: string } }

`Static` `Optional`constructing

constructing?: BarItem

Methods

addLabel

addLabel(in_bar?: boolean, action?: any): void
Adds a label to the HTML element of the bar item
Parameters
- Optionalin_bar: boolean
  Set to true to generate an in-bar label, as opposed to a regular on-hover label
- Optionalaction: any
  Provide the action to generate the label. This defaults to self and is only needed in special cases
Returns void
- Defined in types/custom/action.d.ts:184
addLabel(in_bar?: boolean, action?: any): void
Adds a label to the HTML element of the bar item
Parameters
- Optionalin_bar: boolean
  Set to true to generate an in-bar label, as opposed to a regular on-hover label
- Optionalaction: any
  Provide the action to generate the label. This defaults to self and is only needed in special cases
Returns void
- Defined in types/custom/action.d.ts:220

conditionMet

conditionMet(): boolean
Returns boolean
- Defined in types/custom/action.d.ts:178
conditionMet(): boolean
Returns boolean
- Defined in types/custom/action.d.ts:214

delete

delete(): void
Returns void
Inherited from KeybindItem.delete
- Defined in types/custom/misc.d.ts:8

dispatchEvent

dispatchEvent<T = EventName>(event: T, ...args: any[]): void
Type Parameters
- T = EventName
Parameters
- event: T
- ...args: any[]
Returns void
- Defined in types/custom/action.d.ts:231

getNode

getNode(): HTMLElement
Gets a copy of the elements HTML node that is not yet in use.

Returns HTMLElement
- Defined in types/custom/action.d.ts:188
getNode(): HTMLElement
Gets a copy of the elements HTML node that is not yet in use.

Returns HTMLElement
- Defined in types/custom/action.d.ts:224

on

on(
event_name: ActionEventName,
callback: (data: Record<string, any>) => void,
): void
Adds an event listener to the item
Parameters
- event_name: ActionEventName
  The event type to listen for
- callback: (data: Record<string, any>) => void
Returns void
- Defined in types/custom/action.d.ts:200

once

once(
event_name: ActionEventName,
callback: (data: Record<string, any>) => void,
): void
Adds a single-use event listener to the item
Parameters
- event_name: ActionEventName
  The event type to listen for
- callback: (data: Record<string, any>) => void
Returns void
- Defined in types/custom/action.d.ts:206

pushToolbar

pushToolbar(bar: any): void
Parameters
- bar: any
Returns void
- Defined in types/custom/action.d.ts:193
pushToolbar(bar: any): void
Parameters
- bar: any
Returns void
- Defined in types/custom/action.d.ts:229

removeListener

removeListener(
event_name: ActionEventName,
callback: (data: Record<string, any>) => void,
): void
Removes an event listener from the item
Parameters
- event_name: ActionEventName
- callback: (data: Record<string, any>) => void
Returns void
- Defined in types/custom/action.d.ts:212

toElement

toElement(destination: string | HTMLElement): this
Appends the bar item to a HTML element
Parameters
- destination: string | HTMLElement
Returns this
- Defined in types/custom/action.d.ts:192
toElement(destination: HTMLElement): this
Appends the bar item to a HTML element
Parameters
- destination: HTMLElement
Returns this
- Defined in types/custom/action.d.ts:228