API Referenceclass

class UIToggle

A view class that represents a checkbox or toggle input.

class UIToggle extends UIElement;

Notes

• Renders as a checkbox (default) or switch control that can be toggled on and off.
• Use the UI.Toggle() function to create toggles using a builder.

Constructor

• new UIToggle()
  Creates a new toggle view object with the specified text.

Type members

• class ToggleBuilder static
  A builder class for creating UIToggle instances.

Static members

• function toggleBuilder() static
  Creates a view builder for a toggle (checkbox/switch) element.

Instance members

• value
  The current toggle state; true for the ‘on’ state.
• text
  The text to be displayed alongside the toggle.
• type
  The visual presentation type of the toggle.
• disabled
  True if user input should be disabled on this control.
• textStyle
  The style overrides for the toggle’s text element.

Inherited members

• name
  The identifier for this UI element.
• hidden
  True if the element should be hidden from view.
• style
  The style overrides to apply to this element.
• setStyle()
  Applies additional style overrides to this element.
• position
  The position options for this element.
• accessibleRole
  The WAI-ARIA role for this element, if applicable.
• accessibleLabel
  The WAI-ARIA label text for this element, if applicable.
• requestFocus()
  Requests input focus on this element.
• requestFocusNext()
  Requests input focus for the next sibling element.
• requestFocusPrevious()
  Requests input focus for the previous sibling element.
• getRenderer() protected
  Returns the renderer observer for this element, if any.
• isFocused()
  Returns true if this element currently has input focus.
• render()
  Triggers asynchronous rendering for this element and all contained elements, if any.
• findViewContent()
  Implementation of View.findViewContent(); returns an empty array unless overridden.
• lastRenderOutput
  The last rendered output, if any; set by the UI element renderer.
• emit()
  Emits an event, immediately calling all event handlers.
• emitChange()
  Emits a change event.
• listen()
  Adds a handler for all events emitted by this object.
• listenOnce()
  Returns a promise for a single event with the provided name.
• listenAsync()
  Adds a handler for all events emitted by this object, and returns an async iterable.
• observe()
  Observes a property, a bound property from an attached parent, or an observable object.
• observeAsync()
  Observes one or more targets asynchronously, batching or debouncing/throttling updates.
• attach() protected
  Attaches the specified observable object to this object.
• isUnlinked()
  Returns true if the object has been unlinked.
• unlink()
  Unlinks this observable object.
• beforeUnlink() protected
  A method that’s called immediately before unlinking an object, can be overridden.