PageView class - widgets library

A scrollable list that works page by page.

Each child of a page view is forced to be the same size as the viewport.

You can use a PageController to control which page is visible in the view. In addition to being able to control the pixel offset of the content inside the PageView, a PageController also lets you control the offset in terms of pages, which are increments of the viewport size.

The PageController can also be used to control the PageController.initialPage, which determines which page is shown when the PageView is first constructed, and the PageController.viewportFraction, which determines the size of the pages as a fraction of the viewport size.

Here is an example of PageView. It creates a centered Text in each of the three pages which scroll horizontally.

link

To create a local project with this code sample, run:
flutter create --sample=widgets.PageView.1 mysample

Scroll views attempt to persist their scroll position using PageStorage. For a PageView, this can be disabled by setting PageController.keepPage to false on the controller. If it is enabled, using a PageStorageKey for the key of this widget is recommended to help disambiguate different scroll views from each other.

Constructors

PageView({Key? key, Axis scrollDirection = Axis.horizontal, bool reverse = false, PageController? controller, ScrollPhysics? physics, bool pageSnapping = true, ValueChanged<int>? onPageChanged, List<Widget> children = const <Widget>[], DragStartBehavior dragStartBehavior = DragStartBehavior.start, bool allowImplicitScrolling = false, String? restorationId, Clip clipBehavior = Clip.hardEdge, HitTestBehavior hitTestBehavior = HitTestBehavior.opaque, ScrollBehavior? scrollBehavior, bool padEnds = true}): Creates a scrollable list that works page by page from an explicit List of widgets.
PageView.builder({Key? key, Axis scrollDirection = Axis.horizontal, bool reverse = false, PageController? controller, ScrollPhysics? physics, bool pageSnapping = true, ValueChanged<int>? onPageChanged, required NullableIndexedWidgetBuilder itemBuilder, ChildIndexGetter? findChildIndexCallback, int? itemCount, DragStartBehavior dragStartBehavior = DragStartBehavior.start, bool allowImplicitScrolling = false, String? restorationId, Clip clipBehavior = Clip.hardEdge, HitTestBehavior hitTestBehavior = HitTestBehavior.opaque, ScrollBehavior? scrollBehavior, bool padEnds = true}): Creates a scrollable list that works page by page using widgets that are created on demand.
PageView.custom({Key? key, Axis scrollDirection = Axis.horizontal, bool reverse = false, PageController? controller, ScrollPhysics? physics, bool pageSnapping = true, ValueChanged<int>? onPageChanged, required SliverChildDelegate childrenDelegate, DragStartBehavior dragStartBehavior = DragStartBehavior.start, bool allowImplicitScrolling = false, String? restorationId, Clip clipBehavior = Clip.hardEdge, HitTestBehavior hitTestBehavior = HitTestBehavior.opaque, ScrollBehavior? scrollBehavior, bool padEnds = true}): Creates a scrollable list that works page by page with a custom child model.
const

Properties

allowImplicitScrolling → bool: Controls whether the widget's pages will respond to RenderObject.showOnScreen, which will allow for implicit accessibility scrolling.
final
childrenDelegate → SliverChildDelegate: A delegate that provides the children for the PageView.
final
clipBehavior → Clip: The content will be clipped (or not) according to this option.
final
controller → PageController?: An object that can be used to control the position to which this page view is scrolled.
final
dragStartBehavior → DragStartBehavior: Determines the way that drag start behavior is handled.
final
hashCode → int: The hash code for this object.
no setterinherited
hitTestBehavior → HitTestBehavior: Defines the behavior of gesture detector used in this Scrollable.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
onPageChanged → ValueChanged<int>?: Called whenever the page in the center of the viewport changes.
final
padEnds → bool: Whether to add padding to both ends of the list.
final
pageSnapping → bool: Set to false to disable page snapping, useful for custom scroll behavior.
final
physics → ScrollPhysics?: How the page view should respond to user input.
final
restorationId → String?: Restoration ID to save and restore the scroll offset of the scrollable.
final
reverse → bool: Whether the page view scrolls in the reading direction.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
scrollBehavior → ScrollBehavior?: A ScrollBehavior that will be applied to this widget individually.
final
scrollDirection → Axis: The Axis along which the scroll view's offset increases with each page.
final

Methods

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<PageView>: Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>: Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void: Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode: Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String: A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String: Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String: Returns a one-line detailed description of the object.
inherited
toStringShort() → String: A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited