element-plus/docs/en-US/guide/installation.md
2021-09-17 09:18:40 +08:00

4.6 KiB

title
Installation

Installation

Compatibility

Element Plus can run on browsers that supports ES2018 and ResizeObserver. If you really need to support outdated browsers, please add Babel and Polyfill yourself.

Since Vue 3 no longer supports IE11, Element Plus does not support IE either.

IE Firefox Chrome Safari
Edge ≥ 79 Firefox ≥ 78 Chrome ≥ 64 Safari ≥ 12

Version

Element Plus is currently in a rapid development iteration.

ElementPlus version badge

Using Package Manager

We recommend using the package manager (NPM, Yarn, pnpm) to install Element Plus, so that you can utilize bundlers like Vite and webpack.

# Choose a package manager you like.

# NPM
$ npm install element-plus --save

# Yarn
$ yarn add element-plus

# pnpm
$ pnpm install element-plus

If your network environment is not good, it is recommended to use a mirror registry cnpm or Alibaba.

Import in Browser

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

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

<head>
  <!-- Import style -->
  <link rel="stylesheet" href="//unpkg.com/element-plus/dist/index.css" />
  <!-- Import Vue 3 -->
  <script src="//unpkg.com/vue@next"></script>
  <!-- Import component library -->
  <script src="//unpkg.com/element-plus"></script>
</head>

jsDelivr

<head>
  <!-- Import style -->
  <link
    rel="stylesheet"
    href="//cdn.jsdelivr.net/npm/element-plus/dist/index.css"
  />
  <!-- Import Vue 3 -->
  <script src="//cdn.jsdelivr.net/npm/vue@next"></script>
  <!-- Import component library -->
  <script src="//cdn.jsdelivr.net/npm/element-plus"></script>
</head>

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

:::

Hello World

With CDN, we can easily use Element Plus to write a Hello world page. Online Demo

If you are installing via package manager and want to use it with a packaging tool, please read the next section: Quick Start.