Buscar pacotes, repositórios e categorias de apps

Detalhes do pacotev4.1.0

icon_font_generator

Converte ícones SVG para fonte OTF e gera uma classe compatível com Flutter. Fornece uma API e uma ferramenta de linha de comando.

AndroidiOSWebmacOSWindowsLinux
Downloads em 30 dias
33,6 mil
Curtidas
147
Pontos Pub
130

Instalar pacote

flutter pub add icon_font_generator

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

Um pacote Flutter/Dart que converte ícones SVG em fontes OTF e gera uma classe Dart correspondente para fácil integração em aplicativos Flutter. Oferece tanto uma interface de linha de comando (CLI) quanto uma API para automação, permitindo que desenvolvedores otimizem a gestão de ícones em múltiplas plataformas. A fonte gerada é compatível com Android, iOS, Web, macOS, Windows e Linux, garantindo renderização consistente de ícones. Ideal para equipes que gerenciam conjuntos personalizados de ícones de forma eficiente.

Casos de uso

  • Gerar fontes de ícones personalizadas a partir de SVGs
  • Automatizar a criação de ativos de ícone
  • Integre ícones vetoriais em aplicativos Flutter
  • Suporte de renderização de ícone multiplataforma
  • Simplifique fluxos de trabalho de design para código

Principais recursos

  • Conversão de SVG para fonte OTF
  • Geração de classe Dart para ícones
  • Interfaces de CLI e API
  • Suporte multiplataforma
  • Gerenciamento de conjunto de ícones personalizados
  • Integração fácil com o Flutter

Indicado para

  • Desenvolvedores Flutter
  • equipes de design
  • engenheiros de UI/UX
  • Aplicativos que exigem ícones personalizados
  • Projetos com atualizações frequentes de ícones

Considerações

  • Requer arquivos SVG como entrada
  • Necessita de configuração para uso por meio da CLI ou API
  • Pode exigir etapas adicionais de compilação
  • Considerações sobre o tamanho do arquivo de fonte
  • Limitado a casos de uso apenas com ícones

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

icon_font_generator

pub package

The icon_font_generator package provides an easy way to convert SVG icons to OpenType font and generate Flutter-compatible class that contains identifiers for the icons (just like CupertinoIcons or Icons classes).

The package is written fully in Dart and doesn't require any external dependency. Compatible with dart2js and dart2native.

Font generation

Install via dev dependency
$ flutter pub add --dev icon_font_generator

# And it's ready to go:
$ flutter pub run icon_font_generator:generate <input-svg-dir> <output-font-file> [options]
or Globally activate the package:
$ pub global activate icon_font_generator

# And it's ready to go:
$ icon_font_generator <input-svg-dir> <output-font-file> [options]

Required positional arguments:

  • <input-svg-dir> Path to the input directory that contains .svg files.
  • <output-font-file> Path to the output font file. Should have .otf extension.

Flutter class options:

  • -o or --output-class-file=<path> Output path for Flutter-compatible class that contains identifiers for the icons.
  • -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.

Font options:

  • -f or --font-name=<name> Name for a generated font.
  • --[no-]normalize Enables glyph normalization for the font. Disable this if every icon has the same size and positioning. (defaults to on)
  • --[no-]ignore-shapes Disables SVG shape-to-path conversion (circle, rect, etc.). (defaults to on)

Other options:

  • -z or --config-file=<path> Path to icon_font_generator yaml configuration file. pubspec.yaml and icon_font.yaml files are used by default.
  • -r or --recursive Recursively look for .svg files.
  • -v or --verbose Display every logging message.
  • -h or --help Shows usage information.

Usage example:

$ icon_font_generator assets/svg/ fonts/my_icons_font.otf --output-class-file=lib/my_icons.dart -r

Updated Flutter project's pubspec.yaml:

flutter:
  fonts:
    - family: My Icons
      fonts:
        - asset: fonts/my_icons_font.otf

Config file

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

icon_font:
  input_svg_dir: "assets/svg/"
  output_font_file: "fonts/my_icons_font.otf"
  
  output_class_file: "lib/my_icons.dart"
  class_name: "MyIcons"
  package: my_font_package
  format: true

  font_name: "My Icons"
  normalize: true
  ignore_shapes: true

  recursive: true
  verbose: false

input_svg_dir and output_font_file keys are required. It's possible to specify any other config file by using --config-file option.

Using API

svgToOtf and generateFlutterClass functions can be used for generating font and Flutter class.

The example of API usage is located in example folder.

Notes

  • Generated OpenType font is using CFF table.
  • Generated font is using PostScript Table (post) of version 3.0, i.e., it doesn't contain glyph names.
  • Supported SVG elements: path, g, circle, rect, polyline, polygon, line.
  • SVG transforms are applied to paths according to specs.
  • SVG <g> element's children are expanded to the root with transformations applied. Anything else related to the group is ignored and group referencing is not supported.
  • Consider using Non-zero fill rule.
  • When ignoreShapes is set to false, every SVG shape's (circle, rect, etc.) outline is converted to path. Note that any attributes like "fill" or "stroke" are ignored and only the outline is used, so the resulting glyph may look different from SVG icon. It's recommended to convert every element in SVG to path.
  • When normalize is set to false, it's recommended that SVG icons have the same height. Otherwise, final result might not look as expected.
  • When Flutter class is generated, static variables names derive from SVG file name converted to pascal case with non-allowed characters removed. Name is set to 'unnamed', if it's empty. Suffix '_{i+1}' is added, if name already exists.

Contributing

Any suggestions, issues, pull requests are welcomed.

License

MIT

Credits

This software is fork of unsupported package:

Categorias

Dependências

Lista de dependências 11 itens

Repositório-fonte

Projetos que usam este pacote