TabBar

A view for transitioning between two surfaces based on a 'on' and 'off' state

Overview

Options
Methods
select
deselect
isSelected
setOptions
getSize

TabBar(options)

Constructor Parameters

options

Object

overrides of default options

Methods

select(suppressEvent)

Transition towards the 'on' state and dispatch an event to listeners to announce it was selected. Accepts an optional argument, `suppressEvent`, which, if truthy, prevents the event from being dispatched.

Parameters
suppressEvent
Boolean
When truthy, prevents the widget from emitting the 'select' event.

deselect(suppressEvent)

Transition towards the 'off' state and dispatch an event to listeners to announce it was deselected. Accepts an optional argument, `suppressEvent`, which, if truthy, prevents the event from being dispatched.

Parameters
suppressEvent
Boolean
When truthy, prevents the widget from emitting the 'deselect' event.

isSelected()

Return the state of the button

Returns
Boolean
selected state

setOptions(options)

Override the current options

Parameters
options
Object
JSON

getSize()

Return the size defined in the options object

Returns
Array
two element array [height, width]