auto_shimmer_animate 0.0.2
auto_shimmer_animate: ^0.0.2 copied to clipboard
A Flutter package that automatically converts existing widget trees into animated shimmer skeleton loading states.
Auto Shimmer Animate #
auto_shimmer_animate automatically converts your existing Flutter widgets
into animated shimmer skeleton loaders without creating separate placeholder UI.
Supports Null Safety
Wrap your real UI once and let the package render a shimmer skeleton while data is loading. Common Flutter widgets are transformed automatically, and custom widgets fall back gracefully.
Features #
- Automatic shimmer skeleton generation
- No duplicate loading UI
- State-based shimmer support
- Custom shimmer builder
- Global shimmer theme
- Built-in shimmer engine with no third-party shimmer dependency
- Android, iOS, Web, Windows, macOS, Linux
Preview #
Installation #
dependencies:
auto_shimmer_animate: ^0.0.2
flutter pub get
Import #
import 'package:auto_shimmer_animate/auto_shimmer_animate.dart';
Usage #
Basic Usage #
AutoShimmerAnimate(
isLoading: isLoading,
child: ProductCard(),
)
Custom Colors #
AutoShimmerAnimate(
isLoading: true,
baseColor: Colors.grey.shade300,
highlightColor: Colors.grey.shade100,
child: ProductCard(),
)
Custom Timing #
AutoShimmerAnimate(
isLoading: isLoading,
duration: const Duration(milliseconds: 1200),
repeatDelay: const Duration(milliseconds: 100),
child: ProductCard(),
)
Custom Direction #
AutoShimmerAnimate(
isLoading: isLoading,
direction: AutoShimmerDirection.rightToLeft,
child: ProductCard(),
)
State-Based Usage #
AutoShimmerStateAnimate<ViewStatus>(
state: status,
loadingStates: const [ViewStatus.loading],
child: ProfileView(),
)
Global Theme #
AutoShimmerTheme(
data: AutoShimmerConfig(),
child: MyApp(),
)
API Overview #
| API | Description |
|---|---|
AutoShimmerAnimate |
Automatically transforms widgets into shimmer skeletons |
AutoShimmerStateAnimate<T> |
State-driven shimmer wrapper |
AutoShimmerTheme |
Provides global shimmer configuration |
AutoShimmerConfig |
Controls shimmer appearance and behavior |
AutoShimmerDirection |
Controls the built-in shimmer sweep direction |
Example #
cd example
flutter pub get
flutter run
See the example/ directory for a complete runnable Flutter app.
Additional Information #
The package automatically transforms common Flutter widgets and gracefully falls back for unsupported custom widgets.
License #
MIT License