This plugin is suitable for situations when objects are too big to get into allocated space. For example, if you need to place a large amount of text on one page. To do so, you can create an object called scrolling with proper sizes and add big text inside it - so this text can be scrolled and you can read all of it, this action takes place within the designated area of the screen.

Plugin settings:

Name Description
Object size Size of the content's visible area.
Content size The size of the inner content area, within which all inserted in objects must be located without cutting their edges.
Automatic scrolling This setting is responsible for possibility to scroll object by simple scroll gesture (drag and drop). If this flag is removed, the object does not respond to gestures. It may be necessary in order to create scrolling using buttons or animations or custom area.

In addition to basic settings plugin has two sets of parameters - "vertical scrolling" and "horizontal scrolling", which become available when the content is larger than object on the respective axis.

Set of group "scrolling" settings:

Name Description
Progress Setting is responsible for current progress of the scrolling on respective axis. Value from 0% to 100%. You can animate it, create dependence on it and use it as condition in triggers.
Inertia This setting is responsible for smooth scrolling of the content when user already stops scrolling. Value from 0% to 99.99%, where 0% – no scrolling, and 99.99% – almost infinite scrolling. Default value – 75%.
Pulling effect This setting is responsible for possibility to "pull" content outside the visible area. Value from 0% to 100%, where 0 – no pulling, and 100% is half of the size of the visible area on respecitve axis. Default value – 75%.
Pulling duration This setting determines the time period in milliseconds after which the scrolling returns to its "normal" (inside the visible area) position if user drops the content pulled after scrolling. This option is available only if "pulling effect" is greater than 0%.
Pulling Easing-function This setting determines the easing-function to smooth returning animation. Default value – "Quad - Out".

Additional interaction

This plugin has its own kind of user interaction called "scrolling". This interaction controls area on the screen, where object responds to user's actions. The interaction allows to manage only area, which consists of standart settings: state, position and size of the area.

Plugin triggers:

Name Description
Start scrolling This event triggers at the moment when user presses mouse button (or taps the screen) and begins to scroll object. This event happens only if automatic scrolling is active or custom scrolling area is created.
Scrolling This event triggers constantly while user scrolls object. This event happens only if automatic scrolling is active or custom scrolling area is created.
Stop This event triggers at the moment when user releases the mouse button (or removes finger from the screen) and object stops scrolling. This event happens only if automatic scrolling is active, or custom scrolling area is created.