@gonsin/gview 1.1.17 → 2.0.0

package/README.md

@@ -1,367 +1,3 @@
-# GView
+# gview
 
-GView 项目的前端部分，接收处理来自服务器的 JSON 格式数据快速生成对应的表单、表格等视图。
-
-<a href="https://www.npmjs.com/package/@gonsin/gview">
-    <img src="https://img.shields.io/npm/v/@gonsin/gview.svg?sanitize=true" alt="Version">
-</a>
-
-## 安装依赖
-
-```sh
-npm install
-```
-
-## 项目开发
-
-```sh
-npm run serve
-```
-
-## 项目打包
-
-```sh
-npm run build
-```
-
-## 项目发布
-
-```sh
-npm publish
-```
-
-## `example` 项目运行
-
-```sh
-cd example
-npm install
-npm run serve
-```
-
-## 使用方法
-
-详细参考 `example` 项目。
-
-1. 项目入口文件 `main.js` 配置：
-
-```js
-import store from "./store";
-
-import TDesign from "tdesign-vue";
-Vue.use(TDesign);
-
-import GView from "@gonsin/gview";
-Vue.use(GView, { store });
-
-new Vue({
-    router,
-    render: (h) => h(App),
-}).$mount("#app");
-```
-
-> 注意目前 GView 依赖于 TDesign(1.0.5 版本)，所以需要引入 TDesign；另外需要在 `Vue.use(GView, { store })` 中传入 `Vuex` 的 `store`，以便动态注册 GView 的 `store` 模块。
-
-2. 根据开发修改代理服务的接口地址：
-
-```js
-proxy: {
-  "/api": {
-    target: "http://192.168.2.192:8088",
-    changeOrigin: true,
-    disableHostCheck: false, //  新增该配置项
-  },
-  "/restapi": {
-    target: "http://192.168.2.192:8088",
-    changeOrigin: true,
-    disableHostCheck: false, //  新增该配置项
-  },
-  // 配置websocket开发时代理
-  "/gview/websocket": {
-    target: "ws://192.168.2.192:8088",
-    changeOrigin: true,
-    disableHostCheck: false, //  新增该配置项
-  },
-},
-
-```
-
-3. 设置与 GView 相关的路由映射：
-
-```js
-// 引入菜单管理组件
-import { GMenuManage, config } from "@gonsin/gview";
-
-const routes = [
-    {
-        path: "/view",
-        name: "home",
-        component: () => import("../views/HomeView.vue"),
-    },
-    {
-        path: "/menu",
-        name: "menu",
-        component: GMenuManage,
-    },
-    {
-        path: "/login",
-        name: "login",
-        component: () => import("../views/LoginView.vue"),
-    },
-    {
-        redirect: "/login",
-        path: "/",
-    },
-];
-```
-
-> 与 GView 路由组件相关的路由路径 `path` 必须设置为 `/view`；登录页面的路由路径必须设置为 `/login`；根据需求设置重定向以及路由守卫。具体参考 `example/src/router/index.js`。⚠ 新增 GView 菜单管理界面，需要添加路由路径 `/menu` ，并且从 GView 中引入菜单管理组件作为路由组件。
-
-4. GView 组件的具体用法：
-
-```html
-<template>
-    <GView :config="{ ...defaultConfig, ...config }" />
-</template>
-```
-
-> `:config` 传入用户登录信息以及登录权限菜单；另外可后续传入更多自定义配置。 具体参考 `example/src/views/HomeView.vue`。
-
-5. 另外 GView 提供了已经封装好的 axios 工具以及规范的存储常量名称，可以直接引入使用：
-
-```js
-// 引入提供的axios封装工具
-import { http } from "@gonsin/gview";
-
-// 以用户登录接口为例，使用 http.post 方法发送 POST 请求：
-export const loginApi = (params) => {
-    return http.post(loginApiUrl.loginUrl, qs.stringify(params));
-};
-```
-
-```js
-import { config } from "@gonsin/gview";
-
-// 存入 sessionStorage 最好使用 config 给出的相关常量：
-sessionStorage.setItem(config.LOCAL_USER, JSON.stringify(res.data));
-```
-
-> 更多用法参考 `example/src/store/modules/user.js` 。
-
-## 版本更新日志
-
-### 1.1.17 `2023-03-22`
-
-- 🐛 fix:
-  - fix(GTable): 修复表格数据更新之后视图不更新的问题
-  - fix: 更新axios配置
-  - fix: 优化代码
-- ✨ feat:
-  - feat: 添加 glicense
-
-### 1.1.16 `2023-03-03`
-
-- 🐛 fix:
-  - 修复问题
-  - 优化代码
-
-### 1.1.15 `2023-02-28`
-
-- 🐛 fix:
-  - `GLayout` 改进菜单的配置逻辑和样式
-  - `GHeader` 优化搜索功能
-  - `GTable` 修改表格分页搜索没有重置的问题
-  - 调整布局样式
-    - 修改整体布局的 `padding` 大小
-    - 调整整体 `card` 底部的 `padding` 间距
-    - 调整 `Tab` 视图的 `border` 位置
-    - 调整 `Dialog` 的 `border-radius` 大小
-    - 调整不同视图下表单的尺寸大小
-    - 调整不同视图下 `Dialog` 的尺寸大小
-  - 修改菜单和首页初始化逻辑
-- ✨ feat:
-  - `GMenuManage` 完善菜单管理功能
-  - 将表格封装为通用组件
-    - 将表格相同 props 与样式抽取成通用组件，保持全局表格的一致
-    - 修改表格的样式：单元格的大小、固定第一列与最后一列表格、取消第一列单元格的边框
-- 🔨 chore:
-  - 添加和更新依赖
-    - 添加 `lodash-es` 工具库依赖
-    - 更新 `tdesign-vue` 1.1.3 版本
-
-### 1.1.14 `2023-02-09`
-
-- 🐛 fix:
-  - 修复时间日期选择器错位问题
-  - `GHeader` 处理头部报错不显示问题
-  - 修改链接按钮的动作
-  - 修改与优化 `props` 传递方式
-  - 调整布局样式
-  - 修复与优化表单相关问题：
-    - 修复因表单初始化和更新数据逻辑出错导致某个数据更新时影响其他数据的原先改动（`switch` 开关组件）
-    - 改进 `showIf` 和 `disableIf` 的体验：隐藏或者禁用某个表单项时清楚输入的表单内容
-  - fix: 修改确认对话框提交请求时参数被覆盖的问题
-- ✨ feat:
-  - 完善 WebSocket 重新连接机制
-    - 修改原来 WebSocket 重连后的逻辑
-    - 修改原来刷新（重新加载视图）的逻辑
-  - 封装通用的组件以便统一样式
-    - 封装常用的对话框 `Dialog`、头部 `Header`、表单 `Form` 组件，提供插槽和传入到 TDesign 组件的配置入口
-    - 样式调整统一再通用组件中调整，以便再 GView 以外定义的页面组件中使用
-- 🔨 chore:
-  - 更新 `tdesign` 版本 1.1.1
-
-### 🧧 1.1.13 `2023-02-03`
-
-- 🐛 fix:
-  - `GForm`: 修改时间选择器默认格式
-  - `GTable`: 修改操作栏的显示
-  - `GHeader` 模板头部调整为可拓展插槽的组件
-  - 统一日期时间格式
-  - 调整布局样式
-- ✨ feat:
-  - `GTable` 表格添加显示默认头像或者默认图片
-  - `GMenu` 添加菜单管理界面基本功能
-- 🔨 chore:
-  - 更新 tdesign 版本 1.0.5
-
-### 1.1.12 `2023-01-13`
-
-- 🐛 fix:
-  - `GTable` 调整表格图片显示
-  - 批量操作时传递 props
-  - `socket` 修复 WebSocket 断开时报错
-  - 更新项目开发代理配置
-  - `GForm` 新增表单组件可清除功能
-- ✨ feat:
-  - `GForm`:
-    - 添加表单验证功能
-    - 表单上传组件显示内容修改
-    - 修复表单选项不更新问题
-  - 请求头中添加 lang 字段
-
-### 1.1.11 `2023-01-11`
-
-- 🐛 fix:
-  - `GTable` ：
-    - 修复表格表单没有修改值但提交请求的问题
-    - 调整表格内容总宽度为自适应
-  - `GLayout`:
-    - 调整深色模式下的样式
-    - 调整系统设置面板样式
-    - 修复顶部 Tab 菜单下拉菜单 Bug
-  - `GForm`:
-    - 修复时间选择器无法输入问题
-    - 修复表单区块 showIf 样式 Bug
-    - 修复表单组件 prop 类型检测报错问题
-- ✨ feat:
-  - 完善下载按钮动作
-
-### 1.1.10 `2023-01-09`
-
-- 🐛 fix:
-  - `GForm` 修改表单区块显示内容
-  - `GTable` 修改表格单元列宽度根据权重调整
-  - `GTable` 修复表格表单字段错乱导致提交出错问题
-- ✨ feat:
-  - `GDialog` 添加对话框过渡动画
-
-### 1.1.9 `2023-01-06`
-
-- 🐛 fix:
-  - 修复因为空白 keyName 导致报错重复的问题
-  - 删除 socket 控制台调试信息
-  - `GLayout` 修复折叠菜单变量修改报错问题
-- ✨ feat:
-  - `GForm` 支持表单区块控制 showIf 功能
-  - `GForm` 完善控制表单输入类型
-  - `GForm` 添加上传文件时传入文件名为表单中的一个字段
-  - `GForm` 支持表格中的表单类型单元格
-  - 完善加载过渡动画样式
-
-### 1.1.8 `2022-12-31`
-
-- 🐛 fix:
-  - `GLayout` 修复侧边栏菜单高亮
-- ✨ feat:
-  - `GTable` 完善表格批量操作以及提示
-  - `GTable` 更新显示会议码
-  - 支持 GView 组件按需引入
-
-### 1.1.7 `2022-12-22`
-
-- 🐛 fix:
-  - 修复打包后发现的 Bug
-  - 修复表单上传组件 Bug ：
-    - 修复表单上传组件 Bug
-    - 提供可传入上传 API 地址的接口方便全局修改上传 API 地址
-  - 修复表单无法获取值为 0 的选项的问题
-  - 修复顶部 Tab 菜单栏超出屏幕长度的问题
-  - 完善 TypeScript 配置
-  - 修改请求数据报错
-
-### 1.1.6 `2022-12-20`
-
-- 🐛 fix:
-  - `GForm`: 修改表单日期类型提交的值为时间戳格式
-  - 修复标签页无法关闭以及重复 key 报错问题
-  - 修改登录后处理菜单的逻辑
-  - `GLayout`: 优化侧边菜单的样式和体验
-  - 修改打包配置和接口地址
-- ✨ feat:
-  - `GLayout`: 添加顶部 Tab 菜单的持久化特性
-
-### 1.1.5 `2022-12-17`
-
-- 🐛 fix:
-  - `GForm`:
-    - 修复部分表单类型的 showIf 不起作用的问题
-    - 调整上传组件的 placeholder
-    - 修复表单 key 重复报错及空白问题
-    - 修改表单选择下拉数据携带查询参数
-  - `GView` 解决请求访问 view 数据为空报错的问题
-  - `GDialog` 完善对话框表单请求数据
-  - 修复过滤菜单时可能报错导致页面空白问题
-  - 修改获取用户菜单的接口路径
-- ✨ feat:
-  - `GForm` 完善表单动态 disableIf 功能
-  - `GHeader` 完善头部搜索过滤数据功能
-  - 新增系统设置面板相关功能
-
-### 1.1.4 `2022-12-16`
-
-- 🐛 fix:
-  - 将登录后初始化用户信息及菜单等逻辑转入 GView 包内进行：
-    - 涉及 `example` 用法的更新，使用 GView 组件时传入用户登录后的信息、菜单即可
-    - 更加方便之后传入更多自定义的配置到 GView 中
-  - 处理重复路由跳转报错
-  - 修复刷新后回到首页问题
-  - 修改样式以及规范样式类命名
-  - 解决打包时的变量丢失问题
-  - 调整用户登录相关的逻辑
-- ✨ feat:
-  - `GForm` 完善表单隐藏项目类型
-  - `Auth` 完善传入的 token 以及在每个请求头中添加 token 字段
-
-### 1.1.3 `2022-12-13`
-
-- 🐛 fix:
-  - `GForm` 修改 TreeCheckBox 选中值模式包括父节点
-  - `GLayout` 修复切换 tab 菜单时丢失路径携带的参数导致页面空白的问题
-  - `GTable` 完善表格视图的分页功能
-  - 完善路由守卫
-
-### 1.1.2 `2022-12-12`
-
-- 🐛 fix: 修复 babel 依赖打包后报错问题
-
-### 1.1.1 `2022-12-12`
-
-- 🐛 fix:
-  - `GTab`/`GDialog` 修复 tab 和对话框动态加载组件出错问题
-  - `GForm`/`GTable` 修复 v 方法找不到导致动态渲染内容无法显示问题
-  - `GLayout` 修复头部下拉框消失问题
-  - 修改打包构建配置
-
-### 1.1.0 `2022-12-12`
-
-- ✨ feat: 使用 TypeScript + TDesign 重构项目代码，更换掉原来的组件库 ElementUI。
+基于 Vite/Vue3/TypeScript 的 gview。开发中...