Description

AssetIcon is a powerful and customizable Flutter package for rendering asset-based icons with ease.

Whether you're working with PNG, SVG, or other formats, this package allows you to adjust properties such as size, color, and opacity.

It also offers batch generation of Dart code for your asset keys, making it easier to manage large sets of icons.

✨ Features

1. 📁 Multiple Format Support: Display PNG and SVG icons seamlessly, along with support for other formats.

2. 🎨 Customization: Modify icon size, color, and opacity to fit your app's theme.

3. 🔧 Global Configuration: Set default path and color for consistent styling.

4. 🛡️ Accessibility: Add semantic labels for screen readers.

5. 🚀 Automated Icon Key Generation: Generate constant keys for all icons in your assets folder.

📦 Installation

Add AssetIcon to your pubspec.yaml:

dependencies:
  assets_icon: ^latest_version

💻 Code Generation

Run the generator with:

dart run asset_icon:generate --source-dir assets/icons/ --class-name MyAssetIcons --output-dir lib/generated --output-file my_icons.g.dart

📁 Example Folder Structure

assets/
└── icons/
    ├── example_icon.png
    ├── example_icon.svg
    └── other_icon.png

🤝 Contribute

Submit issues or pull requests to improve functionality.

📜 License

MIT License

Challenges

Managing icons in Flutter projects often becomes complicated when:

• Working with many files spread across directories.

• Needing SVG support (not available in ImageIcon).

• Adjusting opacity or accessibility labels.

• Maintaining consistency without constants for asset paths.

Solutions

• AssetIcon solves these problems by:

• ✅ Supporting both PNG and SVG formats.

• ✅ Allowing customization of size, color, and opacity.

• ✅ Adding semantic labels for accessibility.

• ✅ Providing automated code generation for icon keys, ensuring consistency across the app.