https://github.com/ampslabs/iconify

The ultimate icon solution for Flutter. Access 200,000+ icons instantly, with offline bundling and Impeller-ready hybrid rendering.
https://github.com/ampslabs/iconify

flutter icon iconify

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ampslabs/iconify
• Owner: ampslabs
• License: other
• Created: 2026-03-12T12:48:32.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2026-03-15T23:30:22.000Z (3 months ago)
• Last Synced: 2026-03-16T05:53:42.547Z (3 months ago)
• Topics: flutter, icon, iconify
• Language: Dart
• Homepage: https://iconify.aditi.cc/
• Size: 3.27 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md
  • Roadmap: ROADMAP.md

Awesome Lists containing this project

README

          
# 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](https://img.shields.io/pub/v/iconify_sdk)](https://pub.dev/packages/iconify_sdk)

[![License: MIT](https://img.shields.io/badge/license-MIT-purple.svg)](https://opensource.org/licenses/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**](packages/sdk) | `1.0.1` | The primary Flutter package with the `IconifyIcon` widget. |

| [**iconify_sdk_core**](packages/core) | `1.0.1` | Pure Dart engine for Iconify (models, providers, binary format). |

| [**iconify_sdk_cli**](packages/cli) | `1.0.1` | Command-line tool for syncing, bundling, and auditing icons. |

| [**iconify_sdk_builder**](packages/builder) | `1.0.1` | `build_runner` integration for automated icon bundling. |

## 🏁 Quick Start

1. **Add dependency**:

```bash

flutter pub add iconify_sdk

```

2. **Wrap your app**:

```dart

void main() {

  runApp(

    const IconifyApp(

      child: MyApp(),

    ),

  );

}

```

3. **Use any icon**:

```dart

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.

```bash

# 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](docs/performance-baseline.md).

## 📄 Documentation

- [Binary Format Specification](docs/binary-format-spec.md)

- [Configuration Reference](docs/config-spec.md)

- [License Guide](docs/license-guide.md)

- [Migration Guide](docs/guides/migration-from-iconify-flutter.md)

## ⚖️ License

MIT License. See [LICENSE](LICENSE) for details.