heroicons_flutter

Heroicons for Flutter.

Icons List

All the available icons can be found at the official Heroicons website or at the demo site built with this package.

Usage

Static icons (recommended)

Import the default library and use the icon classes directly:

import 'package:heroicons_flutter/heroicons_flutter.dart';

class MyWidget extends StatelessWidget {
  const MyWidget({super.key});

  @override
  Widget build(BuildContext context) {
    return Column(
      children: [
        const Icon(
          HeroiconsSolid.faceSmile,
          color: Colors.blue,
        ),
        const Icon(
          HeroiconsMini.banknotes,
          color: Colors.blue,
        ),
        const Icon(
          HeroiconsOutline.academicCap,
          color: Colors.blue,
        ),
      ],
    );
  }
}

Icon fonts are tree-shaken when you use static icons this way.

String lookup (optional)

Resolve icons from a string at runtime with named() on the same class:

import 'package:heroicons_flutter/heroicons_flutter.dart';

Icon(HeroiconsOutline.named('academicCap'));
Icon(HeroiconsSolid.named('face_smile'));

named() accepts camelCase, snake_case, kebab-case, and dot.notation strings.

Deprecated fromString()

HeroiconsOutline.fromString() (and the same method on HeroiconsSolid, HeroiconsMini, and HeroiconsMicro) is deprecated. Use named() instead:

// Deprecated
HeroiconsOutline.fromString('academicCap');

// Preferred
HeroiconsOutline.named('academicCap');

Regenerating icon code

Icon classes are generated from lib/heroicons_list.dart:

dart run tool/generate_heroicons.dart