diff --git a/docs/api/ui/font.md b/docs/api/ui/font.md index 617a83e5c71561199e49b4aac89a84817ab18830..6b40c2ca0c7956955ba4c1fa2b54d2e8b5fdc589 100644 --- a/docs/api/ui/font.md +++ b/docs/api/ui/font.md @@ -1,48 +1,54 @@ ### uni.loadFontFace(Object object) - -动态加载网络字体。文件地址需为下载类型。 - -注意: - -1. 引入中文字体,体积过大时会发生错误,建议抽离出部分中文,减少体积,或者用图片替代 -2. 字体链接必须是https。 -3. 字体链接必须是同源下的,或开启了cors支持,微信小程序的域名是servicewechat.com -4. canvas等原生组件不支持使用接口添加的字体 -5. 工具里提示 Faild to load font可以忽略 - -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| -|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|1.9.0+ [自定义组件编译模式](https://ask.dcloud.net.cn/article/35843)|x|基础库 2.1.0+|x|x|x|x| - -**参数说明** - -|属性|类型|默认值|必填|说明| -|:-|:-|:-|:-|:-| -|family|String||是|定义的字体名称| -|source|String||是|字体资源的地址。建议格式为 TTF 和 WOFF,WOFF2 在低版本的iOS上会不兼容。| -|desc|Object||否|可选的字体描述符| -|success|Function||否|接口调用成功的回调函数| -|fail|Function||否|接口调用失败的回调函数| -|complete|Function||否|接口调用结束的回调函数(调用成功、失败都会执行)| - -**Object.desc 的结构** - -|属性|类型|默认值|必填|说明| -|:-|:-|:-|:-|:-| -|style|String|normal|否|字体样式,可选值为 normal / italic / oblique| -|weight|String|normal|否|字体粗细,可选值为 normal / bold / 100 / 200../ 900| -|variant|String|normal|否|设置小型大写字母的字体显示文本,可选值为 normal / small-caps / inherit| - -**代码示例** - -```javascript -uni.loadFontFace({ - family: 'Bitstream Vera Serif Bold', - source: 'url("https://sungd.github.io/Pacifico.ttf")', - success() { - console.log('success') - } -}) -``` + +动态加载字体。 + +注意: + +1. 引入中文字体,体积过大时会发生错误,建议抽离出部分中文,减少体积,或者用图片替代 +2. 微信小程序端只支持网络字体,字体链接必须是https。App支持网络或本地的字体。 +3. 微信小程序端字体链接必须是同源下的,或开启了cors支持,微信小程序的域名是servicewechat.com +4. canvas等原生组件不支持使用接口添加的字体 +5. 微信工具里提示 Faild to load font可以忽略 + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|1.9.0+|x|基础库 2.1.0+|x|x|x|x| + +App端非自定义组件模式不支持此API。 + +**参数说明** + +|属性|类型|默认值|必填|说明| +|:-|:-|:-|:-|:-| +|family|String||是|定义的字体名称| +|source|String||是|字体资源的地址。建议格式为 TTF 和 WOFF,WOFF2 在低版本的iOS上会不兼容。| +|desc|Object||否|可选的字体描述符| +|success|Function||否|接口调用成功的回调函数| +|fail|Function||否|接口调用失败的回调函数| +|complete|Function||否|接口调用结束的回调函数(调用成功、失败都会执行)| + +**Object.desc 的结构** + +|属性|类型|默认值|必填|说明| +|:-|:-|:-|:-|:-| +|style|String|normal|否|字体样式,可选值为 normal / italic / oblique| +|weight|String|normal|否|字体粗细,可选值为 normal / bold / 100 / 200../ 900| +|variant|String|normal|否|设置小型大写字母的字体显示文本,可选值为 normal / small-caps / inherit| + +**代码示例** + +```javascript +uni.loadFontFace({ + family: 'Bitstream Vera Serif Bold', + source: 'url("https://sungd.github.io/Pacifico.ttf")', + success() { + console.log('success') + } +}) +``` + +**Tips** + +插件市场有加载字体的例子:[https://ext.dcloud.net.cn/plugin?id=954](https://ext.dcloud.net.cn/plugin?id=954)