iconify_sdk

The definitive Iconify SDK for Flutter. Instant access to 200,000+ open-source icons with zero-config setup and production-grade optimization.

Installation

Add iconify_sdk to your pubspec.yaml:

dependencies:
  iconify_sdk: ^1.0.0

Getting Started

Add iconify_sdk to your pubspec.yaml and wrap your app in IconifyApp:

import 'package:flutter/material.dart';
import 'package:iconify_sdk/iconify_sdk.dart';

void main() {
  runApp(
    const IconifyApp(
      child: MyApp(),
    ),
  );
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: Scaffold(
        body: Center(
          // One-liner usage. Fetches from API in debug,
          // then you bundle it for production.
          child: IconifyIcon('mdi:home', size: 48, color: Colors.blue),
        ),
      ),
    );
  }
}

Key Features

• 🚀 Zero Config: Works out of the box in Debug mode using the Iconify API.
• 📦 Offline First: Built-in "Starter Registry" with top icons from MDI, Lucide, Tabler, and Heroicons.
• ⚡ High Performance:
  • .iconbin Format: Ultra-fast binary format with zero-parsing startup.
  • Picture Cache: Intelligent LRU caching for dart:ui.Picture objects to minimize re-render overhead.
  • Impeller Ready: Optimized rendering paths for Flutter's newest engine.
• 📏 Bundle Intelligence:
  • GZIP Support: Built-in support for compressed assets, reducing icon data size by ~70%.
  • Font Path: Optional monochromatic font generation for 40% smaller footprint than raw SVG.
  • Web Optimized: Sprite sheet generation for the Flutter Web HTML renderer.
• 📊 Diagnostics: Built-in performance monitoring via IconifyDiagnostics.

The Production Workflow

iconify_sdk is designed to be frictionless in development and rigid in production.

1. Development: Use any icon string (e.g., mdi:rocket). The SDK fetches it automatically.
2. Sync: Run iconify sync to download the full collections you're using.
3. Generate: Run iconify generate --compress --font to bundle exactly the icons you use with maximum optimization.
4. Deploy: Your app now runs 100% offline with zero network overhead and a minimal bundle size.

Documentation

For advanced configuration and tooling details, see the Full Documentation.

License

This project is licensed under the MIT License. See the LICENSE file for details.