ve.Toggle

ve.Component. ve.Toggle

Refer to ve.Component for methods or fields inherited from this Component's parent such as .options.attributes or .element.

Toggle component with HTML labels for on/off switches. Mainly returns a boolean value.

  • Functional binding: veToggle().
Constructor:
  • arg0_value: boolean
  • arg1_options: Object
    • .off_label: string - The off label to be displayed after the HTML icon.
    • .off_name: string - The off name, including the HTML icon, to be displayed in its off state.
    • .on_label: string - The on label to be displayed after the HTML icon.
    • .on_name: string - The on name, including the HTML icon, to be displayed in its on state.
    • .name: string - If set, this reflects a common label shared between both the off/on states.
Methods:
  • updateName()

Constructor

new ve.Toggle()

Source:

Extends

Members

from_binding

Internal .from_binding setter for handling .options.from_binding. Accepts a string literal that is then parsed to a variable reference.

.to_binding counterparts are manually handled child-side.

Overrides:
Source:

limit

Tests the current this.limit by calling this.limit_function(this.v, this). Otherwise resolves to true if no .options.limit is set.

Overrides:
Source:

name

Returns the visual name of the present ve.Component,

Overrides:
Source:

Methods

addComponent()

Adds the current component to this.parent_el should it exist.

Overrides:
Source:

bind(arg0_container_el)

Manually binds/mounts the present ve.Component into the visual DOM.

Overrides:
Source:
Parameters:
Name Type Description
arg0_container_el HTMLElement

fireFromBinding()

Pseudo-setter from binding. Fires only upon program-driven changes to .v directly, which means that this has to be monitored manually component-side in set v(). This should always come last in set v().

Overrides:
Source:

fireToBinding()

Pseudo-setter to binding. Fires only upon user-driven changes, which means that this has to be monitored manually component-side.

Overrides:
Source:

remove()

Removes the component/element from the DOM.

Overrides:
Source:

removeComponent()

Removes the current component from this.parent_el should it exist.

Overrides:
Source:

setOwner(arg0_value, arg1_owner_array)

Sets the root parent and ownership tree. Influences this.parent_el, this.owner, this.owners.

Overrides:
Source:
Parameters:
Name Type Description
arg0_value
arg1_owner_array