Inicio Rápido #

Esta sección describe cómo utilizar Element Plus en su proyecto.

Uso #

Importación completa #

Si no le importa tanto el tamaño del paquete, es más conveniente utilizar la importación completa.

// main.ts
import { createApp } from 'vue'
import ElementPlus from 'element-plus'
import 'element-plus/dist/index.css'
import App from './App.vue'

const app = createApp(App)

app.use(ElementPlus)
app.mount('#app')

Soporte Volar #

Si utiliza volar, agregue la definición global a compilerOptions.types en tsconfig.json.

// tsconfig.json
{
  "compilerOptions": {
    // ...
    "types": ["element-plus/global"]
  }
}

Importación a petición #

Necesita usar un plugin adicional para importar componentes que haya utilizado.

Autoimportación Recomendado #

Primero necesita instalar unplugin-vue-components y unplugin-auto-import.

npm install -D unplugin-vue-components unplugin-auto-import

A continuación, añada el siguiente código en su archivo de configuración Vite o Webpack.

Vite #

// vite.config.ts
import { defineConfig } from 'vite'
import AutoImport from 'unplugin-auto-import/vite'
import Components from 'unplugin-vue-components/vite'
import { ElementPlusResolver } from 'unplugin-vue-components/resolvers'

export default defineConfig({
  // ...
  plugins: [
    // ...
    AutoImport({
      resolvers: [ElementPlusResolver()],
    }),
    Components({
      resolvers: [ElementPlusResolver()],
    }),
  ],
})

Webpack #

// webpack.config.js
const AutoImport = require('unplugin-auto-import/webpack')
const Components = require('unplugin-vue-components/webpack')
const { ElementPlusResolver } = require('unplugin-vue-components/resolvers')

module.exports = {
  // ...
  plugins: [
    AutoImport({
      resolvers: [ElementPlusResolver()],
    }),
    Components({
      resolvers: [ElementPlusResolver()],
    }),
  ],
}

Para más paquetes (Rollup, Vue CLI) y configuraciones, por favor consulte unplugin-vue-components y unplugin-auto-import.

Nuxt #

Para usuarios de Nuxt, solo necesita instalar @element-plus/nuxt.

npm install -D @element-plus/nuxt

Luego añada el código de abajo en su archivo de configuración.

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@element-plus/nuxt'],
})

Consulte los documentos para saber cómo configurarlo.

Importar manualmente #

Element Plus proporciona funcionalidades de Tree Shaking basada en los Módulos ES.

Pero necesita instalar unplugin-element-plus para importar estilo. Y consulte la documentación para saber cómo configurarla.

App.vue

<template>
  <el-button>I am ElButton</el-button>
</template>
<script>
  import { ElButton } from 'element-plus'
  export default {
    components: { ElButton },
  }
</script>

// vite.config.ts
import { defineConfig } from 'vite'
import ElementPlus from 'unplugin-element-plus/vite'

export default defineConfig({
  // ...
  plugins: [ElementPlus()],
})

import 'element-plus/es/components/message/style/css'
import { ElMessage } from 'element-plus'

Plantilla de inicio #

Proporcionamos una Plantilla de Vite.

Para los usuarios de Nuxt tenemos una Plantilla de Nuxt.

Para los usuarios de Laravel tenemos una Plantilla de Laravel.

Configuración global #

Al registrar Element Plus, se puede pasar un objeto de configuración global. Este objeto soporta actualmente los campos size y zIndex size se utiliza para cambiar el tamaño por defecto del componente y zIndex establece el z-indez inicial de la caja emergente, valor por defecto 2000.

Importación completa:

import { createApp } from 'vue'
import ElementPlus from 'element-plus'
import App from './App.vue'

const app = createApp(App)
app.use(ElementPlus, { size: 'small', zIndex: 3000 })

Bajo demanda:

<template>
  <el-config-provider :size="size" :z-index="zIndex">
    <app />
  </el-config-provider>
</template>

<script>
import { defineComponent } from 'vue'
import { ElConfigProvider } from 'element-plus'

export default defineComponent({
  components: {
    ElConfigProvider,
  },
  setup() {
    return {
      zIndex: 3000,
      size: 'small',
    }
  },
})
</script>

Usando Nuxt.js #

También podemos usar Nuxt.js：

Empecemos #

Puede arrancar su proyecto a partir de ahora. Para el uso de cada componente, por favor consulte la documentación individual de cada componente.