Carousel class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- Carousel
Constructors
-
Carousel({Key? key, required Widget itemBuilder(BuildContext context, int index), required int itemCount, CarouselController? controller, double minScale = 0.64, ValueChanged<
int> ? onPageChanged, bool isInfinite = false, bool parallaxEffect = false, Curve curve = Curves.ease, double viewportFraction = 1.0, Axis scrollDirection = Axis.horizontal, ScrollPhysics? physics = const BouncingScrollPhysics(), bool reverse = false, bool pageSnapping = true, DragStartBehavior dragStartBehavior = DragStartBehavior.start, bool allowImplicitScrolling = false, String? restorationId, Clip clipBehavior = Clip.none, ScrollBehavior? scrollBehavior, int initialPage = 0})
Properties
- allowImplicitScrolling → bool
-
Controls whether the widget's pages will respond to
RenderObject.showOnScreen, which will allow for implicit accessibility
scrolling.
final
- clipBehavior → Clip
-
The content will be clipped (or not) according to this option.
final
- controller → CarouselController
-
An object that can be used to control the position to which this page
view is scrolled.
final
- curve → Curve
-
final
- dragStartBehavior → DragStartBehavior
-
Determines the way that drag start behavior is handled.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- initialPage → int
-
final
- isInfinite → bool
-
final
- itemBuilder → Widget Function(BuildContext context, int index)
-
final
- itemCount → int
-
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- minScale → double
-
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
- parallaxEffect → bool
-
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?
-
ScrollBehaviors also provide ScrollPhysics. If an explicit
ScrollPhysics is provided in physics, it will take precedence,
followed by scrollBehavior, and then the inherited ancestor
ScrollBehavior.
final
- scrollDirection → Axis
-
The axis along which the page view scrolls.
final
- viewportFraction → double
-
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _CarouselState -
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