hhx-custom-components
v0.0.5
Published
Vue3 中基于Element-plus二次封装基础组件文档
Downloads
6
Maintainers
luyaweiReadme
hhx-custom-components
介绍
基于 vue3+ ts+ Element-plus 二次封装组件
这是我在学习 Vue3 中基于Element-plus 二次封装基础组件文档，希望对你有用。
npm 方式安装使用
pnpm i hhx-custom-components全局注册使用
前提条件：使用项目必须全局注册 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 "element-plus/theme-chalk/dark/css-vars.css";
import locale from "element-plus/es/locale/lang/zh-cn";
// element-plus图标
import * as ElementPlusIconsVue from "@element-plus/icons-vue";
import TuiPlus from 'hhx-custom-components'
import 'hhx-custom-components/lib/style.css'
const app = createApp(App)
// 注册所有图标
for (const [key, component] of Object.entries(ElementPlusIconsVue)) {
app.component(key, component);
}
// 注册ElementPlus
app.use(ElementPlus, {
locale // 语言设置
// size: Cookies.get('size') || 'medium' // 尺寸设置
});
app.use(TuiPlus)
app.mount('#app')按需引入
// 在main.js中按下引入
import 'hhx-custom-components/lib/style.css'
// 单个.vue文件引入
<script setup lang="ts">
import {TDetail, TForm} from "hhx-custom-components"
</script>全部组件如下
TLayoutPage, // 布局页面
TLayoutPageItem, // 布局页面子项
TAdaptivePage, // 一屏组件（继承TTable 及 TQueryCondition 组件的所有属性、事件、插槽、方法）
TQueryCondition, // 查询条件
TTable, // 表格
TForm, // 表单
TSelectTable, // 下拉选择表格
TSelect, // 下拉选择
TDetail, // 详情
TButton, // 防抖按钮
TStepWizard, // 步骤条
TTimerBtn, // 定时按钮
TModuleForm, // 模块表单/详情
TDatePicker, // 日期选择器
TRadio, // 单选
TCheckbox, // 多选
TChart, // 图表
TTabs // 标签页Use CDN in Project(暂不支持)
<head>
<!-- Import style -->
<link rel="stylesheet" href="//unpkg.com/hhx-custom-components/lib/style.css" />
<!-- Import Vue 3 -->
<script src="//unpkg.com/vue@3"></script>
<!-- Import component library -->
<script src="https://unpkg.com/hhx-custom-components@latest"></script>
</head>hhx-custom-components Volar 组件类型提示
// 需要在使用的项目的tsconfig.json文件中添加以下
compilerOptions：{
"types": [
"hhx-custom-components/components.d.ts",
],
}
Vue3 + Vite项目中安装引入报如下错误的解决方法
把项目的vite版本升级到4+
安装依赖
注意: 本地环境版本最好安装 Node.js 16.x+、pnpm 7.x+
npm install -g pnpm
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: 回滚操作;