MarginPageTransformer

class MarginPageTransformer : ViewPager2.PageTransformer

Adds space between pages via the ViewPager2.PageTransformer API.

Internally relies on setTranslationX and setTranslationY.

Note: translations on pages are not reset when this adapter is changed for another one, so you might want to set them manually to 0 when dynamically switching to another transformer, or when switching ViewPager2 orientation.

See also
setPageTransformer
CompositePageTransformer

Summary

Public constructors

Creates a MarginPageTransformer.

Public functions
Unit
transformPage(page: View, position: Float)

Apply a property transformation to the given page.

Public constructors

MarginPageTransformer

Added in 1.0.0
MarginPageTransformer(marginPx: @Px Int)

Creates a MarginPageTransformer.

Parameters
marginPx: @Px Int

non-negative margin

Public functions

transformPage

Added in 1.1.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.
See also
setOffscreenPageLimit