Swiper class

A scrollable list that works page by page automatically or manually, and it also support loop playbacks.

See also:

Inheritance
Available extensions

Constructors

Swiper({Key? key, Axis direction = Axis.horizontal, bool autoStart = true, SwiperController? controller, Widget? mask, SwiperIndicator? indicator, int speed = 300, Duration interval = const Duration(seconds: 3), bool circular = true, bool reverse = false, AlignmentDirectional indicatorAlignment = AlignmentDirectional.bottomCenter, double viewportFraction = 1.0, ValueChanged<int>? onChanged, required List<Widget>? children})
Swiper.builder({Key? key, Axis direction = Axis.horizontal, required int childCount, required IndexedWidgetBuilder itemBuilder, bool autoStart = true, SwiperController? controller, Widget? mask, SwiperIndicator? indicator, int speed = 300, Duration interval = const Duration(seconds: 3), bool circular = true, bool reverse = false, AlignmentDirectional indicatorAlignment = AlignmentDirectional.bottomCenter, double viewportFraction = 1.0, ValueChanged<int>? onChanged})
const

Properties

autoStart bool
Whether the swiper start switching when it is built.
final
childCount int
The real total number of children, at least 1 .
final
children List<Widget>?
final
circular bool
Determine whether the swiper can continue to switch along the direction When the swiper at start or end page.
final
controller SwiperController?
An object that can be used to control the position to which this swiper is scrolled.
final
direction Axis
The axis along which the swiper scrolls.
final
hashCode int
The hash code for this object.
no setterinherited
indicator SwiperIndicator?
Swiper page indicator
final
indicatorAlignment AlignmentDirectional
The alignment of swiper indicator in swiper
final
interval Duration
Switching interval between two pages.
final
itemBuilder IndexedWidgetBuilder
Called to build children for the swiper.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
mask Widget?
mask
final
onChanged ValueChanged<int>?
final
reverse bool
Whether the swiper scrolls in the reading direction.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
speed int
Page switching speed
final
viewportFraction double
The fraction of the viewport that each page should occupy.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _SwiperState
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}) 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