mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
61 lines
1.0 KiB
Markdown
61 lines
1.0 KiB
Markdown
## Icon
|
||
|
||
### Install
|
||
``` javascript
|
||
import { Icon } from 'vant';
|
||
|
||
Vue.use(Icon);
|
||
```
|
||
|
||
### Usage
|
||
|
||
#### Basic Usage
|
||
View all usable icons on the right.
|
||
|
||
```html
|
||
<van-icon name="success" />
|
||
```
|
||
|
||
#### Use local font file
|
||
Icon uses font file in `yzcdn.cn` by default，if you want to use the local font file，please import the following css file.
|
||
|
||
```js
|
||
import 'vant/lib/vant-css/icon-local.css';
|
||
```
|
||
|
||
#### Add custom iconfont
|
||
|
||
```css
|
||
@font-face {
|
||
font-family: 'custom-iconfont';
|
||
src: url('./iconfont.ttf') format('truetype');
|
||
}
|
||
|
||
.van-icon {
|
||
font-family: 'vant-icon', 'custom-iconfont' !important;
|
||
}
|
||
|
||
.van-icon-extra:before {
|
||
content: '\e626';
|
||
}
|
||
```
|
||
|
||
```html
|
||
<van-icon name="extra" />
|
||
```
|
||
|
||
### API
|
||
|
||
| Attribute | Description | Type | Default |
|
||
|-----------|-----------|-----------|-------------|
|
||
| name | Icon name | `String` | `''` |
|
||
| info | Info message | `String | Number` | `''` |
|
||
| color | Icon color | `String` | `''` | - |
|
||
|
||
|
||
### Event
|
||
|
||
| Event | Description | Arguments |
|
||
|-----------|-----------|-----------|
|
||
| click | Triggered when click icon | - |
|