Logo Liquid Swipe

Pub Awesome Flutter

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

Sample APK

Download sample apk as shown in example from releases.

Get it from Github Releases

Getting Started

  • Add this to your pubspec.yaml

    dependencies:
    liquid_swipe: ^1.3.0
    
    
  • 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 containers. Just to provide flexibity to the developer to design its own view 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
              )),
    );
  }

Attributes

AttributeDatatypeDescriptionDefault ValueComments
pagesList<Container>Set the Pages/ views/ ContainersNullA Page can contain anything, look for an example
fullTransitionValuedoubleSets the scroll distance or sensitivity for a complete swipe.400.0This transition value can be used to increase or decrease the sensitivity of the swipe. 100.0 would make swipe really fast with even a bit of drag
initialPageintSet the initial Page0Should not be >= no.of pages or smaller than 0
enableSlideIconboolUsed to enable Slide icon to the right for where the wave would originatefalseGives a ios style arrow to right side of the screen. Might include modification to it soon.
slideIconWidgetWidgetCreate your own icon and add hereIcon(Icons.arrow_back_ios)You can use icons from Icons package. Thanks to PR #10
positionSlideIcondoublePosition your icon in y-axis at right side of the screen0.54Range from -1 to 1, -1 represents extreme top and 1 represent extreme bottom. Soon add x-axis position, if required!
enableLoopboolEnable or disable pages recurrence.trueIf you dont want to make pages to be in the loop, use this attribute.
waveTypeWaveTypeSelect the type of reveal you want.WaveType.liquidRevealYou can use circularReveal, more coming soon. Import Helpers.dart file if Autoimport doesn't work.
onPageChangeCallbackCallBackPass your method as a callback, it will return a pageNo.Nonesee Example
currentUpdateTypeCallbackCallBacksame Callback but returns an UpdateTypeNonesee Example

Contributors

Thanks to all these wonderful people and everyone that created issues. (emoji key):

mourad-brahim
Mourad

💻
YasserOJ
YasserOJ

🐛💻
JJCLane
Jordon

🖋

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

Credits

Author & support

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

Libraries

CircularWave
Helpers
WaveLayer
animated_page_dragger
liquid_swipe
page
page_dragger
page_reveal