FlexSplashType enum

An enum for easy configuration and selection of ink splash effect in a FlexColorScheme.subThemes configuration.

Inheritance

Constructors

FlexSplashType()
const

Values

defaultSplash → const FlexSplashType

Use default Material splash effect.

If ThemeData.useMaterial3 is false the inkSplash effect is used.

If ThemeData.useMaterial3 is true and this is not a web build, then the inkSparkle effect is used, otherwise inkRipple is used.

This logic is built into the ThemeData factory.

inkSplash → const FlexSplashType

The classic and default ink effect used in Material-2.

A circular ink feature whose origin starts at the input touch point and whose radius expands from zero.

inkRipple → const FlexSplashType

A new faster Material-3 version of inkSplash.

By default used by Material-3 on none Android builds and also on all web builds.

A circular ink feature whose origin starts at the input touch point and whose radius expands from 60% of the final radius. The splash origin animates from the center of its tap/click.

inkSparkle → const FlexSplashType

Material-3 ink sparkle ripple, starts from tap position.

This effect relies on a shader and therefore is unsupported on the Flutter Web HTML backend. If used and the app is built for web, the used ink will be inkRipple.

Used by default on Android builds in Material-3 mode.

noSplash → const FlexSplashType

Removes the ink splash effect.

Use noSplash to totally defeat all ink splashes. Only the pressed highlight remains, which is usually quite subtle due to the typically used highlight color.

For a more prominent immediate click splash, use instantSplash that utilizes the splash color as an immediate ink.

instantSplash → const FlexSplashType

A custom immediate ink splash effect.

Uses an immediate highlight ink feature whose origin starts at the input touch point and expands from touch point with zero duration, for an immediate splash effect, instead of animated splash color based ink.

Properties

hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
splashFactory([bool useMaterial3 = true, bool mockIsWeb = false]) InteractiveInkFeatureFactory?
Return the actual splashFactory defined by the FlexSplashType enum.
toString() String
A string representation of this object.
inherited

Operators

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

Constants

values → const List<FlexSplashType>
A constant List of the values in this enum, in order of their declaration.