liquid_swipe.dart

import 'package:flutter/material.dart';
import 'package:flutter/widgets.dart';
import 'package:liquid_swipe/Helpers/Helpers.dart';
import 'package:liquid_swipe/Helpers/LiquidSwipeChildDelegate.dart';
import 'package:liquid_swipe/PageHelpers/LiquidController.dart';
import 'package:liquid_swipe/PageHelpers/page_dragger.dart';
import 'package:liquid_swipe/Provider/LiquidProvider.dart';
import 'package:provider/provider.dart';

export 'package:liquid_swipe/Helpers/Helpers.dart';
export 'package:liquid_swipe/PageHelpers/LiquidController.dart';

final key = new GlobalKey<_LiquidSwipe>();

/// Callback to provide the current page Index whenever it changes
///
/// Returns an [int] value.
///
/// Simple Usage :
///
/// Create your own method
///
/// ```dart
/// pageChangeCallback(int page) {
///   ...performActions
/// }
/// ```
/// add this methods as callback to [LiquidSwipe.onPageChangeCallback]
///
/// ```dart
///     LiquidSwipe(
///       pages: pages,
///       onPageChangeCallback: pageChangeCallback,
///     ),
/// ```
///
/// see also : [LiquidController.currentPage]
typedef OnPageChangeCallback = void Function(int activePageIndex);

/// Callback to provide the current UpdateType
///
/// Returns an [UpdateType] value.
///
/// Simple Usage :
///
/// Create your own method
///
/// ```dart
/// updateChangeCallback(UpdateType type) {
///   ...performActions
/// }
/// ```
/// add this methods as callback to [LiquidSwipe.currentUpdateTypeCallback]
///
/// ```dart
///     LiquidSwipe(
///       pages: pages,
///       currentUpdateTypeCallback: updateChangeCallback,
///     ),
/// ```
typedef CurrentUpdateTypeCallback = void Function(UpdateType updateType);

/// Callback to provide the slidePercentage, both vertical and horizontal
///
/// Returns two [double] values.
///
/// Simple Usage :
///
/// use [LiquidSwipe.slidePercentCallback] for callbacks
///
/// ```dart
///     LiquidSwipe(
///       pages: pages,
///       slidePercentCallback: (slidePercentHorizontal, slidePercentVertical) => {
///             ...performActions
///       },
///     ),
/// ```
typedef SlidePercentCallback = void Function(
    double slidePercentHorizontal, double slidePercentVertical);

/// LiquidSwipe widget for out of the box Animation between stacked Widgets.
///
/// For Simple Usage LiquidSwipe just requires List of Widgets and assign it to [LiquidSwipe.pages]
///
/// Pages can be or should be Containers or SizedBox etc. Please report if doesn't work on some specific type of the Widgets
///
/// Example :
///
/// ```dart
///     LiquidSwipe(
///       pages: pages,
///     ),
/// ```
///
/// All Other parameters are optional and can be neglected, otherwise see documentation related to each of them.
///
/// An Example of LiquidSwipe with Default values (excluding callbacks) :
///
/// [LiquidSwipe()]
/// ```dart
///       LiquidSwipe(
///           pages: pages,
///           fullTransitionValue: FULL_TRANSITION_PX,
///           initialPage: 0,
///           enableSlideIcon: false,
///           slideIconWidget: const Icon(Icons.arrow_back_ios),
///           positionSlideIcon: 0.54,
///           enableLoop: true,
///           waveType: WaveType.liquidReveal,
///           liquidController: liquidController,
///           disableUserGesture: false,
///           ignoreUserGestureWhileAnimating: false,
///        ),
/// ```
///
/// [LiquidSwipe.builder(itemBuilder: itemBuilder, itemCount: itemCount)]
/// ```dart
///       LiquidSwipe.builder(
///           itemCount : data.length,
///           itemBuilder : (context, index) => Container(...),
///           fullTransitionValue: FULL_TRANSITION_PX,
///           initialPage: 0,
///           enableSlideIcon: false,
///           slideIconWidget: const Icon(Icons.arrow_back_ios),
///           positionSlideIcon: 0.54,
///           enableLoop: true,
///           waveType: WaveType.liquidReveal,
///           liquidController: liquidController,
///           disableUserGesture: false,
///           ignoreUserGestureWhileAnimating: false,
///        ),
/// ```
class LiquidSwipe extends StatefulWidget {
  /// Required a double value for swipe animation sensitivity
  ///
  /// Default : 400
  ///
  /// Lower the value faster the animation
  ///
  /// 100 would make animation much faster than current
  final double fullTransitionValue;

  /// If you want to change the initial page
  ///
  /// Required a int value which should be greater than or equals to 0 and less then the pages length other wise exception will be thrown.
  final int initialPage;

  /// Required a Widget that will be visible only if [enableSlideIcon] is set to true
  ///
  /// If not provided and [enableSlideIcon] is set [true], `Icon(Icons.arrow_back_ios)` this will be used by default
  final Widget? slideIconWidget;

  /// Required a double value ranges from 0.0 - 1.0
  ///
  /// -1.0 represents the 0% of height of the canvas and 100% for 1.0, similarly 0.0 represents vertical centre
  final double positionSlideIcon;

  /// Required a bool value in order to make the swipe in loop mode or not, i.e., to repeat them or not after reaching last page.
  final bool enableLoop;

  ///Required a [LiquidController] object for some magic methods
  final LiquidController? liquidController;

  ///Type of Wave you want, its a enum, you might have to import helpers.dart
  final WaveType waveType;

  ///see [OnPageChangeCallback]
  final OnPageChangeCallback? onPageChangeCallback;

  ///see [CurrentUpdateTypeCallback]
  final CurrentUpdateTypeCallback? currentUpdateTypeCallback;

  ///see [SlidePercentCallback]
  final SlidePercentCallback? slidePercentCallback;

  ///Required a bool value to prefer disabling the drag from the whole page and
  /// allowing only from the revealed part of the screen and the icon.
  ///
  /// When set to true, it will ignore any gesture arenas inside the container pages
  /// allowing them to work properly. However the page will still be draggable from non
  /// gesture arenas.
  ///
  /// At least one of the [slideIconWidget] or [enableSideReveal] must be there
  /// for this to work.
  ///
  /// Set this to true if facing problems in giving gesture controls inside the pages
  ///
  /// ----
  /// Refer to:
  ///
  /// * https://github.com/iamSahdeep/liquid_swipe_flutter/issues/85
  ///
  /// * https://github.com/iamSahdeep/liquid_swipe_flutter/issues/83
  final bool preferDragFromRevealedArea;

  ///Required a bool value for disabling Fast Animation between pages
  ///
  /// If true fast swiping is disabled
  final bool ignoreUserGestureWhileAnimating;

  ///Required a bool value for disabling the user touch. you can still perform programmatic swipes
  ///
  ///see also for runtime changes : [LiquidController.shouldDisableGestures]
  final bool disableUserGesture;

  ///Required a bool to Enable or Disable the side reveal i.e., this clip area on the right side with 15.0px of reveal.
  final bool enableSideReveal;

  /// A Custom child delegate responsible for child creation in case of builder or fetcher in case of List.
  ///
  /// See also [LiquidSwipeChildDelegate]
  final LiquidSwipeChildDelegate liquidSwipeChildDelegate;

  /// Constructor for LiquidSwipe for predefined [pages]
  ///Required List of Widgets like Container/SizedBox
  ///
  /// sample page :
  ///
  /// ```dart
  ///     Container(
  ///      color: Colors.pink,
  ///      child: Column(
  ///       crossAxisAlignment: CrossAxisAlignment.center,
  ///       mainAxisSize: MainAxisSize.max,
  ///       mainAxisAlignment: MainAxisAlignment.spaceEvenly,
  ///       children: <Widget>[
  ///         Image.asset(
  ///           'assets/1.png',
  ///           fit: BoxFit.cover,
  ///         ),
  ///         Padding(
  ///           padding: EdgeInsets.all(20.0),
  ///         ),
  ///         Column(
  ///           children: <Widget>[
  ///             Text(
  ///               "Hi",
  ///               style: MyApp.style,
  ///             ),
  ///             Text(
  ///               "It's Me",
  ///               style: MyApp.style,
  ///             ),
  ///             Text(
  ///               "Sahdeep",
  ///               style: MyApp.style,
  ///             ),
  ///           ],
  ///         ),
  ///       ],
  ///     ),
  ///   ),
  /// ```
  ///
  /// You can just create a list using this type of widgets
  LiquidSwipe({
    Key? key,
    required List<Widget> pages,
    this.fullTransitionValue = FULL_TRANSITION_PX,
    this.initialPage = 0,
    this.slideIconWidget,
    this.positionSlideIcon = 0.8,
    this.enableLoop = true,
    this.liquidController,
    this.waveType = WaveType.liquidReveal,
    this.onPageChangeCallback,
    this.currentUpdateTypeCallback,
    this.slidePercentCallback,
    this.preferDragFromRevealedArea = false,
    this.ignoreUserGestureWhileAnimating = false,
    this.disableUserGesture = false,
    this.enableSideReveal = false,
  })  : assert(initialPage >= 0 && initialPage < pages.length),
        assert(positionSlideIcon >= 0 && positionSlideIcon <= 1),
        liquidSwipeChildDelegate = LiquidSwipePagesChildDelegate(pages),
        super(key: key);

  ///A builder constructor with same fields but with [itemBuilder]
  ///Sample itembuilder :
  ///```dart
  /// LiquidSwipe.builder(
  ///   itemCount: data.length,
  ///   itemBuilder: (context, index){
  ///   return Container(
  ///     color: data[index].color,
  ///     child: Column(
  ///       crossAxisAlignment: CrossAxisAlignment.center,
  ///       mainAxisSize: MainAxisSize.max,
  ///       mainAxisAlignment: MainAxisAlignment.spaceEvenly,
  ///       children: <Widget>[
  ///         Image.asset(
  ///           data[index].image,
  ///           fit: BoxFit.cover,
  ///         ),
  ///         Padding(
  ///           padding: EdgeInsets.all(20.0),
  ///         ),
  ///         Column(
  ///           children: <Widget>[
  ///             Text(
  ///               data[index].text1,
  ///               style: WithPages.style,
  ///             ),
  ///             Text(
  ///               data[index].text2,
  ///               style: WithPages.style,
  ///             ),
  ///             Text(
  ///               data[index].text3,
  ///               style: WithPages.style,
  ///             ),
  ///           ],
  ///         ),
  ///       ],
  ///      ),
  ///   );}
  /// ),
  ///```
  ///
  /// See Example for complete reference.
  LiquidSwipe.builder({
    Key? key,
    required IndexedWidgetBuilder itemBuilder,
    required int itemCount,
    this.fullTransitionValue = FULL_TRANSITION_PX,
    this.initialPage = 0,
    this.slideIconWidget,
    this.positionSlideIcon = 0.8,
    this.enableLoop = true,
    this.liquidController,
    this.waveType = WaveType.liquidReveal,
    this.onPageChangeCallback,
    this.currentUpdateTypeCallback,
    this.slidePercentCallback,
    this.preferDragFromRevealedArea = false,
    this.ignoreUserGestureWhileAnimating = false,
    this.disableUserGesture = false,
    this.enableSideReveal = false,
  })  : assert(itemCount > 0),
        assert(initialPage >= 0 && initialPage < itemCount),
        assert(positionSlideIcon >= 0 && positionSlideIcon <= 1),
        liquidSwipeChildDelegate =
            LiquidSwipeBuilderChildDelegate(itemBuilder, itemCount),
        super(key: key);

  @override
  State<StatefulWidget> createState() => _LiquidSwipe();
}

class _LiquidSwipe extends State<LiquidSwipe> with TickerProviderStateMixin {
  late LiquidController liquidController;

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

  @override
  Widget build(BuildContext context) {
    return ChangeNotifierProvider<LiquidProvider>(
      create: (BuildContext context) {
        return LiquidProvider(
          initialPage: widget.initialPage,
          loop: widget.enableLoop,
          length: widget.liquidSwipeChildDelegate.itemCount(),
          vsync: this,
          slideIcon: widget.positionSlideIcon,
          currentUpdateTypeCallback: widget.currentUpdateTypeCallback,
          slidePercentCallback: widget.slidePercentCallback,
          onPageChangeCallback: widget.onPageChangeCallback,
          disableGesture: widget.disableUserGesture,
          enableSideReveal: widget.enableSideReveal,
        );
      },
      child:
          Consumer(builder: (BuildContext context, LiquidProvider notifier, _) {
        liquidController.setContext(context);
        return Stack(
          alignment: Alignment.center,
          children: <Widget>[
            notifier.slideDirection == SlideDirection.leftToRight
                ? widget.liquidSwipeChildDelegate
                    .getChildAtIndex(context, notifier.activePageIndex)
                : widget.liquidSwipeChildDelegate
                    .getChildAtIndex(context, notifier.nextPageIndex),
            //Pages
            PageDragger(
              //Used for gesture control
              horizontalReveal: notifier.slidePercentHor,
              slideDirection: notifier.slideDirection,
              iconSize: notifier.iconSize,
              waveType: widget.waveType,
              verticalReveal: notifier.slidePercentVer,
              enableSideReveal: notifier.enableSideReveal,
              preferDragFromRevealedArea: widget.preferDragFromRevealedArea,
              fullTransitionPX: widget.fullTransitionValue,
              slideIconWidget: widget.slideIconWidget,
              iconPosition: widget.positionSlideIcon,
              ignoreUserGestureWhileAnimating:
                  widget.ignoreUserGestureWhileAnimating,
              child: notifier.slideDirection == SlideDirection.leftToRight
                  ? widget.liquidSwipeChildDelegate
                      .getChildAtIndex(context, notifier.nextPageIndex)
                  : widget.liquidSwipeChildDelegate
                      .getChildAtIndex(context, notifier.activePageIndex),
            ),
          ], //Widget//Stack
        );
      }),
    ); //Scaffold
  }
}