Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/westracer/fontify
Converts SVG icons to OTF font and generates Flutter-compatible class. Provides an API and a CLI tool.
https://github.com/westracer/fontify
converter dart flutter font-generator svg-converter svgtofont
Last synced: 8 days ago
JSON representation
Converts SVG icons to OTF font and generates Flutter-compatible class. Provides an API and a CLI tool.
- Host: GitHub
- URL: https://github.com/westracer/fontify
- Owner: westracer
- License: other
- Created: 2020-06-06T18:01:53.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-11T14:24:34.000Z (5 months ago)
- Last Synced: 2024-08-01T19:37:43.928Z (3 months ago)
- Topics: converter, dart, flutter, font-generator, svg-converter, svgtofont
- Language: Dart
- Homepage:
- Size: 511 KB
- Stars: 102
- Watchers: 5
- Forks: 12
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-list - fontify - compatible class. Provides an API and a CLI tool. | westracer | 104 | (Dart)
README
# Fontify
[](https://pub.dartlang.org/packages/fontify)
The Fontify 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.
[CupertinoIcons]: https://api.flutter.dev/flutter/cupertino/CupertinoIcons-class.html
[Icons]: https://api.flutter.dev/flutter/material/Icons-class.html
# Using CLI tool
[Globally activate][] the package:
[globally activate]: https://dart.dev/tools/pub/cmd/pub-global
```
$ pub global activate fontify
```
And it's ready to go:
```
$ fontify [options]
```
Required positional arguments:
- ``
Path to the input directory that contains .svg files.
- ``
Path to the output font file. Should have .otf extension.
Flutter class options:
- `-o` or `--output-class-file=`
Output path for Flutter-compatible class that contains identifiers for the icons.
- `-i` or `--indent=`
Number of spaces in leading indentation for Flutter class file.
(defaults to "2")
- `-c` or `--class-name=`
Name for a generated class.
- `-p` or `--package=`
Name of a package that provides a font. Used to provide a font through package dependency.
Font options:
- `-f` or `--font-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 to Fontify yaml configuration file.
pubspec.yaml and fontify.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:*
```
$ fontify assets/svg/ fonts/my_icons_font.otf --output-class-file=lib/my_icons.dart --indent=4 -r
```
Updated Flutter project's pubspec.yaml:
```yaml
...
flutter:
fonts:
- family: Fontify Icons
fonts:
- asset: fonts/my_icons_font.otf
```
# CLI tool config file
Fontify's configuration can also be placed in yaml file.
Add _fontify_ section to either `pubspec.yaml` or `fontify.yaml` file:
```yaml
fontify:
input_svg_dir: "assets/svg/"
output_font_file: "fonts/my_icons_font.otf"
output_class_file: "lib/my_icons.dart"
class_name: "MyIcons"
indent: 4
package: my_font_package
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][].
[example folder]: https://github.com/westracer/fontify/tree/master/example/example.dart
[svgToOtf]: https://pub.dev/documentation/fontify/latest/fontify/svgToOtf.html
[generateFlutterClass]: https://pub.dev/documentation/fontify/latest/fontify/generateFlutterClass.html
# 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 `` 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.
[Non-zero fill rule]: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule
# Planned
- Support svg-to-ttf conversion (cubic-to-quad curves approximation needs to be done).
- Support ligatures.
- Support font variations.
# Contributing
Any suggestions, issues, pull requests are welcomed.
# License
[MIT](https://github.com/westracer/fontify/blob/master/LICENSE)