LiquidProvider class

Internal Class

A ChangeNotifierProvider to manage LiquidSwipe State. Every Change is notified from it. Methods Included :

Inheritance

Constructors

LiquidProvider({required int initialPage, required bool loop, required int length, required TickerProviderStateMixin<StatefulWidget> vsync, required double slideIcon, required OnPageChangeCallback? onPageChangeCallback, required CurrentUpdateTypeCallback? currentUpdateTypeCallback, required SlidePercentCallback? slidePercentCallback, required bool disableGesture, required bool enableSideReveal})
Constructor Contains Default value or Developer desired Values initialPage - Initial Page of the LiquidSwipe (0 - n) loop - Should Enable Loop between Pages length - Total Number of Pages

Properties

activePageIndex ↔ int
Storing ActivePage Index default = 0
read / write
animatedPageDragger ↔ AnimatedPageDragger
AnimatedPageDragger required for completing the animation when UpdateType is UpdateType.doneAnimating
read / write
enableLoop ↔ bool
user manageable bool to make Enable and Disable loop within the Pages
read / write
enableSideReveal ↔ bool
read / write
hashCode → int
The hash code for this object.
read-onlyinherited
hasListeners → bool
Whether any listeners are currently registered.
read-onlyinherited
iconSize ↔ Size
read / write
isAnimating ↔ bool
Getter for _isAnimating
read / write
isInProgress ↔ bool
bool variable to set if Liquid Swipe is currently in Progress
read / write
isUserGestureDisabled → bool
Setter for isUserGestureDisabled
read-only
nextPageIndex ↔ int
Storing next Page Index default = 0
read / write
pagesLength ↔ int
Number of Page.
read / write
positionSlideIcon ↔ double
SlideIcon position, always Horizontal, used in PageDragger
read / write
prevUpdate ↔ UpdateType?
Storing Previous UpdateType
read / write
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
setUserGesture ← bool
Setter for isUserGestureDisabled
write-only
shouldDisableUserGesture ↔ bool
A user handled value if user want, just only to use programmatic pages changes default = false
read / write
singleTickerProviderStateMixin ↔ TickerProviderStateMixin<StatefulWidget>
Ticker Provider from LiquidSwipe, cause need to use it in AnimatedPageDragger
read / write
slideDirection ↔ SlideDirection
Storing the Swipe Direction using SlideDirection
read / write
slidePercentHor ↔ double
percentage of slide both Horizontal and Vertical, during touch
read / write
slidePercentVer ↔ double
read / write
slideUpdate ↔ SlideUpdate?
A SlideUpdate type for storing the current Slide Update.
read / write

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
animateToPage(int page, int duration) → dynamic
Animating page to the mentioned page
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
override
jumpToPage(int page) → dynamic
Directly Jump to the mentioned page without any animation
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
setIconSize(Size size) → dynamic
Method to set iconSize
toString() → String
A string representation of this object.
inherited
updateData(SlideUpdate event) → dynamic
updating data using SlideUpdate, generally we are handling and managing the Animation UpdateType in this methods, All callbacks and factors are also managed by this method.
updateSlide(SlideUpdate slidUpdate) → dynamic
Method to update the slideUpdate and it directly calls updateData

Operators

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