Flutter Octicons

GitHub's octicons for your Flutter app

About

This Dart package allows you to use Octicon icons developed by GitHub and released under the MIT license in Flutter.

flutter_octicons automatically updates itself every night to always stay up to date with the upstream Octicons project.

Usage

import 'package:flutter_octicons/flutter_octicons.dart';

Icon(OctIcons.telescope_fill_24);

Please note that all icons included in this package are of the same size when used as above (set to the default provided by IconTheme), which is usually 24. To correctly set the size for e.g. Octicons of size 16, please provide the following argument:

Icon(OctIcons.telescope_fill_16, size: 16);

Octicons list

For a full list of all Octicons see here

Rolling updates

The motivation for me to create this package was that octicons_icon has not been updated in a long time.

This library automatically avoids becoming stale by rolling in the newest icons changes from the upstream Octicons repository every night.

To comply with the versioning imposed by dart, the minor version always increases by 1 for each update (major.MINOR.patch). You can either specify any as your version constraint to always live at head or remember to update the version once new icons become available.

Why the minor version?
Because new versions may be breaking for you, icons could be changed or completely deleted.

Credits

This package (especially the automation) would not be possible without these awesome projects:

• octicons
• svg-fixer
• fantasticon
• ttfdump

License

BSD 3-Clause “New” or “Revised” License