UIProShimmer class

A customizable shimmer loading effect widget.

Use UIProShimmer to show a loading placeholder with an animated shimmer gradient effect.

Example:

UIProShimmer(
  child: Container(
    width: 200,
    height: 20,
    color: Colors.white,
  ),
)

For a simple box shimmer:

UIProShimmer.box(
  width: 200,
  height: 20,
)

Inheritance

Constructors

UIProShimmer({Key? key, Widget? child, double? width, double? height, double? borderRadius, Color? baseColor, Color? highlightColor, Duration? duration, bool enabled = true, UIProShimmerShape shape = UIProShimmerShape.rectangle, UIProShimmerDirection direction = UIProShimmerDirection.leftToRight}): Creates a shimmer effect widget.
const
UIProShimmer.box({Key? key, required double? width, required double? height, double? borderRadius, Color? baseColor, Color? highlightColor, Duration? duration, bool enabled = true, UIProShimmerDirection direction = UIProShimmerDirection.leftToRight}): Creates a simple box shimmer placeholder.
const
UIProShimmer.circle({Key? key, required double size, Color? baseColor, Color? highlightColor, Duration? duration, bool enabled = true, UIProShimmerDirection direction = UIProShimmerDirection.leftToRight}): Creates a circular shimmer placeholder.
const
UIProShimmer.text({Key? key, double? width, double height = 14, double borderRadius = 4, Color? baseColor, Color? highlightColor, Duration? duration, bool enabled = true}): Creates a text-like shimmer placeholder.
factory

baseColor → Color?: Base color for shimmer (darker shade).
final
borderRadius → double?: Border radius for the shimmer effect.
final
child → Widget?: The child widget to apply shimmer effect to. If null, uses width and height to create a box.
final
direction → UIProShimmerDirection: Direction of the shimmer animation.
final
duration → Duration?: Duration of one shimmer animation cycle.
final
enabled → bool: Whether the shimmer animation is enabled.
final
hashCode → int: The hash code for this object.
no setterinherited
height → double?: Height of the shimmer box (when child is null).
final
highlightColor → Color?: Highlight color for shimmer (lighter shade).
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
shape → UIProShimmerShape: The shape of the shimmer.
final
width → double?: Width of the shimmer box (when child is null).
final

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<UIProShimmer>: 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