From 32741f685b6d31b3ba75ea5c80ce9706d8bf1287 Mon Sep 17 00:00:00 2001 From: xingyu4j Date: Wed, 23 Nov 2022 09:46:26 +0800 Subject: [PATCH] docs --- yudao-ui-admin-vue3/README.md | 2 +- yudao-ui-admin-vue3/use.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/yudao-ui-admin-vue3/README.md b/yudao-ui-admin-vue3/README.md index de675b23d..4e9e09bde 100644 --- a/yudao-ui-admin-vue3/README.md +++ b/yudao-ui-admin-vue3/README.md @@ -18,7 +18,7 @@ ## 注意事项 - 项目路径请不要使用中文命名！！！会造成解析乱码！！！请使用全英文路径！！！ -- node >=14.19.0(建议使用 16 版本) ,pnpm >=7 +- node >=14.19.0(后续升级版本，对应node最低版本也会升级，建议直接使用 16 版本) ,pnpm >=7 - 开发建议使用 [谷歌浏览器-开发者版](https://www.google.cn/intl/zh-CN/chrome/dev/) 不支持 IE\QQ 等浏览器 ### 点击查看[使用说明](./use.md) diff --git a/yudao-ui-admin-vue3/use.md b/yudao-ui-admin-vue3/use.md index 88ef91c8a..afbafde2d 100644 --- a/yudao-ui-admin-vue3/use.md +++ b/yudao-ui-admin-vue3/use.md @@ -1,7 +1,7 @@ # 注意事项 - 项目路径请不要使用中文命名！！！会造成解析乱码！！！请使用全英文路径！！！全英文路径！！！全英文路径！！！ -- node >=16 , pnpm >=7，非node16+ pnpm 7+ 安装问题不予解决、不适配 +- node >=16 , pnpm >=7，非node16+ pnpm 7+ 安装问题不予解决 - 开发建议使用 [谷歌浏览器-开发者版](https://www.google.cn/intl/zh-CN/chrome/dev/) 不支持 IE\QQ 等浏览器 - 本框架使用 TypeScript ，简称ts，和java的类型差不多，为了简化没过多使用 type - 本框架使用 Vue3.2 + setup语法糖，请自行学习相关内容 @@ -12,17 +12,17 @@ ## 简单使用 - 目录结构与 vue2 版本基本保持一致 -- 一个页面(以post为例)由4部分组成 +- 一个页面(以post 岗位管理 为例)由3部分组成 ```bash -/src/api/system/post/index.ts -/src/views/system/post/ [index.vue | post.data.ts] +接口 /src/api/system/post/index.ts +页面和crud schemas /src/views/system/post/ [index.vue | post.data.ts] ``` - 其中api内index.ts 与 vue2 基本一致，只不过axios封装了get post put delete upload download 等方法，不用写method: 'get' 了 - views中，index.vue 与 vue2 基本一致，本框架使用了vxe-table并封装了Search Table Form Descriptions等组件，当然也继续支持vue2的写法 - post.data.ts 中主要是表单校验 rules 和表单 crudSchemas ，通过修改crudSchemas 就可以控制增删改查的字段、输入框还是下拉框等等 -- 本框架集成了国际化，不需要可以自己想办法移除，后期不会提供删减版 +- 本框架集成了国际化，不需要的话可以自己想办法移除，使用方法如下 ```bash import { useI18n } from '@/hooks/web/useI18n'