API Referenceclass

class UIElement

The base class for built-in UI view elements.

abstract class UIElement extends View;

Notes

• This class is abstract and cannot be instantiated directly.
• Subclasses include controls such as UIButton and containers such as UIColumn.

Description

The UIElement class provides common infrastructure for UI controls and containers, including properties for styling, positioning, and accessibility.

Type members

• type UIElement.Position static
  A type that describes options for positioning within parent elements.
• class ElementBuilder abstractstatic
  An abstract base class for UI element builders.

Instance 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.

Inherited members

• 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.