Icon

Element Plus provides a set of common icons.

Icon 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/[email protected]@element-plus/icons-vue@latest and the source element-plus-icons out or Icon Collection

Installation

Using packaging manager

Choose a package manager you like.

::: code-group

shell

$ npm install @element-plus/icons-vue

shell

$ yarn add @element-plus/icons-vue

shell

$ pnpm install @element-plus/icons-vue

:::

Register All Icons

You need import all icons from @element-plus/icons-vue and register them globally.

// main.ts

// if you're using CDN, please remove this line.
import * as ElementPlusIconsVue from '@element-plus/icons-vue'

const app = createApp(App)
for (const [key, component] of Object.entries(ElementPlusIconsVue)) {
  app.component(key, component)
}

You can also refer to this template.

Import in Browser

Import Element Plus Icons through browser HTML tags directly, and use global variable ElementPlusIconsVue.

According to different CDN providers, there are different introduction methods. Here we use unpkg and jsDelivr as example. You can also use other CDN providers.

::: code-group

html

<script src="//unpkg.com/@element-plus/icons-vue"></script>

html

<script src="//cdn.jsdelivr.net/npm/@element-plus/icons-vue"></script>

:::

:::tip

We recommend using CDN to import Element Plus users to lock the version on the link address, so as not to be affected by incompatible updates when Element Plus is upgraded in the future. Please check unpkg.com for the method to lock the version.

:::

Auto Import

Use unplugin-icons and unplugin-auto-import to automatically import any icon collections from iconify. You can refer to this template.

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.

:::

vue

<!-- Use el-icon to provide attributes to SVG icon -->
<template>
  <div>
    <el-icon :size="size" :color="color">
      <Edit />
    </el-icon>
    <!-- Or use it independently without derive attributes from parent -->
    <Edit />
  </div>
</template>

<vp-script setup> import { Edit, Share, Delete, Search, Loading } from '@element-plus/icons-vue' </vp-script> <ElRow> <div> <ElIcon :size="30"> <Edit /> </ElIcon> <Edit /> </div> </ElRow>

Combined with el-icon

el-icon provides extra attributes for raw SVG icon, for more detail, please read to the end.

vue

<template>
  <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>
</template>

<ElRow> <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> <div style="display: flex; align-items: center; justify-content: space-between; width: 100%;"> <ElIcon :size="20"> <Edit /> </ElIcon> <ElIcon color="#409efc" class="no-inherit"> <Share /> </ElIcon> <ElIcon> <Delete /> </ElIcon> <ElIcon class="is-loading"> <Loading /> </ElIcon> <ElButton type="primary"> <ElIcon style="vertical-align: middle; color: #fff;"> <Search /> </ElIcon> <span style="vertical-align: middle;"> Search </span> </ElButton> </div> </ElRow>

Using SVG icon directly

vue

<template>
  <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>
</template>

Icon Collection{#icon-collection}

:::tip

You can use SVG icon in any version as long as you install it

You can click the icon to copy it

:::

API

Attributes

Name	Description	Type	Default
color	SVG tag's fill attribute	^[string]	inherit from color
size	SVG icon size, size x size	^[number] / ^[string]	inherit from font size

Slots

Name	Description
default	Customize default content