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

78 lines
2.1 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
2017-03-19 14:12:58 +08:00
Semantic 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
2017-03-19 14:12:58 +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);
- Naming sequence`[name]-[shape?]-[outline?]-[direction?]`.
2015-06-17 18:20:39 +08:00
2017-03-19 14:12:58 +08:00
> `?` means is optional.
See more design detail at [here](/docs/spec/icon).
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
2017-03-19 14:12:58 +08:00
## Local deployment
2016-03-14 18:39:32 +08:00
2017-03-19 14:12:58 +08:00
By default, icons are deployed at [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);
```
2017-03-19 14:12:58 +08:00
## API
2017-06-13 17:36:54 +08:00
You can set `style` and `className` for size and color of icons because they are still fonts in essence.
```jsx
<Icon type="question" style={{ fontSize: 16, color: '#08c' }} />
```
2017-10-25 10:25:44 +08:00
| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
2016-10-30 12:43:59 +08:00
| spin | Rotate icon with animation | boolean | false |
2017-06-07 17:06:21 +08:00
| style | style properties of icon, like fontSize and color | object | - |
2017-10-25 10:25:44 +08:00
| type | Type of ant design icon | string | - |