liquid_loader 0.0.7

This library adds a liquid loading effect to your screen. Use it as a loading indicator, progress tracker, or any measurement tool.

Liquid Loader

Liquid Loader is a Flutter plugin that creates animated liquid effects inside custom-shaped bottles. It supports various bottle shapes (spherical, triangular, and rectangular) with dynamic animations for the liquid and waves. The package also provides animated bubbles, glossy effects, and customizable colors to make the liquid effect look more realistic.

License

This package is licensed under the BSD-3-Clause License. See the LICENSE file for more details.

Features

• Animated liquid waves in custom-shaped bottles.
• Bubbles with random movements inside the bottle.
• Glossy overlay effect for a shiny liquid appearance.
• Supports different bottle shapes: spherical, triangular, and rectangular.
• Fully customizable colors for the liquid, border, and cap.
• Easy to use and integrate into any Flutter app.

Installation

To install the liquid_loader package, add the following dependency in your pubspec.yaml file:

Example

     LiquidLoader(
        width: 300,  // Width of the loader
        height: 500, // Height of the loader
        liquidColor: Colors.blue, // Liquid color
        borderColor: Colors.grey, // Border color
        capColor: Colors.orange, // Cap color
        liquidLevel: 0.6, // Liquid level (0.0 to 1.0)
        text: "60%", // Text inside the bottle
        textStyle: TextStyle(color: Colors.white, fontSize: 20), // Text style
        shape: Shape.rectangle, // Bottle shape: circle, triangle, rectangle
        hideCap: true, // Whether to hide the cap
     ),

Parameters

• width: The width of the loader (in pixels).
• height: The height of the loader (in pixels).
• liquidColor: The color of the liquid inside the bottle.
• borderColor: The color of the bottle's border.
• capColor: The color of the cap on the bottle.
• liquidLevel: The level of liquid inside the bottle (0.0 to 1.0).
• text: Optional text to display inside the bottle.
• textStyle: Optional styling for the text inside the bottle.
• shape: The shape of the bottle. It can be Shape.circle, Shape.triangle, or Shape.rectangle.
• hideCap: If set to true, the cap will be hidden

Contribution

We welcome contributions to this package! If you find bugs or want to suggest improvements, feel free to open an issue or submit a pull request on GitHub.

Key Sections:

1. Introduction: Provides a description of the package and its features.
2. License: Specifies the BSD-3-Clause license for the package.
3. Features: Lists key features of the package.
4. Installation: Provides steps for installing the package in a Flutter project.
5. Usage: Gives an example of how to use the LiquidLoader widget with customizable parameters.
6. Customization: Explains how to further customize the liquid loader's appearance and behavior.
7. Example Application: Provides instructions on running the example app.
8. Contribution: Encourages contributions and provides instructions on how to contribute.
9. Contact: Provides contact details for inquiries.
10. Footer: Shows the author’s name with a nice touch.

This README.md provides all necessary information to help users get started with your liquid_loader package and integrate it into their apps. Let me know if you need further adjustments or additions!

Contact

For any inquiries, please reach out to [e-mail]

Made with ❤️ by Muhammad Farooq Iqbal

dependencies:
  liquid_loader: any