如果您需要自动创建所有应用程序的图标和启动画面,则Icon Genie提供了可以批量运行的配置文件。
这些配置文件称为“profile files”。 这些文件采用JSON格式,并告诉Icon Genie生成哪些图像以及如何生成它们。 他们还使您不必记住整套Icon Genie命令和参数来生成资产。
文件结构
JSON配置文件的通用形式为:
{
"params": { },
"assets": [ ]
}
我们将在下一节中讨论每个参数。
params
JSON概要文件中的params
对象具有与generate命令参数相同的属性名称(但使用驼峰式命名而不是CLI的短横线命名)。 有一个主要的区别:代替使用mode
(例如:“spa,pwa”、“all”),您将编写include
(例如:[ “spa”, “pwa” ]、[ “all” ] )。
您可以为params
对象编写的属性的完整列表:
属性名 | 类型 | 描述 | 例子 |
---|---|---|---|
include | Array | 包括针对特定Quasar模式的Icon Genie硬编码资产集 | [ "spa", "pwa" ] / [ "all" ] |
icon | String | 图标的源文件的路径; 可以是绝对的,也可以相对于Quasar项目文件夹的根目录 | my-icon.png |
background | String | 可选背景源文件的路径(用于启动画面); 可以是绝对的,也可以相对于Quasar项目文件夹的根目录 | my-bg.png |
filter | String | 由生成器选择性地过滤资产; 使用时,它只能生成一种资产,而不是全部资产 | ico |
quality | Number [1-12] | 生成文件的质量; 质量越高,文件大小越大,速度越慢; 较低的质量意味着较小的文件大小,更快 | 12 |
padding | Array [Number] | (v2.1+) 修剪图标图像后,对其应用固定的填充; 语法:[ <horiz_px>, <vert_px> ]; 默认是: [0, 0] | [10, 0] / [5,5] |
skipTrim | Boolean | (v2.2+) 不要修剪图标源文件 | |
themeColor | String [hex] | 主题颜色,用于所有需要颜色的生成器; 如果还指定了任何生成器颜色,它将被覆盖 | ccc / e2b399 |
pngColor | String [hex] | 资产定义中的“background:true”时用于png生成器的背景颜色(例如cordova/capacitor iOS图标) | ccc / e2b399 |
splashscreenColor | String [hex] | 用于启动画面生成器的背景色 | ccc / e2b399 |
svgColor | String [hex] | 用于生成的单色SVG的颜色 | ccc / e2b399 |
splashscreenIconRatio | Number [0-100] | 图标大小与生成的启动画面的宽度或高度(以较小者为准)的比率; 代表百分比; 0表示不会添加背景顶部的图标 | 40 |
Assets
如果需要,assets
数组可以包含额外资产的个性化定义。 当Icon Genie的每种模式的默认列表不足以满足您的用例时,可以使用此功能。 如果您未在params
中指定include
属性,则只能生成自定义资产。
在99%的情况下,您不需要指定assets
数组,但是Icon Genie的设计非常灵活,因此它也包含此功能。
一些assets
示例,您可以从中提取Icon Genie可以生成的每种可能资产的语法:
"assets": [
{
"generator": "png",
"name": "icon-{size}x{size}.png",
"folder": "src-bex/icons",
"sizes": [ 16, 48, 128 ]
},
{
"generator": "svg",
"name": "safari-pinned-tab.svg",
"folder": "public/icons"
},
{
"generator": "splashscreen",
"name": "apple-launch-{size}.png",
"folder": "public/icons",
"sizes": [
[ 1668, 2388 ]
],
"tag": "<link rel=\"apple-touch-startup-image\" media=\"(device-width: 1024px) and (device-height: 1366px) and (-webkit-device-pixel-ratio: 2)\" href=\"icons/{name}\">"
},
{
"generator": "icns",
"name": "icon.icns",
"folder": "src-electron/icons"
},
{
"generator": "ico",
"name": "icon.ico",
"folder": "src-electron/icons"
},
{
"generator": "splashscreen",
"name": "Default-Landscape-2436h.png",
"folder": "src-cordova/res/screen/ios",
"sizes": [
[ 2436, 1125 ]
]
},
{
"generator": "png",
"name": "icon-29@2x.png",
"folder": "src-cordova/res/ios",
"sizes": [ 58 ],
"platform": "cordova-ios",
"background": true
},
{
"generator": "png",
"name": "icon-29@2x.png",
"folder": "src-cordova/res/ios",
"sizes": [ 58 ],
"platform": "cordova-ios",
"background": true
},
{
"generator": "png",
"name": "xxxhdpi.png",
"folder": "src-cordova/res/android",
"sizes": [ 192 ],
"platform": "cordova-android",
"density": "xxxhdpi"
},
{
"generator": "splashscreen",
"name": "Default@2x~ipad~comany.png",
"folder": "src-cordova/res/screen/ios",
"sizes": [
[ 1278, 2732 ]
],
"platform": "cordova-ios"
},
{
"generator": "splashscreen",
"name": "splash-land-xxxhdpi.png",
"folder": "src-cordova/res/screen/android",
"sizes": [
[ 1920, 1280 ]
],
"platform": "cordova-android",
"density": "land-xxxhdpi"
}
]
启动配置
Icon Genie还提供了profile命令,可以为您启动JSON配置文件。 它可以帮助您创建一个或多个此类文件,然后可以通过带有--profile
参数(或简称为-p
)的generate命令批量运行。
最有用的用例是将多个配置文件生成到一个特定的文件夹中,每个文件都有各自的参数,然后通过$ icongenie generate -p /path/to/folder
运行所有配置文件。