TouchRippleBehavior class
This data class defines the configuration for a touch ripple effect, including animation durations, curves, and spread/fade percentages.
This allows for customization of how the ripple effect behaves, such as the timing and extent of spread, fade-in, fade-out, and event callback triggering.
Constructors
- TouchRippleBehavior({Duration? spreadDuration, Curve? spreadCurve, Duration? fadeInDuration, Curve? fadeInCurve, Duration? fadeOutDuration, Curve? fadeOutCurve, Duration? cancelDuration, Curve? cancelCurve, double? lowerPercent, double? upperPercent, double? fadeLowerPercent, double? fadeUpperPercent, double? eventCallBackableMinPercent, bool? onlyMainButton})
-
const
Properties
- cancelCurve → Curve?
-
The curve of the fade-out animation about cancel for a touch ripple effect.
final
- cancelDuration → Duration?
-
The duration of the fade-out animation about cancel for a touch ripple effect.
final
- eventCallBackableMinPercent → double?
-
The minimum percentage of spread at which the event callback is triggered.
For example, if set to 0.5, the callback is invoked when the ripple effect
has spread to
50%of the widget's area.final - fadeInCurve → Curve?
-
The curve of the fade-in animation for a touch ripple effect.
final
- fadeInDuration → Duration?
-
The duration of the fade-in animation for a touch ripple effect.
final
- fadeLowerPercent → double?
-
The percentage value of the minimum fade ratio for the touch ripple effect.
final
- fadeOutCurve → Curve?
-
The curve of the fade-out animation for a touch ripple effect.
final
- fadeOutDuration → Duration?
-
The duration of the fade-out animation for a touch ripple effect.
final
- fadeUpperPercent → double?
-
The percentage value of the maximum fade ratio for the touch ripple effect.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- lowerPercent → double?
-
The percentage value of the minimum spread ratio for a touch ripple effect.
final
- onlyMainButton → bool?
-
The boolean that is whether only the main button is recognized as a gesture
when the user that is using mouse device clicks on the widget.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- spreadCurve → Curve?
-
The curve of a touch ripple spreading curved animation.
final
- spreadDuration → Duration?
-
The duration of a touch ripple spreading animation.
final
- upperPercent → double?
-
The percentage value of the maximum spread ratio for a touch ripple effect.
final
Methods
-
merge(
TouchRippleBehavior? other) → TouchRippleBehavior - Merges the current TouchRippleBehavior with another, using the provided behavior values if available. If the other behavior is null or lacks specific values, defaults to the current behavior values.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited