Shimmer Alternative is a Flutter package designed to provide beautiful shimmer effects for loading states in your apps. This package is perfect for adding visually appealing animations to your cards, containers, text, and text fields, making the loading experience more engaging for users.
Properties
- `child` (Widget): The widget below this widget in the tree.
- `baseColor` (Color): The base color of the shimmer effect.
- `highlightColor` (Color): The highlight color of the shimmer effect.
- `duration` (Duration): The duration of the shimmer animation.
- `direction` (ShimmerDirection): The direction of the shimmer animation.
- `shape` (ShimmerShape): The shape of the shimmer effect.
- `customGradient` (Gradient?): The custom gradient of the shimmer effect.
- `isDarkMode` (bool): Whether to automatically adjust colors for dark mode.
- `customShapeBuilder` (CustomShapeBuilder?): Custom shape builder callback.
- `onAnimationStart` (VoidCallback?): Callback when the animation starts.
- `onAnimationStop` (VoidCallback?): Callback when the animation stops.
- `colorInterpolation` (double): The interpolation factor for color blending.
- `opacity` (double): The opacity of the shimmer effect.
- `loopCount` (int): The number of times the animation should loop.
- `easing` (Curve): The easing curve for the animation.
Properties ShimmerDirection
- `ltr`: Left to right.
- `rtl`: Right to left.
- `ttb`: Top to bottom.
- `btt`: Bottom to top.
Properties ShimmerShape
- `rectangle`: Rectangle shape
- `circle`: Circle shape
- `custom`: Custom shape
- Customizable shimmer colors
- Adjustable shimmer speed
- Support for multiple directions (left-to-right, right-to-left, top-to-bottom, bottom-to-top)
- Support for multiple shapes (rectangle, circle, custom)
- Custom gradient support
- Automatic dark mode adjustment
- Easy integration with existing widgets
- Lightweight and highly customizable
- Animation control (pause and resume)
- Interpolated colors and opacity control
- Loop count and easing curve support
To use this package, add shimmer_alternative as a dependency in your pubspec.yaml file:
dependencies:
shimmer_alternative: ^0.0.6Here is a simple example of how to use Shimmer Alternative:
import 'package:flutter/material.dart';
import 'package:shimmer_alternative/shimmer_alternative.dart';
void main() => runApp(MyApp());
class MyApp extends StatelessWidget {
const MyApp({Key? key}) : super(key: key);
@override
Widget build(BuildContext context) {
return MaterialApp(
theme: ThemeData.light(),
darkTheme: ThemeData.dark(),
themeMode: ThemeMode.system,
home: Scaffold(
appBar: AppBar(
title: const Text('Shimmer Alternative Example'),
),
body: Padding(
padding: const EdgeInsets.all(8.0),
child: Column(
children: [
ShimmerAlternative(
duration: const Duration(seconds: 2),
direction: ShimmerDirection.ttb,
isDarkMode: true,
child: Container(
width: double.infinity,
height: 150.0,
color: Colors.grey[300],
),
),
const SizedBox(height: 20),
ShimmerAlternative(
duration: const Duration(seconds: 3),
direction: ShimmerDirection.btt,
child: const Text(
'Loading text...',
style: TextStyle(
fontSize: 24.0,
fontWeight: FontWeight.bold,
color: Colors.grey[300],
),
),
),
const SizedBox(height: 20),
ShimmerAlternative(
duration: const Duration(seconds: 1),
direction: ShimmerDirection.rtl,
child: const TextField(
decoration: InputDecoration(
border: OutlineInputBorder(),
labelText: 'Loading...',
fillColor: Colors.grey[300],
filled: true,
),
),
),
const SizedBox(height: 20),
ShimmerAlternative(
customGradient: const LinearGradient(
colors: [Colors.red, Colors.blue, Colors.green],
stops: [0.4, 0.5, 0.6],
),
child: Container(
width: double.infinity,
height: 150.0,
color: Colors.grey[300],
),
),
const SizedBox(height: 20),
ShimmerAlternative(
shape: ShimmerShape.custom,
customShapeBuilder: (canvas, size, paint) {
Path path = Path();
path.moveTo(size.width * 0.5, 0);
path.lineTo(size.width, size.height);
path.lineTo(0, size.height);
path.close();
canvas.drawPath(path, paint);
},
child: Container(
width: double.infinity,
height: 150.0,
color: Colors.grey[300],
),
),
],
),
),
),
);
}
}You can customize the base color and highlight color of the shimmer effect:
ShimmerAlternative(
baseColor: Colors.grey[300]!,
highlightColor: Colors.grey[100]!,
child: Container(
width: double.infinity,
height: 150.0,
color: Colors.grey[300],
),
);You can adjust the speed of the shimmer effect by changing the duration parameter:
ShimmerAlternative(
duration: Duration(seconds: 2),
child: Container(
width: double.infinity,
height: 150.0,
color: Colors.grey[300],
),
);You can change the direction of the shimmer effect using the direction parameter:
ShimmerAlternative(
direction: ShimmerDirection.ttb,
child: Container(
width: double.infinity,
height: 150.0,
color: Colors.grey[300],
),
);You can change the shape of the shimmer effect using the shape parameter:
ShimmerAlternative(
shape: ShimmerShape.circle,
child: Container(
width: 100.0,
height: 100.0,
color: Colors.grey[300],
),
);You can use a custom gradient for the shimmer effect by setting the customGradient parameter:
ShimmerAlternative(
customGradient: LinearGradient(
colors: [Colors.red, Colors.blue, Colors.green],
stops: [0.4, 0.5, 0.6],
),
child: Container(
width: double.infinity,
height: 150.0,
color: Colors.grey[300],
),
);You can automatically adjust the colors for dark mode by setting the isDarkMode parameter:
ShimmerAlternative(
isDarkMode: true,
child: Container(
width: double.infinity,
height: 150.0,
color: Colors.grey[300],
),
);You can define a custom shape for the shimmer effect by using the customShapeBuilder parameter:
ShimmerAlternative(
shape: ShimmerShape.custom,
customShapeBuilder: (canvas, size, paint) {
Path path = Path();
path.moveTo(size.width * 0.5, 0);
path.lineTo(size.width, size.height);
path.lineTo(0, size.height);
path.close();
canvas.drawPath(path, paint);
},
child: Container(
width: double.infinity,
height: 150.0,
color: Colors.grey[300],
),
);You can pause and resume the shimmer animation using pauseAnimation and resumeAnimation methods.
final GlobalKey<ShimmerAlternativeState> shimmerKey = GlobalKey<ShimmerAlternativeState>();
ShimmerAlternative(
key: shimmerKey,
child: Container(
width: double.infinity,
height: 150.0,
color: Colors.grey[300],
),
);
ElevatedButton(
onPressed: () {
shimmerKey.currentState?.pauseAnimation();
},
child: const Text('Pause Animation'),
);
ElevatedButton(
onPressed: () {
shimmerKey.currentState?.resumeAnimation();
},
child: const Text('Resume Animation'),
);Q: How do I customize the shimmer colors?
A: You can customize the shimmer colors by setting the baseColor and highlightColor properties.
Q: How do I change the speed of the shimmer animation?
A: You can change the speed by setting the duration property.
Q: Can I use ShimmerAlternative with other widgets like ListView or GridView?
A: Yes, you can use ShimmerAlternative with any widget.
Q: How do I use custom shapes in the shimmer effect?
A: You can set the shape property to ShimmerShape.custom and implement custom drawing logic in the customShapeBuilder callback.
Q: How do I use a custom gradient for the shimmer effect?
A: You can set the customGradient property to define a custom gradient.
Q: How do I enable dark mode adjustment?
A: You can set the isDarkMode property to true to automatically adjust the colors for dark mode.
Q: How do I control the shimmer animation?
A: You can use the pauseAnimation and resumeAnimation methods to control the shimmer animation.
If you find this project useful and would like to support its ongoing development, consider making a donation.
Thank you for considering contributing to Shimmer Alternative! Here are some guidelines to help you get started:
- Fork the repository.
- Create a new branch (
git checkout -b feature/your-feature). - Make your changes.
- Commit your changes (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature/your-feature). - Create a new Pull Request.
Please ensure your pull request adheres to the following guidelines:
- Describe the changes in detail.
- Update documentation if needed.
- Write tests for new features.
- Ensure code passes all tests and lints.
Contributions are welcome! If you have any ideas, suggestions, or find a bug, please create an issue or submit a pull request.
License This project is licensed under the GPL-3.0 license - see the LICENSE file for details.