ant-design/components/icon/index.en-US.md
2017-10-25 10:25:44 +08:00

2.1 KiB
Raw Blame History

category type title toc
Components General Icon false

Semantic vector graphics.

Icons naming convention

We provide semantic name for every icon, and naming rules are as follows:

  • 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?].

? means is optional.

See more design detail at here.

How To Use

Use tag to create an icon and set its type in the type prop, for example:

<Icon type="link" />

Local deployment

By default, icons are deployed at 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

List of icons

Click the icon and copy the code。

Directional Icons

import IconSet from 'site/theme/template/IconSet';
ReactDOM.render(<IconSet className="icons" catigory="direction" />, mountNode);

Suggested Icons

import IconSet from 'site/theme/template/IconSet';
ReactDOM.render(<IconSet className="icons" catigory="suggestion" />, mountNode);

Application Icons

import IconSet from 'site/theme/template/IconSet';
ReactDOM.render(<IconSet className="icons" catigory="other" />, mountNode);

Brand and Logos

import IconSet from 'site/theme/template/IconSet';
ReactDOM.render(<IconSet className="icons" catigory="logo" />, mountNode);

API

You can set style and className for size and color of icons because they are still fonts in essence.

<Icon type="question" style={{ fontSize: 16, color: '#08c' }} />
Property Description Type Default
spin Rotate icon with animation boolean false
style style properties of icon, like fontSize and color object -
type Type of ant design icon string -