Skip to content

Modern Docker Management, Designed for Everyone

feat: persistent table filters, page size, and column headers (#449)

Kyle Mendella7a899a7fb4e
diff --git a/frontend/src/lib/components/arcane-table/arcane-table.svelte b/frontend/src/lib/components/arcane-table/arcane-table.svelte
index 2125e9165..b086c6f2f 100644
--- a/frontend/src/lib/components/arcane-table/arcane-table.svelte
+++ b/frontend/src/lib/components/arcane-table/arcane-table.svelte
@@ -33,9 +33,17 @@
import { cn } from '$lib/utils.js';
import type { Paginated, SearchPaginationSortRequest } from '$lib/types/pagination.type';
import type { Snippet } from 'svelte';
- import type { ColumnSpec } from './arcane-table.types';
+ import type { ColumnSpec } from './arcane-table.types.svelte';
import TableCheckbox from './arcane-table-checkbox.svelte';
import { m } from '$lib/paraglide/messages';
+ import { PersistedState } from 'runed';
+ import {
+ type CompactTablePrefs,
+ encodeHidden,
+ applyHiddenPatch,
+ encodeFilters,
+ decodeFilters
+ } from './arcane-table.types.svelte';
let {
items,
@@ -47,7 +55,8 @@
columns,
rowActions,
selectedIds = $bindable<string[]>([]),
- onRemoveSelected
+ onRemoveSelected,
+ persistKey
}: {
items: Paginated<TData>;
requestOptions: SearchPaginationSortRequest;
@@ -59,6 +68,7 @@
rowActions?: Snippet<[{ row: Row<TData>; item: TData }]>;
selectedIds?: string[];
onRemoveSelected?: (ids: string[]) => void;
+ persistKey?: string;
} = $props();
let rowSelection = $state<RowSelectionState>({});
@@ -67,6 +77,17 @@
let sorting = $state<SortingState>([]);
let globalFilter = $state<string>('');
+ const enablePersist = !!persistKey;
+
+ const getDefaultLimit = () => requestOptions?.pagination?.limit ?? items?.pagination?.itemsPerPage ?? 20;
+ const prefs = enablePersist
+ ? new PersistedState<CompactTablePrefs>(
+ persistKey as string,
+ { v: [], f: [], g: '', l: getDefaultLimit() },
+ { syncTabs: false }
+ )
+ : null;
+
const passAllGlobal: (row: unknown, columnId: string, filterValue: unknown) => boolean = () => true;
const currentPage = $derived(items.pagination.currentPage ?? requestOptions?.pagination?.page ?? 1);
@@ -76,6 +97,37 @@
const canPrev = $derived(currentPage > 1);
const canNext = $derived(currentPage < totalPages);
+ // Apply persisted state on mount
+ import { onMount } from 'svelte';
+ onMount(() => {
+ if (!enablePersist) return;
+ const cur = prefs?.current ?? { v: [], f: [], g: '', l: getDefaultLimit() };
+
+ applyHiddenPatch(columnVisibility, cur.v);
+
+ // Filters
+ let shouldRefresh = false;
+ const restoredFilters = decodeFilters(cur.f);
+ if (restoredFilters.length) columnFilters = restoredFilters;
+ if (cur.g && cur.g !== globalFilter) {
+ globalFilter = cur.g;
+ requestOptions = {
+ ...requestOptions,
+ search: cur.g,
+ pagination: { page: 1, limit: requestOptions?.pagination?.limit ?? getDefaultLimit() }
+ };
+ shouldRefresh = true;
+ }
+ // Page size
+ const persistedLimit = cur.l ?? getDefaultLimit();
+ const currentLimit = requestOptions?.pagination?.limit ?? getDefaultLimit();
+ if (persistedLimit !== currentLimit) {
+ requestOptions = { ...requestOptions, pagination: { page: 1, limit: persistedLimit } };
+ shouldRefresh = true;
+ }
+ if (shouldRefresh) onRefresh(requestOptions);
+ });
+
function updatePagination(patch: Partial<{ page: number; limit: number }>) {
const prev = requestOptions?.pagination ?? {
page: items?.pagination?.currentPage ?? 1,
@@ -93,6 +145,8 @@
}
function setPageSize(limit: number) {
+ // Persist page size
+ if (enablePersist && prefs) prefs.current = { ...prefs.current, l: limit };
updatePagination({ limit, page: 1 });
}
@@ -245,9 +299,17 @@
},
onColumnFiltersChange: (updater) => {
columnFilters = typeof updater === 'function' ? updater(columnFilters) : updater;
+ // Persist column filters
+ if (enablePersist && prefs) {
+ prefs.current = { ...prefs.current, f: encodeFilters(columnFilters) };
+ }
},
onColumnVisibilityChange: (updater) => {
columnVisibility = typeof updater === 'function' ? updater(columnVisibility) : updater;
+ // Persist visibility
+ if (enablePersist && prefs) {
+ prefs.current = { ...prefs.current, v: encodeHidden(columnVisibility) };
+ }
},
onGlobalFilterChange: (value) => {
globalFilter = (value ?? '') as string;
@@ -257,6 +319,10 @@
search: globalFilter,
pagination: { page: 1, limit }
};
+ // Persist global filter
+ if (enablePersist && prefs) {
+ prefs.current = { ...prefs.current, g: globalFilter };
+ }
onRefresh(requestOptions);
},
getCoreRowModel: getCoreRowModel(),
diff --git a/frontend/src/lib/components/arcane-table/arcane-table.types.svelte.ts b/frontend/src/lib/components/arcane-table/arcane-table.types.svelte.ts
new file mode 100644
index 000000000..3f60f41d2
--- /dev/null
+++ b/frontend/src/lib/components/arcane-table/arcane-table.types.svelte.ts
@@ -0,0 +1,51 @@
+import type { Row, Column, FilterFn, ColumnFiltersState, VisibilityState } from '@tanstack/table-core';
+import type { Snippet } from 'svelte';
+
+export type ColumnSpec<T> = {
+ accessorKey?: keyof T & string;
+ accessorFn?: (row: T) => any;
+ id?: string;
+ title: string;
+ hidden?: boolean;
+ sortable?: boolean;
+ cell?: Snippet<[{ row: Row<T>; item: T; value: unknown }]>;
+ header?: Snippet<[{ column: Column<T>; title: string; class?: string }]>;
+ class?: string;
+ filterFn?: FilterFn<T>;
+};
+
+// Compact persisted prefs to reduce JSON size
+export type CompactTablePrefs = {
+ // v: list of hidden column ids (only the exceptions)
+ v?: string[];
+ // f: filters as [id, value] tuples
+ f?: [string, unknown][];
+ // g: global filter string
+ g?: string;
+ // l: page size (limit)
+ l?: number;
+};
+
+export function encodeHidden(visibility: VisibilityState): string[] {
+ const hidden: string[] = [];
+ for (const [id, visible] of Object.entries(visibility)) {
+ if (visible === false) hidden.push(id);
+ }
+ return hidden;
+}
+
+export function applyHiddenPatch(target: VisibilityState, hidden?: string[]) {
+ if (!hidden?.length) return;
+ for (const id of hidden) {
+ target[id] = false;
+ }
+}
+
+export function encodeFilters(filters: ColumnFiltersState): [string, unknown][] {
+ return (filters ?? []).map((f) => [f.id, (f as any).value] as [string, unknown]);
+}
+
+export function decodeFilters(pairs?: [string, unknown][]): ColumnFiltersState {
+ if (!pairs?.length) return [];
+ return pairs.map(([id, value]) => ({ id, value }));
+}
diff --git a/frontend/src/lib/components/arcane-table/arcane-table.types.ts b/frontend/src/lib/components/arcane-table/arcane-table.types.ts
deleted file mode 100644
index c4aaaf843..000000000
--- a/frontend/src/lib/components/arcane-table/arcane-table.types.ts
+++ /dev/null
@@ -1,15 +0,0 @@
-import type { Row, Column, FilterFn } from '@tanstack/table-core';
-import type { Snippet } from 'svelte';
-
-export type ColumnSpec<T> = {
- accessorKey?: keyof T & string;
- accessorFn?: (row: T) => any;
- id?: string;
- title: string;
- hidden?: boolean;
- sortable?: boolean;
- cell?: Snippet<[{ row: Row<T>; item: T; value: unknown }]>;
- header?: Snippet<[{ column: Column<T>; title: string; class?: string }]>;
- class?: string;
- filterFn?: FilterFn<T>;
-};
diff --git a/frontend/src/lib/components/arcane-table/index.ts b/frontend/src/lib/components/arcane-table/index.ts
index 7f7a22d72..96cf94ed5 100644
--- a/frontend/src/lib/components/arcane-table/index.ts
+++ b/frontend/src/lib/components/arcane-table/index.ts
@@ -1,4 +1,4 @@
export { default as DataTableToolbar } from './arcane-table-toolbar.svelte';
export { default as DataTableViewOptions } from './arcane-table-view-options.svelte';
export { default as DataTableFacetedFilter } from './arcane-table-filter.svelte';
-export type { ColumnSpec } from './arcane-table.types';
+export type { ColumnSpec } from './arcane-table.types.svelte';
diff --git a/frontend/src/routes/compose/compose-table.svelte b/frontend/src/routes/compose/compose-table.svelte
index 871e103e1..60e763ea5 100644
--- a/frontend/src/routes/compose/compose-table.svelte
+++ b/frontend/src/routes/compose/compose-table.svelte
@@ -237,6 +237,7 @@
<Card.Root>
<Card.Content class="py-5">
<ArcaneTable
+ persistKey="arcane-project-table"
items={projects}
bind:requestOptions
bind:selectedIds
diff --git a/frontend/src/routes/containers/container-table.svelte b/frontend/src/routes/containers/container-table.svelte
index 898ad78f5..35d11733d 100644
--- a/frontend/src/routes/containers/container-table.svelte
+++ b/frontend/src/routes/containers/container-table.svelte
@@ -230,6 +230,7 @@
<Card.Root class="border shadow-sm">
<Card.Content>
<ArcaneTable
+ persistKey="arcane-container-table"
items={containers}
bind:requestOptions
bind:selectedIds
diff --git a/frontend/src/routes/images/+page.svelte b/frontend/src/routes/images/+page.svelte
index a6dd70660..1906161bc 100644
--- a/frontend/src/routes/images/+page.svelte
+++ b/frontend/src/routes/images/+page.svelte
@@ -12,7 +12,7 @@
import { ArcaneButton } from '$lib/components/arcane-button/index.js';
import { environmentAPI } from '$lib/services/api';
import StatCard from '$lib/components/stat-card.svelte';
- import ImageTableNew from './image-table.svelte';
+ import ImageTable from './image-table.svelte';
import { m } from '$lib/paraglide/messages';
let { data } = $props();
@@ -122,7 +122,7 @@
class="border-l-4 border-l-amber-500"
/>
</div>
- <ImageTableNew bind:images bind:selectedIds bind:requestOptions />
+ <ImageTable bind:images bind:selectedIds bind:requestOptions />
<ImagePullSheet
bind:open={isPullDialogOpen}
diff --git a/frontend/src/routes/images/image-table.svelte b/frontend/src/routes/images/image-table.svelte
index 988726d27..7cef20eb2 100644
--- a/frontend/src/routes/images/image-table.svelte
+++ b/frontend/src/routes/images/image-table.svelte
@@ -256,6 +256,7 @@
<Card.Root>
<Card.Content class="py-5">
<ArcaneTable
+ persistKey="arcane-image-table"
items={images}
bind:requestOptions
bind:selectedIds
diff --git a/frontend/src/routes/networks/network-table.svelte b/frontend/src/routes/networks/network-table.svelte
index ca662fedb..f45745cf5 100644
--- a/frontend/src/routes/networks/network-table.svelte
+++ b/frontend/src/routes/networks/network-table.svelte
@@ -200,6 +200,7 @@
<Card.Root>
<Card.Content class="py-5">
<ArcaneTable
+ persistKey="arcane-networks-table"
items={networks}
bind:requestOptions
bind:selectedIds
diff --git a/frontend/src/routes/volumes/volume-table.svelte b/frontend/src/routes/volumes/volume-table.svelte
index bb64f8177..8db261770 100644
--- a/frontend/src/routes/volumes/volume-table.svelte
+++ b/frontend/src/routes/volumes/volume-table.svelte
@@ -162,6 +162,7 @@
<Card.Root>
<Card.Content class="py-5">
<ArcaneTable
+ persistKey="arcane-volumes-table"
items={volumes}
bind:requestOptions
bind:selectedIds