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
marginZero → Container

Available on T, provided by the LayoutX extension

no setter
mask → Widget?
mask
final
onChanged → ValueChanged<int>?
final
paddingZero → Padding

Available on T, provided by the LayoutX extension

no setter
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

action({GestureTapCallback? onClick, GestureTapCallback? onDoubleClick, GestureLongPressCallback? onLongPress}) → Material

Available on T, provided by the ActionX extension

aspectRatio(double aspectRatio) → AspectRatio

Available on T, provided by the LayoutX extension

aspect ratio 纵横比
backgroundColor(Color color) → Container

Available on T, provided by the ColorX extension

backgroundColorInt(int color) → Container

Available on T, provided by the ColorX extension

blur() → BlurPanel

Available on T, provided by the BlurEx extension

blurExpanded() → Expanded

Available on T, provided by the BlurEx extension

border({Color color = const Color(0xff95d9f1), double width = 1, double radius = 0}) → Container

Available on T, provided by the BorderX extension

add border
borderIs({Color color = const Color(0xff95d9f1), double width = 1, double radius = 0}) → Container

Available on T, provided by the BorderX extension

add border
circleBorder({Color color = const Color(0xff95d9f1), double width = 1}) → Container

Available on T, provided by the BorderX extension

add Circle border
constraints({double? maxWidth, double? maxHeight, double? minWidth, double? minHeight}) → ConstrainedBox

Available on T, provided by the LayoutX extension

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
expanded() → Expanded

Available on T, provided by the FlexX extension

flexible({int flex = 1, FlexFit fit = FlexFit.loose}) → Flexible

Available on T, provided by the FlexX extension

height(double? height) → SizedBox

Available on T, provided by the LayoutX extension

inList({void onItemClick(BuildContext context, int index)?, Axis scrollDirection = Axis.vertical, bool reverse = false, ScrollController? controller, bool? primary, ScrollPhysics? physics, bool shrinkWrap = false, EdgeInsetsGeometry? padding, double? itemExtent, Widget? prototypeItem, int? itemCount, bool addAutomaticKeepAlives = true, bool addRepaintBoundaries = true, bool addSemanticIndexes = true, double? cacheExtent, int? semanticChildCount, DragStartBehavior dragStartBehavior = DragStartBehavior.start, ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual, String? restorationId, Clip clipBehavior = Clip.hardEdge}) → ListView

Available on T, provided by the LayoutX extension

todo 固定行为 的头部或尾部 todo align相关
inSliverList({void onItemClick(BuildContext context, int index)?, int? findChildIndexCallback(Key)?, int? childCount, bool addAutomaticKeepAlives = true, bool addRepaintBoundaries = true, bool addSemanticIndexes = true, int semanticIndexOffset = 0}) → SliverList

Available on T, provided by the LayoutX extension

linearGradientColor(List<Color> colors, {AlignmentGeometry begin = Alignment.centerLeft, AlignmentGeometry end = Alignment.centerRight}) → Container

Available on T, provided by the ColorX extension

margin({double left = 0, double top = 0, double right = 0, double bottom = 0}) → Container

Available on T, provided by the LayoutX extension

marginAll(double size) → Container

Available on T, provided by the LayoutX extension

marginBottom(double size) → Container

Available on T, provided by the LayoutX extension

marginIs({double left = 0, double top = 0, double right = 0, double bottom = 0}) → Container

Available on T, provided by the LayoutX extension

marginLeft(double size) → Container

Available on T, provided by the LayoutX extension

marginRight(double size) → Container

Available on T, provided by the LayoutX extension

marginSymmetric({double horizontal = 0, double vertical = 0}) → Container

Available on T, provided by the LayoutX extension

marginTop(double size) → Container

Available on T, provided by the LayoutX extension

mask(Widget maskWidget) → Stack

Available on T, provided by the MaskX extension

maxHeight(double? size) → ConstrainedBox

Available on T, provided by the LayoutX extension

maxWidth(double? size) → ConstrainedBox

Available on T, provided by the LayoutX extension

minHeight(double? size) → ConstrainedBox

Available on T, provided by the LayoutX extension

minWidth(double? size) → ConstrainedBox

Available on T, provided by the LayoutX extension

multiShadow(List<BoxShadow> shadows, {Color color = Colors.black12, double borderRadius = 0}) → Container

Available on T, provided by the ShadowX extension

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onClick(GestureTapCallback? onClick) → Material

Available on T, provided by the ActionX extension

onDoubleClick(GestureTapCallback? onDoubleClick) → Material

Available on T, provided by the ActionX extension

onLongPress(GestureLongPressCallback? onLongPress) → Material

Available on T, provided by the ActionX extension

padding({double left = 0, double top = 0, double right = 0, double bottom = 0}) → Padding

Available on T, provided by the LayoutX extension

paddingAll(double size) → Padding

Available on T, provided by the LayoutX extension

paddingBottom(double size) → Padding

Available on T, provided by the LayoutX extension

paddingIs({double left = 0, double top = 0, double right = 0, double bottom = 0}) → Padding

Available on T, provided by the LayoutX extension

paddingLeft(double size) → Padding

Available on T, provided by the LayoutX extension

paddingOnly({double left = 0, double top = 0, double right = 0, double bottom = 0}) → Padding

Available on T, provided by the LayoutX extension

paddingRight(double size) → Padding

Available on T, provided by the LayoutX extension

paddingSymmetric({double horizontal = 0, double vertical = 0}) → Padding

Available on T, provided by the LayoutX extension

paddingTop(double size) → Padding

Available on T, provided by the LayoutX extension

positioned({double? left, double? right, double? top, double? bottom, double? width, double? height}) → Positioned

Available on T, provided by the LayoutX extension

relation(double offsetX, double offsetY, List<Widget> widgets) → dynamic

Available on T, provided by the RelationX extension

relationOne(double offsetX, double offsetY, Widget widget) → dynamic

Available on T, provided by the RelationX extension

repeat(int number, {Axis direction = Axis.vertical}) → SingleChildScrollView

Available on T, provided by the CollectionX extension

rotate(double angle) → Transform

Available on T, provided by the LayoutX extension

roundedRect(double radius) → ClipRRect

Available on T, provided by the RRectX extension

通用圆角，但不适用于有阴影等效果的微件
roundedRectHorizontal(double left, double right) → ClipRRect

Available on T, provided by the RRectX extension

通用圆角，但不适用于有阴影等效果的微件
roundedRectVertical(double top, double bottom) → ClipRRect

Available on T, provided by the RRectX extension

通用圆角，但不适用于有阴影等效果的微件
scale(double scale) → Transform

Available on T, provided by the LayoutX extension

scrollable({Axis direction = Axis.vertical}) → SingleChildScrollView

Available on T, provided by the ScrollableX extension

shadowIs({Color color = Colors.black12, double borderRadius = 0, double blurRadius = 15, double spreadRadius = 1, Offset offset = const Offset(4.0, 8.0)}) → Container

Available on T, provided by the ShadowX extension

size({double? width, double? height}) → SizedBox

Available on T, provided by the LayoutX extension

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
translate(double dx, double dy) → Transform

Available on T, provided by the LayoutX extension

width(double? width) → SizedBox

Available on T, provided by the LayoutX extension

Operators

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