125 lines
5.0 KiB
Markdown
125 lines
5.0 KiB
Markdown
|
## API
|
||
|
|
|
||
|
|
| Property | Description | Type | Default |
|
||
|
|
| --- | --- | --- | --- |
|
||
|
|
| type | Type of the ant design icon | string | - |
|
||
|
|
| style | Style properties of icon, like `fontSize` and `color` | CSSProperties | - |
|
||
|
|
| theme | Theme variant of the icon | 'filled' \| 'outlined' \| 'twoTone' | 'outlined' |
|
||
|
|
| spin | Rotate icon with animation | boolean | false |
|
||
|
|
| rotate | Rotate degrees (added in 1.4.0, not working in IE9) | number | - |
|
||
|
|
| component | The component used for the root node. This will override the **`type`** property. | ComponentType<CustomIconComponentProps\> | - |
|
||
|
|
| twoToneColor | Only support the two-tone icon. Specific the primary color. | string (hex color) | - |
|
||
|
|
|
||
|
|
> Note: icon rendering priority of the Icon component is component > children > type. When props is passed, the higher priority item will work, and the lower priority item will be invalid.
|
||
|
|
|
||
|
|
### SVG icons
|
||
|
|
|
||
|
|
We introduced SVG icons in version `1.2.0`, replacing font icons. This has the following benefits:
|
||
|
|
|
||
|
|
- Complete offline usage of icons, without dependency on a CDN-hosted font icon file (No more empty square during downloading and no need to deploy icon font files locally either!)
|
||
|
|
- Much more display accuracy on lower-resolution screens
|
||
|
|
- The ability to choose icon color
|
||
|
|
- No need to change built-in icons with overriding styles by providing more props in component
|
||
|
|
|
||
|
|
More discussion of SVG icon reference at [#10353](https://github.com/ant-design/ant-design/issues/10353).
|
||
|
|
|
||
|
|
> ⚠️ Given the extra bundle size caused by all SVG icons imported in 1.2.0, we will provide a new API to allow developers to import icons as needed, you can track [#12011](https://github.com/ant-design/ant-design/issues/12011) for updates.
|
||
|
|
>
|
||
|
|
> While you wait, you can use [webpack plugin](https://github.com/Beven91/webpack-ant-icon-loader) from the community to chunk the icon file.
|
||
|
|
|
||
|
|
The properties `theme`, `component` and `twoToneColor` were added in `1.2.0`. The best practice is to pass the property `theme` to every `<Icon />` component.
|
||
|
|
|
||
|
|
```html
|
||
|
|
<a-icon type="star" theme="filled" />
|
||
|
|
```
|
||
|
|
|
||
|
|
All the icons will render to `<svg>`. You can still set `style` and `class` for size and color of icons.
|
||
|
|
|
||
|
|
```html
|
||
|
|
<a-icon type="message" :style="{ fontSize: '16px', color: '#08c' }" />
|
||
|
|
```
|
||
|
|
|
||
|
|
### Set TwoTone Color
|
||
|
|
|
||
|
|
When using the two-tone icons, you can use the static methods `Icon.getTwoToneColor()` and `Icon.setTwoToneColor(colorString)` to spicify the primary color.
|
||
|
|
|
||
|
|
```jsx
|
||
|
|
import { Icon } from 'ant-design-vue';
|
||
|
|
|
||
|
|
Icon.setTwoToneColor('#eb2f96');
|
||
|
|
Icon.getTwoToneColor(); // #eb2f96
|
||
|
|
```
|
||
|
|
|
||
|
|
### Custom Font Icon
|
||
|
|
|
||
|
|
We added a `createFromIconfontCN` function to help developer using their own icons deployed at [iconfont.cn](http://iconfont.cn/) in a convenient way.
|
||
|
|
|
||
|
|
> This method is specified for [iconfont.cn](http://iconfont.cn/).
|
||
|
|
|
||
|
|
```js
|
||
|
|
const MyIcon = Icon.createFromIconfontCN({
|
||
|
|
scriptUrl: '//at.alicdn.com/t/font_8d5l8fzk5b87iudi.js', // generated by iconfont.cn
|
||
|
|
});
|
||
|
|
|
||
|
|
new Vue({
|
||
|
|
el: '#app',
|
||
|
|
components: {
|
||
|
|
'my-icon': MyIcon,
|
||
|
|
},
|
||
|
|
template: '<my-icon type="icon-example" />',
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
It create a component that uses SVG sprites in essence.
|
||
|
|
|
||
|
|
The following options are available:
|
||
|
|
|
||
|
|
| Property | Description | Type | Default |
|
||
|
|
| --- | --- | --- | --- |
|
||
|
|
| scriptUrl | The URL generated by [iconfont.cn](http://iconfont.cn/) project. | string | - |
|
||
|
|
| extraCommonProps | Define extra properties to the component | `{ class, attrs, props, on, style }` | {} |
|
||
|
|
|
||
|
|
The property `scriptUrl` should be set to import the SVG sprite symbols.
|
||
|
|
|
||
|
|
See [iconfont.cn documents](http://iconfont.cn/help/detail?spm=a313x.7781069.1998910419.15&helptype=code) to learn about how to generate `scriptUrl`.
|
||
|
|
|
||
|
|
### Custom SVG Icon
|
||
|
|
|
||
|
|
You can import SVG icon as an vue component by using `vue cli 3` and [`vue-svg-loader`](https://www.npmjs.com/package/vue-svg-loader). `vue-svg-loader`'s `options` [reference](https://github.com/visualfanatic/vue-svg-loader).
|
||
|
|
|
||
|
|
```js
|
||
|
|
// vue.config.js
|
||
|
|
module.exports = {
|
||
|
|
chainWebpack: config => {
|
||
|
|
const svgRule = config.module.rule('svg');
|
||
|
|
|
||
|
|
svgRule.uses.clear();
|
||
|
|
|
||
|
|
svgRule.use('vue-svg-loader').loader('vue-svg-loader');
|
||
|
|
},
|
||
|
|
};
|
||
|
|
```
|
||
|
|
|
||
|
|
```jsx
|
||
|
|
import { Icon } from 'ant-design-vue';
|
||
|
|
import MessageSvg from 'path/to/message.svg'; // path to your '*.svg' file.
|
||
|
|
|
||
|
|
new Vue({
|
||
|
|
el: '#app',
|
||
|
|
components: {
|
||
|
|
'my-icon': MyIcon,
|
||
|
|
},
|
||
|
|
template: '<a-icon :component="MessageSvg" />',
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
The following properties are available for the component:
|
||
|
|
|
||
|
|
| Property | Description | Type | Default |
|
||
|
|
| -------- | ------------------------------------------------ | ---------------- | -------------- |
|
||
|
|
| width | The width of the `svg` element | string \| number | '1em' |
|
||
|
|
| height | The height of the `svg` element | string \| number | '1em' |
|
||
|
|
| fill | Define the color used to paint the `svg` element | string | 'currentColor' |
|
||
|
|
| class | The computed class name of the `svg` element | string | - |
|
||
|
|
| style | The computed style of the `svg` element | CSSProperties | - |
|