更新记录

1.5.1(2023-12-25)

  • 修复部分分包静态资源路径引入错误问题

1.5(2023-12-22)

  • Akai-hy 更新项目架构,页面静态资源分包预加载并且加入分包示例。
  • 重写Akai-hy使用说明和使用介绍,让小伙伴更易上手!
  • 缩减项目体积,主包代码优化。主分包静态资源存储更换位置

1.4.4(2023-11-09)

  • 完善vuex封装以及使用教程,让用户用起来更加得心应手!
查看更多

平台兼容性

Vue2 Vue3
×
App 快应用 微信小程序 支付宝小程序 百度小程序 字节小程序 QQ小程序
app-nvue × × × × ×
钉钉小程序 快手小程序 飞书小程序 京东小程序
× × × ×
H5-Safari Android Browser 微信浏览器(Android) QQ浏览器(Android) Chrome IE Edge Firefox PC-Safari
× × × × × × ×

### 初次见面!🌷

Halo! 😊
感谢您选择 Akai-hy 的 uniApp 前端项目模板!
此模板只是为您提供了一个简单而有力的起点。但开发过程中仍离不开您的创意和努力,希望这份代码能成为您创作的画布,让您的想象力在这里自由绽放!


Akai-hy 亮点指南 👇

集成Z-paging 支持全平台兼容,支持自定义下拉刷新、上拉加载更多,支持虚拟列表,支持自动管理空数据图、点击返回顶部,支持聊天分页、本地分页,支持展示最后更新时间,支持国际化等等。

集成uView-Ui2.0是全面兼容nvue的uni-app生态框架,全面的组件和便捷的工具会让您信手拈来,如鱼得水。

集成animate.css动效库,让您在小程序开发的过程也能实现炫酷的特效!

集成lodash.js库,您可以在开发过程中方便的处理一下数据(例如防抖、节流、二维数组转换...)

uni.request、uni.upload请求的三层封装,API封装以及页面导入使用及无痛刷新token,让代码更优雅,请求更便捷。

封装了一些常用的功能函数,例如参数转换、时间转换、toast提示、断网提示、confirm确认等。

此模板提供一个全局的config.js,包含项目的一些公共配置(例如:appid、sign、appKey、appSecret、url)等,可供全局访问。

提供了一些常用的页面模板以及布局实例,包含自定义导航栏、梯形选项卡、scroll-box还有下拉刷新上拉加载页面实例模板!

为避免模板项目大小超包,阿凯已为您提前做好分包(包括组件按需加载、分包预加载、图片分包)


协议指引 📔

使用说明 📖

Akai-hy 的使用说明我会尽可能的详细,以便您阅读使用!若有辞藻尚未得体之处,请联系我修改!

1.首先您需要下载插件压缩包或者直接通过Hbuilder快速导入项目

  • 导入项目之后您需要在此项目根目录初始化项目或下载依赖
  • 您可通过yarn init -ynpm init -y来初始化项目(Tips:默认是不需要初始化项目的奥)
  • 然后您再使用yarnnpm installnpm i下载Akai-hy项目所需要的依赖包
  • 下载完成之后您可以此项目内的package.jsonnode_modules中查看该项目所需依赖

    2.更改项目的一些配置信息(项目名)

  • 更改package.json文件中的name
  • 更改manifedt文件中的name属性
  • 更改page.json文件中的globalStyle配置
  • 若您可忽略这些,也可直接跳过此步骤。

    3.点击Hbuilder开发工具左上角,直接运行即可!

    4.若您认为项目内有过多页面或一些功能函数,您可选择性删除!

项目内部分模块使用说明 🎺

1.z-paging说明

  • z-paging是属于uni_modules插件,存在于项目根目录下的uni_modules文件夹中。您可选中z-paging右键更新或执行其他操作。
  • 若项目拉取下来没有uni-modules目录或者uni-modules目录下没有z-paging目录的时候,需在插件市场导入z-paging
  • z-paging插件网址,点击使用HbuilderX导入插件按钮导入到刚才创建的项目。
  • z-paging的下拉刷新上拉加载案例在pagesFunc/refresh.vue中有示例代码!并在此文件中附有详细说明。
  • 若您希望有一些其他的案例,详情请查阅z-paging官方文档👉,也可加入z-paging的官方交流群进行咨询解惑371624008

    2.animate.css说明

  • 您无需单独下载animate.css,我已将您需要的文件都已集成。
  • 在项目根目录下static/animate文件夹中的animate.css便是我们使用animate动画的主要文件了。
  • 您可确认animate.css文件中的:root选择器是否已被命名为page。(注::root选择器在小程序中不生效!!!)
  • 在项目根目录下的App.vue文件中,使用@import '@/static/animate/animate.css';将animate.css全局引入!
  • 通过给元素设置类名来使用animate.css动画特效。例如animate__animated animate__heartBeat,其中animate__animated是不可或缺的一部分,而animate__heartBeat则是动效的运作方式。
  • pages/func/func.vue中,有关于animate.css的使用,您可以在style中根据类名设置运行规律以及持续时间。
  • 您可以查阅animate.css文档获取更多特效案例。

    3.lodash.js说明

  • pagesFunc/lodash.vue文件中有关于lodash的简单实用案例说明。
  • 详情可查阅lodash.js官方文档

    4.request请求说明

  • 在项目根目录下的request/request.js文件夹中有关于项目的请求封装。其中request-s.js是带有无痛刷新token功能的。
  • 您可以在上面两个文件夹中修改一些配置其中包括请求前后的loading、请求头的配置等。(此文件都已有详细的说明!)
  • 在项目根目录的apis文件夹中用户管理和存放咱么项目功能模块的请求,其中包括多种请求方式的编写示例以及说明。
  • pagesFunc文件夹中的refresh.js文件中有请求示例代码。
    onShow(){
        const param={name:'cy',age:23,city:'南京'};
        zhiHuHotListApi(param).then(res=>{
            console.log(res);
        }).catch(err=>{
            console.log(err);
        })
    }

    5.upload上传功能

  • 在项目根目录下的upload/upload.js文件夹中有关于项目的上传封装。和请求封装类似。

    6.关于项目分包,您可完全按照我当前设计的来分包仅需要更改page.json中文件名字即可。

    7.关于公共函数的使用。utils/auth.js或者utils/common.js

  • common.js文件已在main.js全局挂载,您可以通过this.tool.xxx()来使用里面的功能函数,例如this.tool.toastTip('Akai','success',1030)

    8.公共配置文件congfig.js的使用。

  • config/config.js文件已在App.vue文件夹中引入并且挂载于globalData上,您可通过getApp().globalData.config来访问挂载的config配置对象。

    9.vuex状态机的使用(store文件夹和vuex_tool文件夹不可以删除奥)

  • 使用的时候请先查看store/index.js文件(此文件有详细使用说明),需要在state中设置咱们需要存储的字段。一般以vuex_frenidName这种形式。例如以下
    state: {
        // !!!以下就是您需要存在状态机的字段
        vuex_frenidName: null, 
        vuex_girlName:'晨阳'
    },
  • 在其他地方可以通过this.vuex.frenidName来访问存在vuex的变量。
  • 如果您需要重新赋值或者设置新的值,赋值this.vuex('frenidName','阿凯')。修改this.vuex('girlName','CY')

答疑解惑技术交流反馈 🧸

~ 🌼

  • 鸣谢:z-paging、uView-Ui、lodash.js、animate.css!
  • 感谢您的信任和支持,如果您在使用过程中有任何疑问或建议,或者您在阅读使用文档的时候遇到了疑惑或者困难,我将格外珍惜您的反馈。欢迎您的咨询~😃
  • 如果您认为Akai-hy对您有帮助,Akai-hy的创作者非常希望您能动动小手评论点赞和收藏一下,诚挚致谢!

隐私、权限声明

1. 本插件需要申请的系统权限列表:

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

MIT协议

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问