idata-ui-plus
v0.0.3
Published
Vue3 中基于Element-plus二次封装组件文档
Downloads
40
Maintainers
sunddReadme
idata-ui-plus
介绍
基于 vue3+ ts + Element-plus 二次封装组件
这是我在学习 Vue3 中基于Element-plus 二次封装基础文档，希望对你有用。可查看 详细组件案例文档 预览
安装
建议您使用包管理器 (pnpm推荐 ， yarn，npm) 安装 idata-ui-plus。
pnpm install idata-ui-plus -Syarn add idata-ui-plusnpm install idata-ui-plus -S全局注册使用
前提条件：使用项目必须先注册 Element-plus 组件库，可以选择全量引入或者按需引入。
// 在main.js中按下引入
import { createApp } from "vue"
import App from "./App.vue"
import ElementPlus from "element-plus"
import "element-plus/dist/index.css"
import locale from "element-plus/es/locale/lang/zh-cn"
import IdataUiPlus from "idata-ui-plus"
import "idata-ui-plus/lib/style.css"
const app = createApp(App)
// 注册ElementPlus
app.use(ElementPlus, {
locale // 语言设置
})
app.use(IdataUiPlus)
app.mount("#app")按需引入
// 在main.js中按下引入
import "idata-ui-plus/lib/style.css"
// 单个.vue文件引入
;<script setup lang="ts">
import {IdataListLayout} from "idata-ui-plus"
</script>浏览器直接引入 Use CDN in Project(v1.5.0 支持)--建议使用 pnpm 安装使用
浏览器直接引入组件库，属性
驼峰命名必须转换为短横线,直接通过浏览器的 HTML 标签导入idata-ui-plus，然后就可以使用全局变量IdataUiPlus了
<head>
<!-- Import style -->
<link rel="stylesheet" href="https://unpkg.com/element-plus/dist/index.css" />
<link rel="stylesheet" href="https://unpkg.com/idata-ui-plus/lib/style.css" />
<!-- Import Vue 3 -->
<script src="https://unpkg.com/vue@3"></script>
<!-- Import component library -->
<script src="https://unpkg.com/element-plus"></script>
<!-- 3. 引入t-ui-plus的组件库 -->
<script src="https://unpkg.com/idata-ui-plus@latest"></script>
</head>
<body>
<div id="app">
<IdataListLayout :show-left="true">
<template #left>
<div>left</div>
</template>
<template #search>
<div>search</div>
</template>
<template #action>
<div>action</div>
</template>
<template #content>
<div>content</div>
</template>
</IdataListLayout>
</div>
<script>
const app = Vue.createApp({
data() {
return {
value: ""
}
}
})
app.mount("#app")
</script>
</body>全部组件如下
| 组件名称 | 说明 | | --------------- | ---------------- | | IdataListLayout | 列表页面布局组件 | | | | | | |
idata-ui-plus Volar 组件类型提示
// 需要在使用的项目的tsconfig.json文件中添加以下
compilerOptions：{
"types": [
"idata-ui-plus/components.d.ts",
],
}
安装依赖
注意: 本地环境版本最好安装 Node.js 18.x+、pnpm 9.x+
npm install -g pnpm
# 安装依赖
pnpm install --registry=https://registry.npmjs.org/
>pnpm config get registry 查看当前指向源
# 如果安装依赖失败，可以尝试使用淘宝镜像 --registry=https://registry.npmmirror.com/
>pnpm config set registry https://registry.npmmirror.com/ 切换淘宝镜像源
>pnpm install
本地运行 vuepress 中组件文档
// docs项目(文档demo示例)基于vue3+vite项目
npm run docs:dev
Git 提交规范
ci: ci 配置文件和脚本的变动;chore: 构建系统或辅助工具的变动;fix: 代码 BUG 修复;feat: 新功能;perf: 性能优化和提升;refactor: 仅仅是代码变动，既不是修复 BUG 也不是引入新功能;style: 代码格式调整，可能是空格、分号、缩进等等;docs: 文档变动;test: 补充缺失的测试用例或者修正现有的测试用例;revert: 回滚操作;