NxShimmerBox class

A loading placeholder widget that displays a shimmer animation effect.

This widget creates a container with a shimmering animation, commonly used to indicate loading states in the UI. The shimmer effect moves across the container, creating a subtle loading animation.

Example usage:

// Basic shimmer box with default size
NxShimmerBox()

// Custom sized shimmer box
NxShimmerBox(
  width: 200,
  height: 100,
  opacity: 0.8,
  color: Colors.grey[300],
)

// Loading card with shimmer effect
Card(
  child: Padding(
    padding: EdgeInsets.all(16),
    child: Column(
      children: [
        NxShimmerBox(
          height: 24,
          width: double.infinity,
        ),
        SizedBox(height: 8),
        NxShimmerBox(
          height: 100,
          width: double.infinity,
        ),
      ],
    ),
  ),
)
Inheritance

Constructors

NxShimmerBox.new({Key? key, double width = double.infinity, double height = double.infinity, double opacity = 1, Color? color})
Creates a shimmer box widget.
const

Properties

color Color?
The background color of the box.
final
hashCode int
The hash code for this object.
no setterinherited
height double
The height of the shimmer box.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
opacity double
The opacity of the shimmer effect.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
width double
The width of the shimmer box.
final

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
createElement() StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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