@netang/quasar 0.0.94 → 0.0.96

package/_docs/docs/utils/form.md

@@ -1,101 +1,33 @@
 # $form 表单
 
 ::: tip
-`@netang/quasar/utils/$auth.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/%24auth.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/%24auth.js)
+`@netang/quasar/utils/$form.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/%24form.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/%24form.js)
 
-用户登录鉴权工具
+表单工具
 :::
 
-## $auth.isLogin
+## $form.create
 
-判断用户是否已登录
+创建表格实例
 
 - 类型
 
 ```javascript
-$auth.isLogin(): boolean
+$form.create(options: Object): Object
 ```
 
+### options 参数
 
-## $auth.getUserInfo
+| 参数名       | 说明     | 类型         | 可选值 | 默认值 | 示例  |
+|-----------|--------|------------|-----|-----|-----|
+| $power    | 权限实例   | `Object`   | -   | -   | -   | 
+| formData  | 初始表单数据 | `Object`   | -   | { } | -   | 
+| resetForm | 重置表单方法 | `Function` | -   | -   | -   | 
 
-获取用户信息
-
-- 类型
-
-```javascript
-$auth.getUserInfo(): Object
-```
-
-- 返回
-
-| 参数名     | 说明      | 类型        | 默认值 | 可选值 | 示例                         |
-|---------|---------|-----------|-----|-----|----------------------------|
-| id      | 用户 id   | `Number`  | -   | -   | -                          | 
-| token   | 鉴权认证    | `String`  | -   | -   | -                          | 
-| info    | 用户信息    | `Object`  | -   | -   | { mobile: 123456, sex: 1 } | 
-| isLogin | 用户是否已登录 | `Boolean` | -   | -   | -                          | 
-
-
-## $auth.getUserId
-
-获取用户 ID
-
-- 类型
-
-```javascript
-
-$auth.getUserId(): Number
-```
-
-- 说明
-
-如果返回 0：说明用户未登录
-
-否则返回已登录的用户 ID
-
-
-## $auth.pushLogin
-
-跳转登录页面
-
-- 类型
-
-```javascript
-$auth.pushLogin(query: Object): void
-```
-
-- 说明
-
-`query` 为跳转至登录页面的参数
-
-
-## $auth.logout
-
-退出登录
-
-- 类型
-
-```javascript
-$auth.logout(): void
-```
-
-
-## $auth.updateLogin
-
-登录后更新用户状态数据
-
-- 类型
-
-```javascript
-$auth.updateLogin(options: Object): boolean
-```
-
-- options 参数
-
-| 参数名       | 说明     | 类型       | 默认值 | 可选值 | 示例                         |
-|-----------|--------|----------|-----|-----|----------------------------|
-| i         | 用户 id  | `Number` | -   | -   | -                          | 
-| t         | 鉴权认证   | `String` | -   | -   | -                          | 
-| user_info | 用户基础信息 | `Object` | -   | -   | { mobile: 123456, sex: 1 } | 
+### 返回数据
 
+| 参数名         | 说明     | 类型            | 可在 `<q-form>` 组件中使用 |
+|-------------|--------|---------------|---------------------|
+| formRef     | 表单节点   | `ref()`       | ref="formRef"       |
+| rawFormData | 原始表单数据 | `Object`      | -                   |
+| formData    | 表单数据   | `ref(Object)` | -                   |

package/_docs/docs/utils/getData.md

@@ -1,18 +1,60 @@
-# xxxx xxxx
+# getData 获取公共数据
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/getData.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/getData.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/getData.js)
 :::
 
-### 使用示例
+- 请求公共数据地址设置
 
 ```javascript
+import { settings } from '@netang/quasar/utils/config'
 
+/**
+ * 配置设置
+ */
+settings({
+    // 用户配置
+    userConfig: {
+        apiDataUrl: '公共数据地址',
+    },
+})
 ```
 
+- 示例
 
-### xxxx 参数
+```javascript
+
+// 页面状态
+const pageStatus = ref(false)
+// 空状态描述
+const emptyDescription = ref('')
+// 仓库列表
+const warehouseLists = ref([])
+
+// 获取仓库列表
+const res1 = await getData('get_warehouse', pageStatus, emptyDescription, warehouseLists)
+if (res1 === false) {
+    return
+}
+console.log(warehouseLists.value)
+
+// 获取获取多条公共数据
+const res2 = await getData(['get_admin_group', 'get_admin_post', 'get_admin_role'], pageStatus, emptyDescription)
+if (res2 === false) {
+    return
+}
+console.log(res2[1], res2[2], res2[3])
+```
+
+- 类型
+
+```javascript
+await getData(url, pageStatus, emptyDescription, refValue)
+```
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+| 参数名      | 说明 | 类型       | 默认值   |
+|----------|--|----------|-------|
+| url      | 请求地址 | `String` / `Array` | -     |
+| pageStatus | 页面状态 | `ref(Boolean)` | - |
+| emptyDescription | 空状态描述 | `ref(String)` | - |
+| refValue | 请求成功后设置值 | `ref()` | - |

package/_docs/docs/utils/getFile.md

@@ -1,18 +1,21 @@
-# xxxx xxxx
+# getFile 获取文件地址
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/getFile.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/getFile.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/getFile.js)
 :::
 
-### 使用示例
+- 示例
 
 ```javascript
-
+getFile('https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png')
 ```
 
+- 类型
 
-### xxxx 参数
+```javascript
+await getFile(src)
+```
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+| 参数名      | 说明 | 类型       | 默认值   |
+|----------|--|----------|-------|
+| src      | 文件地址 | `String` / `Array`  | -     |

package/_docs/docs/utils/getImage.md

@@ -1,18 +1,33 @@
-# xxxx xxxx
+# getImage 获取图片地址
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/getImage.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/getImage.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/getImage.js)
 :::
 
-### 使用示例
+- 示例
 
 ```javascript
+getImage('https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png')
+```
+
+- 类型
 
+```javascript
+await getImage(src, options)
 ```
 
+| 参数名      | 说明 | 类型       | 默认值   |
+|----------|--|----------|-------|
+| src      | 图片地址 | `String` / `Array` / `Object` | -     |
+| options | 参数 | `Object` | - |
 
-### xxxx 参数
+options 参数
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+| 参数名      | 说明 | 类型       | 默认值   |
+|----------|--|----------|-------|
+| w      | 图片宽 | `Number` | -     |
+| h      | 图片高 | `Number` | -     |
+| q      | 图片质量 | `Number` | 75     |
+| format | 图片格式 | `String` | webp     |
+| maxWidth | 图片最大宽度 | `Number` | - |
+| zoom | 是否自动缩放 | `Boolean` | false |

package/_docs/docs/utils/getTime.md

@@ -1,18 +1,51 @@
-# xxxx xxxx
+# getTime 获取时间
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/getTime.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/getTime.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/getTime.js)
 :::
 
-### 使用示例
+- 示例
 
 ```javascript
+// 如果没有时间, 则显示默认值：无
+getTime(0, '无')
 
+// 显示秒
+getTime(Date.now(), { showSecond: true, }, '-')
+
+// 自定义格式
+getTime(Date.now(), { format: 'MM-DD', })
+
+// 显示日历格式
+getTime(Date.now() - 86401000, { calendar: true, })
+
+getTime(Date.now() - 172800000, { calendar: true, })
+
+// 隐藏当前年份
+// 如果是今年则隐藏当前年份, 否则显示年份
+getTime(Date.now(), { hideCurrentYear: true, })
+getTime(Date.now() - 31536000000, { hideCurrentYear: true, })
+```
+
+- 类型
+
+```javascript
+getTime(time, options, defaultValue)
 ```
 
+| 参数名      | 说明 | 类型       | 默认值   |
+|----------|--|----------|-------|
+| time      | 秒时间戳 / 毫秒时间戳 | `Number` | -     |
+| options | 参数 | `Object` | - |
+| defaultValue | 默认值 | `Any` | - |
 
-### xxxx 参数
+options 参数
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+| 参数名      | 说明 | 类型       | 默认值   |
+|----------|--|----------|-------|
+| format      | 默认格式化 | `String` | MM-DD HH:mm     |
+| showSecond | 是否显示秒 | `Boolean` | false|
+| hideCurrentYear | 是否隐藏当前年份 | `Boolean` | false|
+| calendar | 是否显示日历格式 | `Boolean` | false|
+| showCalendarToday | 是否显示日历今天 | `Boolean` | false|
+| showCalendarTime | 是否显示日历时间 | `Boolean` | false|

package/_docs/docs/utils/loading.md

@@ -1,18 +1,18 @@
-# xxxx xxxx
+# loading 全局加载
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/loading.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/loading.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/loading.js)
+
+继承 `Loading` 所有特性
+[中文文档](http://www.quasarchs.com/quasar-plugins/loading) [英文文档](https://quasar.dev/quasar-plugins/loading)
 :::
 
-### 使用示例
+- 示例
 
 ```javascript
+// 全局加载
+loading.show()
 
+// 取消全局加载
+loading.hide()
 ```
-
-
-### xxxx 参数
-
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |

package/_docs/docs/utils/notify.md

@@ -1,18 +1,29 @@
-# xxxx xxxx
+# notify 通知
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/notify.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/notify.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/notify.js)
+
+继承 `Notify.create()` 所有特性
+[中文文档](http://www.quasarchs.com/quasar-plugins/notify) [英文文档](https://quasar.dev/quasar-plugins/notify)
 :::
 
-### 使用示例
+- 示例
 
 ```javascript
-
+notify({
+    color: 'green-4',
+    textColor: 'white',
+    icon: 'cloud_done',
+    message: '修改成功'
+})
 ```
 
+- 类型
 
-### xxxx 参数
+```javascript
+notify(options: Object): void
+```
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+| 参数名     | 说明  | 类型       |
+|---------|-----|----------|
+| options | 参数  | `Object` |

package/_docs/docs/utils/power.md

@@ -18,23 +18,23 @@ $power.create(options: Object): Object
 
 ### options 参数
 
-| 参数名                                 | 说明          | 类型         | 默认值                  | 可选值 | 示例  |
-|-------------------------------------|-------------|------------|----------------------|-----|-----|
-| path                                | 路由路径        | `String`   | -                    | -   | -   | 
-| query                               | 路由参数        | `Object`   | -                    | -   | -   | 
-| pageLoading                         | 是否加载页面      | `Boolean`  | false                | -   | -   | 
-| pageStatus                          | 页面状态        | `Boolean`  | null                 | -   | -   | 
-| emptyDescription                    | 空状态描述       | `String`   | -                    | -   | -   | 
-| power                               | 是否开启权限      | `Boolean`  | true                 | -   | -   | 
-| showPowerBtns                       | 是否显示权限按钮    | `Boolean`  | true                 | -   | -   | 
+| 参数名                                 | 说明        | 类型         | 默认值                  | 可选值 | 示例  |
+|-------------------------------------|-----------|------------|----------------------|-----|-----|
+| path                                | 路由路径      | `String`   | 当前路由路径               | -   | -   | 
+| query                               | 路由参数      | `Object`   | 当前路由参数               | -   | -   | 
+| pageLoading                         | 是否加载页面    | `Boolean`  | false                | -   | -   | 
+| pageStatus                          | 页面状态      | `Boolean`  | null                 | -   | -   | 
+| emptyDescription                    | 空状态描述     | `String`   | -                    | -   | -   | 
+| power                               | 是否开启权限    | `Boolean`  | true                 | -   | -   | 
+| showPowerBtns                       | 是否显示权限按钮  | `Boolean`  | true                 | -   | -   | 
 | showToolbarPowerBtns                | 是否显示工具栏权限按钮 | `Boolean`  | true                 | -   | -   | 
-| [formatPowerBtns](#formatpowerbtns) | 格式化权限按钮     | `Function` | -                    | -   | -   | 
-| leftDrawerIcon                      | 左边侧滑菜单图标    | `String`   | format_list_bulleted | -   | -   | 
-| rightDrawerIcon                     | 右边侧滑菜单图标    | `search`   | -                    | -   | -   | 
-| [requestBefore](#requestbefore)     | 请求前执行       | `Function` | -                    | -   | -   | 
-| [requestSuccess](#requestsuccess)   | 请求成功执行      | `Function` | -                    | -   | -   | 
-| [requestFail](#requestfail)         | 请求失败执行      | `Function` | -                    | -   | -   | 
-| [requestAfter](#requestafter)       | 请求后执行       | `Function` | -                    | -   | -   | 
+| [formatPowerBtns](#formatpowerbtns) | 格式化权限按钮   | `Function` | -                    | -   | -   | 
+| leftDrawerIcon                      | 左边侧滑菜单图标  | `String`   | format_list_bulleted | -   | -   | 
+| rightDrawerIcon                     | 右边侧滑菜单图标  | `search`   | -                    | -   | -   | 
+| [requestBefore](#requestbefore)     | 请求前执行     | `Function` | -                    | -   | -   | 
+| [requestSuccess](#requestsuccess)   | 请求成功执行    | `Function` | -                    | -   | -   | 
+| [requestFail](#requestfail)         | 请求失败执行    | `Function` | -                    | -   | -   | 
+| [requestAfter](#requestafter)       | 请求后执行     | `Function` | -                    | -   | -   | 
 
 #### formatPowerBtns
 
@@ -83,11 +83,11 @@ const $power = $n.$power.create({
 })
 ```
 
-| 参数名              | 说明        | 类型        | 示例  |
-|------------------|-------------|----------------|-----|
-| powerBtn         | 单个权限按钮数据  | `Object`  | -    |
-| isFixed          | 是否固定在表格列中 | `Boolean` | -    |
-| tableSelected      | 表格选中数据    | `Array`   | -    |
+| 参数名           | 说明        | 类型        | 示例  |
+|---------------|-----------|-----------|-----|
+| powerBtn      | 单个权限按钮数据  | `Object`  | -   |
+| isFixed       | 是否固定在表格列中 | `Boolean` | -   |
+| tableSelected | 表格选中数据    | `Array`   | -   |
 
 #### requestBefore
 
@@ -229,7 +229,7 @@ const $power = $n.$power.create({
 | hidden | 是否隐藏按钮                            | `Boolean` | -                                                                     | -                      |
 | data   | 按钮参数                              | `Object`  | -                                                                     | -                      |
 
-data 按钮参数
+- data 按钮参数
 
 | 参数名             | 说明                       | 类型                   | 可选值                               | 默认值    | 示例  |
 |-----------------|--------------------------|----------------------|-----------------------------------|--------|-----|
@@ -244,3 +244,110 @@ data 按钮参数
 | requestQuery    | 请求参数                     | `Object`             | -                                 | -      | -   |
 | requestSuccess  | 请求成功执行                   | `Object`             | -                                 | -      | -   |
 | params          | 自定义参数, 任意类型              | `Any`                | -                                 | -      | -   |
+
+- requestQuery
+
+请求参数
+
+| 参数名  | 说明  | 类型                | 示例 |
+|------  |-----|--------------------|--|
+| list | 列表  | `String` / `Array` | [ "id", "sku_id AS sku" ] |
+| query | 参数  | `String` / `Array` | [ "id", "sku_id AS sku", { "type": 1, "name": "age" } ] |
+
+
+- requestSuccess
+
+请求成功执行
+
+| 参数名  | 说明  | 类型                | 可选值 |
+|------  |-----|--------------------|--|
+| type | 类型  | `String` | `close` / `closePush` / `closePushRefresh` / `resetForm` / `refreshList` |
+| params | 参数  | `Any` | - |
+
+
+## $power.setData
+
+设置权限数据
+
+- 类型
+
+```javascript
+$power.setData(options: Object): void
+```
+
+### options 参数
+
+| 参数名  | 说明    | 类型       |
+|------|-------|----------|
+| rows | 路由路径  | `Array`  |
+| v    | 权限版本号 | `Number` |
+
+
+## $power.getData
+
+获取权限数据
+
+- 类型
+
+```javascript
+await $power.getData(): Object
+```
+
+### 返回数据
+
+| 参数名  | 说明 | 类型       | 默认值  |
+|------|--|----------|------|
+| v    | 权限版本号 | `Number` | null |
+| all | 以 id 为索引的权限数据对象 | `Object`  |      |
+| urls | 以 url 为索引的权限数据对象 | `Object`  |      |
+| btns | 以 url 为索引的权限按钮对象 | `Object`  |      |
+| menus | 所有权限菜单数组 | `Array`  |      |
+
+
+## $power.getPageData
+
+获取权限数据
+
+- 类型
+
+```javascript
+$power.getPageData($route): Object
+```
+
+### 返回数据
+
+| 参数名  | 说明 | 类型       |
+|------|--|----------|
+| page    | 页面权限 | `Number` |
+| btns | 页面权限按钮数组 | `Array`  |
+
+
+## $power.formatBtns
+
+格式化权限按钮
+
+- 类型
+
+```javascript
+$power.formatBtns(powerBtns, filterBtns, toObject = false): Array
+```
+
+## $power.request
+
+权限请求
+
+- 类型
+
+```javascript
+await $power.request(powerBtns, filterBtns, toObject = false): void
+```
+
+| 参数名  | 说明 | 类型       |
+|------|--|-----|
+| powerBtn    | 权限按钮数据 | `Object` |
+| tableSelected | 表格选中数据 | `Array`  |
+| checkUploading | 检查是否正在上传文件 | `Function`  |
+| [requestBefore](#requestbefore)     | 请求前执行       | `Function` |
+| [requestSuccess](#requestsuccess)   | 请求成功执行      | `Function` |
+| [requestFail](#requestfail)         | 请求失败执行      | `Function` |
+| [requestAfter](#requestafter)       | 请求后执行       | `Function` |

package/_docs/docs/utils/previewImage.md

@@ -1,18 +1,11 @@
-# xxxx xxxx
+# previewImage 预览图片
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/previewImage.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/previewImage.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/previewImage.js)
 :::
 
-### 使用示例
+- 示例
 
 ```javascript
-
+previewImage('https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png')
 ```
-
-
-### xxxx 参数
-
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |

package/_docs/docs/utils/price.md

@@ -1,18 +1,45 @@
-# xxxx xxxx
+# price 换算金额
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/price.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/price.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/price.js)
+
+继承 `@netang/utils/decimal.js` 所有特性 [Github](https://github.com/netangsoft/netang-utils/blob/main/decimal.js) [Gitee](https://gitee.com/jinmarcus/netang-utils/blob/main/decimal.js)
 :::
 
-### 使用示例
+- 换算金额设置
 
 ```javascript
+import { settings } from '@netang/quasar/utils/config'
 
+/**
+ * 配置设置
+ */
+settings({
+    // 用户配置
+    userConfig: {
+        // 是否设置金额由热门民币的[分]转为[元]
+        // true: 默认金额单位为：分
+        // false: 默认金额单位为：元
+        priceCentToYuan: false,
+    },
+})
 ```
 
+- 示例
+
+```javascript
+price(123.45678)
+// 如果 priceCentToYuan 为 true 返回 123.45
+// 如果 priceCentToYuan 为 false 返回 1.23
+```
 
-### xxxx 参数
+- 类型
+
+```javascript
+price(value, options)
+```
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+| 参数名      | 说明 | 类型       | 默认值   |
+|----------|--|----------|-------|
+| value      | 金额值 | `Number` | -     |
+| options | 参数 | `Object` | - |

package/_docs/docs/utils/rule.md

@@ -1,18 +1,30 @@
-# xxxx xxxx
+# $rule 表单单个验证
 
 ::: tip
-xxxxxxxx
-:::
+`@netang/quasar/utils/$rule.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/%24rule.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/%24rule.js)
 
-### 使用示例
+单个验证规则(用于表单验证)
+:::
 
-```javascript
+- 示例
 
+```html
+<q-input
+    class="n-field-fieldset"
+    label="新密码 *"
+    v-model="formData.password"
+    type="password"
+    outlined
+    clearable
+    stack-label
+    dense
+    lazy-rules
+    :rules="[ $rule('required|min:6|max:20') ]"
+/>
 ```
 
+### options 参数
 
-### xxxx 参数
-
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+| 参数名                  | 说明          | 类型         |
+|----------------------|-------------|------------|
+| rule                 | 验证规则        | `String`   |