my-uniapp-tools 1.0.6 → 1.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +445 -445
- package/dist/clipboard/index.d.ts +9 -0
- package/dist/index.d.ts +6 -0
- package/dist/localStorage/index.d.ts +26 -0
- package/dist/my-uniapp-tools.cjs.js +486 -0
- package/dist/my-uniapp-tools.cjs.js.map +1 -0
- package/dist/my-uniapp-tools.esm.js +470 -0
- package/dist/my-uniapp-tools.esm.js.map +1 -0
- package/dist/navigation/index.d.ts +10 -0
- package/dist/system/index.d.ts +66 -0
- package/{src/ui/index.ts → dist/ui/index.d.ts} +1 -14
- package/dist/utils/index.d.ts +11 -0
- package/package.json +28 -16
- package/examples/payment-example.js +0 -179
- package/src/clipboard/index.ts +0 -57
- package/src/index.js +0 -16
- package/src/localStorage/index.ts +0 -69
- package/src/navigation/index.ts +0 -37
- package/src/system/index.ts +0 -223
- package/src/utils/index.ts +0 -89
- package/tsconfig.json +0 -20
package/README.md
CHANGED
|
@@ -1,446 +1,446 @@
|
|
|
1
|
-
# My UniApp Tools
|
|
2
|
-
|
|
3
|
-
一个专为 UniApp 开发设计的实用工具函数库,提供常用的功能模块,帮助开发者快速构建跨平台应用。
|
|
4
|
-
|
|
5
|
-
## 📦 安装
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
# 使用 npm
|
|
9
|
-
npm install my-uniapp-tools
|
|
10
|
-
|
|
11
|
-
# 使用 yarn
|
|
12
|
-
yarn add my-uniapp-tools
|
|
13
|
-
|
|
14
|
-
# 使用 pnpm
|
|
15
|
-
pnpm add my-uniapp-tools
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
## 🚀 快速开始
|
|
19
|
-
|
|
20
|
-
```javascript
|
|
21
|
-
// 导入所有工具函数
|
|
22
|
-
import * as Tools from 'my-uniapp-tools'
|
|
23
|
-
|
|
24
|
-
// 或者按需导入
|
|
25
|
-
import {
|
|
26
|
-
useToast,
|
|
27
|
-
useBack,
|
|
28
|
-
copyText,
|
|
29
|
-
setStorageSync,
|
|
30
|
-
getStorageSync,
|
|
31
|
-
clearStorageSync,
|
|
32
|
-
useWindowInfo,
|
|
33
|
-
getPlatform,
|
|
34
|
-
getCurrentEnv,
|
|
35
|
-
onCheckForUpdate,
|
|
36
|
-
getStatusBarHeight,
|
|
37
|
-
getNavHeight,
|
|
38
|
-
getTopNavBarHeight
|
|
39
|
-
} from 'my-uniapp-tools'
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
## 📚 API 文档
|
|
43
|
-
|
|
44
|
-
### 🎨 UI交互工具 (UI)
|
|
45
|
-
|
|
46
|
-
#### `useToast(title, mask, icon, duration)`
|
|
47
|
-
|
|
48
|
-
显示消息提示框
|
|
49
|
-
|
|
50
|
-
**参数:**
|
|
51
|
-
- `title` (string): 提示的内容,默认为空字符串
|
|
52
|
-
- `mask` (boolean): 是否显示透明蒙层,默认为 `false`
|
|
53
|
-
- `icon` (string): 图标类型,可选值:`'none'` | `'success'` | `'loading'` | `'error'` | `'fail'` | `'exception'`,默认为 `'none'`
|
|
54
|
-
- `duration` (number): 提示的延迟时间,默认为 `2000` 毫秒
|
|
55
|
-
|
|
56
|
-
**示例:**
|
|
57
|
-
```javascript
|
|
58
|
-
// 基础用法
|
|
59
|
-
useToast('操作成功')
|
|
60
|
-
|
|
61
|
-
// 完整参数
|
|
62
|
-
useToast(
|
|
63
|
-
'操作成功', // 提示文字
|
|
64
|
-
false, // 是否显示透明蒙层
|
|
65
|
-
'success', // 图标类型
|
|
66
|
-
2000 // 显示时长(毫秒)
|
|
67
|
-
)
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
### 🧭 导航工具 (Navigation)
|
|
71
|
-
|
|
72
|
-
#### `useBack(params)`
|
|
73
|
-
|
|
74
|
-
返回上一页并支持传递参数给上一页的 init 方法
|
|
75
|
-
|
|
76
|
-
**参数:**
|
|
77
|
-
- `params` (any): 传递给上一页 init 方法的参数,默认为空字符串
|
|
78
|
-
|
|
79
|
-
**示例:**
|
|
80
|
-
```javascript
|
|
81
|
-
// 简单返回
|
|
82
|
-
useBack()
|
|
83
|
-
|
|
84
|
-
// 返回并传递参数
|
|
85
|
-
useBack({ refresh: true, data: 'some data' })
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
**注意:** 上一页需要暴露 `init` 方法来接收参数
|
|
89
|
-
|
|
90
|
-
### 📋 剪贴板工具 (Clipboard)
|
|
91
|
-
|
|
92
|
-
#### `copyText(text)`
|
|
93
|
-
|
|
94
|
-
跨平台文本复制功能,支持 H5、App、小程序。H5 平台优先使用现代的 Clipboard API,失败时回退到传统方法。
|
|
95
|
-
|
|
96
|
-
**参数:**
|
|
97
|
-
- `text` (string): 要复制的文本内容
|
|
98
|
-
|
|
99
|
-
**示例:**
|
|
100
|
-
```javascript
|
|
101
|
-
copyText('要复制的文本内容')
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
### 🖥️ 系统信息工具 (System)
|
|
105
|
-
|
|
106
|
-
#### `useWindowInfo()`
|
|
107
|
-
|
|
108
|
-
获取当前窗口的尺寸、像素比等信息
|
|
109
|
-
|
|
110
|
-
**返回值:**
|
|
111
|
-
- 窗口信息对象,包含窗口尺寸、像素比等信息
|
|
112
|
-
|
|
113
|
-
**示例:**
|
|
114
|
-
```javascript
|
|
115
|
-
const windowInfo = useWindowInfo()
|
|
116
|
-
console.log(windowInfo.windowWidth) // 窗口宽度
|
|
117
|
-
console.log(windowInfo.windowHeight) // 窗口高度
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
#### `getPlatform()`
|
|
121
|
-
|
|
122
|
-
获取当前运行平台类型
|
|
123
|
-
|
|
124
|
-
**返回值:**
|
|
125
|
-
- `string`: 平台类型,可能的值:`'weixin'` | `'web'` | `'app'` | `'alipay'` | `'h5'`
|
|
126
|
-
|
|
127
|
-
**示例:**
|
|
128
|
-
```javascript
|
|
129
|
-
const platform = getPlatform()
|
|
130
|
-
console.log(platform) // 'weixin' | 'web' | 'app' | 'alipay' | 'h5'
|
|
131
|
-
|
|
132
|
-
// 根据平台执行不同逻辑
|
|
133
|
-
if (platform === 'weixin') {
|
|
134
|
-
// 微信小程序特有逻辑
|
|
135
|
-
} else if (platform === 'h5') {
|
|
136
|
-
// H5 特有逻辑
|
|
137
|
-
}
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
#### `getCurrentEnv()`
|
|
141
|
-
|
|
142
|
-
获取小程序账户信息,包含appId、版本、环境等信息
|
|
143
|
-
|
|
144
|
-
**返回值:**
|
|
145
|
-
- `object`: 小程序账户信息对象
|
|
146
|
-
- `appId` (string): 小程序appId
|
|
147
|
-
- `version` (string): 小程序版本号
|
|
148
|
-
- `envVersion` (string): 小程序环境版本(develop开发版、trial体验版、release正式版)
|
|
149
|
-
- `accountInfo` (object): 完整的账户信息对象
|
|
150
|
-
|
|
151
|
-
**示例:**
|
|
152
|
-
```javascript
|
|
153
|
-
const envInfo = getCurrentEnv()
|
|
154
|
-
console.log(envInfo.appId) // 小程序appId
|
|
155
|
-
console.log(envInfo.version) // 小程序版本号
|
|
156
|
-
console.log(envInfo.envVersion) // 环境版本
|
|
157
|
-
|
|
158
|
-
// 根据环境执行不同逻辑
|
|
159
|
-
if (envInfo.envVersion === 'develop') {
|
|
160
|
-
// 开发版特有逻辑
|
|
161
|
-
} else if (envInfo.envVersion === 'release') {
|
|
162
|
-
// 正式版特有逻辑
|
|
163
|
-
}
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
#### `onCheckForUpdate()`
|
|
167
|
-
|
|
168
|
-
检查小程序版本更新,自动处理版本检查、下载和更新流程
|
|
169
|
-
|
|
170
|
-
**参数:**
|
|
171
|
-
- 无参数
|
|
172
|
-
|
|
173
|
-
**功能说明:**
|
|
174
|
-
- 自动检查小程序是否有新版本
|
|
175
|
-
- 发现新版本时静默下载
|
|
176
|
-
- 下载完成后弹窗提示用户是否重启应用
|
|
177
|
-
- 处理下载失败的情况
|
|
178
|
-
- 支持用户选择稍后更新或立即重启
|
|
179
|
-
|
|
180
|
-
**平台支持:**
|
|
181
|
-
- ✅ 微信小程序
|
|
182
|
-
- ✅ 支付宝小程序
|
|
183
|
-
- ✅ 百度小程序
|
|
184
|
-
- ✅ 抖音小程序
|
|
185
|
-
- ✅ QQ小程序
|
|
186
|
-
- ✅ 快手小程序
|
|
187
|
-
- ✅ 京东小程序
|
|
188
|
-
- ❌ App (App端请使用其他更新方案)
|
|
189
|
-
- ❌ H5 (H5端无需此功能)
|
|
190
|
-
|
|
191
|
-
**示例:**
|
|
192
|
-
```javascript
|
|
193
|
-
// 在App.vue中使用
|
|
194
|
-
export default {
|
|
195
|
-
onLaunch() {
|
|
196
|
-
// 应用启动时检查更新
|
|
197
|
-
onCheckForUpdate()
|
|
198
|
-
},
|
|
199
|
-
onShow() {
|
|
200
|
-
// 每次从后台切换到前台时检查更新
|
|
201
|
-
onCheckForUpdate()
|
|
202
|
-
}
|
|
203
|
-
}
|
|
204
|
-
|
|
205
|
-
// 或在页面中手动调用
|
|
206
|
-
onCheckForUpdate()
|
|
207
|
-
```
|
|
208
|
-
|
|
209
|
-
**注意事项:**
|
|
210
|
-
- 建议在App.vue的onLaunch或onShow生命周期中调用
|
|
211
|
-
- 开发版和体验版无法检查版本更新,需要在正式版中测试
|
|
212
|
-
- 在开发者工具中可以通过"模拟更新编译"来测试更新功能
|
|
213
|
-
- 函数内部已处理异常情况,不会影响应用正常运行
|
|
214
|
-
|
|
215
|
-
#### `getStatusBarHeight()`
|
|
216
|
-
|
|
217
|
-
获取设备状态栏高度
|
|
218
|
-
|
|
219
|
-
**返回值:**
|
|
220
|
-
- `number`: 状态栏高度(单位:px)
|
|
221
|
-
|
|
222
|
-
**示例:**
|
|
223
|
-
```javascript
|
|
224
|
-
const statusBarHeight = getStatusBarHeight()
|
|
225
|
-
console.log(statusBarHeight) // 44 (iPhone) 或其他设备的状态栏高度
|
|
226
|
-
|
|
227
|
-
// 用于页面布局适配
|
|
228
|
-
const pageStyle = {
|
|
229
|
-
paddingTop: statusBarHeight + 'px'
|
|
230
|
-
}
|
|
231
|
-
```
|
|
232
|
-
|
|
233
|
-
#### `getNavHeight()`
|
|
234
|
-
|
|
235
|
-
获取小程序导航栏总高度,包含状态栏高度和菜单按钮高度
|
|
236
|
-
|
|
237
|
-
**返回值:**
|
|
238
|
-
- `number`: 导航栏总高度(单位:px)
|
|
239
|
-
|
|
240
|
-
**示例:**
|
|
241
|
-
```javascript
|
|
242
|
-
const navHeight = getNavHeight()
|
|
243
|
-
console.log(navHeight) // 88 (iPhone) 或其他设备的导航栏总高度
|
|
244
|
-
|
|
245
|
-
// 用于自定义导航栏高度设置
|
|
246
|
-
const customNavStyle = {
|
|
247
|
-
height: navHeight + 'px'
|
|
248
|
-
}
|
|
249
|
-
```
|
|
250
|
-
|
|
251
|
-
#### `getTopNavBarHeight()`
|
|
252
|
-
|
|
253
|
-
一次性获取应用所需的状态栏和导航栏高度配置信息
|
|
254
|
-
|
|
255
|
-
**返回值:**
|
|
256
|
-
- `object`: 配置信息对象
|
|
257
|
-
- `statusBarHeight` (number): 状态栏高度(单位:px)
|
|
258
|
-
- `navHeight` (number): 导航栏总高度(单位:px)
|
|
259
|
-
|
|
260
|
-
**示例:**
|
|
261
|
-
```javascript
|
|
262
|
-
const topNavConfig = getTopNavBarHeight()
|
|
263
|
-
console.log(topNavConfig.statusBarHeight) // 状态栏高度
|
|
264
|
-
console.log(topNavConfig.navHeight) // 导航栏总高度
|
|
265
|
-
|
|
266
|
-
// 用于全局配置
|
|
267
|
-
const globalConfig = {
|
|
268
|
-
...topNavConfig,
|
|
269
|
-
contentHeight: windowHeight - topNavConfig.navHeight
|
|
270
|
-
}
|
|
271
|
-
```
|
|
272
|
-
|
|
273
|
-
**注意事项:**
|
|
274
|
-
- 这些函数主要用于小程序平台的界面适配
|
|
275
|
-
- 在不同设备上返回的高度值可能不同
|
|
276
|
-
- 建议在应用启动时获取并存储这些配置信息
|
|
277
|
-
- 如果获取失败,会返回默认值确保应用正常运行
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
### 💾 本地存储工具 (Storage)
|
|
282
|
-
|
|
283
|
-
#### `setStorageSync(key, obj)`
|
|
284
|
-
|
|
285
|
-
同步设置本地缓存,自动处理对象序列化
|
|
286
|
-
|
|
287
|
-
**参数:**
|
|
288
|
-
- `key` (string): 缓存键
|
|
289
|
-
- `obj` (unknown): 要缓存的值,可以是任何类型
|
|
290
|
-
|
|
291
|
-
**示例:**
|
|
292
|
-
```javascript
|
|
293
|
-
// 存储字符串
|
|
294
|
-
setStorageSync('username', 'john')
|
|
295
|
-
|
|
296
|
-
// 存储对象(自动序列化)
|
|
297
|
-
setStorageSync('userInfo', { name: 'john', age: 25 })
|
|
298
|
-
|
|
299
|
-
// 存储数组
|
|
300
|
-
setStorageSync('list', [1, 2, 3, 4, 5])
|
|
301
|
-
|
|
302
|
-
// 存储布尔值
|
|
303
|
-
setStorageSync('isLogin', true)
|
|
304
|
-
```
|
|
305
|
-
|
|
306
|
-
#### `getStorageSync(key)`
|
|
307
|
-
|
|
308
|
-
同步获取本地缓存,自动处理对象反序列化
|
|
309
|
-
|
|
310
|
-
**参数:**
|
|
311
|
-
- `key` (string): 缓存键
|
|
312
|
-
|
|
313
|
-
**返回值:**
|
|
314
|
-
- 缓存的值。如果存储的是 JSON 字符串,则返回解析后的对象;否则返回原始值
|
|
315
|
-
|
|
316
|
-
**示例:**
|
|
317
|
-
```javascript
|
|
318
|
-
// 获取字符串
|
|
319
|
-
const username = getStorageSync('username')
|
|
320
|
-
|
|
321
|
-
// 获取对象(自动反序列化)
|
|
322
|
-
const userInfo = getStorageSync('userInfo')
|
|
323
|
-
|
|
324
|
-
// 获取数组
|
|
325
|
-
const list = getStorageSync('list')
|
|
326
|
-
|
|
327
|
-
// 获取布尔值
|
|
328
|
-
const isLogin = getStorageSync('isLogin')
|
|
329
|
-
```
|
|
330
|
-
|
|
331
|
-
#### `clearStorageSync(key?)`
|
|
332
|
-
|
|
333
|
-
清理本地缓存,支持清理指定项或全部清理
|
|
334
|
-
|
|
335
|
-
**参数:**
|
|
336
|
-
- `key` (string, 可选): 缓存键。如果传入则删除对应的缓存项,如果不传入则清除所有缓存
|
|
337
|
-
|
|
338
|
-
**示例:**
|
|
339
|
-
```javascript
|
|
340
|
-
// 清理指定缓存
|
|
341
|
-
clearStorageSync('username')
|
|
342
|
-
|
|
343
|
-
// 清理所有缓存
|
|
344
|
-
clearStorageSync()
|
|
345
|
-
```
|
|
346
|
-
|
|
347
|
-
## 🛠️ 开发使用
|
|
348
|
-
|
|
349
|
-
### 安装依赖
|
|
350
|
-
```bash
|
|
351
|
-
yarn install
|
|
352
|
-
# 或
|
|
353
|
-
npm install
|
|
354
|
-
```
|
|
355
|
-
|
|
356
|
-
### 开发脚本
|
|
357
|
-
```bash
|
|
358
|
-
# 开发模式
|
|
359
|
-
yarn dev
|
|
360
|
-
# 或
|
|
361
|
-
npm run dev
|
|
362
|
-
|
|
363
|
-
# 运行测试
|
|
364
|
-
yarn test
|
|
365
|
-
# 或
|
|
366
|
-
npm test
|
|
367
|
-
```
|
|
368
|
-
|
|
369
|
-
## 🏗️ 技术栈
|
|
370
|
-
|
|
371
|
-
- **TypeScript** - 类型安全的 JavaScript
|
|
372
|
-
- **UniApp** - 跨平台应用开发框架
|
|
373
|
-
- **ES6 Modules** - 模块化开发
|
|
374
|
-
|
|
375
|
-
## 📁 项目结构
|
|
376
|
-
|
|
377
|
-
```
|
|
378
|
-
my-uniapp-tools/
|
|
379
|
-
├── .augment/ # 增强配置目录
|
|
380
|
-
│ └── rules/
|
|
381
|
-
├── src/
|
|
382
|
-
│ ├── ui/ # UI交互工具函数
|
|
383
|
-
│ │ └── index.ts
|
|
384
|
-
│ ├── navigation/ # 导航相关工具
|
|
385
|
-
│ │ └── index.ts
|
|
386
|
-
│ ├── clipboard/ # 剪贴板工具
|
|
387
|
-
│ │ └── index.ts
|
|
388
|
-
│ ├── system/ # 系统信息工具
|
|
389
|
-
│ │ └── index.ts
|
|
390
|
-
│ ├── localStorage/ # 本地存储工具
|
|
391
|
-
│ │ └── index.ts
|
|
392
|
-
│ └── index.js # 主入口文件
|
|
393
|
-
├── .gitignore # Git 忽略配置
|
|
394
|
-
├── package.json # 项目配置
|
|
395
|
-
├── tsconfig.json # TypeScript 配置
|
|
396
|
-
├── yarn.lock # Yarn 依赖锁定文件
|
|
397
|
-
├── README.md # 项目说明
|
|
398
|
-
└── RECORD.md # 项目记录
|
|
399
|
-
```
|
|
400
|
-
|
|
401
|
-
## 🔄 版本信息
|
|
402
|
-
|
|
403
|
-
当前版本:v1.0.0
|
|
404
|
-
|
|
405
|
-
## 📄 许可证
|
|
406
|
-
|
|
407
|
-
ISC
|
|
408
|
-
|
|
409
|
-
## 🤝 贡献指南
|
|
410
|
-
|
|
411
|
-
欢迎提交 Issue 和 Pull Request 来完善这个工具库!
|
|
412
|
-
|
|
413
|
-
### 开发规范
|
|
414
|
-
|
|
415
|
-
1. 所有函数都应该遵循单一职责原则
|
|
416
|
-
2. 必须添加详细的中文注释
|
|
417
|
-
3. 新增功能需要在 README.md 中更新文档
|
|
418
|
-
4. 保持代码简洁可读
|
|
419
|
-
5. 确保跨平台兼容性
|
|
420
|
-
|
|
421
|
-
## 📝 更新日志
|
|
422
|
-
|
|
423
|
-
### v1.0.0
|
|
424
|
-
- 🎯 **初始版本发布**
|
|
425
|
-
- 🏗️ **模块化架构**:按功能类型组织代码结构
|
|
426
|
-
- 📁 **五大核心模块**:
|
|
427
|
-
- `ui` - UI交互工具(useToast)
|
|
428
|
-
- `navigation` - 导航工具(useBack)
|
|
429
|
-
- `clipboard` - 剪贴板工具(copyText)
|
|
430
|
-
- `system` - 系统信息工具(useWindowInfo, getPlatform, getCurrentEnv, onCheckForUpdate, getStatusBarHeight, getNavHeight, getTopNavBarHeight)
|
|
431
|
-
- `localStorage` - 本地存储工具(setStorageSync, getStorageSync, clearStorageSync)
|
|
432
|
-
- ✨ **核心功能**:
|
|
433
|
-
- 📱 跨平台消息提示和导航返回
|
|
434
|
-
- 📋 跨平台剪贴板操作
|
|
435
|
-
- 🖥️ 系统信息获取和平台检测
|
|
436
|
-
- 🔄 小程序版本更新检查
|
|
437
|
-
- 📏 状态栏和导航栏高度适配
|
|
438
|
-
- 💾 本地存储数据管理
|
|
439
|
-
- 🛡️ **完善的错误处理机制**,确保函数调用的稳定性
|
|
440
|
-
- 💡 **遵循单一职责原则**,每个函数专注于特定功能
|
|
441
|
-
- 📚 **详细的API文档**,包含使用说明和示例代码
|
|
442
|
-
- 🎯 **支持主流平台**:微信、支付宝、百度、抖音、QQ、快手、京东等小程序平台以及H5、App
|
|
443
|
-
|
|
444
|
-
---
|
|
445
|
-
|
|
1
|
+
# My UniApp Tools
|
|
2
|
+
|
|
3
|
+
一个专为 UniApp 开发设计的实用工具函数库,提供常用的功能模块,帮助开发者快速构建跨平台应用。
|
|
4
|
+
|
|
5
|
+
## 📦 安装
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# 使用 npm
|
|
9
|
+
npm install my-uniapp-tools
|
|
10
|
+
|
|
11
|
+
# 使用 yarn
|
|
12
|
+
yarn add my-uniapp-tools
|
|
13
|
+
|
|
14
|
+
# 使用 pnpm
|
|
15
|
+
pnpm add my-uniapp-tools
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## 🚀 快速开始
|
|
19
|
+
|
|
20
|
+
```javascript
|
|
21
|
+
// 导入所有工具函数
|
|
22
|
+
import * as Tools from 'my-uniapp-tools'
|
|
23
|
+
|
|
24
|
+
// 或者按需导入
|
|
25
|
+
import {
|
|
26
|
+
useToast,
|
|
27
|
+
useBack,
|
|
28
|
+
copyText,
|
|
29
|
+
setStorageSync,
|
|
30
|
+
getStorageSync,
|
|
31
|
+
clearStorageSync,
|
|
32
|
+
useWindowInfo,
|
|
33
|
+
getPlatform,
|
|
34
|
+
getCurrentEnv,
|
|
35
|
+
onCheckForUpdate,
|
|
36
|
+
getStatusBarHeight,
|
|
37
|
+
getNavHeight,
|
|
38
|
+
getTopNavBarHeight
|
|
39
|
+
} from 'my-uniapp-tools'
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## 📚 API 文档
|
|
43
|
+
|
|
44
|
+
### 🎨 UI交互工具 (UI)
|
|
45
|
+
|
|
46
|
+
#### `useToast(title, mask, icon, duration)`
|
|
47
|
+
|
|
48
|
+
显示消息提示框
|
|
49
|
+
|
|
50
|
+
**参数:**
|
|
51
|
+
- `title` (string): 提示的内容,默认为空字符串
|
|
52
|
+
- `mask` (boolean): 是否显示透明蒙层,默认为 `false`
|
|
53
|
+
- `icon` (string): 图标类型,可选值:`'none'` | `'success'` | `'loading'` | `'error'` | `'fail'` | `'exception'`,默认为 `'none'`
|
|
54
|
+
- `duration` (number): 提示的延迟时间,默认为 `2000` 毫秒
|
|
55
|
+
|
|
56
|
+
**示例:**
|
|
57
|
+
```javascript
|
|
58
|
+
// 基础用法
|
|
59
|
+
useToast('操作成功')
|
|
60
|
+
|
|
61
|
+
// 完整参数
|
|
62
|
+
useToast(
|
|
63
|
+
'操作成功', // 提示文字
|
|
64
|
+
false, // 是否显示透明蒙层
|
|
65
|
+
'success', // 图标类型
|
|
66
|
+
2000 // 显示时长(毫秒)
|
|
67
|
+
)
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### 🧭 导航工具 (Navigation)
|
|
71
|
+
|
|
72
|
+
#### `useBack(params)`
|
|
73
|
+
|
|
74
|
+
返回上一页并支持传递参数给上一页的 init 方法
|
|
75
|
+
|
|
76
|
+
**参数:**
|
|
77
|
+
- `params` (any): 传递给上一页 init 方法的参数,默认为空字符串
|
|
78
|
+
|
|
79
|
+
**示例:**
|
|
80
|
+
```javascript
|
|
81
|
+
// 简单返回
|
|
82
|
+
useBack()
|
|
83
|
+
|
|
84
|
+
// 返回并传递参数
|
|
85
|
+
useBack({ refresh: true, data: 'some data' })
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
**注意:** 上一页需要暴露 `init` 方法来接收参数
|
|
89
|
+
|
|
90
|
+
### 📋 剪贴板工具 (Clipboard)
|
|
91
|
+
|
|
92
|
+
#### `copyText(text)`
|
|
93
|
+
|
|
94
|
+
跨平台文本复制功能,支持 H5、App、小程序。H5 平台优先使用现代的 Clipboard API,失败时回退到传统方法。
|
|
95
|
+
|
|
96
|
+
**参数:**
|
|
97
|
+
- `text` (string): 要复制的文本内容
|
|
98
|
+
|
|
99
|
+
**示例:**
|
|
100
|
+
```javascript
|
|
101
|
+
copyText('要复制的文本内容')
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### 🖥️ 系统信息工具 (System)
|
|
105
|
+
|
|
106
|
+
#### `useWindowInfo()`
|
|
107
|
+
|
|
108
|
+
获取当前窗口的尺寸、像素比等信息
|
|
109
|
+
|
|
110
|
+
**返回值:**
|
|
111
|
+
- 窗口信息对象,包含窗口尺寸、像素比等信息
|
|
112
|
+
|
|
113
|
+
**示例:**
|
|
114
|
+
```javascript
|
|
115
|
+
const windowInfo = useWindowInfo()
|
|
116
|
+
console.log(windowInfo.windowWidth) // 窗口宽度
|
|
117
|
+
console.log(windowInfo.windowHeight) // 窗口高度
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
#### `getPlatform()`
|
|
121
|
+
|
|
122
|
+
获取当前运行平台类型
|
|
123
|
+
|
|
124
|
+
**返回值:**
|
|
125
|
+
- `string`: 平台类型,可能的值:`'weixin'` | `'web'` | `'app'` | `'alipay'` | `'h5'`
|
|
126
|
+
|
|
127
|
+
**示例:**
|
|
128
|
+
```javascript
|
|
129
|
+
const platform = getPlatform()
|
|
130
|
+
console.log(platform) // 'weixin' | 'web' | 'app' | 'alipay' | 'h5'
|
|
131
|
+
|
|
132
|
+
// 根据平台执行不同逻辑
|
|
133
|
+
if (platform === 'weixin') {
|
|
134
|
+
// 微信小程序特有逻辑
|
|
135
|
+
} else if (platform === 'h5') {
|
|
136
|
+
// H5 特有逻辑
|
|
137
|
+
}
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
#### `getCurrentEnv()`
|
|
141
|
+
|
|
142
|
+
获取小程序账户信息,包含appId、版本、环境等信息
|
|
143
|
+
|
|
144
|
+
**返回值:**
|
|
145
|
+
- `object`: 小程序账户信息对象
|
|
146
|
+
- `appId` (string): 小程序appId
|
|
147
|
+
- `version` (string): 小程序版本号
|
|
148
|
+
- `envVersion` (string): 小程序环境版本(develop开发版、trial体验版、release正式版)
|
|
149
|
+
- `accountInfo` (object): 完整的账户信息对象
|
|
150
|
+
|
|
151
|
+
**示例:**
|
|
152
|
+
```javascript
|
|
153
|
+
const envInfo = getCurrentEnv()
|
|
154
|
+
console.log(envInfo.appId) // 小程序appId
|
|
155
|
+
console.log(envInfo.version) // 小程序版本号
|
|
156
|
+
console.log(envInfo.envVersion) // 环境版本
|
|
157
|
+
|
|
158
|
+
// 根据环境执行不同逻辑
|
|
159
|
+
if (envInfo.envVersion === 'develop') {
|
|
160
|
+
// 开发版特有逻辑
|
|
161
|
+
} else if (envInfo.envVersion === 'release') {
|
|
162
|
+
// 正式版特有逻辑
|
|
163
|
+
}
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
#### `onCheckForUpdate()`
|
|
167
|
+
|
|
168
|
+
检查小程序版本更新,自动处理版本检查、下载和更新流程
|
|
169
|
+
|
|
170
|
+
**参数:**
|
|
171
|
+
- 无参数
|
|
172
|
+
|
|
173
|
+
**功能说明:**
|
|
174
|
+
- 自动检查小程序是否有新版本
|
|
175
|
+
- 发现新版本时静默下载
|
|
176
|
+
- 下载完成后弹窗提示用户是否重启应用
|
|
177
|
+
- 处理下载失败的情况
|
|
178
|
+
- 支持用户选择稍后更新或立即重启
|
|
179
|
+
|
|
180
|
+
**平台支持:**
|
|
181
|
+
- ✅ 微信小程序
|
|
182
|
+
- ✅ 支付宝小程序
|
|
183
|
+
- ✅ 百度小程序
|
|
184
|
+
- ✅ 抖音小程序
|
|
185
|
+
- ✅ QQ小程序
|
|
186
|
+
- ✅ 快手小程序
|
|
187
|
+
- ✅ 京东小程序
|
|
188
|
+
- ❌ App (App端请使用其他更新方案)
|
|
189
|
+
- ❌ H5 (H5端无需此功能)
|
|
190
|
+
|
|
191
|
+
**示例:**
|
|
192
|
+
```javascript
|
|
193
|
+
// 在App.vue中使用
|
|
194
|
+
export default {
|
|
195
|
+
onLaunch() {
|
|
196
|
+
// 应用启动时检查更新
|
|
197
|
+
onCheckForUpdate()
|
|
198
|
+
},
|
|
199
|
+
onShow() {
|
|
200
|
+
// 每次从后台切换到前台时检查更新
|
|
201
|
+
onCheckForUpdate()
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
// 或在页面中手动调用
|
|
206
|
+
onCheckForUpdate()
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
**注意事项:**
|
|
210
|
+
- 建议在App.vue的onLaunch或onShow生命周期中调用
|
|
211
|
+
- 开发版和体验版无法检查版本更新,需要在正式版中测试
|
|
212
|
+
- 在开发者工具中可以通过"模拟更新编译"来测试更新功能
|
|
213
|
+
- 函数内部已处理异常情况,不会影响应用正常运行
|
|
214
|
+
|
|
215
|
+
#### `getStatusBarHeight()`
|
|
216
|
+
|
|
217
|
+
获取设备状态栏高度
|
|
218
|
+
|
|
219
|
+
**返回值:**
|
|
220
|
+
- `number`: 状态栏高度(单位:px)
|
|
221
|
+
|
|
222
|
+
**示例:**
|
|
223
|
+
```javascript
|
|
224
|
+
const statusBarHeight = getStatusBarHeight()
|
|
225
|
+
console.log(statusBarHeight) // 44 (iPhone) 或其他设备的状态栏高度
|
|
226
|
+
|
|
227
|
+
// 用于页面布局适配
|
|
228
|
+
const pageStyle = {
|
|
229
|
+
paddingTop: statusBarHeight + 'px'
|
|
230
|
+
}
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
#### `getNavHeight()`
|
|
234
|
+
|
|
235
|
+
获取小程序导航栏总高度,包含状态栏高度和菜单按钮高度
|
|
236
|
+
|
|
237
|
+
**返回值:**
|
|
238
|
+
- `number`: 导航栏总高度(单位:px)
|
|
239
|
+
|
|
240
|
+
**示例:**
|
|
241
|
+
```javascript
|
|
242
|
+
const navHeight = getNavHeight()
|
|
243
|
+
console.log(navHeight) // 88 (iPhone) 或其他设备的导航栏总高度
|
|
244
|
+
|
|
245
|
+
// 用于自定义导航栏高度设置
|
|
246
|
+
const customNavStyle = {
|
|
247
|
+
height: navHeight + 'px'
|
|
248
|
+
}
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
#### `getTopNavBarHeight()`
|
|
252
|
+
|
|
253
|
+
一次性获取应用所需的状态栏和导航栏高度配置信息
|
|
254
|
+
|
|
255
|
+
**返回值:**
|
|
256
|
+
- `object`: 配置信息对象
|
|
257
|
+
- `statusBarHeight` (number): 状态栏高度(单位:px)
|
|
258
|
+
- `navHeight` (number): 导航栏总高度(单位:px)
|
|
259
|
+
|
|
260
|
+
**示例:**
|
|
261
|
+
```javascript
|
|
262
|
+
const topNavConfig = getTopNavBarHeight()
|
|
263
|
+
console.log(topNavConfig.statusBarHeight) // 状态栏高度
|
|
264
|
+
console.log(topNavConfig.navHeight) // 导航栏总高度
|
|
265
|
+
|
|
266
|
+
// 用于全局配置
|
|
267
|
+
const globalConfig = {
|
|
268
|
+
...topNavConfig,
|
|
269
|
+
contentHeight: windowHeight - topNavConfig.navHeight
|
|
270
|
+
}
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
**注意事项:**
|
|
274
|
+
- 这些函数主要用于小程序平台的界面适配
|
|
275
|
+
- 在不同设备上返回的高度值可能不同
|
|
276
|
+
- 建议在应用启动时获取并存储这些配置信息
|
|
277
|
+
- 如果获取失败,会返回默认值确保应用正常运行
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
### 💾 本地存储工具 (Storage)
|
|
282
|
+
|
|
283
|
+
#### `setStorageSync(key, obj)`
|
|
284
|
+
|
|
285
|
+
同步设置本地缓存,自动处理对象序列化
|
|
286
|
+
|
|
287
|
+
**参数:**
|
|
288
|
+
- `key` (string): 缓存键
|
|
289
|
+
- `obj` (unknown): 要缓存的值,可以是任何类型
|
|
290
|
+
|
|
291
|
+
**示例:**
|
|
292
|
+
```javascript
|
|
293
|
+
// 存储字符串
|
|
294
|
+
setStorageSync('username', 'john')
|
|
295
|
+
|
|
296
|
+
// 存储对象(自动序列化)
|
|
297
|
+
setStorageSync('userInfo', { name: 'john', age: 25 })
|
|
298
|
+
|
|
299
|
+
// 存储数组
|
|
300
|
+
setStorageSync('list', [1, 2, 3, 4, 5])
|
|
301
|
+
|
|
302
|
+
// 存储布尔值
|
|
303
|
+
setStorageSync('isLogin', true)
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
#### `getStorageSync(key)`
|
|
307
|
+
|
|
308
|
+
同步获取本地缓存,自动处理对象反序列化
|
|
309
|
+
|
|
310
|
+
**参数:**
|
|
311
|
+
- `key` (string): 缓存键
|
|
312
|
+
|
|
313
|
+
**返回值:**
|
|
314
|
+
- 缓存的值。如果存储的是 JSON 字符串,则返回解析后的对象;否则返回原始值
|
|
315
|
+
|
|
316
|
+
**示例:**
|
|
317
|
+
```javascript
|
|
318
|
+
// 获取字符串
|
|
319
|
+
const username = getStorageSync('username')
|
|
320
|
+
|
|
321
|
+
// 获取对象(自动反序列化)
|
|
322
|
+
const userInfo = getStorageSync('userInfo')
|
|
323
|
+
|
|
324
|
+
// 获取数组
|
|
325
|
+
const list = getStorageSync('list')
|
|
326
|
+
|
|
327
|
+
// 获取布尔值
|
|
328
|
+
const isLogin = getStorageSync('isLogin')
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
#### `clearStorageSync(key?)`
|
|
332
|
+
|
|
333
|
+
清理本地缓存,支持清理指定项或全部清理
|
|
334
|
+
|
|
335
|
+
**参数:**
|
|
336
|
+
- `key` (string, 可选): 缓存键。如果传入则删除对应的缓存项,如果不传入则清除所有缓存
|
|
337
|
+
|
|
338
|
+
**示例:**
|
|
339
|
+
```javascript
|
|
340
|
+
// 清理指定缓存
|
|
341
|
+
clearStorageSync('username')
|
|
342
|
+
|
|
343
|
+
// 清理所有缓存
|
|
344
|
+
clearStorageSync()
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
## 🛠️ 开发使用
|
|
348
|
+
|
|
349
|
+
### 安装依赖
|
|
350
|
+
```bash
|
|
351
|
+
yarn install
|
|
352
|
+
# 或
|
|
353
|
+
npm install
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
### 开发脚本
|
|
357
|
+
```bash
|
|
358
|
+
# 开发模式
|
|
359
|
+
yarn dev
|
|
360
|
+
# 或
|
|
361
|
+
npm run dev
|
|
362
|
+
|
|
363
|
+
# 运行测试
|
|
364
|
+
yarn test
|
|
365
|
+
# 或
|
|
366
|
+
npm test
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
## 🏗️ 技术栈
|
|
370
|
+
|
|
371
|
+
- **TypeScript** - 类型安全的 JavaScript
|
|
372
|
+
- **UniApp** - 跨平台应用开发框架
|
|
373
|
+
- **ES6 Modules** - 模块化开发
|
|
374
|
+
|
|
375
|
+
## 📁 项目结构
|
|
376
|
+
|
|
377
|
+
```
|
|
378
|
+
my-uniapp-tools/
|
|
379
|
+
├── .augment/ # 增强配置目录
|
|
380
|
+
│ └── rules/
|
|
381
|
+
├── src/
|
|
382
|
+
│ ├── ui/ # UI交互工具函数
|
|
383
|
+
│ │ └── index.ts
|
|
384
|
+
│ ├── navigation/ # 导航相关工具
|
|
385
|
+
│ │ └── index.ts
|
|
386
|
+
│ ├── clipboard/ # 剪贴板工具
|
|
387
|
+
│ │ └── index.ts
|
|
388
|
+
│ ├── system/ # 系统信息工具
|
|
389
|
+
│ │ └── index.ts
|
|
390
|
+
│ ├── localStorage/ # 本地存储工具
|
|
391
|
+
│ │ └── index.ts
|
|
392
|
+
│ └── index.js # 主入口文件
|
|
393
|
+
├── .gitignore # Git 忽略配置
|
|
394
|
+
├── package.json # 项目配置
|
|
395
|
+
├── tsconfig.json # TypeScript 配置
|
|
396
|
+
├── yarn.lock # Yarn 依赖锁定文件
|
|
397
|
+
├── README.md # 项目说明
|
|
398
|
+
└── RECORD.md # 项目记录
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
## 🔄 版本信息
|
|
402
|
+
|
|
403
|
+
当前版本:v1.0.0
|
|
404
|
+
|
|
405
|
+
## 📄 许可证
|
|
406
|
+
|
|
407
|
+
ISC
|
|
408
|
+
|
|
409
|
+
## 🤝 贡献指南
|
|
410
|
+
|
|
411
|
+
欢迎提交 Issue 和 Pull Request 来完善这个工具库!
|
|
412
|
+
|
|
413
|
+
### 开发规范
|
|
414
|
+
|
|
415
|
+
1. 所有函数都应该遵循单一职责原则
|
|
416
|
+
2. 必须添加详细的中文注释
|
|
417
|
+
3. 新增功能需要在 README.md 中更新文档
|
|
418
|
+
4. 保持代码简洁可读
|
|
419
|
+
5. 确保跨平台兼容性
|
|
420
|
+
|
|
421
|
+
## 📝 更新日志
|
|
422
|
+
|
|
423
|
+
### v1.0.0
|
|
424
|
+
- 🎯 **初始版本发布**
|
|
425
|
+
- 🏗️ **模块化架构**:按功能类型组织代码结构
|
|
426
|
+
- 📁 **五大核心模块**:
|
|
427
|
+
- `ui` - UI交互工具(useToast)
|
|
428
|
+
- `navigation` - 导航工具(useBack)
|
|
429
|
+
- `clipboard` - 剪贴板工具(copyText)
|
|
430
|
+
- `system` - 系统信息工具(useWindowInfo, getPlatform, getCurrentEnv, onCheckForUpdate, getStatusBarHeight, getNavHeight, getTopNavBarHeight)
|
|
431
|
+
- `localStorage` - 本地存储工具(setStorageSync, getStorageSync, clearStorageSync)
|
|
432
|
+
- ✨ **核心功能**:
|
|
433
|
+
- 📱 跨平台消息提示和导航返回
|
|
434
|
+
- 📋 跨平台剪贴板操作
|
|
435
|
+
- 🖥️ 系统信息获取和平台检测
|
|
436
|
+
- 🔄 小程序版本更新检查
|
|
437
|
+
- 📏 状态栏和导航栏高度适配
|
|
438
|
+
- 💾 本地存储数据管理
|
|
439
|
+
- 🛡️ **完善的错误处理机制**,确保函数调用的稳定性
|
|
440
|
+
- 💡 **遵循单一职责原则**,每个函数专注于特定功能
|
|
441
|
+
- 📚 **详细的API文档**,包含使用说明和示例代码
|
|
442
|
+
- 🎯 **支持主流平台**:微信、支付宝、百度、抖音、QQ、快手、京东等小程序平台以及H5、App
|
|
443
|
+
|
|
444
|
+
---
|
|
445
|
+
|
|
446
446
|
如有问题或建议,请提交 Issue 或联系开发者。感谢您的使用! 🙏
|