Skip to main content

Scrollview

The scrollview component defines a scrollable area in the user interface. The scrollview can be scrolled through scrollbar components.

For more details, see the User Interface section.

Scrollview Component

Component Properties

PropertyDescription
Scroll ModeSpecifies how the scroll view should behave when the user scrolls past the end of the content. Modes are defined as follows:
  • Clamp: Content does not scroll beyond the boundaries.
  • Bounce: Content scrolls beyond the boundaries and then smoothly returns.
  • Infinite: Content can scroll infinitely.
BounceControls how far the content must move before it returns.
FrictionControls how freely the content should move when thrown, i.e., when flicking on mobile or throwing the mouse scroll wheel. A value of 1 means the content stops immediately, and 0 means the content continues moving forever (or until it reaches the content's boundaries, depending on the scroll mode).
Use Mouse WheelWhether to use the mouse wheel for scrolling when the mouse is within the boundaries.
Mouse Wheel SensitivityThe horizontal and vertical sensitivity of the mouse wheel. Only used when Use Mouse Wheel is set. Setting a direction to 0 disables mouse wheel scrolling in that direction. 1 is considered a good default sensitivity. You can set values higher or lower than 1 to adjust the sensitivity. The default value is [1, 1].
ViewportThe entity to be used as the masked viewport area where content is scrolled. This entity must have an ElementGroup component.
ContentThe entity containing the scrollable content itself. This entity must have an Element component.
HorizontalWhether to enable horizontal scrolling.
Scrollbar (horizontal)The entity to be used as the horizontal scrollbar. This entity must have a Scrollbar component.
Visibility (horizontal)Controls whether the horizontal scrollbar should always be visible or only when the content exceeds the viewport size.
VerticalWhether to enable vertical scrolling.
Scrollbar (vertical)The entity to be used as the vertical scrollbar. This entity must have a Scrollbar component.
Visibility (vertical)Controls whether the vertical scrollbar should always be visible or only when the content exceeds the viewport size.