TouchRippleStyle class

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

Inheritance

Constructors

TouchRippleStyle({Key? key, required Widget child, Color? rippleColor, Color? hoverColor, Color? focusColor, double? rippleScale, double? rippleBlurRadius, BorderRadius? rippleBorderRadius, Duration? previewDuration, Duration? tappableDuration, Duration? doubleTappableDuration, Duration? doubleTapAliveDuration, Duration? longTappableDuration, Duration? longTapCycleDuration, TouchRippleBehavior? tapBehavior, TouchRippleBehavior? doubleTapBehavior, TouchRippleBehavior? longTapBehavior, TouchRippleRejectBehavior? rejectBehavior, TouchRippleCancelBehavior? cancelBehavior, TouchRippleOverlapBehavior? overlapBehavior, TouchRippleRenderOrderType? renderOrderType, TouchRippleFocusTiming? focusTiming, TouchRippleOrigin? origin, TouchRippleShape? shape, TouchRippleAnimation? focusAnimation, TouchRippleAnimation? hoverAnimation, bool? useHoverEffect, bool? useFocusEffect, bool? onlyMainButton})
const

Properties

cancelBehavior → TouchRippleCancelBehavior?
The value defines the behavior that defines the touch ripple spread animation when the touch ripple effect is canceled.
final
child → Widget
The widget below this widget in the tree.
finalinherited
doubleTapAliveDuration → Duration?
The value defines the duration until double-tap deactivation. During this period, any single tap is still considered a double-tap without requiring continuous double-tapping.
final
doubleTapBehavior → TouchRippleBehavior?
The value defines the touch ripple behavior applied to the touch ripple effect for double tapped or double clicked.
final
doubleTappableDuration → Duration?
The value defines 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.
final
focusAnimation → TouchRippleAnimation?
The value defines the instance of the fade animation for the touch ripple effect when the focus effect is triggered.
final
focusColor → Color?
The value defines the background color of the solid effect when a consecutive (e.g. about double-tap and long-tap) event state occurs.
final
focusTiming → TouchRippleFocusTiming?
The value defines the enumeration defines when the focus of a touch ripple should start, specifying the priority based on timing conditions.
final
hashCode → int
The hash code for this object.
no setterinherited
hoverAnimation → TouchRippleAnimation?
The value defines the instance of the fade animation for the touch ripple effect when the hover effect is triggered.
final
hoverColor → Color?
The value defines the background color of a effect when the user hovers.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
longTapBehavior → TouchRippleBehavior?
The value defines the touch ripple behavior applied to the touch ripple effect for long tapped or long pressed and long clicked.
final
longTapCycleDuration → Duration?
The value defines 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.
final
longTappableDuration → Duration?
The value defines 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.
final
onlyMainButton → bool?
The value defines 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
origin → TouchRippleOrigin?
The value defines the enumeration defines the starting point of a spread ripple effect, specifying the origin of the ripple based on the user interaction.
final
overlapBehavior → TouchRippleOverlapBehavior?
The value defines the behavior of a touch ripple when it overlaps with other ripple effects. (e.g. overlappable, cancel, ignore)
final
previewDuration → Duration?
The value defines 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.
final
rejectBehavior → TouchRippleRejectBehavior?
The value defines the behavior that defines when a gesture should be rejected, specifying the conditions for rejection.
final
renderOrderType → TouchRippleRenderOrderType?
The value defines the enumeration specifies the rendering order of the touch ripple effect, determining whether it should appear in the foreground or background.
final
rippleBlurRadius → double?
The value defines the radius pixels of a blur filter to touch ripple.
final
rippleBorderRadius → BorderRadius?
The value defines the instance of a border radius for a ripple effect.
final
rippleColor → Color?
The value defines the background color of a spread ripple effect.
final
rippleScale → double?
The value defines the scale percentage value of a ripple effect.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shape → TouchRippleShape?
The value defines the enumeration defines the shape of the ripple effect based on the widget layout, specifying how the ripple appears visually.
final
tapBehavior → TouchRippleBehavior?
The value defines the touch ripple behavior applied to the touch ripple effect for tapped or clicked.
final
tappableDuration → Duration?
The value defines 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.
final
useFocusEffect → bool?
The value defines 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.
final
useHoverEffect → bool?
The value defines whether the hover effect is enabled for touch ripple animations. If true, a solid hover effect is applied when the user hovers.
final

Methods

createElement() → InheritedElement
Inflates this configuration to a concrete instance.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited
updateShouldNotify(covariant TouchRippleStyle oldWidget) → bool
Whether the framework should notify widgets that inherit from this widget.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

maybeOf(BuildContext context) → TouchRippleStyle?
Returns the TouchRippleStyle most closely associated with the given context, and returns null if there is no ScrollController associated with the given context.