Class: CheckBox

.box~ CheckBox

new CheckBox(configopt)

Base check box implementation.

Parameters:
Name Type Attributes Default Description
config Object <optional>
 {}

init parameters (all inherited from the parent)

Properties
Name Type Attributes Default Description
value boolean <optional>
 false

initial state
group string <optional>

group name to work synchronously with other checkboxes
Source:
Example
var CheckBox = require('stb/ui/check.box'),
    checkBox = new CheckBox({
        value: true,
        group: 'lang'
    });

Extends

  • Component

Members

group :string

Group name to work synchronously with other checkboxes.

Type:
  • string
Source:

value :boolean

Initial state.

Type:
  • boolean
Source:

Methods

set(value) → {boolean}

Set the given state. Does nothing in case the value is already as necessary.

Parameters:
Name Type Description
value boolean

new value to set
Source:
Fires:
Returns:

operation status

Type
boolean