webfont
11.2.20 (2021-07-31)
Generator von Schriftarten aus SVG -Ikonen.
WOFF2 , WOFF , EOT , TTF und SVG ;JavaScript , JSON oder YAML -Datei, um Konfigurationsinformationen für ein ganzes Verzeichnis und alle seine Unterverzeichnisse anzugeben.css , scss , styl usw.);gulp , grunt oder andere große Werkzeuge;linux , windows und osx );npm install --save-dev webfont import webfont from "webfont" ;
webfont ( {
files : "src/svg-icons/**/*.svg" ,
fontName : "my-font-name" ,
} )
. then ( ( result ) => {
// Do something with result
Function . prototype ( result ) ;
// Or return it
return result ;
} )
. catch ( ( error ) => {
throw error ;
} ) ;oder
const webfont = require ( "webfont" ) . default ;
webfont ( {
files : "src/svg-icons/**/*.svg" ,
fontName : "my-font-name" ,
} )
. then ( ( result ) => {
// Do something with result
Function . prototype ( result ) ;
// Or return it
return result ;
} )
. catch ( ( error ) => {
throw error ;
} ) ;filesstring | arraynode_modules UND bower_components werden immer ignoriert. configFilestring(JSON, YAML, or CommonJS) oder zum Namen eines Moduls in node_modules , die auf eins verweist.configFile nicht angeben, sucht WebFont an den folgenden Stellen in dieser Reihenfolge den Verzeichnisbaum nach Konfigurationsdatei:webfont -Eigenschaft in package.json.webfontrc -Datei (mit oder ohne Dateiname -Erweiterung: .json , .yaml und .js sind verfügbar)webfont.config.js -Datei, in der ein JS object exportiert wird. Die Suche beginnt im Arbeitsverzeichnis und verschiebt den Verzeichnisbaum, bis eine Konfigurationsdatei gefunden wird. fontNamestringwebfontformatsarray ,['svg', 'ttf', 'eot', 'woff', 'woff2'] ,svg, ttf, eot, woff, woff2 ,template Typ: string
Standard: null
Mögliche Werte: css , scss , styl (zögern Sie nicht, mehr beizutragen).
Hinweis: Wenn Sie eine benutzerdefinierte Vorlage verwenden möchten, verwenden Sie diese Option in einer string wie folgt:
webfont ( {
template : "./path/to/my-template.css" ,
} ) ;Oder
webfont ( {
template : path . resolve ( __dirname , "./my-template.css" ) ,
} ) ;Oder
webfont ( {
template : path . resolve ( __dirname , "./my-template.styl" ) ,
} ) ; templateClassNamestringnulltemplateFontPathstring./CSS -Datei. templateFontNamestringfontName , wenn nicht festgelegt, aber Sie können einen Wert angeben.ligaturesbooleantrueglyphTransformFn Typ: function
Standard: null
Beschreibung: Wenn Sie Glyphenmetadaten (z. B. Titel von CSS -Klassen oder Unicode) transformieren möchten, bevor Sie sie in Ihrer Stilvorlage für Ihre Symbole übertragen, können Sie diese Option mit Glyphen -Metadatenobjekten verwenden.
Beispiel:
import webfont from "webfont" ;
webfont ( {
files : "src/svg-icons/**/*.svg" ,
glyphTransformFn : ( obj ) => {
obj . name += "_transform" ;
something ( ) ;
return obj ;
} ,
} )
. then ( ( result ) => {
// Do something with result
Function . prototype ( result ) ;
// Or return it
return result ;
} )
. catch ( ( error ) => {
throw error ;
} ) ; sortbooltrueDiese können an WebFont -Optionen beigefügt werden. Diese werden direkt an SVGICONS2SVGFONT übergeben.
svgicons2svgfont.fontNamestringsvgicons2svgfont.fontIdstringfontName -Wertsvgicons2svgfont.fontStylestring''svgicons2svgfont.fontWeightstring''svgicons2svgfont.fixedWidthbooleanfalsesvgicons2svgfont.centerHorizontallybooleanfalsesvgicons2svgfont.normalizebooleanfalsesvgicons2svgfont.fontHeightnumberMAX(icons.height)svgicons2svgfont.roundnumber10e12 Setup SVG -Pfadrundung. svgicons2svgfont.descentnumber0svgicons2svgfont.ascentnumberfontHeight - descentsvgicons2svgfont.metadatastringundefinedsvgicons2svgfont.logfunctionconsole.logfunction(){} eingestellt, um die Protokollierung zu deaktivieren. Die Schnittstelle zur Befehlszeilennutzung ist in dieser Phase ziemlich simpel, wie im folgenden Gebrauchsabschnitt zu sehen ist.
Fügen Sie das cli -Skript zu Ihrem scripts Objekt Ihrer package.json -Datei hinzu:
{
"scripts" : {
"webfont" : " node node_modules/webfont/dist/cli.js "
}
}Wenn Sie Cross-Env verwenden:
{
"scripts" : {
"webfont" : " cross-env node_modules/webfont/dist/cli.js "
}
} Usage: webfont [input] [options]
Input: File(s) or glob(s).
If an input argument is wrapped in quotation marks, it will be passed to " fast-glob "
for cross-platform glob support.
Options:
--config
Path to a specific configuration file (JSON, YAML, or CommonJS)
or the name of a module in ` node_modules ` that points to one.
If no ` --config ` argument is provided, webfont will search for
configuration files in the following places, in this order:
- a ` webfont ` property in ` package.json `
- a ` .webfontrc ` file (with or without filename extension:
` .json ` , ` .yaml ` , and ` .js ` are available)
- a ` webfont.config.js ` file exporting a JS object
The search will begin in the working directory and move up the
directory tree until a configuration file is found.
-f, --font-name
The font family name you want, default: " webfont " .
-h, --help
Output usage information.
-v, --version
Output the version number.
-r, --formats
Only this formats generate.
-d, --dest
Destination for generated fonts.
-m, --dest-create
Create destination directory if it does not exist.
-t, --template
Type of template ( ` css ` , ` scss ` , ` styl ` ) or path to custom template.
'
-s, --dest-template
Destination for generated template. If not passed used `dest` argument value.
-c, --template-class-name
Class name in css template.
-p, --template-font-path
Font path in css template.
-n, --template-font-name
Font name in css template.
--no-sort
Keeps the files in the same order of entry
--verbose
Tell me everything!.
For "svgicons2svgfont":
--font-id
The font id you want, default as "--font-name".
--font-style
The font style you want.
--font-weight
The font weight you want.
--fixed-width
Creates a monospace font of the width of the largest input icon.
--center-horizontally
Calculate the bounds of a glyph and center it horizontally.
--normalize
Normalize icons by scaling them to the height of the highest icon.
--font-height
The outputted font height [MAX(icons.height)].
--round
Setup the SVG path rounding [10e12].
--descent
The font descent [0].
--ascent
The font ascent [height - descent].
--start-unicode
The start unicode codepoint for files without prefix [0xEA01].
--prepend-unicode
Prefix files with their automatically allocated unicode codepoint.
--metadata
Content of the metadata tag.
--add-hash-in-font-url
Generated font url will be : [webfont].[ext]?v=[hash]
Die CLI kann den Vorgang mit den folgenden Exit -Codes verlassen:
webpack -Plugin.ttf2woff2 mit der nativen JS -Bibliothek);Fühlen Sie sich frei, Ihren Code voranzutreiben, wenn Sie der Veröffentlichung im Rahmen der MIT -Lizenz zustimmen.
Überprüfen Sie unseren Changelog
Überprüfen Sie unsere Lizenz
