feat: usePagination adds default parameter defaultPage (alibaba#1777)

* feat: usePagination add deafultPage * test: add test case * fix: defaultPage -> defaultCurrent * fix: remove pnpm-lock change * fix: text case
beriny · Aug 1, 2022 · 975dfb4 · 975dfb4
1 parent d3f39de
commit 975dfb4
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 2 deletions.
diff --git a/packages/hooks/src/usePagination/__tests__/index.test.ts b/packages/hooks/src/usePagination/__tests__/index.test.ts
@@ -128,4 +128,35 @@ describe('usePagination', () => {
     expect(hook.result.current.pagination.current).toEqual(1);
     expect(hook.result.current.pagination.pageSize).toEqual(20);
   });
+
+  it('should default params work', async () => {
+    queryArgs = undefined;
+    act(() => {
+      hook = setUp(asyncFn, {
+        defaultPageSize: 5,
+        defaultCurrent: 2,
+      });
+    });
+    expect(hook.result.current.loading).toEqual(true);
+    expect(queryArgs.current).toEqual(2);
+    expect(queryArgs.pageSize).toEqual(5);
+    await hook.waitForNextUpdate();
+
+    expect(hook.result.current.loading).toEqual(false);
+
+    expect(hook.result.current.pagination.current).toEqual(2);
+    expect(hook.result.current.pagination.pageSize).toEqual(5);
+    expect(hook.result.current.pagination.total).toEqual(55);
+    expect(hook.result.current.pagination.totalPage).toEqual(11);
+
+    act(() => {
+      hook.result.current.pagination.changeCurrent(3);
+    });
+    expect(hook.result.current.loading).toEqual(true);
+    expect(queryArgs.current).toEqual(3);
+    expect(queryArgs.pageSize).toEqual(5);
+    await hook.waitForNextUpdate();
+    expect(hook.result.current.pagination.current).toEqual(3);
+    expect(hook.result.current.pagination.pageSize).toEqual(5);
+  });
 });
diff --git a/packages/hooks/src/usePagination/index.en-US.md b/packages/hooks/src/usePagination/index.en-US.md
@@ -79,4 +79,5 @@ const {
 | Property        | Description                                                                                                                                      | Type                   | Default |
 | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------- | ------- |
 | defaultPageSize | Default page size                                                                                                                                | `number`               | -       |
+| defaultCurrent  | Number of pages on initial request                                                                                                               | `number`               | -       |
 | refreshDeps     | Changes in `refreshDeps` will reset current to the first page and re-initiate the request. Generally, you can put the dependent conditions here. | `React.DependencyList` | `[]`    |
diff --git a/packages/hooks/src/usePagination/index.ts b/packages/hooks/src/usePagination/index.ts
@@ -8,10 +8,10 @@ const usePagination = <TData extends Data, TParams extends Params>(
   service: Service<TData, TParams>,
   options: PaginationOptions<TData, TParams> = {},
 ) => {
-  const { defaultPageSize = 10, ...rest } = options;
+  const { defaultPageSize = 10, defaultCurrent = 1, ...rest } = options;
 
   const result = useRequest(service, {
-    defaultParams: [{ current: 1, pageSize: defaultPageSize }],
+    defaultParams: [{ current: defaultCurrent, pageSize: defaultPageSize }],
     refreshDepsAction: () => {
       // eslint-disable-next-line @typescript-eslint/no-use-before-define
       changeCurrent(1);

diff --git a/packages/hooks/src/usePagination/index.zh-CN.md b/packages/hooks/src/usePagination/index.zh-CN.md
@@ -79,4 +79,5 @@ const {
 | 参数            | 说明                                                                                        | 类型                   | 默认值 |
 | --------------- | ------------------------------------------------------------------------------------------- | ---------------------- | ------ |
 | defaultPageSize | 默认分页数量                                                                                | `number`               | -      |
+| defaultCurrent  | 初次请求时的页数                                                                            | `number`               | -      |
 | refreshDeps     | `refreshDeps` 变化，会重置 current 到第一页，并重新发起请求，一般你可以把依赖的条件放这里。 | `React.DependencyList` | `[]`   |
diff --git a/packages/hooks/src/usePagination/types.ts b/packages/hooks/src/usePagination/types.ts
@@ -24,4 +24,5 @@ export interface PaginationResult<TData extends Data, TParams extends Params>
 export interface PaginationOptions<TData extends Data, TParams extends Params>
   extends Options<TData, TParams> {
   defaultPageSize?: number;
+  defaultCurrent?: number;
 }