GFShimmer class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- GFShimmer
Constructors
- GFShimmer({Key? key, required Widget child, Gradient? gradient, GFShimmerDirection direction = GFShimmerDirection.leftToRight, Duration duration = const Duration(milliseconds: 1500), int shimmerEffectCount = 0, bool showShimmerEffect = true, bool showGradient = false, Color mainColor = Colors.grey, Color secondaryColor = GFColors.LIGHT})
-
GFShimmer shows shimmer effect.
const
Properties
- child → Widget
-
The child of type Widget to display shimmer effect.
final
- direction → GFShimmerDirection
-
Controls the direction of the shimmer effect.
The default direction is GFShimmerDirection.leftToRight.
final
- duration → Duration
-
Controls the speed of the shimmer effect.
The default value is 1500 milliseconds.
final
- gradient → Gradient?
-
Controls the child's shades of color using Linear gradient.
Child Widget only takes gradient color, If showGradient is true.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- mainColor → Color
-
Defines the main color of the child's shimmer effect.
Child Widget takes main color, only if showGradient is false.
Default showGradient will be false.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- secondaryColor → Color
-
defines the secondary color of the child's shimmer effect.
Child Widget takes secondary color, only if showGradient is false.
Default showGradient will be false.
final
- shimmerEffectCount → int
-
Controls the animation shimmerEffectCount.
The default value is '0', that displays child Widget's shimmer effect forever.
final
- showGradient → bool
-
If true, takes gradient color gradient for the child's shimmer effect.
Default set to false.
final
- showShimmerEffect → bool
-
Controls animation effect, defaults true state that makes animation active.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _GFShimmerState -
Creates the mutable state for this widget at a given location in the tree.
override
-
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
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited