div-action-scroll-by

Scrolls the container by item_count or offset starting from the current position. If both values are specified, the action will be combined. For scrolling back, use negative values.

Parameters

Parameters Description
id

string

Required parameter.

ID of the element where the action should be performed.

Available platforms: Android.
type

string

Required parameter.

The value must always be scroll_by.

Available platforms: Android.
animated

bool

Enables scrolling animation.

Default value: true.

Available platforms: Android.
item_count

int

Number of container elements to scroll through. For scrolling back, use negative values.

Default value: 0.

Available platforms: Android.
offset

int

Scrolling distance measured in dp from the current position. For scrolling back, use negative values. Only applies in gallery.

Default value: 0.

Available platforms: Android.
overflow

string

Defines navigation behavior at boundary elements:

  • clamp: Stop navigation at the boundary element (default)
  • ring: Navigate to the start or end, depending on the current element.

    • Possible values: clamp, ring.

    Default value: clamp.

    Available platforms: Android.
    JSON 
    {
  type*: "scroll_by",
  animated: "bool",
  id*: "string",
  item_count: "int",
  offset: "int",
  overflow: "string"
}