13 Star 191 Fork 63

奔跑的蜗牛 / vue3+vant4-h5

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

vue3+vant4

项目地址

vue项目演示

react项目演示

react项目代码:react项目代码

环境版本

npm-check-updates@16.14.12 (ncu -u)
nvm@1.1.11
node@20.0.0
npm@9.6.4

项目重要知识点

(keep-alive分支采用回调函数方式实现页面缓存前进触发初始化函数后退达到页面缓存效果,当前分支采用的是中央事件总线通知的形式实现)
1. 采用 vue3 + vite + pinia
2.可通过配置路由实现页面缓存效果(路由插件+中央事件总线+keep-alive组件+component组件构成)
3. 使用 unplugin-auto-import
插件实现自动导入库、方法、函数、自定义等,以$global为前缀作为全局自动导入 
4.使用unplugin-vue-components 插件实现自动导入UI库、指定文件下自动全局导入作为组件
5.通过模块化配置vite插件,在vite-config/plugins文件夹下配置vite插件
6.全局方法、变量有:$globalReady、$globalStore、$globalRegisterStore、$globalEventBus
   $globalLang、$globalConfigure、$globalHttp、$globalRequestUrl、$globalRequest
   $globalConstant、$globalRouter、$globalRouterModules、$globalExpandRouter

脚手架

master 分支使用 vite + pinia

项目安装

npm install 或 cnpm install

项目启动

npm run vite

项目打包

npm run build:dev
npm run build:prod

项目目录结构

|-- src
|    |-- api // api地址
|    |-- assets // 样式以及图片
|    |-- common // 公用模块
|    |       |-- globalConfigure.js // 全局自动导入页面缓存初始化函数
|    |       |-- globalConstant.js // 全局自动导入常量
|    |       |-- globalEventBus.js // 全局通知实例
|    |       |-- globalExpandRouter.js // 全局自动导入路由处理方法
|    |       |-- globalHttp.js // 全局自动导入请求处理函数
|    |       |-- globalInitialize.js // 全局自动导入初始化方法
|    |       |-- globalLocales.js // 全局自动导入国际化方法
|    |       |-- globalRequest.js // 全局自动导入请求拦截方法
|    |       |-- globalRouter.js // 全局自动导入路由配置
|    |       |-- globalStore.js // 全局自动导入pinia处理函数
|    |-- components // 全局自动注册组件
|    |-- constant // 全局自动注册常量
|    |-- locales // 多语言配置
|    |-- router // 路由模块
|    |-- store // pinia
|    |-- util // 工具类
|    |-- views // 页面
|    |-- App.vue // 入口文件
|    |-- main.js // 入口js文件
|--vite-config  // vite配置
|     |--plugins // vite插件配置
|     |--index.js // vite处理配置
|--vite-env  // vite环境配置
|     |-- .env    // 本地环境配置
|     |-- .env.dev // 测试环境配置
|     |-- .env.prod // 生产环境配置
|
|-- .eslintrc.js // es配置
|-- babel.config.js // babel配置
|-- vite.config.js // 脚手架配置

项目全局导入自定义函数、UI 库、自定义组件

(1)安装 unplugin-vue-components 插件用于导入组件库和自定义组件,安装 unplugin-auto-import 用于导入方法、变量等

(2)vite.config.js 配置说明
import { defineConfig, loadEnv } from "vite";
import vue from "@vitejs/plugin-vue";
import { baseCfg, pluginCfg } from "./vite-config";
export default async ({ mode }) => {
	const { VITE_BASE_URL } = loadEnv(mode, process.cwd());
	return defineConfig({
		...baseCfg({ VITE_BASE_URL }),
		plugins: [vue(), ...(await pluginCfg({ VITE_BASE_URL }))],
	});
};
    (3) 对于vite.config.js配置,通过在vite-config/plugins文件夹下建js文件,在index.js会自动加载,在index.js文件内也可配置vite的基本配置
    (4) 对于unplugin-auto-import.js的配置, 针对vue、vue-router、vue-i18n、pinia页面无需使用例如: import { useRouter } from "vue-router";
       可以直接使用 const route = useRouter()
    (5) 对于unplugin-auto-import.js的配置,针对对象内的配置自定义导入的,key为路径,值为数组的形式,
    数组内的名称必须要与路径配置的文件export {}导
       出的名称一致
    (6) 针对unplugin-auto-import.js的自定义配置导出名称建议都以:$global作前缀定义,以说明是通过插件全局自动导入,
    配置则在unplugin-auto-import.js文件内

    (7) 对于unplugin-vue-components.js配置,会读取dirs项数组内的路径加载以extensions项配置的后缀名的文件,
    目前以加载src/components下的所有.vue文件作为组件:
      在文件夹内的index.vue文件时,组件会以文件夹名称作为组件名,例如:components/footer-nav/index.vue
      组件名为<footer-nav></footer-nav>, 除index.vue以外的文件则以vue文件名作为组件。
    (8) 规范化建议在components文件夹下的组件文件夹以分割号作为间隔命名文件夹名称,文件夹内建一个index.vue文件
    (9) vue文件同名机制是以外层的文件优先作为组件,以文件排在前面的文件优先

项目路由原理

注意:本地调试时,在缓存页面进行刷新时可能会导致不触发路由通知初始化的情况 (缓存路由配置只能使用push、replace方式跳转)。

路由大体分为两种:缓存页面、不缓存页面

1.通过路由配置+路由插件+中央事件总线+keep-alive组件+component组件共同构成

2.配置不缓存组件:配置isKeepAlive为fasle或者不配置
   {
		path: "/setting",
		name: "setting",
		component: () => import("@/views/common/setting.vue"),
		meta: {},
	},
3.配置缓存路由:
   (1)只要在src/router 内的所有模块js文件内的isKeepAlive设置为true,则页面起缓存效果
   {
		path: "/addressList",
		name: "addressList",
		component: () => import("@/views/common/addressList.vue"),
		meta: {
			isKeepAlive: true,
		},
	},
   (2)在使用页面(缓存页面)的生命周期使用($globalConfigure已插件全局导入可直接使用),页面实现再次进入重载可定义一个变量(isReload)和在根元素配合v-if使用起到页面重新渲染效果

<template>
	<div v-if="isReload"></div>
</template>

const isReload = ref(false)
onMounted(() => {

	$globalConfigure(() => {
      isReload = false
		console.log("缓存页面时--总监听事件接收--用于初始化操作");
      nextTick(()=>{
         isReload = true
      })
	});
});
   (3)在(2)的$globalConfigure内做当前页面初始化操作

   通过以上四步配置达到效果是:使用push()、replace()方法跳进页面会初始化当前页面,在当前页面再跳入其他页面后,
   再返回当前页面当前页面不会初始化起到缓存效果。例子:A->B->C, B页面缓存,C倒回B不初始化B页面,
   当C倒回B倒回A后再由A-B页面会执行初始化函数$globalConfigure

4.配置无限A页面跳A页面缓存路由:
   (1)只要在src/views/router 内的所有模块js文件内的isRouterKeepAlive需要设置为true,则页面起缓存效果
   {
		path: "/goodsDetail",
		name: "goodsDetail",
		component: () => import("@/views/common/goodsDetail.vue"),
		meta: {
			isRouterKeepAlive: true
		},
	},
  (2) 在使用页面(缓存页面)的生命周期使用($globalConfigure已插件全局导入可直接使用),页面实现再次进入重载可定义一个变量(isReload)和在根元素配合v-if使用起到页面重新渲染效果 同上3.点
 (3)使用push()、replace() 在query或parmas上带唯一标识(业务Id或时间戳)
 (4)该配置实现的效果,A页面内有链接,点击跳转还是跳到A页面,但当业务id改变时,跳转后会触发页面初始化函数,在点击回退上一页面时,
      上一页面缓存的是跳转前的页面数据。

5. 针对isKeepAlive与isRouterKeepAlive的优先级问题,isRouterKeepAlive优先级高于isKeepAlive

6.路由(编程式)传参
  (1)使用query传参
        跳转

            const router = useRouter();
            router.push({
                name: "路由名称",
                query: { 参数 },
            });
        接收

            const router = useRouter();
            const queryParmas =  router?.currentRoute?.value?.query
    (2) 使用state传参 (用于传较多参数)
         跳转

            const router = useRouter();
            router.push({
                name: "路由名称",
                state: { 参数 },
            });
        接收

            const stateParmas =  history.state

项目国际化配置

src/locales文件夹下:
1.ZH-CN文件夹配置中文json
2.US-EN文件夹配置英文json
3.ZH-CN/common.json、US-EN/common.json 中配置时使用:$t("文件名.json文件内定义的key") 如 $t("common.home")
4. 远程接口配置国际化覆盖本地配置:接口返回的json格式要与本地配置的json格式一致才能起到远程覆盖本地的效果

项目 pinia 配置

1.src/store文件夹下的每个js文件代表一个模块
2.模块命名规则:use+文件名首字母大写(store唯一ID),如:Common.js,处理后模块为useCommon
3.本地起项目,若store中模块store唯一ID存在重复时,调试中会提示报错重复的具体store的ID
4.pinia持久化使用pinia-plugin-persistedstate插件,配置参考pinia-plugin-persistedstate官网
5.在Common.js内
export default defineStore("store唯一ID", {
	state: () => ({}),
	getters: {},
	actions: {},
});
5.页面使用:
(1)const { useCommon } =  $globalStore; // 已用插件导入全局(vue文件内可结构)
 (2) 通过 $globalStore.模块名.(state/getters/actions)的变量或方法进行使用。
useCommon.subMsgKey; // 使用state
useCommon.SET_GOODS_NUM(); //调用actions

项目组件 name 属性设置

1.安装vite-plugin-vue-setup-extend插件,在vite.config.js进行插件配置,
在vite-config/plugins下建vite-plugin-vue-setup-extend.js文件
import setupExtend from "vite-plugin-vue-setup-extend"; //组件命名插件
const vueSetupExtend = (viteEnv = {}) => {
	return setupExtend();
};

export { vueSetupExtend };
2.在页面组件内使用:
<script setup name="wc-test-global-2">
	onMounted(() => {});
</script>

项目图片

登录 首页 分类 购物车 我的 地址

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

vue3+vant+vite移动端项目(主要用vue3的组合式API) 展开 收起
JavaScript 等 4 种语言
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
JavaScript
1
https://gitee.com/674074365/vue3-vant3-h5.git
git@gitee.com:674074365/vue3-vant3-h5.git
674074365
vue3-vant3-h5
vue3+vant4-h5
master

搜索帮助