iconify_sdk library

The Flutter package for Iconify icons.

This package provides the IconifyIcon widget, which allows you to render any icon from over 200 open-source icon sets with a single widget.

Quick start:

void main() {
  runApp(
    const IconifyApp(
      child: MaterialApp(
        home: Scaffold(
          body: Center(
            child: IconifyIcon('mdi:home'),
          ),
        ),
      ),
    ),
  );
}

Classes

AssetBundleLivingCacheStorage
A LivingCacheStorage implementation that reads from the Flutter AssetBundle.
FileSystemLivingCacheStorage
A LivingCacheStorage implementation that uses dart:io for filesystem access.
FlutterAssetBundleIconifyProvider
An IconifyProvider that reads Iconify JSON files from a Flutter AssetBundle.
IconifyApp
A wrapper widget that initializes and provides the Iconify environment.
IconifyCollectionInfo
Metadata for an Iconify icon collection (icon set).
IconifyConfig
Global configuration for the Iconify SDK.
IconifyDiagnostics
Provides diagnostic information for the Iconify SDK.
IconifyErrorWidget
The default widget shown when an IconifyIcon fails to load.
IconifyIcon
A widget that renders an Iconify icon by its prefix:name identifier.
IconifyIconData
The data for a single Iconify icon.
IconifyLicense
License information for an icon collection.
IconifyName
An immutable, validated Iconify icon identifier.
IconifyProvider
The core abstraction for resolving Iconify icon data.
IconifyScope
Provides an IconifyProvider to the widget tree.
LivingCacheProvider
A provider that manages a "living cache" of icons used by the application.
LivingCacheStorage
An abstraction for reading and writing the living cache file.
MemoryIconifyProvider
An IconifyProvider backed by in-memory maps.
PictureCacheStats
Statistics for the IconifyPictureCache.
RemoteIconifyProvider
An IconifyProvider that fetches icons from the Iconify HTTP API.

Enums

IconifyMode
Defines the operational mode for icon resolution.
RenderStrategy
Defines how icons should be rendered in the Flutter layer.

Exceptions / Errors

CircularAliasException
Thrown when a circular alias chain is detected.
CollectionNotFoundException
Thrown when a collection is not available in any configured provider.
IconifyCacheException
Thrown when the local cache fails to read or write.
IconifyException
Base sealed exception for all Iconify errors.
IconifyNetworkException
Thrown on HTTP or network-layer failures.
IconifyParseException
Thrown when the Iconify JSON data is malformed or fails schema validation.
IconNotFoundException
Thrown when an icon is not found in any provider.
InvalidIconNameException
Thrown when an icon identifier string cannot be parsed.