liquid_swipe 2.1.0
liquid_swipe: ^2.1.0 copied to clipboard

A Flutter plugin to implement liquid Swipe effect to provided widgets.


Liquid Swipe

Pub Awesome Flutter

This repository contains the Liquid Swipe Flutter source code. Liquid swipe is the revealing clipper to bring off amazing liquid like swipe to stacked Container/Widgets and inspired by Cuberto's liquid swipe and IntroViews.

Table of contents #

Getting Started #

  • Add this to your pubspec.yaml

    dependencies:
    liquid_swipe: ^2.0.2
    
    
  • Get the package from Pub:

    flutter packages get
    
  • Import it in your file

    import 'package:liquid_swipe/liquid_swipe.dart';
    

Usage #

  • Liquid Swipe just requires the list of Widgets like Container. Just to provide flexibity to the developer to design its own UI through it.
 final pages = [
    Container(...),
    Container(...),
    Container(...),
  ];
  • Now just pass these pages to LiquidSwipe widget.
  @override
  Widget build(BuildContext context) {
    return new MaterialApp(
      home: Builder(
          builder: (context) =>
              LiquidSwipe(
                  pages: pages
              )),
    );
  }

Migration #

Some things to keep in mind while updating to v2.0.0 from any version.

  • v2.0.0 is migrated to null safety. See migration
  • Attribute enableSlideIcon is removed from LiquidSwipe. You can simply pass null to slideIconWidget to enable and disable it.
  • Attribute positionSlideIcon is now ranged from 0.0 to 1.0.
  • Next Reveal is there by default. If you want to disable it you might want to make changes in your fork. Create an issue I will help.

That's it ;)

Sample APK #

Please download apk from Releases or Assets folder

Documentation #

LiquidSwipe #

Please Refer to API documentation for more details.

PropertyTypeDescriptionDefault Value
pagesList<Widget>Set Pages/Views/Containers. See complete example for usage.@required value
fullTransitionValuedoubleHandle swipe sensitivity through it. Lower the value faster the animation400.0
initialPageintSet initial page value, wrong position will throw exception.0
slideIconWidgetWidgetIcon/Widget you want to display for swipe indication. Remember the curve will be created according to it.null
positionSlideIcondoubleIcon position on vertical axis. Must satisfy this condition 0.0 <= value <= 1.00.8
enableLoopboolWhether you want to loop through all those pages.true
liquidControllerLiquidControllerController to handle some runtime changes. Refernull
waveTypeWaveType enumType of clipper you want to use.WaveType.liquidReveal
onPageChangeCallbackCallbackTriggered whenever page changes.null
currentUpdateTypeCallbackCallbackTriggered whenever UpdateType changes. Refernull
slidePercentCallbackCallbackTriggered on Swipe animation. Use carefully as its quite frequent on swipe.null
ignoreUserGestureWhileAnimatingboolIf you want to block gestures while swipe is still animating. See #5false
disableUserGestureboolDisable user gesture, always.false
enableSideRevealboolEnable/Disable side revealfalse

LiquidController #

A Controller class with some utility fields and methods.

Simple Usage :

Firstly make an Object of LiquidController and initialize it in initState()

   LiquidController liquidController;

   @override
   void initState() {
   super.initState();
   liquidController = LiquidController();
   }

Now simply add it to LiquidSwipe's Constructor

   LiquidSwipe(
        pages: pages,
        LiquidController: liquidController,
    ),

Only Rules/Limitation to its Usage is, you can't use any method in Liquid Controller before build method is being called in which LiquidSwipe is initialized. So we have to use them after LiquidSwipe is Built

  • Properties
    • currentPage - Getter to get current Page. Default value is 0.
    • isUserGestureDisabled - If somehow you want to check if gestures are disabled or not. Default value is false;
  • Methods
    • animateToPage({required int page, int duration = 600}) Animate to mentioned page within given Duration Remember the duration here is the total duration in which it will animate though all pages not the single page.
    • jumpToPage({required int page}) Jump Directly to mentioned Page index but without Animation.
    • shouldDisableGestures({required bool disable}) Use this method to disable gestures during runtime, like on certain pages using OnPageChangeCallback.

Please Refer to API documentation for more details.

Credits #

Disclaimer : This project is not anyhow connected to Cuberto, but have apprised them through this issue. #

Author & support #

This project is created by Sahdeep Singh but with lots of support and help. See credits.

If you appreciate my work, consider buying me a cup of ☕ to keep me recharged 🤘

Or you can also connect/endorse me on LinkedIn to keep me motivated.

Contributors ✨ #

Thanks goes to these wonderful people (emoji key):


Sahdeep Singh

💻

Yasser Omar Jammeli

💻 🐛

Mourad Brahim

💻

heshesh2010

🐛 📓

Federico Tarascio

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

386
likes
130
pub points
97%
popularity

Publisher

sahdeepsingh.com

A Flutter plugin to implement liquid Swipe effect to provided widgets.

Repository (GitHub)
View/report issues

Documentation

API reference

License

Apache 2.0 (LICENSE)

Dependencies

flutter, provider

More

Packages that depend on liquid_swipe