UIPageLayout

Show Deprecated

Creates a paged viewing window, like the home screen of a mobile device. You can use a UIPageLayout by parenting it to a GuiObject. The UIPageLayout will then apply itself to all of its GuiObject siblings.

Summary

Properties

Whether or not to animate transitions between pages.

Whether or not the page layout wraps around at the ends.

The page that is either currently being displayed or is the target of the current animation.

READ ONLY
NOT REPLICATED

The easing direction to use when performing an animation.

The easing style to use when performing an animation.

Controls the overrides of NextSelection{Up, Down, Left, Right}. Defaults to true.

Determines the amount that pages are separated from each other by.

Controls the use of scroll wheel, in case that it is intended for something else. Defaults to true.

Controls touch scrolling, in case this is a non-interactive layout. Defaults to true.

The length of the animation.

Events


Fires when a page comes into view, and is going to be rendered.


Fires when a page leaves view, and will not be rendered.

Stopped(currentPage: Instance): RBXScriptSignal  

Fires when an animation to UIPageLayout.CurrentPage is completed without being canceled, and the view stops scrolling.

Methods

JumpTo(page: Instance): void  

If the page is in the UIPageLayout, then it sets UIPageLayout.CurrentPage to it and animates to it. If the circular layout is enabled, it will take the shortest path to this page.

JumpToIndex(index: number): void  

If the index is >= 0 and less than the size of the layout, this method acts like UIPageLayout:JumpTo(). If it's out of bounds and circular is set, it will animate the full distance between the in-bounds index of UIPageLayout.CurrentPage and the new index.

Next(): void  

Sets UIPageLayout.CurrentPage to the page after the current page and animates to it, or does nothing if there isn't a next page.

Previous(): void  

Sets UIPageLayout.CurrentPage to the page before the current page and animates to it, or does nothing if there isn't a previous page.

Properties

Animated

Whether or not to animate transitions between pages.

Circular

Whether or not the page layout wraps around at the ends.

CurrentPage

Read Only
Not Replicated

The page that is either currently being displayed or is the target of the current animation.

EasingDirection

The easing direction to use when performing an animation.

EasingStyle

The easing style to use when performing an animation.

GamepadInputEnabled

Controls the overrides of NextSelection{Up,Down,Left,Right}. Defaults to true.

Padding

Determines the amount that pages are separated from each other by. Can be set either using scale (Percentage of parent's size in the current direction) or offset (a static spacing value, similar to pixel size).

ScrollWheelInputEnabled

Controls the use of scroll wheel, in case that it is intended for something else. Defaults to true.

TouchInputEnabled

Controls touch scrolling, in case this is a non-interactive layout. Defaults to true.

TweenTime

The length of the animation.

Events

PageEnter

Fires when a page comes into view, and is going to be rendered.

Parameters

page: Instance

PageLeave

Fires when a page leaves view, and will not be rendered.

Parameters

page: Instance

Stopped

Fires when an animation to UIPageLayout.CurrentPage is completed without being canceled, and the view stops scrolling.

Parameters

currentPage: Instance

Methods

JumpTo

void

If the page is in the UIPageLayout, then it sets UIPageLayout.CurrentPage to it and animates to it. If the circular layout is enabled, it will take the shortest path to this page.

Parameters

page: Instance

Returns

void

JumpToIndex

void

If the index is >= 0 and less than the size of the layout, this method acts like UIPageLayout:JumpTo(). If it's out of bounds and circular is set, it will animate the full distance between the in-bounds index of UIPageLayout.CurrentPage and the new index.

Parameters

index: number

Returns

void

Next

void

Sets UIPageLayout.CurrentPage to the page after the current page and animates to it, or does nothing if there isn't a next page.


Returns

void

Previous

void

Sets UIPageLayout.CurrentPage to the page before the current page and animates to it, or does nothing if there isn't a previous page.


Returns

void