LightCarousel class

main library

Inheritance

Constructors

LightCarousel({Key? key, List? images, Curve animationCurve = Curves.ease, Duration animationDuration = const Duration(milliseconds: 300), double dotSize = 8.0, double dotSpacing = 25.0, double dotIncreaseSize = 2.0, Color dotColor = Colors.white, Color? dotBgColor, Color dotIncreasedColor = Colors.white, bool showIndicator = true, double indicatorBgPadding = 20.0, BoxFit boxFit = BoxFit.cover, bool borderRadius = false, Radius? radius, DotPosition dotPosition = DotPosition.bottomCenter, double dotHorizontalPadding = 0.0, double dotVerticalPadding = 0.0, double moveIndicatorFromBottom = 0.0, bool noRadiusForIndicator = false, bool overlayShadow = false, Color? overlayShadowColors, double overlayShadowSize = 0.5, bool autoPlay = true, Duration autoPlayDuration = const Duration(seconds: 3), void onImageTap(int)?, void onImageChange(int, int)?, dynamic defaultImage})
const

Properties

animationCurve → Curve
Transtition animation timing curver. The default is Curves.ease Watch out! some Curves transition caused stuck failed to animate Do not use Curves.easeInBack and some of unknown animation.
final
animationDuration → Duration
Transmition Duration 300ms is default value
final
autoPlay → bool
Enable/Disable the auto play of the slider. Default true
final
autoPlayDuration → Duration
Duration of the Auto play slider by seconds. Default Duration(seconds: 3)
final
borderRadius → bool
Enable or Disable radius Border for the images. Default is false
final
boxFit → BoxFit
How to show the images in the box. Default is BoxFit.cover
final
defaultImage → dynamic
All Images on this Carousel
final
dotBgColor → Color?
he background Color of the dots. Default is [Colors.grey800.withOpacity(0.5)]
final
dotColor → Color
Color of each DOT Colors.white is default
final
dotHorizontalPadding → double
Move the Indicator Horizontally relative to the dot position
final
dotIncreasedColor → Color
The Color of each increased dot. Default is Colors.white
final
dotIncreaseSize → double
Increase size of the selected DOT default value is 2.0
final
dotPosition → DotPosition
Indicator position. Default DotPosition.bottomCenter
final
dotSize → double
Base dotSize 8.0 is default
final
dotSpacing → double
The distance between each DOT default value is 25.0
final
dotVerticalPadding → double
Move the Indicator Vertically relative to the dot position
final
hashCode → int
The hash code for this object.
no setterinherited
images → List?
All list of images on this Carousel Provide The Image whether it's from Netowrk or local Assets. Implement NetworkImage('imageUrl'), AssetImage('assets/image.png')
final
indicatorBgPadding → double
Padding Size of the background Indicator. Default is 20.0
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
moveIndicatorFromBottom → double
Move the Indicator From the Bottom
final
noRadiusForIndicator → bool
Remove the radius bottom from the indicator background. Default false
final
onImageChange → (void Function(int, int)?)
On image change event, passes previous image index and current image index as arguments
final
onImageTap → (void Function(int)?)
Duration of the Auto play slider by seconds. Default 3 seconds
final
overlayShadow → bool
Enable/Disable Image Overlay Shadow. Default false
final
overlayShadowColors → Color?
Choose the color of the overlay Shadow color. Default [Colors.grey800]
final
overlayShadowSize → double
Choose the size of the Overlay Shadow, from 0.0 to 1.0. Default 0.5
final
radius → Radius?
Border Radius of the images. Default is Radius.circular(8.0)
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showIndicator → bool
The Color of each increased dot. Default is Colors.white
final

Methods

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