React TreeList - scrolling

Configures scrolling.

Type:

Object

Scrolling allows a user to browse data left outside the current viewport. The widget provides several scrolling modes detailed in the mode option description.

See Also

mode

Specifies the scrolling mode.

Type:

String

Default Value: 'virtual'
Accepted Values: 'standard' | 'virtual'

The following scrolling modes are available in the widget:

  • Standard
    All rows are loaded at once. Scrolling appears only if the widget height cannot fit all rows.

  • Virtual
    Rows are loaded when they get into the viewport and removed once they leave it. Use this mode if a user should be able to scroll data jumping from one row to another.

When using the widget as an ASP.NET MVC Control, specify this option using the TreeListScrollingMode enum. This enum accepts the following values: Standard and Virtual.

preloadEnabled

Specifies whether the widget should load pages adjacent to the current page. Applies only if scrolling.mode is "virtual".

Type:

Boolean

Default Value: false

In virtual scrolling mode, a page is loaded when it gets into the viewport. If you set this option to true, adjacent pages will be loaded as well. Note that although this setting makes scrolling smoother, it may cause lags on devices with low performance.

scrollByContent

Specifies whether a user can scroll the content with a swipe gesture. Applies only if useNative is false.

Type:

Boolean

Default Value: true

scrollByThumb

Specifies whether a user can scroll the content with the scrollbar. Applies only if useNative is false.

Type:

Boolean

Default Value: false

showScrollbar

Specifies when to show scrollbars. Applies only if useNative is false.

Type:

String

Default Value: 'onScroll'
Accepted Values: 'always' | 'never' | 'onHover' | 'onScroll'

The scrollbars help to scroll the content vertically and horizontally. Vertical scrolling is available when all the rows do not fit in the widget's height. Horizontal scrolling is available when all the columns do not fit in the widget's width, which can happen when columns have fixed widths or the columnAutoWidth option is set to true.

When using the widget as an ASP.NET MVC Control, specify this option using the ShowScrollbarMode enum. This enum accepts the following values: OnScroll, OnHover, Always and Never.

useNative

Specifies whether the widget should use native or simulated scrolling.

Type:

String

|

Boolean

Default Value: 'auto'

By default, the widget employs native scrolling on most platforms, except non-Mac desktops and devices based on Android older than version 4. To employ native scrolling on all platforms without exception, assign true to this option. If you assign false, the widget simulates scrolling on all platforms.