API Referenceclass

class UIScrollView

A view class that represents a container element that allows users to scroll, emitting asynchronous scroll events.

class UIScrollView extends UIContainer;

Description

A scroll view functions like a regular container element, but allows users to scroll horizontally and/or vertically.

Type members

• type UIScrollView.ScrollEvent static
  Type definition for an event that’s emitted when the user scrolls up, down, left, or right in a UIScrollView.
• type UIScrollView.ScrollEventData static
  The data structure contained by each UIScrollView.ScrollEvent.
• class ScrollViewBuilder static
  A builder for UIScrollView instances.

Instance members

• topThreshold
  Vertical threshold (in pixels) until which UIScrollEvent.atTop is set, defaults to 0.
• bottomThreshold
  Vertical threshold (in pixels) until which UIScrollEvent.atBottom is set, defaults to 0.
• horizontalThreshold
  Horizontal threshold (in pixels) until which UIScrollEvent.atHorizontalStart or UIScrollEvent.atHorizontalEnd is set, defaults to 0.
• verticalScroll
  True if vertical scrolling should be enabled if necessary, defaults to true.
• horizontalScroll
  True if horizontal scrolling should be enabled if necessary, defaults to true.
• restoreScrollKey
  Key for persisting scroll position, to restore across navigation.
• scrollTo()
  Scrolls to the specified pair of vertical and horizontal offset values.
• scrollToTop()
  Scroll to the top of the scrollable content, if possible.
• scrollToBottom()
  Scroll to the bottom of the scrollable content, if possible.

Inherited members

• layout
  Options related to layout of content UI elements within this container.
• allowFocus
  True if this container may receive direct input focus.
• allowKeyboardFocus
  True if this container may receive input focus using the keyboard (e.g. Tab key).
• trackHover
  True if hover state should be tracked for this container.
• reverse
  True if content should be displayed in reverse order.
• gap
  Gap between UI elements, in pixels or CSS length with unit.
• isHovered()
  Returns true if this container is currently hovered by the mouse.
• content readonly
  The list of all (attached) content view objects.
• findViewContent()
  Implementation of View.findViewContent() that searches within this container.
• 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.
• 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.