swipe_to #

SwipeTo is a wrapper for a chat view widget which can be used initiate callback when user horizontally swipe on it.

Getting Started #

To use this packages, you just simply need to wrap your child component in SwipeTo widget and pass a VoidCallback that you can carry forward with your task.

In the pubspec.yaml of your flutter project, add the following dependency:

dependencies:
  ...
  swipe_to: 0.0.1+5

In your library add the following import:

import 'package:swipe_to/swipe_to.dart';

Parameter Info #

• child : (@required) StateLess or StateFull flutter widget.
• onRightSwipe : callback which will be initiated at the end of right swipe animation. If not passed right swipe will be disabled
• onLeftSwipe : callback which will be initiated at the end of left swipe animation. If not passed left swipe will be disabled
• iconOnRightSwipe : IconData that will be displayed on left beneath child widget when swiped right. If not specified default is Icons.reply
• iconOnLeftSwipe : IconData that will be displayed on right beneath child widget when swiped left. If not specified default is Icons.reply
• iconSize : Double value defining size of displayed icon beneath child widget. If not specified default it will take 26
• iconColor : Color value defining color of displayed icon beneath child widget. If not specified primaryColor from theme will be taken
• offsetDx : Double dx value used in Offset() till which position of child widget will get animated. If not specified 0.3 default will be taken. onRightSwipe +dx value will be used and for onLeftSwipe -dx value will be used
• animationDuration : Duration value to define animation duration. If not specified default is 150 milliseconds

Major changes in [ver 0.0.1+5] #

• For a single child widget, we can now enable swipe for both left and right direction
• swipeDirection parameter is removed. Now onLeftSwipe and onRightSwipe callback will enable swiping for a particular direction if passed
• iconData is now split into two parameter, iconOnRightSwipe & iconOnLeftSwipe for future use
• endOffset is now change to accept a double value only
• callBack is now split into two parameter, onLeftSwipe & onRightSwipe

Deprecated/Removed Parameters #

• swipeDirection : Enum value from [swipeToLeft, swipeToRight] only. Make sure to pass relative Offset value according to passed swipeDirection value. If not specified swipeToRight will be taken as default.
• iconData : IconData that will be displayed beneath child widget. if not specified default is Icons.reply
• endOffset : Offset value till which position of child widget will get animated. if not specified Offset(0.3, 0.0) default will be taken
• callBack : (@required) callback which will be initiated at the end of swipe animation

Example : SwipeToRight Wrap your desired widget with SwipeTo & pass a call to onRightSwipe parameter.

SwipeTo(
    child: Container(
        padding: const EdgeInsets.symmetric(vertical: 10.0, horizontal: 8.0),
        child: Text('Hey You! Swipe me right 👉🏿'),
    ),
    onRightSwipe: () {
        print('Callback from Swipe To Right');
    },
),

Example : SwipeToLeft Wrap your desired widget with SwipeTo & pass a call to onLeftSwipe parameter.

SwipeTo(
    child: Container(
        padding: const EdgeInsets.symmetric(vertical: 10.0, horizontal: 8.0),
        child: Text('👈🏿 Hey You! Swipe me Left'),
    ),
    onLeftSwipe: () {
        print('Callback from Swipe To Left');
    },
),

Sample Outputs #