4.2 KiB
Icon
Element Plus provides a set of common icons.
:::warning Element Plus team is replacing all Font Icon in the previously built components to SVG Icon, please keep you eyes on ChangeLog, for getting latest updates, Font Icon will be deprecated after the first stable release. :::
SvgIcon Usage
-
If you want to use directly like the example, you need to globally register the components before using it.
-
If you want to see all available SVG icons please check @element-plus/icons and the source Github/ElementPlus/icons out or SVG icons
Installation
The current icon is only targeted to Vue3.
Using packaging manager
$ yarn add @element-plus/icons
# or
$ npm install @element-plus/icons
Simple usage
:::warning
Because HTML standard has already defined a tag named menu,
so you need to use an alias in order to render the icon, if you register Menu
directly it will not work.
:::
<!-- Use el-icon to provide attributes to SVG icon -->
<el-icon :size="size" :color="color">
<edit />
</el-icon>
<!-- Or use it independently without derive attributes from parent -->
<edit />
<script lang="ts">
import { Edit } from '@element-plus/icons'
export default defineComponent({
components: {
// or Shorthanded,
Edit,
},
})
</script>
Combined with el-icon
:::demo el-icon
provides extra attributes for raw SVG icon, for more detail, please read to the end.
<p>
with extra class <b>is-loading</b>, your icon is able to rotate 360 deg in 2 seconds, you can also override this
</p>
<el-icon :size="20">
<edit />
</el-icon>
<el-icon color="#409EFC" class="no-inherit">
<share />
</el-icon>
<el-icon>
<delete />
</el-icon>
<el-icon class="is-loading">
<loading />
</el-icon>
<el-button type="primary">
<el-icon style="vertical-align: middle;">
<search />
</el-icon>
<span style="vertical-align: middle;">
Search
</span>
</el-button>
:::
Using SVG icon directly
:::demo
<div style="font-size: 20px;">
<!-- Since svg icons do not carry any attributes by default -->
<!-- You need to provide attributes directly -->
<edit style="width: 1em; height: 1em; margin-right: 8px;" />
<share style="width: 1em; height: 1em; margin-right: 8px;" />
<delete style="width: 1em; height: 1em; margin-right: 8px;" />
<search style="width: 1em; height: 1em; margin-right: 8px;" />
</div>
:::
SVG Icons collection
:::tip
This collection is updated after ElementPlus@1.0.2-beta.66(included), you can only use el-icon
to wrap it after ElementPlus@1.0.2-beta.66(included), or directly use it without version constrains
You can use SVG icon in any version as long as you install it
You can click the icon to copy it :::
- {{component}}
Font Icon Basic usage
Just assign the class name to el-icon-iconName
.
:::demo
<i class="el-icon-edit"></i>
<i class="el-icon-share"></i>
<i class="el-icon-delete"></i>
<el-button type="primary" icon="el-icon-search">Search</el-button>
:::
Font Icons
- {{'el-icon-' + name}}
SVG Icon Attributes
Attribute | Description | Type | Acceptable Value | Default |
---|---|---|---|---|
color | SVG tag's fill attribute | Pick<CSSProperties, 'color'> | - | inherit from color |
size | SVG icon size, size x size | number | - | inherit from font size |