flutter_touch_ripple library

Classes

HoldingGestureRecognizer

The gesture recognizer that tracks holding gestures, defined as when a pointer is pressed but not yet released. It resolves the gesture if the pointer is lifted.

TouchRipple<T extends dynamic>

Introduction

TouchRippleBehavior

This data class defines the configuration for a touch ripple effect, including animation durations, curves, and spread/fade percentages.

TouchRippleColor

TouchRippleController

The class defines and manages states, listeners, a context and other values related to touch ripple, ensuring that each state exists uniquely within the controller.

TouchRippleDoubleTapGestureRecognizer

TouchRippleDragGestureRecognizer

TouchRippleEffect

TouchRippleGestureDetector<T extends dynamic>

This widget detects user gestures, notifies the relevant controller that manages touch ripple effects, and delegates the handling to it.

TouchRippleGestureRecognizer

The abstract class that defines the touch ripple gesture base behavior, which is a basic and essential behavior.

TouchRippleLongTapGestureRecognizer

TouchRippleSolidEffect

TouchRippleSpreadingEffect

TouchRippleStyle

This inherited widget globally provides the style information for touch ripple effects to all descendant widgets in the widget tree.

TouchRippleTapGestureRecognizer

Enums

TouchRippleCancelBehavior

The enumeration defines the behavior that defines the touch ripple spread animation when the touch ripple effect is canceled.

TouchRippleFocusTiming

The enumeration defines when the focus of a touch ripple should start, specifying the priority based on timing conditions.

TouchRippleOrigin

The enumeration defines the starting point of a spread ripple effect, specifying the origin of the ripple based on the user interaction.

TouchRippleOverlapBehavior

The enumeration defines the behavior of a touch ripple when it overlaps with other ripple effects.

TouchRippleRejectBehavior

The enumeration defines when a gesture should be rejected, specifying the conditions for rejection.

TouchRippleShape

The enumeration defines the shape of the ripple effect based on the widget layout, specifying how the ripple appears visually.

Mixins

FocusableGestureRecognizerMixin

The mixin that adds focus gesture recognition to OneSequenceGestureRecognizer. Provides callbacks for when a focus gesture starts or ends.

HoldableGestureRecognizerMixin

The mixin provides functionality to continuously track the defined pointers to prevent the gesture from being rejected.

TouchRippleContext

The mixin provides necessary information for gesture behaviors and other rendering processes about the touch ripple effects.

Typedefs

GestureRecognizerBuilder<T extends GestureRecognizer> = T Function()

Signature for the builder function that creates an instance of GestureRecognizer.

GestureRecognizerDisposeCallback = void Function(GestureRecognizer instance)

Signature for the callback function that is called when a GestureRecognizer disposed.

TouchRippleAsyncCallback<T> = Future<T> Function()

Signature for the function that returns a Future of type T that represents the data type returned asynchronously.

TouchRippleAsyncNotifyCallback<T> = void Function(Future<T> data)

Signature for the function that indicates the start of an asynchronous operation. It includes a parameter to provide the associated Future instance.

TouchRippleAsyncResultCallback<T> = void Function(T result)

Signature for the function that takes a parameter of type T that represents the result of an asynchronous operation, passed to the function when the operation is completed.

TouchRippleCallback = void Function(Offset offset)

Signature for the callback function that is called when a touch ripple effect is triggered. The offset parameter provides the position of the touch event relative to a widget coordinate system.

TouchRippleConsecutiveCallback = bool Function(Offset offset, int count)

Signature for the callback function that is called when a consecutive touch ripple event occurs, combining both the behavior of TouchRippleCallback and TouchRippleContinuableCallback.

TouchRippleContinuableCallback = bool Function(int count)

Signature for the callback function that is called to determine whether a continuable touch ripple event should continue.

TouchRippleDragCallback = void Function(double delta)

Signature for the callback function that is called when the user drags
horizontally(e.g. left, right) or vertically(e.g. top, bottom) and the gesture event is accepted.

TouchRippleListener = VoidCallback

Signature for the function that is called when the touch ripple effect is added or when the state of the touch ripple controller changes.