YaruCarousel class
Display a list of widgets in a carousel view.
It comes with useful features like navigation controls, a default place indicator and auto-scroll (through YaruCarouselController).
See also:
- YaruPageIndicator, a responsive page indicator, used by default in this carousel.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- YaruCarousel
Constructors
-
YaruCarousel({Key? key, double height = 500, double width = 500, YaruCarouselController? controller, required List<
Widget> children, bool placeIndicator = true, double placeIndicatorMarginTop = 12.0, Widget? previousIcon, Widget? nextIcon}) -
Creates a YaruCarousel.
const
Properties
-
children
→ List<
Widget> -
The list of child widgets shown in the carousel.
final
- controller → YaruCarouselController?
-
An optional controller that can be used to enable the auto-scroll behavior.
It can also be used to navigate to a specific page.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- height → double
-
The height of the children, defaults to 500.0.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
Display previous and next navigation buttons.
final
- nextIcon → Widget?
-
Icon used for the next button.
Require navigationControls to be true.
final
- placeIndicator → bool
-
Display a place indicator.
final
- placeIndicatorMarginTop → double
-
Margin between the carousel and the place indicator.
final
- previousIcon → Widget?
-
Icon used for the previous button.
Require navigationControls to be true.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- width → double
-
The width of the children, defaults to 500.0.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< YaruCarousel> -
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