feat: add function list.reset & list.proxy.reset

Author: cloydlau

README.md

@@ -357,6 +357,23 @@ const { list } = useAdmate()
 list.search() // 手动检索
 ```
 
+#### list.reset
+
+重置筛选条件后执行 `list.read`
+
+```ts
+const { list } = useAdmate()
+
+/**
+ * PS: 以下为原始函数签名，如果你配置了 list.proxy.reset ，则以 list.proxy.reset 为准
+ *
+ * @param {any} [payload = list.filter]
+ * @param {'data'|'params'|'config'} [payloadAs] 指定 payload 的用途
+ * @returns {Promise<any>} 接口返回值
+ */
+list.reset() // 手动重置
+```
+
 #### list.proxy.read
 
 你可以使用 `list.proxy.read` 来代理 `list.read`，以便在 `list.read` 前后做一些操作，或改变 `list.read` 的行为
@@ -430,6 +447,41 @@ const { list } = useAdmate({
 })
 ```
 
+#### list.proxy.reset
+
+你可以使用 `list.proxy.reset` 来代理 `list.reset`，以便在 `list.reset` 前后执行一些操作，或改变 `list.reset` 的行为
+
+```ts
+useAdmate({
+  list: {
+    proxy: {
+      /**
+       * @param {Function} resetList 被代理的原始 resetList
+       */
+      reset(resetList) {},
+    },
+  },
+})
+```
+
+```ts
+// 示例: 使用 UI 组件库的表单重置函数来重置筛选条件
+
+useAdmate({
+  list: {
+    proxy: {
+      reset(resetList) {
+        listFilterElFormRef.value.resetFields()
+        // 如果分页组件不归属于表单，则表单重置时页码不会被重置，需调用 list.search
+        if (!list.watchFilter) {
+          list.search()
+        }
+      },
+    }
+  }
+})
+```
+
 <br>
 
 ### 读取状态

src/index.js

@@ -94,16 +94,17 @@ export default function useAdmate({
         data: [],
         loading: false,
         total: 0,
-        ...userProp?.pageNumberAt && {
-          filter: setValue({}, userProp.pageNumberAt, 1),
-        },
+        filter: setValue({}, userProp?.pageNumberAt, 1),
         watchFilter: true,
         debounceInterval: 300,
+        proxy: {},
       }),
       defaultIsDynamic: true,
     })
 
-  const listExported = reactive(getInitialList())
+  const initialList = getInitialList()
+  const initialListFilter = cloneDeep(initialList.filter)
+  const listExported = reactive(initialList)
 
   const getInitialForm = () =>
     cloneDeep({
@@ -116,6 +117,7 @@ export default function useAdmate({
       loading: false,
       submitting: false,
       title: '',
+      proxy: {},
       ...form,
     })
 
@@ -157,6 +159,13 @@ export default function useAdmate({
       })
   }
 
+  const resetList = (payload, payloadAs) => {
+    listExported.filter = cloneDeep(initialListFilter)
+    if (!listExported.watchFilter) {
+      readList(payload = listExported.filter, payloadAs)
+    }
+  }
+
   let oldPageNumber = 1
 
   listExported.read = (...args) => {
@@ -216,6 +225,21 @@ export default function useAdmate({
     } */
   }
 
+  // 列表重置
+  listExported.reset = (...args) => {
+    // args 是用户直接调用 list.reset 传的参，优先级低
+    // argsProxy 是用户在 list.proxy.reset 内部调用 resetList 传的参，优先级高
+    const result = listExported.proxy.reset
+      ? listExported.proxy.reset(
+        (...argsProxy) => resetList(...(argsProxy.length ? argsProxy : args)),
+      )
+      : resetList(...args)
+
+    readListTrigger.value = undefined
+
+    return result
+  }
+
   // 列表筛选，页码重置
   listExported.search = (...args) => {
     if (getValue(listExported.filter, listExported.pageNumberAt) === 1) {