module:Checkbox

module:Checkbox

Checkbox class
checkbox demo

Constructor

# new module:Checkbox(positionDefinition, optionsopt)

Checkbox constructor

Parameters:
Name Type Attributes Description
positionDefinition PositionDefinition

Top-left corner

options CheckboxOptions <optional>

Specific options

Extends

Members

# (static) defaultOptions :CheckboxOptions

Type:
  • CheckboxOptions

# (static) MARGIN :Number

Margin around the filling square in ratio

Type:
  • Number

# height

Get it's height

# height

Set it's height

# value

Return whether it's checked

Overrides:

# value

Change whether it's checked

Overrides:

# width

Get it's width

# width

Set it's width

Methods

# toggle(newValueopt) → {Boolean}

Inverse whether it's checked

Parameters:
Name Type Attributes Description
newValue Boolean <optional>

If defined, will force the value

Returns:
Type
Boolean

Type Definitions

# CheckboxOptions

Type:
  • Object
Properties
Name Type Attributes Default Description
size Number <optional>
20

Width and height of the checkbox

value Boolean <optional>
false

Whether it's check ot not