CustomInkRippleSetting class

A setting class for CustomInkRipple, this class contains some durations options for ripple effect and color fading.

Constructors

CustomInkRippleSetting({Duration unconfirmedRippleDuration = const Duration(milliseconds: 1000), Duration unconfirmedFadeInDuration = const Duration(milliseconds: 75), Duration confirmedRippleDuration = const Duration(milliseconds: 225), Duration confirmedFadeOutDuration = const Duration(milliseconds: 150), Duration confirmedFadeOutInterval = const Duration(milliseconds: 225), bool confirmedFadeOutWaitForForwarding = false, Duration canceledFadeOutDuration = const Duration(milliseconds: 75), double radiusAnimationBeginFn(double targetRadius)?, double radiusAnimationEndFn(double targetRadius)?, Offset radiusCanvasCenterFn(RenderBox referenceBox, double targetRadius)?})
const

Properties

canceledFadeOutDuration Duration
The fade-out duration when ink is canceled, which refers to original _kCancelDuration.
final
confirmedFadeOutDuration Duration
The effective fade-out duration when ink is confirmed, which refers to original _kFadeOutDuration. See _confirmedFadeOutDuration.
final
confirmedFadeOutInterval Duration
The effective fade-out interval when ink is confirmed, which refers to original _kFadeOutIntervalStart. See _confirmedFadeOutInterval.
final
confirmedFadeOutWaitForForwarding bool
The flag to make the start of fade-out animation wait for the end of radius-ripple and fade-in animations forwarding, when ink is confirmed.
final
confirmedRippleDuration Duration
The radius-ripple duration when ink is confirmed, which equals to original _kRadiusDuration.
final
hashCode int
The hash code for this object.
no setterinherited
radiusAnimationBeginFn → (double Function(double targetRadius)?)
The getter function for begin radius in radius animation, which defaults to (r) => r * 0.30 in defaultSetting.
final
radiusAnimationEndFn → (double Function(double targetRadius)?)
The getter function for end radius in radius animation, which defaults to (r) => r + 5.0 in defaultSetting.
final
radiusCanvasCenterFn → (Offset Function(RenderBox referenceBox, double targetRadius)?)
The getter function for radius center in canvas, which defaults to (box, _) => Box.size.center(Offset.zero) in defaultSetting.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
unconfirmedFadeInDuration Duration
The fade-in duration when ink is unconfirmed, which equals to original _kFadeInDuration.
final
unconfirmedRippleDuration Duration
The radius-ripple duration when ink is unconfirmed, which equals to original _kUnconfirmedRippleDuration.
final

Methods

copyWith({Duration? unconfirmedRippleDuration, Duration? unconfirmedFadeInDuration, Duration? confirmedRippleDuration, Duration? confirmedFadeOutDuration, Duration? confirmedFadeOutInterval, bool? confirmedFadeOutWaitForForwarding, Duration? canceledFadeOutDuration, double radiusAnimationBeginFn(double targetRadius)?, double radiusAnimationEndFn(double targetRadius)?, Offset radiusCanvasCenterFn(RenderBox referenceBox, double targetRadius)?}) CustomInkRippleSetting
Creates a copy of this value but with given fields replaced with the new 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

Constants

defaultSetting → const CustomInkRippleSetting
The default, or said, the original settings of InkRipple in Flutter.
preferredSetting → const CustomInkRippleSetting
The preferred CustomInkRipple setting by AoiHosizora :)