webfont
11.2.20 (2021-07-31)
SVGアイコンからのフォントのジェネレーター。
WOFF2 、 WOFF 、 EOT 、 TTF 、 SVG 。JavaScript 、 JSON 、またはYAMLファイルを使用して、ディレクトリ全体およびそのすべてのサブディレクトリの構成情報を指定します。css 、 scss 、 stylなど)を使用できます。gulp 、 grunt 、またはその他の大きなツールなどの追加の依存関係はありません。linux 、 windows 、 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 ;
} ) ;または
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とbower_componentsは常に無視されます。 configFilestring(JSON, YAML, or CommonJS)へのパスまたは1つを指すnode_modulesのモジュールの名前。configFile提供しない場合、WebFontは次の場所で構成ファイルをディレクトリツリーで検索します。package.jsonのwebfontプロパティ.webfontrcファイル(filename拡張子の有無にかかわらず: .json 、 .yaml 、および.jsが利用可能)objectをエクスポートするwebfont.config.jsファイル。検索は、作業ディレクトリから開始され、構成ファイルが見つかるまでディレクトリツリーを上に移動します。 fontNamestringwebfontformatsarray 、['svg', 'ttf', 'eot', 'woff', 'woff2'] 、svg, ttf, eot, woff, woff2 、templateタイプ: string
デフォルト: null
考えられる値: css 、 scss 、 styl (もっと貢献してください)。
注:カスタムテンプレートを使用する場合は、このようなパス文字stringでこのオプションパスを使用します。
webfont ( {
template : "./path/to/my-template.css" ,
} ) ;または
webfont ( {
template : path . resolve ( __dirname , "./my-template.css" ) ,
} ) ;または
webfont ( {
template : path . resolve ( __dirname , "./my-template.styl" ) ,
} ) ; templateClassNamestringnulltemplateFontPathstring./CSSファイル内の生成されたフォントへのパス。 templateFontNamestringfontNameからですが、任意の値を指定できます。ligaturesbooleantrueglyphTransformFnタイプ: function
デフォルト: null
説明:アイコンのスタイルテンプレートで転送する前に、Glyphメタデータ(CSSクラスまたはUnicodeのタイトルなど)を変換する場合は、Glyphsメタデータオブジェクトでこのオプションを使用できます。
例:
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 ;
} ) ; sortbooltrueこれらは、WebFontオプションに追加できます。これらは、svgicons2svgfontに直接渡されます。
svgicons2svgfont.fontNamestringsvgicons2svgfont.fontIdstringfontName値svgicons2svgfont.fontStylestring''svgicons2svgfont.fontWeightstring''svgicons2svgfont.fixedWidthbooleanfalsesvgicons2svgfont.centerHorizontallybooleanfalsesvgicons2svgfont.normalizebooleanfalsesvgicons2svgfont.fontHeightnumberMAX(icons.height)svgicons2svgfont.roundnumber10e12セットアップSVGパスラウンド。 svgicons2svgfont.descentnumber0svgicons2svgfont.ascentnumberfontHeight - descentsvgicons2svgfont.metadatastringundefinedsvgicons2svgfont.logfunctionconsole.logfunction(){}に設定して、ロギングを無効にします。 次の使用セクションに見られるように、この段階ではコマンドライン使用のインターフェイスはかなり単純化されています。
cliスクリプトをpackage.jsonファイルのscriptsオブジェクトに追加します。
{
"scripts" : {
"webfont" : " node node_modules/webfont/dist/cli.js "
}
}Cross-ENVを使用している場合:
{
"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]
CLIは、次の出口コードでプロセスを終了できます。
webpack 。ttf2woff2実装してください)。MITライセンスの下での公開に同意する場合は、コードを自由にプッシュしてください。
Changelogを確認してください
ライセンスを確認してください