ViewPager2.PageTransformer

interface ViewPager2.PageTransformer

Known direct subclasses
CompositePageTransformer

Allows for combining multiple PageTransformer objects.

MarginPageTransformer

Adds space between pages via the ViewPager2.PageTransformer API.


A PageTransformer is invoked whenever a visible/attached page is scrolled. This offers an opportunity for the application to apply a custom transformation to the page views using animation properties.

Summary

Public functions

Unit
transformPage(page: View, position: Float)

Apply a property transformation to the given page.

Public functions

transformPage

Added in 1.0.0
fun transformPage(page: View, position: Float): Unit

Apply a property transformation to the given page.

Parameters
page: View

Apply the transformation to this page

position: Float

Position of page relative to the current front-and-center position of the pager. 0 is front and center. 1 is one full page position to the right, and -2 is two pages to the left. Minimum / maximum observed values depend on how many pages we keep attached, which depends on offscreenPageLimit.