@netang/quasar 0.0.94 → 0.0.96

package/_docs/docs/utils/ruleValid.md

@@ -1,18 +1,31 @@
-# xxxx xxxx
+# $ruleValid 表单单个验证
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/$ruleValid.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/%24ruleValid.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/%24ruleValid.js)
+
+单个验证真假规则(用于表单验证)
 :::
 
-### 使用示例
+- 示例
 
 ```javascript
+dialog.create({
+    title: '请输入',
+    prompt: {
+        model: '',
+        type: 'text',
+        isValid: $ruleValid('required|min:6|max:20'),
+    },
+    cancel: true,
+    persistent: true,
+})
+    .onOk(function(data) {
 
+    })
 ```
 
+### options 参数
 
-### xxxx 参数
-
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+| 参数名                  | 说明          | 类型         |
+|----------------------|-------------|------------|
+| rule                 | 验证规则        | `String`   |

package/_docs/docs/utils/symbols.md

@@ -1,18 +1,30 @@
-# xxxx xxxx
+# symbols 内置符号
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/symbols.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/symbols.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/symbols.js)
 :::
 
-### 使用示例
+- 示例
 
 ```javascript
+import { inject } from 'vue'
+import { NRenderKey, NPowerKey, NTableKey, NFormKey, NDialogKey, NUploaderKey } from './symbols'
 
-```
+// 获取渲染组件注入
+inject(NRenderKey)
+
+// 获取权限注入
+inject(NPowerKey)
 
+// 获取表格注入
+inject(NTableKey)
 
-### xxxx 参数
+// 获取表单注入
+inject(NFormKey)
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+// 获取对话框注入
+inject(NDialogKey)
+
+// 获取上传器注入
+inject(NUploaderKey)
+```

package/_docs/docs/utils/table.md

@@ -1,18 +1,195 @@
-# xxxx xxxx
+# $table 表格
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/$table.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/%24table.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/%24table.js)
+
+表格工具
 :::
 
-### 使用示例
+## $table.create
+
+创建表格实例
+
+- 类型
+
+```javascript
+$table.create(options: Object): Object
+```
+
+### options 参数
+
+| 参数名                  | 说明          | 类型         | 可选值                                         | 默认值                                 | 示例  |
+|----------------------|-------------|------------|---------------------------------------------|-------------------------------------|-----|
+| path                 | 路由路径        | `String`   | -                                           | -                                   | -   | 
+| query                | 路由参数        | `Object`   | -                                           | { }                                 | -   | 
+| data                 | 附加请求数据      | `Object`   | -                                           | { }                                 | -   | 
+| rowKey               | 表格行唯一键值     | `String`   | -                                           | id                                  | -   | 
+| selection            | 选择类型        | `String`   | `none` / `single` / `multiple`              | single                              | -   | 
+| separator            | 分隔栏         | `String`   | `horizontal` / `vertical` / `cell` / `none` | cell                                | -   | 
+| selected             | 初始已选数据      | `Array`    | -                                           | [ ]                                 | -   | 
+| loading              | 初始表格加载状态    | `Boolean`  | -                                           | false                               | -   | 
+| columns              | 表格列数据(对象数组) | `Array`    | -                                           | [ ]                                 | -   | 
+| visibleColumns       | 初始可见列       | `Array`    | -                                           | [ ]                                 | -   | 
+| rows                 | 表格行数据       | `Array`    | -                                           | [ ]                                 | -   | 
+| pagination           | 表格翻页参数      | `Object`   | -                                           | -                                   | -   | 
+| rowsPerPageOptions   | 每页显示行数选项    | `Array`    | -                                           | [ 30, 40, 50, 100, 200, 500, 1000 ] | -   | 
+| request              | 自定义请求方法     | `Function` | -                                           | -                                   | -   | 
+| formatRow            | 格式化单条数据     | `Function` | -                                           | -                                   | -   | 
+| httpSettings         | http 设置     | `Object`   | -                                           | -                                   | -   | 
+| search               | 是否开启初始搜素    | `Boolean`  | -                                           | true                                | -   | 
+| summary              | 是否开启合计      | `Boolean`  | -                                           | false                               | -   | 
+| searchFromQuery      | 从参数中获取搜索值   | `Boolean`  | -                                           | true                                | -   | 
+| showGrid             | 是否显示宫格      | `Boolean`  | -                                           | true                                | -   | 
+| showVisibleColumns   | 是否显示可见列     | `Boolean`  | -                                           | true                                | -   | 
+| cache                | 是否开启缓存      | `Boolean`  | -                                           | true                                | -   | 
+| refreshResetSelected | 是否刷新后清空已选数据 | `Boolean`  | -                                           | true                                | -   | 
+| rowClick             | 单击表格行事件     | `Function` | -                                           | -                                   | -   | 
+| rowDblClick          | 双击表格行事件     | `Function` | -                                           | -                                   | -   | 
+
+#### pagination
+
+表格翻页参数
+
+| 参数名         | 说明          | 类型        | 默认值  |
+|-------------|-------------|-----------|------|
+| page        | 页码          | `Number`  | 1    |
+| rowsPerPage | 每页的数据条数     | `Number`  | 30   |
+| rowsNumber  | 数据总数(服务器返回) | `Number`  | 1    |
+| sortBy      | 排序字段        | `String`  | null |
+| descending  | 是否降序排列      | `Boolean` | true |
+
+#### request
+
+格式化表格按钮
+
+```javascript
+// 创建表格实例
+const $table = $n.$table.create({
+
+    // 自定义请求方法
+    async request({ data, props, rows, selected }) {
+        return await $n.http({
+            url: '...',
+            data,
+        })
+    },
+})
+```
+
+| 参数名      | 说明     | 类型       | 示例  |
+|----------|--------|----------|-----|
+| data     | 请求数据   | `Object` | -   |
+| props    | 表格声明属性 | `Array`  | -   |
+| rows     | 表格行数据  | `Array`  | -   |
+| selected | 表格选中数据 | `Array`  | -   |
+
+#### formatRow
+
+格式化单条数据
 
 ```javascript
+// 创建表格实例
+const $table = $n.$table.create({
+    
+    // 格式化单条数据
+    formatRow({ row, rows, selected }) {
+        row.title = '[测试]' + row.title
+    },
+})
+```
+
+| 参数名      | 说明     | 类型       | 示例  |
+|----------|--------|----------|-----|
+| row      | 当前单条数据 | `Object` | -   |
+| rows     | 表格行数据  | `Array`  | -   |
+| selected | 表格已选数据 | `Array`  | -   |
+
+#### rowClick
+
+单击表格行事件
+
+```javascript
+// 创建表格实例
+const $table = $n.$table.create({
+    
+    // 单击表格行事件
+    rowClick(evt, row, index) {
+        
+    },
+})
+```
+
+#### rowDblClick
 
+双击表格行事件
+
+```javascript
+// 创建表格实例
+const $table = $n.$table.create({
+    
+    // 双击表格行事件
+    rowDblClick(evt, row, index) {
+        
+    },
+})
 ```
 
+### 返回数据
+
+返回的数据可提供给 `<q-table>` 使用
+
+| 参数名                     | 说明               | 类型             | 可在 `<q-table>` 组件中使用                             |
+|-------------------------|------------------|----------------|--------------------------------------------------|
+| routeFullPath           | 当前路由全路径          | `String`       | -                                                |
+| routePath               | 当前路由路径           | `String`       | -                                                |
+| routeQuery              | 当前路由参数           | `Object`       | -                                                |
+| getRoute                | 获取当前路由           | `Function`     | -                                                |
+| tableLoading            | 表格加载状态           | `ref(Boolean)` | :loading="tableLoading"                          |
+| tableRowKey             | 表格行唯一键值          | `String`       | :row-key="tableRowKey"                           |
+| tableSelection          | 表格选择类型           | `ref(String)`  | :selection="tableSelection"                      |
+| tableSeparator          | 表格分隔栏            | `ref(String)`  | :separator="tableSeparator"                      |
+| tableRowsPerPageOptions | 表格每页显示行数选项       | `Array`        | :rows-per-page-options="tableRowsPerPageOptions" |
+| tableColumns            | 表格列数据(对象数组)      | `Array`        | :columns="tableColumns"                          |
+| tableVisibleColumns     | 表格可见列            | `ref(Array)`   | :visible-columns="tableVisibleColumns"           |
+| tableRows               | 表格行数据            | `ref(Array)`   | :rows="tableRows"                                |
+| tablePagination         | 表格翻页参数           | `ref(Object)`  | v-model:pagination="tablePagination"             |
+| tableSelected           | 表格已选数据           | `ref(Array)`   | v-model:selected="tableSelected"                 |
+| tableFixedPowerBtns     | 固定在右边的权限按钮列表     | `computed`     | -                                                |
+| showTableFixed          | 是否显示固定在右边的权限按钮列表 | `computed`     | -                                                |
+| tableImgNames           | 表格图片标识           | `ref(Array)`   | 可在插槽中使用                                          |
+| tableGrid               | 表格宫格             | `ref(Boolean)` | :grid="tableGrid"                                |
+| tableSummary            | 表格合计             | `ref(Object)`  | 可在插槽中使用                                          |
+| tableSearchValue        | 表格搜索数据           | `ref(Array)`   | -                                                |
+| tableSearchOptions      | 表格搜索参数           | `ref(Array)`   | -                                                |
+| setQuery                | 设置表格传参           | `Function`     | -                                                |
+| isTableLoaded           | 表格是否已加载          | `Function`     | -                                                |
+| tableLoad               | 表格加载(只加载一次)      | `Function`     | -                                                |
+| tableReload             | 表格重新加载           | `Function`     | -                                                |
+| tableRefresh            | 表格刷新             | `Function`     | -                                                |
+| tableSearchReset        | 表格搜索重置           | `Function`     | -                                                |
+| getTableRequestData     | 获取表格请求数据         | `Function`     | -                                                |
+| tableRequest            | 表格请求数据           | `Function`     | @request="tableRequest"                          |
+| tableRowClick           | 表格单击表格行          | `Function`     | @row-click="tableRowClick"                       |
+| tableRowDblclick        | 表格双击表格行          | `Function`     | @row-dblclick="currentTableRowDblclick"          |
+| setTableSearchOptions   | 设置表格搜索参数         | `Function`     | -                                                |
+
+
+## $table.config
+
+获取表格配置
+
+从 `src/tables` 文件夹中获取路由路径对应的表格配置
+
+- 示例
+
+```javascript
+$table.config(routePath, path, defaultValue)
+```
 
-### xxxx 参数
+### options 参数
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+| 参数名          | 说明              | 类型       | 示例                |
+|--------------|-----------------|----------|-------------------|
+| routePath    | 路由路径            | `String` | goods/goods/index |
+| path         | 配置字段            | `String` | columns           |
+| defaultValue | 默认值（没有获取到配置时显示） | `Any`    | [ ]               |

package/_docs/docs/utils/timestamp.md

@@ -1,18 +1,27 @@
-# xxxx xxxx
+# timestamp 当前时间戳
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/timestamp.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/timestamp.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/timestamp.js)
 :::
 
-### 使用示例
+- 服务器时间同步设置
 
 ```javascript
+import { stateTimeDiff } from '@netang/quasar/store'
 
+// 获取服务器当前时间(秒)
+const serverTime = ...
+
+// 设置当前时间差值 = 当前时间(秒) - 服务器时间(秒)
+stateTimeDiff.value = Math.floor(Date.now() / 1000) - serverTime
 ```
 
+- 示例
 
-### xxxx 参数
+```javascript
+// 获取时间戳（秒）
+timestamp()
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+// 获取时间戳（毫秒）
+timestamp(true)
+```

package/_docs/docs/utils/toast.md

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

package/_docs/docs/utils/tree.md

@@ -1,18 +1,174 @@
-# xxxx xxxx
+# $tree 树
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/$tree.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/%24tree.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/%24tree.js)
+
+树工具
 :::
 
-### 使用示例
+## $tree.create
+
+创建树实例
+
+- 类型
+
+```javascript
+$tree.create(options: Object): Object
+```
+
+### options 参数
+
+| 参数名         | 说明         | 类型            | 默认值   | 示例  |
+|-------------|------------|---------------|-------|-----|
+| $power      | 权限实例       | `Object`      | -     | -   | -   | 
+| path        | 路由路径       | `String`      | -     | -   |
+| path        | 路由路径       | `String`      | -     | -   |
+| query       | 路由参数       | `Object`      | -     | -   |
+| nodes       | 树节点列表      | `ref(Array)`  | -     | -   |
+| expanded    | 树展开节点      | `ref(Array)`  | -     | -   |
+| rawFormData | 原始表单数据     | `Object`      | -     | -   |
+| formData    | 表单数据       | `ref(Object)` | -     | -   |
+| reload      | 重新加载       | `Function`    | -     | -   |
+| cache       | 是否开启展开节点缓存 | `Boolean`     | false | -   |
+
+### 返回数据
+
+| 参数名              | 说明       | 类型         | 示例  |
+|------------------|----------|------------|-----|
+| routeFullPath    | 当前路由全路径  | `String`   | -   |
+| routePath        | 当前路由路径   | `String`   | -   |
+| routeQuery       | 当前路由参数   | `Object`   | -   |
+| getRoute         | 获取当前路由   | `Function` | -   |
+| [getNode](#getnode)         | 获取节点     | `Function` | -   |
+| [updateNode](#updatenode)       | 更新节点     | `Function` | -   |
+| [deleteNode](#deletenode)       | 删除节点     | `Function` | -   |
+| [getMenuStatus](#getmenustatus)    | 获取菜单状态   | `Function` | -   |
+| [menuClick](#menuclick)        | 菜单点击     | `Function` | -   |
+| [getExpandedCache](#getexpandedcache) | 获取展开节点缓存 | `Function` | -   |
+| [setExpandedCache](#setexpandedcache) | 设置展开节点缓存 | `Function` | -   |
+| [expandAll](#expandall)        | 展开全部     | `Function` | -   |
+| [collapseAll](#collapseall)      | 收起全部     | `Function` | -   |
+
+
+#### getNode
+
+获取节点
+
+```javascript
+$tree.getNode(nodeId)
+```
+
+| 参数名    | 说明     | 类型       |
+|--------|--------|----------|
+| nodeId | 树节点 ID | `Number` |
+
+
+#### updateNode
+
+更新节点
+
+```javascript
+$tree.updateNode(data)
+```
+
+| 参数名  | 说明     | 类型       |
+|------|--------|----------|
+| data | 新的表单数据 | `Object` |
+
+
+#### deleteNode
+
+删除节点
+
+```javascript
+$tree.deleteNode(nodeItem)
+```
+
+| 参数名      | 说明    | 类型       |
+|----------|-------|----------|
+| nodeItem | 树节点数据 | `Object` |
+
+
+#### getMenuStatus
+
+获取菜单状态
+
+```javascript
+$tree.getMenuStatus(options)
+```
+
+| 参数名        | 说明   | 类型       | 默认值     |
+|------------|------|----------|---------|
+| updateName | 更新标识 | `String` | update  |
+| moveName   | 移动标识 | `String` | move    |
+| copyName   | 复制标识 | `String` | copy    |
+| deleteName | 删除标识 | `String` | realdel |
+| statusName | 状态标识 | `String` | status  |
+
+#### menuClick
+
+菜单点击
 
 ```javascript
+// 获取菜单状态
+const menuStatus = computed(function() {
+    return $tree.getMenuStatus()
+})
+
+$tree.menuClick({
+    // 菜单类型
+    type: 'update',
+    // 节点
+    node,
+    // 菜单状态
+    menuStatus,
+})
+```
+
+| 参数名        | 说明                                | 类型         | 可选值                                                                                                |
+|------------|-----------------------------------|------------|----------------------------------------------------------------------------------------------------|
+| type       | 菜单类型                              | `String`   | `update` / `moveUp` / `moveIn` / `moveDown` / `copy` / `delete` / `statusDisable` / `statusNormal` |
+| node       | 节点                                | `Object`   | -                                                                                                  |
+| menuStatus | 菜单状态, 可从 $tree.getMenuStatus() 获取 | `computed` | -                                                                                                  |
 
+#### getExpandedCache
+
+获取展开节点缓存
+
+```javascript
+$tree.getExpandedCache(defaultValue): Array
 ```
 
+| 参数名          | 说明  | 类型      | 
+|--------------|-----|---------|
+| defaultValue | 默认值 | `Array` | |
+
 
-### xxxx 参数
+#### setExpandedCache
 
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+设置展开节点缓存
+
+```javascript
+$tree.setExpandedCache(expanded): Array
+```
+
+| 参数名      | 说明     | 类型      | 
+|----------|--------|---------|
+| expanded | 展开节点数组 | `Array` | |
+
+
+#### expandAll
+
+展开全部
+
+```javascript
+$tree.expandAll(): void
+```
+
+#### collapseAll
+
+收起全部
+
+```javascript
+$tree.collapseAll(): void
+```

package/_docs/docs/utils/uploader.md

@@ -1,18 +1,29 @@
-# xxxx xxxx
+# uploader 上传器
 
 ::: tip
-xxxxxxxx
+`@netang/quasar/utils/uploader.js` [Github](https://github.com/netangsoft/netang-quasar/blob/main/utils/uploader.js) [Gitee](https://gitee.com/jinmarcus/netang-quasar/blob/main/utils/uploader.js)
+
+配合组件 [`<n-uploader>`](../components/uploader.md) 使用
 :::
 
-### 使用示例
+- 类型
 
 ```javascript
-
+uploader(options: Object): void
 ```
 
-
-### xxxx 参数
-
-| 参数名   | 类型    | 默认值 | 可选值 | 说明  |
-|-------|-------|-----|-----|-----|
-| xxxxx | xxxxx | -   | -   | -   |
+| 参数名     | 说明  | 类型                 | 可选值 | 默认值 |
+|---------|-----|--------------------|--|-----|
+| fileRef | 上传文件输入框节点  | `ref()` | -  | -    |
+| modelValue | 值  | `String` / `Array` | -  | -    |
+| type | 上传文件类型  | `String` | `file` / `image` / `video` / `audio` |  image   |
+| count | 上传文件数量(0:不限)  | `Number` | - |  0   |
+| maxSize | 单个文件的最大大小(单位: MB) | `Number` | - |  0   |
+| exts | 单个文件的限制后缀 | `Array` | - |  [ ]   |
+| valueArray | 值是否为数组 | `Boolean` | - |  false   |
+| unique | 是否去重 | `Boolean` | - |  false   |
+| loadInfo | 是否初始加载文件信息(仅图片有效, 其他类型自动会加载文件信息) | `Boolean` | - |  false   |
+| confirm | 单文件上传提示 | `Boolean` | - |  false   |
+| uploadFileLists | 上传文件列表 | `ref(Array)` | - |  -   |
+| onUpdateModelValue | 更新值方法(初始化上传列表时不更新值) | `Function` | - |  -   |
+| onUpdate | 更新方法 | `Function` | - |  -   |

package/components/field-table/index.vue

@@ -208,14 +208,14 @@ const {
 export default {
 
     /**
-     * 关闭组件 attribute 透传行为
+     * 标识
      */
-    inheritAttrs: false,
+    name: 'NFieldTable',
 
     /**
-     * 标识
+     * 关闭组件 attribute 透传行为
      */
-    name: 'NFieldTable',
+    inheritAttrs: false,
 
     /**
      * 声明属性
@@ -248,8 +248,6 @@ export default {
 
         // 请求路径
         path: String,
-        // 请求地址(如果为空, 则默认为表格路由地址)
-        url: String,
         // 请求参数
         query: Object,
         // 附加请求数据
@@ -298,7 +296,7 @@ export default {
             default: 500
         },
         // 自定义请求方法
-        onRequest: Function,
+        request: Function,
     },
 
     /**
@@ -402,6 +400,19 @@ export default {
             },
             // 刷新后清空已选数据
             refreshResetSelected: false,
+            // 自定义请求方法
+            async request({ httpOptions }) {
+                return $n_isFunction(props.request) ?
+                    // 如果有自定义请求方法
+                    await $n_runAsync(props.request)({
+                        // http 请求参数
+                        httpOptions,
+                        // 对话框是否已显示
+                        showDialog: showDialog.value,
+                    }) :
+                    // 否则请求数据
+                    await $n_http(httpOptions)
+            },
         })
 
         // 创建睡眠实例
@@ -747,8 +758,8 @@ export default {
         async function onRequestSelected(value) {
 
             // 请求参数
-            const options = {
-                url: props.url ?? $table.routePath,
+            const httpOptions = {
+                url: $table.routePath,
                 data: Object.assign(
                     // 获取表格请求数据
                     $table.getTableRequestData({
@@ -777,16 +788,16 @@ export default {
             }
 
             // 请求数据
-            const { status, data } = $n_isFunction(props.onRequest) ?
+            const { status, data } = $n_isFunction(props.request) ?
                 // 如果有自定义请求方法
-                await $n_runAsync(props.onRequest)({
-                    options,
-                    props,
-                    // 是否在对话框中
-                    inDialog: showDialog.value,
+                await $n_runAsync(props.request)({
+                    // http 请求参数
+                    httpOptions,
+                    // 对话框是否已显示
+                    showDialog: showDialog.value,
                 }) :
                 // 否则请求数据
-                await $n_http(options)
+                await $n_http(httpOptions)
 
             return status && $n_isValidArray($n_get(data, 'rows')) ? data.rows : []
         }