PageView class

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.

See also:

Inheritance

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 [] })
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 IndexedWidgetBuilder itemBuilder, int itemCount })
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 })
Creates a scrollable list that works page by page with a custom child model.

Properties

childrenDelegate → SliverChildDelegate
A delegate that provides the children for the PageView. [...]
final
controller → PageController
An object that can be used to control the position to which this page view is scrolled.
final
onPageChanged → ValueChanged<int>
Called whenever the page in the center of the viewport changes.
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
reverse → bool
Whether the page view scrolls in the reading direction. [...]
final
scrollDirection → Axis
The axis along which the page view scrolls. [...]
final
hashCode → int
The hash code for this object. [...]
read-only, inherited
key → Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

createState() → _PageViewState
Creates the mutable state for this widget at a given location in the tree. [...]
override
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree. [...]
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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 toStringDeep. [...]
inherited
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String
Returns a string representation of this object.
inherited
toStringDeep({String prefixLineOne: '', String prefixOtherLines, DiagnosticLevel minLevel: DiagnosticLevel.debug }) → 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 ==(dynamic other) → bool
The equality operator. [...]
inherited