mirror of https://gitee.com/element-plus/element-plus.git synced 2024-12-14 01:11:25 +08:00

chore: add attribute enum autosuggestion for WebStorm (#9663 )

2022-09-10 09:14:31 +08:00

6.2 KiB

Raw Blame History

title	lang
Icon	en-US

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/icons-vue@1.x @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.

# NPM
$ npm install @element-plus/icons-vue
# Yarn
$ yarn add @element-plus/icons-vue
# pnpm
$ 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.

unpkg

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

jsDelivr

<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.

:::

<!-- 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>

import { Edit, Share, Delete, Search, Loading } from '@element-plus/icons-vue'

Combined with el-icon

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

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

with extra class is-loading, your icon is able to rotate 360 deg in 2 seconds, you can also override this

Using SVG icon directly

<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