ant-design/components/icon/index.en-US.md

74 lines
1.9 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
type: General
2016-09-08 16:53:50 +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
2016-08-20 11:58:31 +08:00
Meaningful vector graphics.
2015-06-17 19:48:17 +08:00
2016-08-20 11:58:31 +08:00
## Icons naming convention
2015-06-17 18:20:39 +08:00
2016-09-10 13:43:30 +08:00
We provide semantic name for every icon, and naming rules are as follows:
2015-06-17 18:20:39 +08:00
2016-08-20 11:58:31 +08:00
- Scanning line icon has the similar name with its solid onebut it's distinguished by `-o`, for example, `question-circle`(a full circle) and `question-circle-o`(an empty circle);
2015-06-17 18:20:39 +08:00
2016-08-20 11:58:31 +08:00
- Naming sequence`[icon's name]-[shape, optional]-[Scanning line or not]-[direction, optional]`.
2015-06-17 18:20:39 +08:00
2016-09-10 13:43:30 +08:00
## How To Use
2016-08-20 11:58:31 +08:00
Use tag <Icon /> to create an icon and set its type in the type prop, for example:
```html
2015-12-07 16:32:44 +08:00
<Icon type="link" />
```
2015-06-17 18:20:39 +08:00
2016-08-20 11:58:31 +08:00
Finally, it will be rendered as follow:
2015-06-07 14:01:59 +08:00
```html
2015-12-07 16:32:44 +08:00
<i class="anticon anticon-${type}"></i>
2015-06-07 14:01:59 +08:00
```
2016-08-20 11:58:31 +08:00
## Local deployment of icons font
2016-03-14 18:39:32 +08:00
2016-08-20 11:58:31 +08:00
By default, icon components uses [iconfont.cn](http://iconfont.cn), publicly available repository of a huge set of icons. In case you need to use a locally deployed version of the icon font, you can refer to [this example](https://github.com/ant-design/antd-init/tree/master/examples/local-iconfont)。
2016-03-14 18:39:32 +08:00
2016-08-20 11:58:31 +08:00
## List of icons
2015-05-27 15:43:29 +08:00
2016-08-20 11:58:31 +08:00
> Click the icon and copy the code。
2015-12-07 16:32:44 +08:00
2016-09-10 14:00:57 +08:00
### Directional Icons
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
### Suggested Icons
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
```
2017-03-03 14:42:00 +08:00
### Application Icons
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
### Brand and Logos
```__react
import IconSet from 'site/theme/template/IconSet';
ReactDOM.render(<IconSet className="icons" catigory="logo" />, mountNode);
```
## Props
| Property | Description | Type | Default |
|----------|------------------|------- |---------|
2016-10-30 12:43:59 +08:00
| type | Type of ant design icons | string | - |
| spin | Rotate icon with animation | boolean | false |