ShimmerAiConfig class
Configuration class for customizing the shimmer effect.
Constructors
- ShimmerAiConfig({Color baseColor = const Color(0xFFE0E0E0), Color highlightColor = const Color(0xFFF5F5F5), Duration duration = const Duration(milliseconds: 1500), ShimmerDirection direction = ShimmerDirection.ltr, double angle = 0.0, double borderRadius = 10.0, bool repeat = true, int? loopCount, LinearGradient? customGradient, double? width, double? height, EdgeInsetsGeometry? margin, EdgeInsetsGeometry? padding, AlignmentGeometry? alignment, BoxConstraints? constraints, Decoration? decoration})
-
Configuration for the shimmer effect, controlling its appearance and animation.
const
Properties
- alignment → AlignmentGeometry?
-
final
- angle → double
-
The angle of the shimmer effect in radians. Defaults to 0.0 (horizontal).
final
- baseColor → Color
-
The base color of the shimmer effect. Defaults to Colors.grey
300!.final - borderRadius → double
-
The border radius for rectangular shimmer placeholders. Defaults to 10.0.
final
- constraints → BoxConstraints?
-
final
- customGradient → LinearGradient?
-
A custom LinearGradient to use for the shimmer effect.
If provided, baseColor and highlightColor will be ignored.
final
- decoration → Decoration?
-
final
- direction → ShimmerDirection
-
The direction of the shimmer animation. Defaults to ShimmerDirection.ltr.
final
- duration → Duration
-
The duration of one shimmer animation cycle. Defaults to 1500 milliseconds.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- height → double?
-
final
- highlightColor → Color
-
The highlight color of the shimmer effect. Defaults to Colors.grey
100!.final - loopCount → int?
-
The number of times the shimmer animation should repeat.
Only applicable if repeat is true. Defaults to null (infinite).
final
- margin → EdgeInsetsGeometry?
-
final
- padding → EdgeInsetsGeometry?
-
final
- repeat → bool
-
Whether the shimmer animation should loop continuously. Defaults to true.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- width → double?
-
final
Methods
-
buildShimmer(
{required Widget child}) → Widget -
Builds a
Shimmerwidget to apply the shimmer effect to a child widget. -
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