@netang/quasar 0.0.94 → 0.0.96

package/_docs/docs/.vuepress/configs/sidebar/zh.js

@@ -42,18 +42,16 @@ export const sidebarZh = {
             text: 'Utils 工具',
             children: [
                 '/utils/auth',
-                '/utils/form',
                 '/utils/power',
-                '/utils/rule',
-                '/utils/ruleValid',
-                '/utils/search',
                 '/utils/table',
+                '/utils/form',
                 '/utils/tree',
-                '/utils/alert',
+                '/utils/rule',
+                '/utils/ruleValid',
                 '/utils/area',
+                '/utils/alert',
                 '/utils/arr',
                 '/utils/bus',
-                '/utils/config',
                 '/utils/confirm',
                 '/utils/copy',
                 '/utils/dialog',
@@ -71,9 +69,6 @@ export const sidebarZh = {
                 '/utils/timestamp',
                 '/utils/toast',
                 '/utils/uploader',
-                '/utils/useAuth',
-                '/utils/useRouter',
-                '/utils/useUploader',
             ],
         }
     ],

package/_docs/docs/utils/alert.md

@@ -1,18 +1,26 @@
-# xxxx xxxx
+# alert 提示框
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/alert.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/alert.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/alert.js)
+
+继承 `Dialog.create()` 所有特性
+[中文文档](http://www.quasarchs.com/quasar-plugins/dialog) [英文文档](https://quasar.dev/quasar-plugins/dialog)
 :::
 
-### 使用示例
+- 示例
 
 ```javascript
-
+alert({
+    message: '登录验证失败',
+})
 ```
 
+- 类型
 
-### xxxx 参数
+```javascript
+alert(options: Object): void
+```
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+| 参数名     | 说明  | 类型       |
+|---------|-----|----------|
+| options | 参数  | `Object` |

package/_docs/docs/utils/area.md

@@ -1,18 +1,112 @@
-# xxxx xxxx
+# area 提示框
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/area.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/area.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/area.js)
+
+继承 `Dialog.create()` 所有特性
+[中文文档](http://www.quasarchs.com/quasar-plugins/dialog) [英文文档](https://quasar.dev/quasar-plugins/dialog)
 :::
 
-### 使用示例
+## getData 获取地区数据
+
+- 示例
+
+```javascript
+// 获取地区数据数据
+await area.getData(3)
+```
+
+- 类型
+
+```javascript
+await getData(level, options): Array
+```
+
+| 参数名     | 说明                | 类型       | 可选值             | 默认值 |
+|---------|-------------------|----------|-----------------|-----|
+| level | 地区级别(1：省，2：市，3：区) | `Number` | `1` / `2` / `3` | 3   |
+| options | 参数                | `Object` | -               | -   |
+
+options 参数
+
+| 参数名     | 说明                | 类型       | 可选值 | 默认值 |
+|---------|-------------------|----------|-----|-----|
+| ignore | 忽略地区 id | `Array`  | -   | [ ] |
+
+
+## getInfo 获取地区详情
+
+- 示例
 
 ```javascript
+// 获取地区数据数据
+await area.getInfo({
+    // 第 3 级区编码
+    code: 340202,
+})
+```
+
+- 类型
 
+```javascript
+await getInfo(options): Object
 ```
 
+| 参数名          | 说明                                         | 类型       | 可选值             | 默认值  |
+|--------------|--------------------------------------------|----------|-----------------|------|
+| areaData     | 地址数据（由 `area.getData()` 创建的数据）（如果为空，则重新获取） | `Object` | -               | null |
+| level        | 地区级别                                       | `Number` | `1` / `2` / `3` | 3    |
+| code         | 第 3 级区编码                                   | `Number` | -               | 0    |
+| provinceText | 省文字                                        | `String` | -               | ""   |
+| cityText     | 市文字                                        | `String` | -               | ""   |
+| areaText     | 区文字                                        | `String` | -               | ""   |
+| regionText   | 详细区域文字                                     | `String` | -               | ""   |
+
+- 返回数据
+
+返回数据示例
 
-### xxxx 参数
+```javascript
+{
+    "id": 340202,
+    "pid": 340200,
+    "title": "镜湖区",
+    "level": 3,
+    "region": [
+        {
+            "id": 340000,
+            "pid": 0,
+            "title": "安徽省",
+            "level": 1
+        },
+        {
+            "id": 340200,
+            "pid": 340000,
+            "title": "芜湖市",
+            "level": 2
+        },
+        {
+            "id": 340202,
+            "pid": 340200,
+            "title": "镜湖区",
+            "level": 3
+        }
+    ],
+    "region_ids": [
+        340000,
+        340200,
+        340202
+    ],
+    "region_text": "安徽省芜湖市镜湖区"
+}
+```
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+| 参数名         | 说明       | 类型       | 示例  |
+|-------------|----------|----------|-----|
+| id          | 当前编码     | `Number` | -   | -     |
+| pid         | 上级编码     | `Number` | -   | -     |
+| title       | 地区标题     | `String` | -   | -     |
+| level       | 地区级别     | `Number` | -   | -     |
+| region      | 地区对象数组   | `Array`  | -   | -     |
+| region_ids  | 地区 id 数组 | `Array`  | -   | -     |
+| region_text | 地区名称数组   | `Array`  | -   | -     |

package/_docs/docs/utils/arr.md

@@ -1,18 +1,80 @@
-# xxxx xxxx
+# arr 操作数组
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/arr.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/arr.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/arr.js)
 :::
 
-### 使用示例
+- 示例
+
+```html
+<div class="col-xs-12 col-md-auto text-grey-8">
+    <q-btn icon="add" class="q-mr-xs" size="12px" flat dense round @click="arr.add(formData.params, itemIndex, createNode)" />
+    <q-btn icon="remove" class="q-mr-xs" size="12px" flat dense round @click="arr.delete(formData.params, itemIndex)" :disable="formData.params.length <= 1" />
+    <q-btn icon="expand_less" class="q-mr-xs" size="12px" flat dense round @click="arr.up(formData.params, itemIndex)" :disable="itemIndex === 0" />
+    <q-btn icon="expand_more" class="q-mr-xs" size="12px" flat dense round @click="arr.down(formData.params, itemIndex)" :disable="formData.params.length <= itemIndex + 1" />
+</div>
+```
+
+### arr.add
+
+数组添加值
+
+- 类型
+
+```javascript
+arr.add(children, index, newItem)
+```
+
+| 参数名      | 说明   | 类型                 | 默认值 |
+|----------|------|--------------------|-----|
+| children | 操作数组 | `Array`            | -   |
+| index    | 数组索引 | `Number`           | -   |
+| newItem  | 添加值  | `Any` / `Function` | -   |
+
+
+### arr.delete
+
+数组删除值
+
+- 类型
 
 ```javascript
+arr.delete(children, index)
+```
+
+| 参数名      | 说明   | 类型                 | 默认值 |
+|----------|------|--------------------|-----|
+| children | 操作数组 | `Array`            | -   |
+| index    | 数组索引 | `Number`           | -   |
+
+
+### arr.up
 
+数组值上移
+
+- 类型
+
+```javascript
+arr.up(children, index)
 ```
 
+| 参数名      | 说明   | 类型                 | 默认值 |
+|----------|------|--------------------|-----|
+| children | 操作数组 | `Array`            | -   |
+| index    | 数组索引 | `Number`           | -   |
 
-### xxxx 参数
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+### arr.down
+
+数组值下移
+
+- 类型
+
+```javascript
+arr.down(children, index)
+```
+
+| 参数名      | 说明   | 类型                 | 默认值 |
+|----------|------|--------------------|-----|
+| children | 操作数组 | `Array`            | -   |
+| index    | 数组索引 | `Number`           | -   |

package/_docs/docs/utils/bus.md

@@ -1,18 +1,18 @@
-# xxxx xxxx
+# bus 通知
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/bus.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/bus.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/bus.js)
+
+继承 `new EventBus()` 所有特性
+[中文文档](http://www.quasarchs.com/quasar-utils/event-bus-util) [英文文档](https://quasar.dev/quasar-utils/event-bus-util)
 :::
 
-### 使用示例
+- 示例
 
 ```javascript
+bus.on('some-event', (arg1, arg2, arg3) => {
+    // do some work
+})
 
+bus.emit('some-event', 'arg1 value', 'arg2 value', 'arg3 value')
 ```
-
-
-### xxxx 参数
-
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |

package/_docs/docs/utils/confirm.md

@@ -1,18 +1,31 @@
-# xxxx xxxx
+# confirm 确认框
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/confirm.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/confirm.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/confirm.js)
+
+继承 `Dialog.create()` 所有特性
+[中文文档](http://www.quasarchs.com/quasar-plugins/dialog) [英文文档](https://quasar.dev/quasar-plugins/dialog)
 :::
 
-### 使用示例
+- 示例
 
 ```javascript
-
+// 确认框
+confirm({
+    message: '确认删除吗？',
+})
+    // 点击确认执行
+    .onOk(function () {
+        
+    })
 ```
 
+- 类型
 
-### xxxx 参数
+```javascript
+confirm(options: Object): void
+```
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+| 参数名     | 说明  | 类型       |
+|---------|-----|----------|
+| options | 参数  | `Object` |

package/_docs/docs/utils/copy.md

@@ -1,18 +1,22 @@
-# xxxx xxxx
+# copy 复制
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/copy.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/copy.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/copy.js)
 :::
 
-### 使用示例
+- 示例
 
 ```javascript
 
-```
+// 复制并提示：复制成功
+copy('test1')
 
+// 复制并提示：复制【test1】成功
+copy('test1', true)
 
-### xxxx 参数
+// 复制并提示：ok
+copy('test1', 'ok')
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+// 复制并关闭自动提示
+copy('test1', false)
+```

package/_docs/docs/utils/dialog.md

@@ -1,18 +1,98 @@
-# xxxx xxxx
+# dialog 对话框
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/dialog.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/dialog.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/dialog.js)
+
+继承 `Dialog.create()` 所有特性
+[中文文档](http://www.quasarchs.com/quasar-plugins/dialog) [英文文档](https://quasar.dev/quasar-plugins/dialog)
 :::
 
-### 使用示例
+- 普通示例
 
 ```javascript
+dialog.create({
+    title: '请输入',
+    prompt: {
+        model: '',
+        type: 'text',
+        isValid: $ruleValid('required|min:6|max:20'),
+    },
+    cancel: true,
+    persistent: true,
+})
+    .onOk(function(data) {
 
+    })
 ```
 
+- 调用 vue 路由页面
+
+通过 `path` 参数定义 vue 路由路径来调用路由页面
+
+并且对话框使用的组件是 `<n-dialog>`，可通过 `props` 参数定义该组件的声明属性
+
+```javascript
+dialog.create({
+    // 标题
+    title: '订单明细',
+    // 宽
+    width: '80%',
+    // 关闭底部
+    bottom: false,
+    // 路由路径
+    path: 'order/order/view',
+    // 路由参数
+    query: {
+        // 订单 id
+        id: 123,
+    },
+})
+```
 
-### xxxx 参数
+- 调用自定义组件
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+通过 `name` 参数获取自定义组件
+
+并且对话框使用的组件是 `<n-dialog>`，可通过 `props` 参数定义该组件的声明属性
+
+```javascript
+// 创建对话框
+dialog.create({
+    // 组件标识
+    name: 'packageAddSku',
+    // 标题
+    title: '添加商品',
+    // 宽
+    width: '80%',
+    // 不能通过按 ESC 键关闭对话框
+    noEscDismiss: true,
+    // 不能通过在对话框外单击来关闭对话框
+    noBackdropDismiss: true,
+    // 显示取消按钮
+    cancel: true,
+    // 组件声明参数
+    props: {
+        test: 123,
+    },
+    // 点击确认执行
+    async onConfirm(data) {
+
+        // 验证回调数据
+        const res = $n.validator(data, {
+            // 仓库 id
+            warehouse_id: 'natural',
+            // sku 列表
+            sku_lists: 'array',
+        })
+        if (res) {
+            // 轻提示
+            $n.toast({
+                message: res.msg,
+            })
+            return false
+        }
+        
+        console.log(data)
+    },
+})
+```

package/_docs/docs/utils/dict.md

@@ -1,18 +1,50 @@
-# xxxx xxxx
+# dict 数据字典
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/dict.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/dict.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/dict.js)
 :::
 
-### 使用示例
+- 字典设置
 
 ```javascript
+import { settings } from '@netang/quasar/utils/config'
 
+/**
+ * 配置设置
+ */
+settings({
+    // 用户数据字典
+    userDict: {
+        DICT_STATUS: [
+            ['正常', 1],
+            ['禁用', 0]
+        ],
+        DICT_YESNO: [
+            ['是', 1],
+            ['否', 0]
+        ]
+    },
+})
 ```
 
+- 示例
 
-### xxxx 参数
+```javascript
+dict('DICT_STATUS', 1) // 返回：正常
+
+dict('DICT_YESNO', 100, '无') // 返回： 无
+```
+
+- 类型
+
+```javascript
+dict(key: String, value, defaultValue)
+```
+
+返回字典值对应的文字
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+| 参数名          | 说明   | 类型                  | 默认值 |
+|--------------|------|---------------------|-----|
+| key          | 字典键值 | `String`            | -   |
+| value        | 字典值  | `String` / `Number` | -   |
+| defaultValue | 默认值  | `Any`               | ""  |

package/_docs/docs/utils/dictOptions.md

@@ -1,18 +1,27 @@
-# xxxx xxxx
+# dictOptions 数据字典选项
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/dictOptions.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/dictOptions.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/dictOptions.js)
 :::
 
-### 使用示例
+- 示例
 
 ```javascript
+dictOptions('DICT_STATUS') // 返回：[ { label: '正常', value: 1 }, { label: '禁用', value: 0 } ]
 
+dictOptions('DICT_YESNO', 'title', 'id') // 返回：[ { title: '正常', id: 1 }, { title: '禁用', id: 0 } ]
 ```
 
+- 类型
 
-### xxxx 参数
+```javascript
+dictOptions(key: String, textKey: String, valueKey: String): Array
+```
+
+返回数据字典选项数组
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+| 参数名      | 说明   | 类型       | 默认值   |
+|----------|------|----------|-------|
+| key      | 字典键值 | `String` | -     |
+| labelKey | 标签键值 | `String` | label |
+| valueKey | 值键值  | `String` | value |