https://github.com/vaetas/heroicons

HeroIcons SVG icons for Flutter
https://github.com/vaetas/heroicons

dart flutter flutter-package

Last synced: about 2 months ago
JSON representation

HeroIcons SVG icons for Flutter

• Host: GitHub
• URL: https://github.com/vaetas/heroicons
• Owner: vaetas
• License: mit
• Created: 2020-09-03T19:17:28.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-02-21T22:04:57.000Z (11 months ago)
• Last Synced: 2024-02-22T22:43:30.271Z (11 months ago)
• Topics: dart, flutter, flutter-package
• Language: Dart
• Homepage: https://pub.dev/packages/heroicons
• Size: 855 KB
• Stars: 15
• Watchers: 1
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# HeroIcons

[heroicons](https://heroicons.com/) port to Flutter. This package renders the icons as SVG

images.

  

  This package was last updated to use [heroicons](https://heroicons.com/)

  version [`2.1.1`](https://github.com/tailwindlabs/heroicons/releases/tag/v2.1.1)

  (on `February 21st, 2024`). If there's a newer version of HeroIcons available, please

  create an issue or pull request.

## Usage

```dart

class MyExampleWidget extends StatelessWidget {

  @override

  Widget build(BuildContext context) {

    return HeroIcon(

      HeroIcons.calendar,

      style: HeroIconStyle.outline, // Outlined icons are used by default.

      color: Colors.red,

      size: 30,

    );

  }

}

```

You can also use `HeroIconTheme` to set the default style (e.g., outline or solid) for all icons in your app.

(You'll still be able to override the style for individual icons.)

```dart

class MyApp extends StatelessWidget {

  @override

  Widget build(BuildContext context) {

    return MaterialApp(

      // ...

      home: HeroIconTheme(

        style: HeroIconStyle.solid,

        child: MyHomePage(),

      ),

    );

  }

}

```

## Install

Add `heroicons` package into your `pubspec.yaml`.

```yaml

dependencies:

  heroicons: # Latest version

```

You can also run `flutter pub add heroicons` to quickly add latest version from your CLI.

## Development

Fetch new icons and automatically generate source code for `heroicons.dart` (runs both of the below steps)

```

dart tool/update.dart

```

### Extra Commands

If, for any reason, you need to run the steps separately, you can do so as follows:

- Fetch new icons, organize into `assets/` and update the README.

  ```bash

  dart tool/fetch_icons.dart

  ```

  

  Optionally, a branch may be specified to fetch icons from. For example, to fetch icons from the `dev` branch:

  ```bash

  dart tool/fetch_icons.dart dev

  ```

  

  Note that older branches (i.e., `v1`) won't work yet as the SVGs are organized differently and not all styles are

  available.

- Run source code generation to create `heroicons.dart` file with an enum entry for every icon.

  ```bash

  dart tool/generator.dart

  ```