[Improvement] Reorganize document (#1066)

2018-05-15 10:39:01 +08:00
parent b1142fd862
commit e8aad7246c
124 changed files with 181 additions and 186 deletions
@@ -0,0 +1,60 @@
+## 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 | - |