Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

feat(pagination): synchronize pagination state in URL for documents list page (#883)

Corentin Thomasset63ddecf4899d
diff --git a/.changeset/cuddly-olives-press.md b/.changeset/cuddly-olives-press.md
new file mode 100644
index 00000000..13de5a27
--- /dev/null
+++ b/.changeset/cuddly-olives-press.md
@@ -0,0 +1,5 @@
+---
+"@papra/app": patch
+---
+
+Synchronized pagination state in the URL on the documents list page.
\ No newline at end of file
diff --git a/apps/papra-client/src/modules/documents/components/documents-list.component.tsx b/apps/papra-client/src/modules/documents/components/documents-list.component.tsx
index 0c450046..7673eb9f 100644
--- a/apps/papra-client/src/modules/documents/components/documents-list.component.tsx
+++ b/apps/papra-client/src/modules/documents/components/documents-list.component.tsx
@@ -1,6 +1,7 @@
import type { ColumnDef } from '@tanstack/solid-table';
import type { Accessor, Component, Setter } from 'solid-js';
import type { Document } from '../documents.types';
+import type { Pagination } from '@/modules/shared/pagination/pagination.types';
import type { Tag } from '@/modules/tags/tags.types';
import { formatBytes } from '@corentinth/chisels';
import { A } from '@solidjs/router';
@@ -21,11 +22,6 @@ import { Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from '@
import { getDocumentIcon, getDocumentNameExtension, getDocumentNameWithoutExtension } from '../document.models';
import { DocumentManagementDropdown } from './document-management-dropdown.component';
-type Pagination = {
- pageIndex: number;
- pageSize: number;
-};
-
export const createdAtColumn: ColumnDef<Document> = {
header: () => {
const { t } = useI18n();
diff --git a/apps/papra-client/src/modules/documents/pages/documents.page.tsx b/apps/papra-client/src/modules/documents/pages/documents.page.tsx
index 66c26c9a..e1305bf4 100644
--- a/apps/papra-client/src/modules/documents/pages/documents.page.tsx
+++ b/apps/papra-client/src/modules/documents/pages/documents.page.tsx
@@ -1,10 +1,11 @@
import type { Component } from 'solid-js';
-import { useParams, useSearchParams } from '@solidjs/router';
+import { useParams } from '@solidjs/router';
import { keepPreviousData, useQuery } from '@tanstack/solid-query';
-import { createEffect, createSignal, Show, Suspense } from 'solid-js';
+import { Show, Suspense } from 'solid-js';
import { useI18n } from '@/modules/i18n/i18n.provider';
+import { createParamSynchronizedPagination } from '@/modules/shared/pagination/query-synchronized-pagination';
+import { createParamSynchronizedSignal } from '@/modules/shared/signals/params';
import { cn } from '@/modules/shared/style/cn';
-import { asSingleParam } from '@/modules/shared/utils/query-params';
import { useDebounce } from '@/modules/shared/utils/timing';
import { Button } from '@/modules/ui/components/button';
import { TextField, TextFieldRoot } from '@/modules/ui/components/textfield';
@@ -15,19 +16,9 @@ import { searchDocuments } from '../documents.services';
export const DocumentsPage: Component = () => {
const params = useParams();
const { t } = useI18n();
- const [searchParams, setSearchParams] = useSearchParams();
- const [getSearchQuery, setSearchQuery] = createSignal<string>(asSingleParam(searchParams.query) ?? '');
+ const [getSearchQuery, setSearchQuery] = createParamSynchronizedSignal<string>({ paramKey: 'query', defaultValue: '' });
const debouncedSearchQuery = useDebounce(getSearchQuery, 300);
- const [getPagination, setPagination] = createSignal({ pageIndex: 0, pageSize: 15 });
-
- const onSearchInput = (query: string) => {
- setSearchQuery(query);
- setSearchParams({ query });
- };
-
- createEffect(() => {
- setSearchQuery(asSingleParam(searchParams.query) ?? '');
- });
+ const [getPagination, setPagination] = createParamSynchronizedPagination();
const documentsQuery = useQuery(() => ({
queryKey: ['organizations', params.organizationId, 'documents', getPagination(), debouncedSearchQuery()],
@@ -70,7 +61,7 @@ export const DocumentsPage: Component = () => {
name="search"
placeholder={t('documents.list.search.placeholder')}
value={getSearchQuery()}
- onInput={e => onSearchInput(e.currentTarget.value)}
+ onInput={e => setSearchQuery(e.currentTarget.value)}
class="pr-9"
autofocus
/>
@@ -82,7 +73,7 @@ export const DocumentsPage: Component = () => {
size="icon"
class="size-6 ml--8"
disabled={documentsQuery.isFetching}
- onClick={() => onSearchInput('')}
+ onClick={() => setSearchQuery('')}
aria-label={documentsQuery.isFetching ? 'Loading' : 'Clear search'}
>
<div
diff --git a/apps/papra-client/src/modules/shared/pagination/pagination.types.ts b/apps/papra-client/src/modules/shared/pagination/pagination.types.ts
new file mode 100644
index 00000000..1a0a7e22
--- /dev/null
+++ b/apps/papra-client/src/modules/shared/pagination/pagination.types.ts
@@ -0,0 +1,4 @@
+export type Pagination = {
+ pageIndex: number;
+ pageSize: number;
+};
diff --git a/apps/papra-client/src/modules/shared/pagination/query-synchronized-pagination.ts b/apps/papra-client/src/modules/shared/pagination/query-synchronized-pagination.ts
new file mode 100644
index 00000000..884ffefc
--- /dev/null
+++ b/apps/papra-client/src/modules/shared/pagination/query-synchronized-pagination.ts
@@ -0,0 +1,40 @@
+import type { Accessor, Setter } from 'solid-js';
+import type { Pagination } from './pagination.types';
+import { useSearchParams } from '@solidjs/router';
+import { resolveSetterValue } from '../signals/setters';
+import { asSingleParam } from '../utils/query-params';
+
+export function createParamSynchronizedPagination({
+ defaultPageIndex = 0,
+ defaultPageSize = 15,
+ pageIndexParamName = 'page',
+ pageSizeParamName = 'pageSize',
+}: {
+ defaultPageIndex?: number;
+ defaultPageSize?: number;
+ pageIndexParamName?: string;
+ pageSizeParamName?: string;
+} = {}) {
+ const [searchParams, setSearchParams] = useSearchParams();
+
+ const getPagination: Accessor<Pagination> = () => {
+ const pageIndex = Number(asSingleParam(searchParams[pageIndexParamName]) ?? defaultPageIndex);
+ const pageSize = Number(asSingleParam(searchParams[pageSizeParamName]) ?? defaultPageSize);
+
+ return { pageIndex, pageSize };
+ };
+
+ const setPagination: Setter<Pagination> = (valueOrUpdater) => {
+ const value = resolveSetterValue(valueOrUpdater, getPagination());
+
+ setSearchParams(
+ {
+ [pageIndexParamName]: value.pageIndex === defaultPageIndex ? undefined : value.pageIndex,
+ [pageSizeParamName]: value.pageSize === defaultPageSize ? undefined : value.pageSize,
+ },
+ { replace: true },
+ );
+ };
+
+ return [getPagination, setPagination] as const;
+}
diff --git a/apps/papra-client/src/modules/shared/signals/params.ts b/apps/papra-client/src/modules/shared/signals/params.ts
new file mode 100644
index 00000000..d8580bb2
--- /dev/null
+++ b/apps/papra-client/src/modules/shared/signals/params.ts
@@ -0,0 +1,40 @@
+import { useSearchParams } from '@solidjs/router';
+import { asSingleParam } from '../utils/query-params';
+import { resolveSetterValue } from './setters';
+
+export function createParamSynchronizedSignal<T extends string | number | boolean>({
+ paramKey,
+ defaultValue,
+ serialize = value => String(value),
+ deserialize = value => value as unknown as T,
+}: {
+ paramKey: string;
+ defaultValue: T;
+ serialize?: (value: T) => string;
+ deserialize?: (value: string) => T;
+}) {
+ const [searchParams, setSearchParams] = useSearchParams();
+
+ const getValue = () => {
+ const paramValue = asSingleParam(searchParams[paramKey]);
+
+ if (paramValue === undefined) {
+ return defaultValue;
+ }
+
+ return deserialize(paramValue);
+ };
+
+ const setValue = (valueOrUpdater: T | ((prevValue: T) => T)) => {
+ const newValue = resolveSetterValue(valueOrUpdater, getValue());
+
+ setSearchParams(
+ {
+ [paramKey]: newValue === defaultValue ? undefined : serialize(newValue),
+ },
+ { replace: true },
+ );
+ };
+
+ return [getValue, setValue] as const;
+}
diff --git a/apps/papra-client/src/modules/shared/signals/setters.test.ts b/apps/papra-client/src/modules/shared/signals/setters.test.ts
new file mode 100644
index 00000000..ea8d0bfa
--- /dev/null
+++ b/apps/papra-client/src/modules/shared/signals/setters.test.ts
@@ -0,0 +1,11 @@
+import { describe, expect, test } from 'vitest';
+import { resolveSetterValue } from './setters';
+
+describe('setters', () => {
+ describe('resolveSetterValue', () => {
+ test('helps resolve a solidjs setter value, which can be either a direct value or an updater function', () => {
+ expect(resolveSetterValue(5, 0)).toBe(5);
+ expect(resolveSetterValue((prev: number) => prev + 1, 5)).toBe(6);
+ });
+ });
+});
diff --git a/apps/papra-client/src/modules/shared/signals/setters.ts b/apps/papra-client/src/modules/shared/signals/setters.ts
new file mode 100644
index 00000000..303328da
--- /dev/null
+++ b/apps/papra-client/src/modules/shared/signals/setters.ts
@@ -0,0 +1,3 @@
+export function resolveSetterValue<T>(valueOrUpdater: T | ((prevValue: T) => T), prevValue: T): T {
+ return typeof valueOrUpdater === 'function' ? (valueOrUpdater as (prevValue: T) => T)(prevValue) : valueOrUpdater;
+}