Skip to main content

pixelarticons 0.16.0 copy "pixelarticons: ^0.16.0" to clipboard
pixelarticons: ^0.16.0 copied to clipboard

Pixel Art Icons made simple for Flutter, powered by pixelarticons

Pixel Art Icons package for Flutter #

This package provides a set of pixel art icons as font for Flutter, it can be used in the same way we use Icons class.

Icon set created by @halfmage, if you like this free icon set you will also like the premium ones.

Show preview

Pixelarticons - Frame Pixelarticons - Frame

Install the package #

You can check the latest version on pub.dev/pixelarticons.

dependencies:
  # ...
  pixelarticons: <latest-version>
  # ...

or run:

flutter pub add pixelarticons

Import the package #

Import wherever you want:

import 'package:pixelarticons/pixelarticons.dart';

Use as IconData #

pixelarticons package uses the IconData class, so the usage is pretty much the same of the Icons class but renamed to Pixel.

Be aware:

  • Lower-case for all icons and no separators, for example arrow-down is written as Pixel.arrowdown.
  • Names starting with numbers and Dart keywords get a k prefix.

Icon full list https://pixelarticons.com/free/.

Icon(Pixel.android);
Icon(Pixel.clock);
Icon(Pixel.arrowdown);

Develop locally #

Use Dart 3.8+ and Flutter 3.32+ for the package. Development of the example and locked release tool uses Flutter 3.47+ / Dart 3.13+. Android also requires JDK 17.

The font and generated Pixel class are committed, so a fresh checkout works without downloading upstream icons or running the generator:

flutter pub get
flutter analyze
flutter test
cd example
flutter run -d chrome

The example also supports Android (flutter run with an Android device).

Sync and generate icons #

Automation lives in tool/, a standalone Dart package. Run its commands from that directory so Dart resolves the tool's own dependencies:

cd tool
dart pub get
dart run bin/pixelarticons_tool.dart --project-root .. --dry-run
dart run bin/pixelarticons_tool.dart --project-root ..

A sync fetches the current upstream commit, downloads that exact revision, extracts the free SVGs, and generates both fonts/pixelarticons.otf and lib/pixel.dart. It uses the Dart 3 compatible icon_font_generator instead of the retired fontify. All icons retain their 24×24 grid and lowercase Dart names, including keyword and numeric prefixes.

This breaking release uses only the current upstream icon set. Removed v1 icons and historical spelling aliases are no longer available. Update your Pixel references to names in the current icon set.

Glyph codepoints may change on regeneration; always use Pixel constants with the matching bundled font rather than storing numeric codepoints.

--no-cache rebuilds even when the upstream commit matches, without bumping the version or adding a duplicate changelog entry. --force-release explicitly bumps the version for a release without upstream changes. --dry-run does not modify the project.

# From tool/
dart run bin/pixelarticons_tool.dart --project-root .. --no-cache
dart analyze
dart test
cd ..
dart format lib test tool/lib tool/bin tool/test example/lib
flutter analyze
flutter test
cd example
flutter build web

CI and publishing #

To release manually, open GitHub → Actions → Update icons and publish release → Run workflow. Select the release branch and click Run workflow. By default, this checks upstream, downloads the current icons, regenerates the font and class, bumps the version, updates the changelog, runs validation, and pushes the commit and version tag together. The tag then starts Publish package to pub.dev automatically. Follow that second workflow to confirm publication.

Manual runs always create a new version, even when upstream icons are unchanged. Scheduled runs on the 1st and 15th only release when upstream changes are found.

One-time setup: add the repository secret TAG_PAT with permission to write repository contents, and enable automated publishing on pub.dev for libsrcdev/pixelarticons with tag pattern v{{version}}. The release token must be authorized by any repository rules that restrict branch or tag pushes.

  • validate.yml analyzes and tests the tool and package, checks formatting, and builds the web example on pushes and pull requests.
  • sync-upstream-icons.yml checks upstream on the 1st and 15th of each month or on manual dispatch, generates and validates artifacts, then commits and tags a release. Set the repository's TAG_PAT secret to a token authorized to push commits and tags; this allows the tag push to trigger the release workflow.
  • publish-pubdev.yml validates and publishes tagged releases using pub.dev OIDC automated publishing. Configure the trusted GitHub repository and tag pattern in the pub.dev package's automated publishing settings.

Remote issues addressed #

  • #5: solid clock: the current path-based clock is bundled, with a raster test verifying its hollow interior and visible outline.
  • #6: new icons: the generated package includes 1,036 current free upstream icons. Paid upstream icons are not distributed here.

Contribute #

Use the issues tab to discuss new features and bug reports.

16
likes
150
points
338
downloads

Documentation

Documentation
API reference

Publisher

verified publisherlibsrc.dev

Weekly Downloads

Pixel Art Icons made simple for Flutter, powered by pixelarticons

Repository (GitHub)
View/report issues

License

MIT (license)

Dependencies

flutter

More

Packages that depend on pixelarticons