yk-ui-plus
TypeScript icon, indicating that this package has built-in type declarations

1.4.32 • Public • Published

Yk-Ui-Plus

基于 Element-ui 二次封装基础组件地址

yk-bi-vite-front是基于 Vue3.3、TypeScript、Vite4、Pinia、Element-Plus 开源的一套后台管理模板;此项目全面使用了Yk-Ui-Plus二次封装基础组件库

``

介绍

基于 vue3+ ts+ Element-plus 二次封装组件

这是我在学习 Vue3 中基于Element-plus 二次封装基础组件文档,希望对你有用。可查看 详细组件案例文档 预览

vue3 yk-ui-plus yk-ui-plus npm

动态效果图

npm 方式安装使用

npm i yk-ui-plus

全局注册使用

前提条件:使用项目必须全局注册 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 YkuiPlus from 'yk-ui-plus'
import 'yk-ui-plus/lib/style.css'
import request from "../src/utils/request" // 本项目内封装后的request文件
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(YkuiPlus)
app.config.globalProperties.$YkuiPlus = { request }; // 将插件需要的配置 全局定义 $YkuiPlus 变量 
app.mount('#app')

按需引入

// 在main.js中按下引入
import 'yk-ui-plus/lib/style.css'
// 单个.vue文件引入
<script setup lang="ts">
  import {YkDetail, YkForm} from "yk-ui-plus"
</script>

全部组件如下

YkLayoutPage, // 布局页面
YkLayoutPageItem, // 布局页面子项
YkAdaptivePage, // 一屏组件(继承YkTable 及 YkQueryCondition 组件的所有属性、事件、插槽、方法)
YkQueryCondition, // 查询条件
YkTable, // 表格
YkForm, // 表单
YkSelectTable, // 下拉选择表格
YkSelect, // 下拉选择
YkDetail, // 详情
YkButton, // 防抖按钮
YkStepWizard, // 步骤条
YkTimerBtn, // 定时按钮
YkModuleForm, // 模块表单/详情
YkDatePicker, // 日期选择器
YkRadio, // 单选
YkCheckbox, // 多选
YkChart, // 图表
YkTabs // 标签页

Use CDN in Project(暂不支持)

<head>
  <!-- Import style -->
  <link rel="stylesheet" href="//unpkg.com/yk-ui-plus/lib/style.css" />
  <!-- Import Vue 3 -->
  <script src="//unpkg.com/vue@3"></script>
  <!-- Import component library -->
  <script src="https://unpkg.com/yk-ui-plus@latest"></script>
</head>

yk-ui-plus Volar 组件类型提示

// 需要在使用的项目的tsconfig.json文件中添加以下
compilerOptions:{
  "types": [
      "yk-ui-plus/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: 回滚操作;

Package Sidebar

Install

npm i yk-ui-plus

Repository

github.com

Homepage

github.com

Weekly Downloads

1

Version

1.4.32

License

MIT

Unpacked Size

1.43 MB

Total Files

64

Last publish

Collaborators

  • wangzhongkui