Skip to content

ampslabs/iconify

Repository files navigation

Iconify SDK for Flutter

The definitive Flutter SDK for Iconify. Access 200,000+ open-source icons from 100+ collections (MDI, Lucide, Phosphor, etc.) with zero-config setup and high-performance production bundling.

Pub Version License: MIT


🚀 Key Features

  • Blistering Performance:proprietary .iconbin format for zero-parsing startup and $O(\log n)$ lookup.
  • Intelligent Bundling: Automatic GZIP compression and monochromatic font path for minimal bundle footprint.
  • Impeller Ready: Hardware-accelerated rendering with intelligent raster fallbacks.
  • Offline-First: Built-in "Starter Registry" and "Living Cache" system.
  • License Aware: Automatic attribution report generation and license policy enforcement.

📦 Packages

Package Version Description
iconify_sdk 1.0.1 The primary Flutter package with the IconifyIcon widget.
iconify_sdk_core 1.0.1 Pure Dart engine for Iconify (models, providers, binary format).
iconify_sdk_cli 1.0.1 Command-line tool for syncing, bundling, and auditing icons.
iconify_sdk_builder 1.0.1 build_runner integration for automated icon bundling.

🏁 Quick Start

  1. Add dependency:
flutter pub add iconify_sdk
  1. Wrap your app:
void main() {
  runApp(
    const IconifyApp(
      child: MyApp(),
    ),
  );
}
  1. Use any icon:
IconifyIcon('mdi:rocket', color: Colors.blue, size: 32)

🛡️ The Production Workflow

Iconify SDK is designed to be frictionless in development and rigid in production.

  1. Install CLI: dart pub global activate iconify_sdk_cli
  2. Build: Just run iconify in your project root.
  3. Result: The tool scans your code, downloads missing data, and bundles optimized assets.
# One-command optimization
iconify

📊 Performance Baseline

Feature JSON (v1) Binary (v2) Improvement
Startup Parse 29ms 11ms 2.6x
Icon Lookup 11.8ms 3.9μs ~3000x
Bundle Size (50 icons) 21KB 6KB (GZ) 70% reduction

For detailed metrics, see docs/performance-baseline.md.

📄 Documentation

⚖️ License

MIT License. See LICENSE for details.

About

The ultimate icon solution for Flutter. Access 200,000+ icons instantly, with offline bundling and Impeller-ready hybrid rendering.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

 
 
 

Contributors

Languages