Uniapp Vue3 项目模板

Uniapp Vue3 项目模板, 包含技术栈(Vue3 + TuniaoUI/wot-design-uni + Pinia + Vite + TS + Unocss)

[!重要] 注意: 升级依赖时, 请不要升级@vueuse/core和pinia, 这两个依赖需要vue3.3的支持, 但是uniapp目前还不支持vue3.3

Rem 适配
自动引入UI库组件/项目组件/函数等
Pinia 状态管理
自动生成路由
Api封装
列表封装: useLists
开发环境配置proxy跨域
Unocss
eslint/stylelint/prettierrc/vue-tsc

运行方法参考 uni-app 官方文档：运行、发布uni-app

Variations

vite-nuxt3 - Nuxt3 + Vite 入门模板
vite-uniapp-vue3 - Uniapp3 + Vite 入门模板
vite-react-mobx-ssr - React + Mobx + Vite + SSR 入门模板
vite-react-mobx - React + Mobx + Vite 入门模板
vite-react-redux - React + Redux + Vite 入门模板
vite-vue3-h5-ssr - Vue3 + Vant + Vite + SSR 入门模板
vite-vue3-h5 - Vue3 + Vant + Vite 入门模板
vite-vue3-admin - Vue3 + ElementPlus + Vite 管理后台入门模板

Rem 适配

设计稿相关参数配置见: src/design.config.ts, 按UI给的设计稿, 修改即可

设计稿宽度: designWidth

设计稿高度: designHeight

字号: fontSize

由于Uniapp在H5端本身就有转换成Rem的功能, 所以我们只需要将px转换成rpx即可

具体插件配置详见: vite.config.css.ts

自动引入UI库组件/项目组件/函数等

项目已经配置了unplugin-auto-import和unplugin-vue-components

前者能自动引入vue, vue-router, vueuse等提供的方法, 而无需一遍遍的import

后者能自动引入UI组件, 及项目被定义的组件, 也不用一遍遍的import, 脚手架默认使用TuNiaoUI和wot-design-uni, 因为这个UI组件库对Ts支持比较好

详细配置见: vite.config.components.ts

UI组件库

项目配置了两个UI组件库, 分别是: https://github.com/Moonofweisheng/wot-design-uni https://github.com/tuniaoTech/tuniaoui-rc-vue3-uniapp

两个UI组件库可以混用, 也可以知选择其一使用, 影响不大, 如果想删除另外一个, 那么只需要在src/App.vue中

<style lang="scss">
@import '@tuniao/tn-style/dist/uniapp/index.css';
@import 'wot-design-uni/components/common/abstracts/variable.scss';
@import './assets/scss/style.scss';
</style>

保留对应的scss引入即可, 其他地方无需改动

Pinia 状态管理

vue 官方出品的, 比vuex更好用的状态管理

使用方法:

在pinia文件夹下,新建一个ts文件, 如: useUserInfo.ts

里面代码如下:

import { defineStore } from 'pinia'
import type { UserData, UserInfo } from '~/pages/user.types'

interface State {
    userInfo: Nullable<UserInfo>
}

export const useUserStore = defineStore('userInfo', () => {
    const lsUserInfo = ls.get<UserInfo>('user-info') || {}
    const state: State = reactive({
        userInfo: lsUserInfo,
    })

    async function getUserInfo() {
        const { code, data } = await $api.get<UserData>('/user/info', { })
        if (code === 200 && data && data.userInfo) {
            state.userInfo = data.userInfo
            ls.set('user-info', data.userInfo)
        }
    }

    return {
        ...toRefs(state),
        getUserInfo,
    }
})

那么在需要用到该状态管理的地方, 只需要

const userStore = useUserStore()
userStore.setGlobalLoading(true)

即可, 因为配置了unplugin-auto-import, 所以根本无需要import, 你只需要直接把文件名改成驼峰的方式, 直接当函数使用即可

注意: 直接用文件名当函数名, 只有代码是用export default导出时可用, 如果是用export const xxx, export function xxx {} 这样导出的, 那么直接使用xxx作为方法名即可

具体可以看src/z-auto-imports.d.ts为你生成了那些方法, 这里的方法都可以直接使用, 而无需import

自动生成路由

路由使用了@uni-helper/vite-plugin-uni-pages插件, 只需要在对应目录创建vue文件, 会自动生成路由, 还可以在路由组件直接定义pages.json里的信息, 如:

<route lang="json">
    { "style": { "navigationStyle": "custom", "enablePullDownRefresh": true } }
</route>

将会在pages.json变为:

{
  "path": "pages/activity",
  "type": "page",
  "style": {
    "navigationStyle": "custom",
    "enablePullDownRefresh": true
  }
}

Api封装

使用axios重新封装, 并使用fant-axios-adapter将小程序的api适配一致

src/api/index.ts封装了get, post, put, delete4中常用的方法, 分别对应4种method, 而$api为全局方法, 可以在任何.vue页面, 直接使用$api.get/post/put/delete

接口默认判断code=200 || status=200为正常返回, 如果后端接口不是用code或者status作为判断, 那么需要在src/api/index.ts做对应修改

如:

let detail: NullAble<Article> = null
async function getDetail() {
    const { code, data } = await $api.get<Article>('article/detail', {})
    if (code === 200) {
        detail = data
    }
}

getDetail()

列表封装: useLists

在src/composables/get-lists.ts中封装了useLists方法, 让你所有上拉加载, 下拉刷新几行代码就搞定, 如:

interface ApiParams { page: number; limit: number; by: string; cache: string; xxx?: number }

const { dataIsLoaded, dataLists, loadStatus, getData, apiParams } = useLists<Article, ApiParams>('/frontend/article/list', {
    limit: 20,
    by: 'visit',
    cache: 'true',
    page: 1,
})

如上面代码, 只需要将接口相关参数传入接口, 返回的参数中,

dataIsLoaded为接口是否请求完成(响应式的Ref数据),
apiParams为传入参数(响应式的Ref数据),
dataList为数据列表(响应式的Ref数据),
getData为请求列表的方法,
loadStatus为分页状态(响应式的Ref数据), 可能的值为: 'loading' | 'loadmore' | 'nomore'

模板代码为:

<template>
    <div>
        <TnListItem
            v-for="(item, index) in dataLists"
            :key="index"
            right-icon="right"
            @click="router.push(`/pages-sub/acticity/detail?id=${item._id}`)"
        >
            <div flex--c>
                <TnIcon name="tree" />
                <div ml-10px class="tn-text-ellipsis-1">{{ item.title }}</div>
            </div>
        </TnListItem>
        <div pb-10px pt-30px>
            <TnLoadmore
                :status="loadStatus"
                loading-icon-mode="flower"
                color="#999"
            />
        </div>
    </div>
</template>

如果你需要做搜索, 或者切换分类什么的, 也很简单, 假设我现在需要修改by的值,然后重新请求接口, 那么只需要:

function changeBy(by: string) {
    apiParams.value.by = by
    apiParams.value.page = 1
    getData()
}

先更新apiParams里的相关参数, 然后重新请求接口即可

当然也可以新增参数, 不过需要在ts类型里先定义好

function addParams() {
    apiParams.value.xxx = 1
    apiParams.value.page = 1
    getData()
}

接口默认返回数据接口为:

{
    data: {
        hasNext: number | boolean
        hasPrev: number | boolean
        total: number
        list: any[]
    }
    code: number
    status: number
    message: string
    info?: string
}

如果你用的接口返回数据结构不一样, 需要在src/composables/get-lists.ts稍做修改

另外还有还有get-list和get-detail, 分别对应无分页的列表及详情页, 使用方法基本一致

开发环境配置proxy跨域

{
    server: {
        port: 6778,
        proxy: {
            '/api': {
                target: 'https://api.mmxiaowu.com',
                changeOrigin: true,
                rewrite: (path: string) => path.replace(/^\/api/, '/api'),
            },
        },
    },
}

详见: vite.config.build.ts

Unocss

unocss是一个及时/按需/原子化的css引擎, 项目中也做了相关配置, 可直接使用

配置见:

https://github.com/lincenying/base-config/blob/main/src/uno.uniapp.config.ts

官方文档见:

https://unocss.dev/

eslint/stylelint/prettierrc/vue-tsc

根目录下的eslint.config.js、.stylelintrc.json、.prettier内置了 lint 规则，帮助你规范地开发代码，有助于提高团队的代码质量和协作性，可以根据团队的规则进行修改

注意: prettier只在编辑器层面, 在eslint中并没有添加prettier插件

lincenying / vite-vue3-uniapp