TouchRippleContext mixin
The mixin provides necessary information for gesture behaviors and other rendering processes about the touch ripple effects.
Properties
- cancelBehavior → TouchRippleCancelBehavior
-
Returns the behavior that defines the touch ripple spread animation
when the touch ripple effect is canceled.
no setter
- context → BuildContext
-
Returns the instance of the build context for the widget for applying
the ripple effect.
no setter
- doubleTapAliveDuration → Duration
-
Returns the duration until double-tap deactivation. During this period,
any single tap is still considered a double-tap without requiring
continuous double-tapping.
no setter
- doubleTapBehavior → TouchRippleBehavior
-
Returns the touch ripple behavior applied to the touch ripple
effect for double tapped or double clicked.
no setter
- doubleTappableDuration → Duration
-
Returns the minimum duration used to distinguish between a tap and a double-tap.
If the user does not perform a second tap within this duration, it is considered
just a single-tap.
no setter
- focusAnimation → TouchRippleAnimation
-
Returns the instance of the fade animation for the touch ripple effect
when the focus effect is triggered.
no setter
- focusColor → Color
-
Returns the background color of the solid effect when a consecutive
(e.g. about double-tap and long-tap) event state occurs.
no setter
- focusTiming → TouchRippleFocusTiming
-
Returns the enumeration defines when the focus of a touch ripple
should start, specifying the priority based on timing conditions.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- hoverAnimation → TouchRippleAnimation
-
Returns the instance of the fade animation for the touch ripple effect
when the hover effect is triggered.
no setter
- hoverColor → Color
-
Returns the background color of the solid effect when a user hovers.
no setter
- longTapBehavior → TouchRippleBehavior
-
Returns the touch ripple behavior applied to the touch ripple
effect for long tapped or long pressed and long clicked.
no setter
- longTapCycleDuration → Duration
-
Returns the duration until long-tap reactivation. After this period, any
pointer down and move is still considered a long-tap without requiring
the continuous process of pointer-up followed by pointer-down.
no setter
- longTappableDuration → Duration
-
Returns the minimum duration used to distinguish between a tap and
a long-tap. After this duration has passed, the long-tap effect
starts to be displayed to the user.
no setter
- origin → TouchRippleOrigin
-
Returns the enumeration defines the starting point of a spread ripple effect,
specifying the origin of the ripple based on the user interaction.
no setter
- overlapBehavior → TouchRippleOverlapBehavior
-
Return the behavior of a touch ripple when it overlaps with
other ripple effects. (e.g. overlappable, cancel, ignore)
no setter
- previewDuration → Duration
-
Returns the duration for which the ripple effect is previewed even if the gesture
is not finalized, allowing the user to see the effect while the pointer is down or moving.
no setter
- rejectBehavior → TouchRippleRejectBehavior
-
Returns the behavior that defines when a gesture should be rejected,
specifying the conditions for rejection.
no setter
- rippleBlurRadius → double
-
Returns the radius pixels of a blur filter for spread ripple effect. It cannot
be negative and as the value increases, the edge of the spread ripple effect
becomes blurrier.
no setter
- rippleBorderRadius → BorderRadius
-
Returns the instance of a border radius for a ripple effect. For reference,
this option can be replaced with a widget like ClipRRect depending on
the situation.
no setter
- rippleColor → Color
-
Returns the background color of the spread ripple effect.
no setter
- rippleScale → double
-
Returns the scale percentage value of a ripple effect and by default
the origin position is center.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shape → TouchRippleShape
-
Returns the enumeration defines the shape of the ripple effect based
on the widget layout, specifying how the ripple appears visually.
no setter
- tapBehavior → TouchRippleBehavior
-
Returns the touch ripple behavior applied to the touch ripple
effect for tapped or clicked.
no setter
- tappableDuration → Duration
-
Returns the duration after which the gesture is considered rejected if the pointer
is still down and no tap is completed. If this duration elapses without
a successful gesture, the gesture will be rejected.
no setter
- useFocusEffect → bool
-
Returns whether the focus effect is enabled for touch ripple animations.
If true, a solid focus color effect is applied for consecutive events
like double-tap and long-tap or others.
no setter
- useHoverEffect → bool
-
Returns whether the hover effect is enabled for touch ripple animations.
If true, a solid hover effect is applied when the user hovers.
no setter
- vsync → TickerProvider
-
Returns the instance of a TickerProvider for playing
ripple effects and other animations.
no setter
Methods
-
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