Skip to content

Installation

Compatibility

Vue EP Toolkit provides both components and utility functions with different browser compatibility requirements.

Since Vue 3 no longer supports IE11, Vue EP Toolkit does not support IE either.

FeatureChrome
Chrome
Edge
Edge
Firefox
Firefox
Safari
Safari
ComponentsChrome ≥ 85Edge ≥ 85Firefox ≥ 79Safari ≥ 14.1
Utility FunctionsChrome ≥ 74Edge ≥ 18Firefox ≥ 66Safari ≥ 11

Sass

Version 2.8.5 and later, the minimum compatible version of Sass is 1.79.0.

If your terminal prompts legacy JS API Deprecation Warning, you can configure the following code in vite.config.ts.

ts
css: {
  preprocessorOptions: {
    scss: { api: 'modern-compiler' },
  }
}

Version

Vue EP Toolkit is currently in a rapid development iteration. VueEpToolkit version badge

Using Package Manager

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

Choose a package manager you like.

shell
$ npm install vue-ep-toolkit --save
shell
$ yarn add vue-ep-toolkit
shell
$ pnpm install vue-ep-toolkit

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

shell
npm config set registry https://registry.npmmirror.com

Import in Browser

Import Vue EP Toolkit through browser HTML tags directly, and use global variable VueEpToolkit.

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

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

jsDelivr

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

TIP

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

Released under the MIT License.