webfont
11.2.20 (2021-07-31)
Generador de fuentes de iconos SVG.
WOFF2 , WOFF , EOT , TTF y SVG ;JavaScript , JSON o YAML para especificar información de configuración para un directorio completo y todos sus subdirectorios;css , scss , styl , etc.);gulp , grunt u otras grandes herramientas;linux , windows y 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 ;
} ) ;o
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 y bower_components siempre se ignoran. configFilestring(JSON, YAML, or CommonJS) o el nombre de un módulo en node_modules que apunta a uno.configFile , WebFont buscará el árbol de directorio para el archivo de configuración en los siguientes lugares, en este orden:webfont en package.json.webfontrc (con o sin extensión del nombre de archivo: .json , .yaml y .js están disponibles)webfont.config.js que exporta un object JS. La búsqueda comenzará en el directorio de trabajo y moverá el árbol de directorio hasta que encuentre un archivo de configuración. fontNamestringwebfontformatsarray ,['svg', 'ttf', 'eot', 'woff', 'woff2'] ,svg, ttf, eot, woff, woff2 ,template Tipo: string
Valor predeterminado: null
Valores posibles: css , scss , styl (no dude en contribuir más).
Nota: Si desea usar una plantilla personalizada, use esta opción Pase en una string de ruta como esta:
webfont ( {
template : "./path/to/my-template.css" ,
} ) ;O
webfont ( {
template : path . resolve ( __dirname , "./my-template.css" ) ,
} ) ;O
webfont ( {
template : path . resolve ( __dirname , "./my-template.styl" ) ,
} ) ; templateClassNamestringnulltemplateFontPathstring./CSS . templateFontNamestringfontName si no está configurado, pero puede especificar cualquier valor.ligaturesbooleantrueglyphTransformFn Tipo: function
Valor predeterminado: null
Descripción: Si desea transformar metadatos de glifo (por ejemplo, títulos de clases CSS o unicode) antes de transferirlo en su plantilla de estilo para sus iconos, puede usar esta opción con el objeto de metadatos glifos.
Ejemplo:
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 ;
} ) ; sortbooltrueEstos pueden agregarse a las opciones de Fitt. Estos se pasan directamente a SVGICONS2SVGFONT.
svgicons2svgfont.fontNamestringsvgicons2svgfont.fontIdstringfontNamesvgicons2svgfont.fontStylestring''svgicons2svgfont.fontWeightstring''svgicons2svgfont.fixedWidthbooleanfalsesvgicons2svgfont.centerHorizontallybooleanfalsesvgicons2svgfont.normalizebooleanfalsesvgicons2svgfont.fontHeightnumberMAX(icons.height)svgicons2svgfont.roundnumber10e12 Configuración de redondeo de ruta SVG. svgicons2svgfont.descentnumber0svgicons2svgfont.ascentnumberfontHeight - descentsvgicons2svgfont.metadatastringundefinedsvgicons2svgfont.logfunctionconsole.logfunction(){} para deshabilitar el registro. La interfaz para el uso de la línea de comandos es bastante simplista en esta etapa, como se ve en la siguiente sección de uso.
Agregue el script cli al objeto scripts de su archivo package.json :
{
"scripts" : {
"webfont" : " node node_modules/webfont/dist/cli.js "
}
}Si estás usando cruzado:
{
"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]
La CLI puede salir del proceso con los siguientes códigos de salida:
webpack .ttf2woff2 con la biblioteca JS nativa);No dude en presionar su código si está de acuerdo con la publicación bajo la licencia MIT.
Revise nuestro ChangeLog
Revise nuestra licencia
