Skip to content

Plugin

ts
import FastElementPlus, { install, version } from "fast-element-plus";
  • The default export is a Vue plugin with install(app) and version.
  • Installation registers Element Plus, both required icon sets, every component, and every directive. Reinstalling into the same app is idempotent.
  • version is the current package version.
  • INSTALLED_KEY marks full-plugin installation on a Vue app; needed only for custom installation integration.

Importing the root applies Fast's Element Plus prop defaults and enhances ElMessageBox.alert, confirm, and prompt singletons. app.use(FastElementPlus) also registers Element Plus and both icon sets. These are public runtime contracts.

Follow the compatibility review for Element Plus minor upgrades.

install Install

Registers Element Plus, both icon sets, all Fast components, and directives in a Vue app.

Signature

ts
install(app: App): void;

Example

ts
import { createApp } from "vue";
import { install } from "fast-element-plus";

const app = createApp({});
install(app);

Input

InputTypeRequired / defaultDescription
appAppRequiredVue 3 app receiving the library.

Returns

ValueTypeDescription
resultvoidNo return value; repeated installation in the same app is idempotent.