XShimmerEffect class

Widget to apply a shimmer effect (loading placeholder) on a child widget.

XShimmerEffect wraps a child widget and applies a moving linear gradient animation, creating a skeleton-loading shimmer effect commonly used in modern apps.

Example usage:

XShimmer(
  child: Container(
    width: 200,
    height: 20,
    color: Colors.grey,
  ),
)

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• XShimmerEffect

Constructors

XShimmerEffect({Key? key, required Widget child, Duration duration = const Duration(milliseconds: 1000), Color baseColor = const Color(0xFFE0E0E0), Color highlightColor = const Color(0xFFF5F5F5)})

const

Properties

baseColor → Color

Base color of the shimmer (background color).

final

child → Widget

The child widget to display with shimmer effect.

final

duration → Duration

The duration of the shimmer animation.

final

hashCode → int

The hash code for this object.

no setter, inherited

highlightColor → Color

Highlight color of the shimmer (the brighter moving part).

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → State<XShimmerEffect>

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, int wrapWidth = 65}) → 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