[Doc] improve custom icon documentation

This commit is contained in:
陈嘉涵 2018-03-22 16:32:13 +08:00
parent 996447c772
commit a0bed46a63
2 changed files with 21 additions and 37 deletions

View File

@ -23,36 +23,27 @@ Icon uses font file in `yzcdn.cn` by defaultif you want to use the local font
import 'vant/lib/vant-css/icon-local.css';
```
#### Use custom font
Add more custom icon
[Demo](https://github.com/qianzhaoy/vant--mobile-mall/blob/master/src/assets/scss/iconfont/iconfont.css)
#### Add custom iconfont
```css
@font-face {
font-family: "iconfont";
src: url('./iconfont.ttf') format('truetype');
}
@font-face {
font-family: "vanIcon";
src: url(https://b.yzcdn.cn/zanui/icon/vant-icon-4c3245.ttf) format('truetype');
font-family: 'custom-iconfont';
src: url('./iconfont.ttf') format('truetype');
}
.van-icon {
position: relative;
font-family: "iconfont", "vanIcon" !important;
font-size: 14px;
font-style: normal;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
font-family: 'vant-icon', 'custom-iconfont' !important;
}
.van-icon-success:before {
content: "\e626";
.van-icon-extra:before {
content: '\e626';
}
```
```html
<van-icon name="extra" />
```
### API
| Attribute | Description | Type | Default | Accepted Values |

View File

@ -23,35 +23,28 @@ Icon 组件默认引用 `yzcdn.cn` 域名下的字体文件,如果想要使用
import 'vant/lib/vant-css/icon-local.css';
```
#### 自定义字体
如果我们的Icon数量无法满足你的需求可以用以下方法保留原本Icon的情况下增加更多你想要的Icon
#### 自定义图标
如果需要在现有 Icon 的基础上使用更多图标,可以引入你需要的 iconfont 对应的 ttf 文件和样式,之后就可以在 Icon 组件中直接使用
[Demo地址](https://github.com/qianzhaoy/vant--mobile-mall/blob/master/src/assets/scss/iconfont/iconfont.css)
```css
@font-face {
font-family: "iconfont";
src: url('./iconfont.ttf') format('truetype');
}
@font-face {
font-family: "vanIcon";
src: url(https://b.yzcdn.cn/zanui/icon/vant-icon-4c3245.ttf) format('truetype');
font-family: 'custom-iconfont';
src: url('./iconfont.ttf') format('truetype');
}
.van-icon {
position: relative;
font-family: "iconfont", "vanIcon" !important;
font-size: 14px;
font-style: normal;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
font-family: 'vant-icon', 'custom-iconfont' !important;
}
.van-icon-success:before {
content: "\e626";
.van-icon-extra:before {
content: '\e626';
}
```
```html
<van-icon name="extra" />
```
### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 |