ant-design/components/icon/index.zh-CN.md

79 lines
2.0 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
2016-09-21 11:28:38 +08:00
subtitle: 图标
type: General
2016-09-21 11:28:38 +08:00
title: Icon
2016-07-26 19:45:55 +08:00
toc: false
2016-03-31 14:17:09 +08:00
---
2015-05-27 15:43:29 +08:00
语义化的矢量图形。
2015-06-17 19:48:17 +08:00
2015-06-17 18:20:39 +08:00
## 图标的命名规范
2015-12-07 16:32:44 +08:00
我们为每个图标赋予了语义化的命名,命名规则如下:
2015-06-17 18:20:39 +08:00
2017-03-19 14:12:58 +08:00
- 实心和描线图标保持同名,用 `-o` 来区分,比如 `question-circle`(实心) 和 `question-circle-o`(描线);
- 命名顺序:`[图标名]-[形状?]-[描线?]-[方向?]`。
2015-06-17 18:20:39 +08:00
2017-03-19 14:12:58 +08:00
> `?` 为可选。
完整的图标设计规范请访问 [图标规范](/docs/spec/icon)。
2015-06-17 18:20:39 +08:00
2015-12-07 16:32:44 +08:00
## 如何使用
2015-12-07 16:32:44 +08:00
使用 `<Icon />` 标签声明组件,指定图标对应的 type 属性,示例代码如下:
```html
2015-12-07 16:32:44 +08:00
<Icon type="link" />
```
2015-06-17 18:20:39 +08:00
2016-03-14 18:39:32 +08:00
## 本地部署
2017-03-19 14:12:58 +08:00
图标默认托管在 [iconfont.cn](http://iconfont.cn),默认公网可访问。如需本地部署,可参考 [示例](https://github.com/ant-design/antd-init/tree/master/examples/local-iconfont)。
2016-03-14 18:39:32 +08:00
2015-05-27 15:43:29 +08:00
## 图标列表
2015-12-07 16:32:44 +08:00
> 点击图标复制代码。
2016-09-10 14:00:57 +08:00
### 方向性图标
2015-06-10 18:13:49 +08:00
2016-03-07 11:58:14 +08:00
```__react
import IconSet from 'site/theme/template/IconSet';
ReactDOM.render(<IconSet className="icons" catigory="direction" />, mountNode);
2016-03-07 11:58:14 +08:00
```
2016-09-10 14:00:57 +08:00
### 提示建议性图标
2016-03-07 11:58:14 +08:00
```__react
2017-01-19 15:19:03 +08:00
import IconSet from 'site/theme/template/IconSet';
ReactDOM.render(<IconSet className="icons" catigory="suggestion" />, mountNode);
2016-03-07 11:58:14 +08:00
```
2016-09-10 14:00:57 +08:00
### 网站通用图标
2016-03-07 11:58:14 +08:00
```__react
2017-01-19 15:19:03 +08:00
import IconSet from 'site/theme/template/IconSet';
ReactDOM.render(<IconSet className="icons" catigory="other" />, mountNode);
2016-03-07 11:58:14 +08:00
```
2017-03-03 14:42:00 +08:00
### 品牌和标识
```__react
import IconSet from 'site/theme/template/IconSet';
ReactDOM.render(<IconSet className="icons" catigory="logo" />, mountNode);
```
2017-03-19 14:12:58 +08:00
## API
由于图标字体本质上还是文字,可以使用 `style``className` 设置图标的大小和颜色。
```jsx
<Icon type="question" style={{ fontSize: 16, color: '#08c' }} />
```
2017-10-25 10:25:44 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
2016-10-30 12:43:59 +08:00
| spin | 是否有旋转动画 | boolean | false |
2017-06-07 17:06:21 +08:00
| style | 设置图标的样式,例如 fontSize 和 color | object | - |
2017-10-25 10:25:44 +08:00
| type | 图标类型 | string | - |