IconsGenerator class abstract

The architecture of the IconFont generator.

Implementers
Annotations
  • @immutable

Constructors

IconsGenerator({required String importPath, required String exportPath, required String fontExportPath, Encoding? exportEncoding, Encoding? encoding, DartFormatter? formatter, String? baseName, String? fontFamily, int? baseCodePoint, int? height, int? descent, bool? normalize, Map<String, Object?>? package, bool? convert, bool? yarn, bool? force})
The architecture of the IconFont generator.

Properties

baseCodePoint → int
The starting code point for referencing IconFont icons.
final
baseName → String
The name of the base assets class.
final
buildExtensions → Map<String, List<String>>
Mapping from input file extension to output file extensions.
no setter
convert → bool
If the IconFont names should be converted using StringUtils.toCamelCase.
final
descent → int?
The descent is usefull to fix the font baseline.
final
encoding → Encoding
The encoding used for reading the .json and .yaml files.
finalinherited
exportEncoding → Encoding
The encoding used for writing the .dart files.
finalinherited
exportPath → String
The path to export data to.
finalinherited
fileMap → Map<String, Object?>
The map of files that was loaded from importPath.
finalinherited
fontExportPath → String
The path to export generated font to.
final
fontFamily → String
The name of the font specified in pubspec.yaml.
final
force → bool
If the package should be installed forcefully. Otherwise, if fantasticon executable is present, installation is ommited.
final
formatter → DartFormatter
The formatter used to format generated files.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
height → int?
The height of the heighest icon.
final
iconsMap → Map<String, Object?>
The IconFont path graph.
final
importPath → String
The path to import data from.
finalinherited
loadFiles → bool
If file contents should be loaded during build into fileMap.
finalinherited
normalize → bool?
If the icons should be normalized by scaling them to the height of the highest icon.
final
package → Map<String, Object?>
The js package to run npm install or yarn install with.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
yarn → bool
If the package should be installed with yarn instead of npm.
final

Methods

build([BuildStep? buildStep]) → FutureOr<void>
Generate IconFont from fileMap.
className(String name, [Iterable<String> keys = const Iterable<String>.empty()]) → String
Return the class name from the base name and keys.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited