Element Plus 与 Vue 3:构建现代化 Web 应用的完美搭档

卓卓没头发 2024-08-20 16:33:02 阅读 92

引言

Element Plus是基于Vue 3的组件库,它继承了Element UI的优秀基因,为Vue 3应用提供了丰富的界面组件。Element Plus不仅拥有与Element UI相同的高质量组件,还针对Vue 3进行了优化和更新,确保了与Vue 3的无缝集成。

环境准备

在开始使用Vue 3和Element Plus构建Web应用之前,确保你的开发环境已经准备就绪。以下是环境准备的步骤:

确保Node.js和npm/yarn已安装

1.检查Node.js版本

打开终端或命令提示符,输入以下命令来检查Node.js是否已安装以及其版本:

<code>node -v

如果没有安装Node.js,或者安装的版本低于推荐版本,你需要从Node.js官网下载并安装最新版本。

2.检查npm/yarn版本(也可以用更高性能的pnpm)

npm是Node.js的包管理器,而yarn是另一个流行的包管理工具。你可以使用以下命令来检查npm或yarn是否已安装以及其版本:

npm -v

或者

yarn -v

如果没有安装npm或yarn,或者需要更新到最新版本,你可以根据需要进行安装或更新。

创建Vue 3项目(使用Vue CLI或Vite)

1.使用Vue CLI创建Vue 3项目

Vue CLI是一个基于Vue.js进行快速开发的完整系统。首先,确保你已经全局安装了Vue CLI:

npm install -g @vue/cli

或者

yarn global add @vue/cli

然后,创建一个新的Vue 3项目:

vue create my-vue3-project

在创建过程中,选择Vue 3作为项目版本。

2.使用Vite创建Vue 3项目(更推荐这个,性能更好)

Vite是一个现代的前端构建工具,它提供了快速的冷启动和即时热更新。首先,确保你已经全局安装了Vite:

npm install -g create-vite

或者

yarn create vite

然后,创建一个新的Vue 3项目:

create-vite my-vue3-project --template vue

或者

yarn create vite my-vue3-project --template vue

这将创建一个使用Vue 3的新项目。

安装Element Plus

Element Plus 是一个基于 Vue 3 的组件库,它提供了丰富的 UI 组件,可以帮助开发者快速构建高质量的用户界面。以下是使用 npm 或 yarn 安装 Element Plus 的步骤:

使用 npm 安装 Element Plus

在项目根目录下打开终端,执行以下命令:

npm install element-plus --save

使用 yarn 安装 Element Plus

在项目根目录下打开终端,执行以下命令:

yarn add element-plus

或者也可以使用性能更加好的pnpm 

引入 Element Plus 的 CSS 样式

安装完成后,需要引入 Element Plus 的 CSS 样式。这可以通过在项目的入口文件(通常是 main.js 或 main.ts)中添加以下代码来实现:

import 'element-plus/dist/index.css'

在 Vue 项目中全局注册 Element Plus 组件

为了在 Vue 项目中全局使用 Element Plus 组件,需要在创建 Vue 应用实例时使用 app.use() 方法来注册 Element Plus:

import { createApp } from 'vue'

import App from './App.vue'

import ElementPlus from 'element-plus'

const app = createApp(App)

app.use(ElementPlus)

app.mount('#app')

通过以上步骤,Element Plus 就已经成功安装并注册到你的 Vue 项目中了。现在,你可以在项目的任何组件中直接使用 Element Plus 提供的 UI 组件,无需在每个组件中单独导入。

注意事项

确保你的项目是基于 Vue 3 创建的,因为 Element Plus 是专门为 Vue 3 设计的。如果你的项目使用了 TypeScript,Element Plus 也提供了类型定义,可以无缝集成。Element Plus 提供了按需引入组件的功能,这可以帮助你进一步减小打包体积。你可以使用 babel-plugin-component 插件来实现按需引入。

基本使用

在 Vue 3 中,Element Plus 提供了一套丰富的组件库,用于构建现代化的用户界面。以下是如何在 Vue 3 项目中创建组件、局部注册 Element Plus 组件,并使用这些组件构建界面的步骤。

创建Vue组件

首先,你需要创建一个新的 Vue 组件。在 Vue 3 中,你可以使用单文件组件(SFC)的方式来创建组件。例如,创建一个名为 MyComponent.vue 的文件:

<template>

<div>

<el-button>默认按钮</el-button>

</div>

</template>

<script>

export default {

name: 'MyComponent'

}

</script>

<style scoped>

/* 在这里添加组件的样式 */

</style>

在组件中局部注册Element Plus组件

在 Vue 3 中,你可以使用 <script setup> 语法来局部注册 Element Plus 组件。这允许你在单个组件中使用 Element Plus 的组件,而不需要在全局范围内注册它们。以下是如何在组件中局部注册 Element Plus 的按钮组件的示例:

<template>

<div>

<el-button>默认按钮</el-button>

</div>

</template>

<script setup>

import { ElButton } from 'element-plus'

// 使用Element Plus的按钮组件

const Button = ElButton

</script>

<style scoped>

/* 在这里添加组件的样式 */

</style>

在上面的代码中,我们通过 import 语句从 element-plus 包中导入了 ElButton 组件,并在 <script setup> 块中将其注册为局部组件。然后在 <template> 中使用它。

使用Element Plus组件构建界面

现在,你已经了解了如何在 Vue 组件中局部注册 Element Plus 组件,接下来可以使用这些组件来构建你的界面。以下是一个使用 Element Plus 组件构建的简单界面示例:

<template>

<div>

<el-form :model="formModel" :rules="rules">code>

<el-form-item label="用户名" prop="username">code>

<el-input v-model="formModel.username"></el-input>code>

</el-form-item>

<el-form-item label="密码" prop="password">code>

<el-input type="password" v-model="formModel.password"></el-input>code>

</el-form-item>

<el-form-item>

<el-button type="primary" @click="submitForm">登录</el-button>code>

</el-form-item>

</el-form>

</div>

</template>

<script setup>

import { ref } from 'vue'

import { ElForm, ElFormItem, ElInput, ElButton } from 'element-plus'

const formModel = ref({

username: '',

password: ''

})

const rules = {

username: [

{ required: true, message: '请输入用户名', trigger: 'blur' }

],

password: [

{ required: true, message: '请输入密码', trigger: 'blur' }

]

}

</script>

<style scoped>

/* 在这里添加组件的样式 */

</style>

在这个示例中,我们使用了 Element Plus 的表单组件(el-form)、表单项组件(el-form-item)、输入框组件(el-input)和按钮组件(el-button)来构建一个简单的登录表单界面。

有的小伙伴可能不明白这个表单数据是怎么传达的,以及规则如何配置,下面我们展开讲讲

使用 :model 绑定数据和 :rules 绑定规则

在 Element Plus 的表单组件中,el-form 组件的 :model 属性和 :rules 属性是用于实现表单数据绑定和表单验证的关键特性。下面将详细解释这两个属性的原理和使用思路。

:model 绑定数据

el-form 组件的 :model 属性用于绑定一个响应式对象,该对象包含了表单的所有数据字段。当表单中的输入字段发生变化时,model 对象中的相应属性也会自动更新,反之亦然。

原理:

:model 属性通过 Vue 的响应式系统与表单输入字段进行双向绑定。当用户在输入字段中输入数据时,输入字段的值会更新到 model 对象中对应的属性。同样,如果 model 对象中的属性值发生变化,输入字段的显示也会相应更新。

使用思路:

1.在 Vue 组件的 <script setup> 部分,使用 ref 或 reactive 创建一个响应式对象作为表单数据模型。

2.在 el-form 组件中使用 :model 属性将这个响应式对象绑定为表单的数据源。

3.在 el-form-item 组件中,使用 v-model 将输入字段与 model 对象中相应的属性进行双向绑定。

人话::model绑定对象数组,然后用v-model绑定具体对象的值

示例代码:

<template>

<el-form :model="formModel">code>

<el-form-item label="用户名" prop="username">code>

<el-input v-model="formModel.username"></el-input>code>

</el-form-item>

<!-- 其他表单项 -->

</el-form>

</template>

<script setup>

import { ref } from 'vue'

const formModel = ref({

username: '',

// 其他字段

})

</script>

:rules 绑定规则(表单验证)

Element Plus 提供了一套完整的表单验证机制,使得开发者可以轻松地为表单添加验证规则,并处理验证错误。以下是如何在 Vue 3 项目中使用 Element Plus 的表单验证机制来创建带有验证规则的表单,并触发表单验证和错误处理的步骤。

Element Plus 的表单验证机制

Element Plus 的表单验证机制基于以下核心概念:

验证规则(Rules):定义了表单字段需要满足的条件。这些规则可以是必填、格式匹配、自定义验证函数等。触发时机(Triggers):定义了何时触发表单验证。例如,可以设置在输入框失去焦点(blur)或用户提交表单时进行验证。错误信息(Messages):当验证失败时,显示给用户的提示信息。

创建带有验证规则的表单

在 Vue 3 组件中,你可以使用 el-form 和 el-form-item 组件来创建表单,并通过 :rules 属性为每个表单项添加验证规则。以下是一个带有验证规则的表单示例:

<template>

<el-form :model="formModel" :rules="rules" ref="formRef" @submit.prevent="handleSubmit">code>

<el-form-item label="用户名" prop="username">code>

<el-input v-model="formModel.username"></el-input>code>

</el-form-item>

<el-form-item label="密码" prop="password">code>

<el-input type="password" v-model="formModel.password"></el-input>code>

</el-form-item>

<el-form-item>

<el-button type="primary" @click="submitForm">提交</el-button>code>

</el-form-item>

</el-form>

</template>

<script setup>

import { ref, reactive } from 'vue'

const formModel = reactive({

username: '',

password: ''

})

const rules = {

username: [

{ required: true, message: '请输入用户名', trigger: 'blur' },

{ min: 3, max: 10, message: '用户名长度在 3 到 10 个字符', trigger: 'blur' }

],

password: [

{ required: true, message: '请输入密码', trigger: 'blur' },

{ min: 6, message: '密码长度不能少于 6 个字符', trigger: 'blur' }

]

}

const formRef = ref(null)

const handleSubmit = () => {

formRef.value.validate((valid) => {

if (valid) {

// 表单验证通过,执行提交逻辑

console.log('表单提交成功', formModel)

} else {

// 表单验证失败,显示错误信息

console.log('表单验证失败')

}

})

}

</script>

在这个示例中,我们定义了 formModel 作为表单的数据模型,并通过 :rules 属性为用户名和密码字段添加了验证规则。我们还使用了 el-form 的 ref 属性来获取表单的引用,并在提交时调用 validate 方法来触发表单验证。

触发表单验证和错误处理

在上面的示例中,我们通过点击提交按钮来触发表单验证。当用户点击提交按钮时,handleSubmit 方法会被调用,该方法使用 formRef.value.validate 方法来验证表单数据。如果验证通过,我们可以执行表单提交的逻辑;如果验证失败,我们可以显示错误信息或进行其他错误处理。

在 el-form-item 组件中,我们使用 prop 属性来指定要验证的字段。当表单验证失败时,Element Plus 会自动显示与该字段关联的错误信息。

el-form 组件的 :rules 属性用于绑定一个对象,该对象定义了表单验证的规则。这些规则会在表单提交时被触发,用于验证表单数据是否符合预期。

原理:

:rules 属性通过 Element Plus 的表单验证系统与表单输入字段进行关联。当表单提交时,Element Plus 会根据 rules 对象中定义的规则对表单数据进行验证。如果验证失败,Element Plus 会显示相应的错误信息,并阻止表单提交。

使用思路:

1.在 Vue 组件的 <script setup> 部分,定义一个对象作为表单验证规则。

2.在 el-form 组件中使用 :rules 属性将这个验证规则对象绑定到表单上。

3.在 el-form-item 组件中,使用 prop 属性指定要验证的字段。

人话:表单上用:rules绑定整个规则对象,prop接受对应的数组(数组里面包含了一条或多条规则对象)

高级特性

使用 Element Plus 的指令(如 v-loading、v-popover等)

Element Plus 提供了一些自定义指令,如 v-loading 和 v-popover,这些指令可以简化特定功能的实现。

1.v-loading

v-loading 指令用于在元素上显示加载状态。你可以将它绑定到一个布尔值,以控制加载状态的显示。

<el-button v-loading="isLoading">加载中</el-button>code>

2.v-popover

v-popover 指令用于创建一个弹出提示框。你可以通过绑定一个对象来配置弹出提示框的内容、触发方式等。

<el-button v-popover="popoverConfig">悬停显示</el-button>code>

<script>

export default {

data() {

return {

popoverConfig: {

title: '标题',

content: '这里是内容',

trigger: 'hover'

}

};

}

}

</script>

Element Plus 的国际化(i18n)支持

Element Plus 支持国际化,允许你为应用提供多语言支持。

1.配置国际化

你需要安装 element-plus 的国际化插件,并在你的应用中配置它。

npm install element-plus --save

npm install @element-plus/icons-vue --save

2.使用国际化插件

在你的应用中,你可以使用 useElementPlusI18n 方法来配置国际化。

import { createApp } from 'vue';

import App from './App.vue';

import ElementPlus from 'element-plus';

import en from 'element-plus/lib/locale/lang/en';

import zh from 'element-plus/lib/locale/lang/zh-CN';

const app = createApp(App);

app.use(ElementPlus, {

locale: zh // 或者 en

});

app.mount('#app');

总结 

Element Plus 是一个专为 Vue 3 设计的组件库,它继承了 Element UI 的优秀基因,提供了丰富的 UI 组件,帮助开发者快速构建高质量的用户界面

资料推荐

一个 Vue 3 UI 框架 | Element Plus 官方文档



声明

本文内容仅代表作者观点,或转载于其他网站,本站不以此文作为商业用途
如有涉及侵权,请联系本站进行删除
转载本站原创文章,请注明来源及作者。