icomoon_download 0.0.3

A tool to download icomoon icons from icomoon.io and generate a dart file to use in Flutter (using icomoon_generator package) Provides an API and a CLI tool.

icomoon_download

A tool to download icomoon icons from icomoon.io and generate a dart file to use in Flutter (using icomoon_generator package). Please note that this package is not affiliated with icomoon.io. It's just a tool to help you download and use icomoon icons in Flutter.

Font generation

Install via dev dependency

$ flutter pub add --dev icomoon_download

# And it's ready to go:
$ flutter pub run icomoon_download:generate <project-name> <host-id> <output-class-file> [options]

or Globally activate the package:

$ pub global activate icomoon_download

# And it's ready to go:
$ icomoon_download <project-name> <host-id> <output-class-file> [options]

Example: https://i.icomoon.io/public/temp/12345/MyProject/selection.json <- project-name is MyProject, host-id is 12345 and --no-is-temp option (default) is used. Required positional arguments:

• <project-name> Name of the project.
• <host-id> Host ID of the project.
• <output-class-file> Path to the output class file. Should have .dart extension.

Flutter class options:

• -c or --class-name=<name> Name for a generated class.
• -p or --package=<name> Name of a package that provides a font. Used to provide a font through package dependency.
• --[no-]format Format dart generated code.

Other options:

• --[no-]-is-temp Using free version of icomoon.
• -s or --output-selection-file=<path> Output file for the selection.json. If not provided, the file is saved in the current working directory.
• -z or --config-file=<path> Path to icomoon_download yaml configuration file. pubspec.yaml and icomoon_download.yaml files are used by default.
• -v or --verbose Display every logging message.
• -h or --help Shows usage information.

Usage example:

Updated Flutter project's pubspec.yaml:

flutter:
  fonts:
    - family: Icomoon
      fonts:
        - asset: fonts/icomoon.ttf

$ icomoon_download MyProject 12345 lib/my_icons.dart --class-file=MyIcons --output-selection-file=selection.json -v

Config file

icomoon_download's configuration can also be placed in yaml file. Add icomoon_download section to either pubspec.yaml or icomoon_download.yaml file:

icomoon_download:
  project_name: MyProject
  host_id: "123456"
  is_temp: true

  output_selection_file: fonts/selection.json
  output_class_file: lib/ui/icons.dart

  class_name: UiIcons
  format: true

  verbose: false

project_name, host_id and output_class_file keys are required. It's possible to specify any other config file by using --config-file option.

Contributing

Any suggestions, issues, pull requests are welcomed.

License

MIT