UNIAPP如何自定义全局方法?

最近再写uniapp的时候,发现工作中有些小伙伴对于如何定义一些全局方法不是很清楚,无法清晰地去封装和完善公共方法,这里简单的介绍一下

技术栈:uniapp + vue3 + vite + ts(typescript)

一 定义一个简单的hooks

1、什么是hook(钩子机制,钩子函数)?

在JavaScript和前端开发中,Hooks通常与React框架中的Hooks概念相关联,但在其他框架或环境中,我们可以通过其他方式模拟或实现类似的功能。

钩子函数一般是一种再特定时间或者函数执行前后插入的自定义代码的技术,允许扩展或者修改原有的程序的行为

包括:函数修改、状态管理,事件拦截等

比如:使用uniapp去二次封装一个全局的提示 hooks/useToast.ts

TypeScript 复制代码
const defaultToastOpts: UniApp.ShowToastOptions = {
  icon: 'none',
  mask: true,
  duration: 1500,
}

export const useCommon  = () => {
	const Toast = (arg: string | UniApp.ShowToastOptions) => {
		if (typeof arg === 'string') { 
			uni.showToast({ title: arg })
		} else {
			const opts: object = {
			    title: arg.title,
			    ...defaultToastOpts,
			    ...arg,
			}
			return uni.showToast(opts)
		}
	}
	
	Toast.loading = () => uni.showToast({ icon: 'loading', duration: 120000, mask: true         })
	Toast.clear = () => uni.hideToast()
	
	
	return {
		Toast
	}
}

二、定义全局引入的函数

/types/auto-import.d.ts

TypeScript 复制代码
export {}
declare global {
    ...
    const useCommon: typeof import('../hooks/useToast')['useToast']
    ...
}

import { UnwrapRef } from 'vue'
declare module 'vue' {
    ...
    readonly useCommon: UnwrapRef<typeof import('../hooks/useToast')['useToast']>
    ...
}

三、如何配置自定引入

vite.config.ts

TypeScript 复制代码
import uni from "@dcloudio/vite-plugin-uni";
import AutoImport from 'unplugin-auto-import/vite'

export default defineConfig({
    ...
	plugins: [
		uni(),
        AutoImport({
		    imports: ['vue', 'uni-app'],
		    dts: 'src/types/auto-import.d.ts',
		    dirs: ['src/hooks'], // 自动导入 hooks
		    eslintrc: { enabled: true },
		    vueTemplate: true, // default false
		}),
    ]
    ...
})

四、如何结合场景使用?

TypeScript 复制代码
<script setup lang="ts">
    const { Toast } = useToast()
    onMounted(() => {
        Toast('这是一个提示')
        Toast.loadin()
        setTimeout(() => {
            Toast.clear()
        }, 2000)
    })
</script>

总结:简简单单实现,有时候代码并不是很多,也能实现一个小功能。

个人的一点小想法,请多多指教!!!

相关推荐
阿桂有点桂40 分钟前
React使用笔记(持续更新中)
前端·javascript·react.js·react
shykevin1 小时前
uni-app x开发商城系统,商品列表点击跳转至商品详情页
windows·uni-app
蜕变菜鸟1 小时前
PC网站和uniapp安卓APP、H5接入支付宝支付
uni-app
im_AMBER1 小时前
React 15
前端·javascript·笔记·学习·react.js·前端框架
狼性书生2 小时前
uniapp实现的Tab 选项卡组件模板
前端·uni-app·vue·组件·插件
许___3 小时前
el-table多选模式下跨分页保留当前页选项
javascript·vue.js
梦想平凡3 小时前
情怀源代码工程实践(加长版 1/3):确定性内核、事件回放与最小可运行骨架
开发语言·javascript·ecmascript
爱吃甜品的糯米团子3 小时前
详解 JavaScript 内置对象与包装类型:方法、案例与实战
java·开发语言·javascript
华仔啊3 小时前
JavaScript + Web Audio API 打造炫酷音乐可视化效果,让你的网页跟随音乐跳起来
前端·javascript
是你的小橘呀4 小时前
深入理解 JavaScript 预编译:从原理到实践
前端·javascript