Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for sharing table views via link #168

Merged
merged 4 commits into from
Oct 24, 2023
Merged

Add support for sharing table views via link #168

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2fccfc2
Add support for sharing table views via link
clevelandcs Oct 22, 2023
c1b591b
make url hash always represent current table state
clevelandcs Oct 23, 2023
201665d
merge urlfilter with only url hash
clevelandcs Oct 23, 2023
cf518b1
only update localStorage and hash if table setting differs from default
clevelandcs Oct 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 39 additions & 5 deletions client/src/utils/saveload.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import React from "react";
import { CrudFilter, CrudSort } from "@refinedev/core";
import { isLocalStorageAvailable } from "./support";

interface Pagination {
current: number;
pageSize: number;
Expand All @@ -16,10 +15,10 @@ export interface TableState {

export function useInitialTableState(tableId: string): TableState {
const [initialState] = React.useState(() => {
const savedSorters = isLocalStorageAvailable ? localStorage.getItem(`${tableId}-sorters`) : null;
const savedFilters = isLocalStorageAvailable ? localStorage.getItem(`${tableId}-filters`) : null;
const savedPagination = isLocalStorageAvailable ? localStorage.getItem(`${tableId}-pagination`) : null;
const savedShowColumns = isLocalStorageAvailable ? localStorage.getItem(`${tableId}-showColumns`) : null;
const savedSorters = hasHashProperty(`${tableId}-sorters`) ? getHashProperty(`${tableId}-sorters`) : isLocalStorageAvailable ? localStorage.getItem(`${tableId}-sorters`) : null;
const savedFilters = hasHashProperty(`${tableId}-filters`) ? getHashProperty(`${tableId}-filters`) : isLocalStorageAvailable ? localStorage.getItem(`${tableId}-filters`) : null;
const savedPagination = hasHashProperty(`${tableId}-pagination`) ? getHashProperty(`${tableId}-pagination`) : isLocalStorageAvailable ? localStorage.getItem(`${tableId}-pagination`) : null;
const savedShowColumns = hasHashProperty(`${tableId}-showColumns`) ? getHashProperty(`${tableId}-showColumns`) : isLocalStorageAvailable ? localStorage.getItem(`${tableId}-showColumns`) : null;

const sorters = savedSorters ? JSON.parse(savedSorters) : [{ field: "id", order: "asc" }];
const filters = savedFilters ? JSON.parse(savedFilters) : [];
Expand All @@ -35,28 +34,44 @@ export function useStoreInitialState(tableId: string, state: TableState) {
if (isLocalStorageAvailable) {
localStorage.setItem(`${tableId}-sorters`, JSON.stringify(state.sorters));
}
if (JSON.stringify(state.sorters) != JSON.stringify([{ field: "id", order: "asc" }])) {
updateURLHash(`${tableId}-sorters`, JSON.stringify(state.sorters));
clevelandcs marked this conversation as resolved.
Show resolved Hide resolved
}
}, [tableId, state.sorters]);

React.useEffect(() => {
if (isLocalStorageAvailable) {
localStorage.setItem(`${tableId}-filters`, JSON.stringify(state.filters));
}
if (JSON.stringify(state.filters) != JSON.stringify([])) {
updateURLHash(`${tableId}-filters`, JSON.stringify(state.filters));
}
}, [tableId, state.filters]);

React.useEffect(() => {
if (isLocalStorageAvailable) {
localStorage.setItem(`${tableId}-pagination`, JSON.stringify(state.pagination));
}
if (JSON.stringify(state.pagination) != JSON.stringify({ current: 1, pageSize: 20 })) {
updateURLHash(`${tableId}-pagination`, JSON.stringify(state.pagination));
}

}, [tableId, state.pagination]);

React.useEffect(() => {
if (isLocalStorageAvailable) {
if (state.showColumns === undefined) {
localStorage.removeItem(`${tableId}-showColumns`);
const params = new URLSearchParams(window.location.hash.substring(1));
if (params.has(`${tableId}-showColumns`)) {
params.delete(`${tableId}-showColumns`)
}
window.location.hash = params.toString();
} else {
localStorage.setItem(`${tableId}-showColumns`, JSON.stringify(state.showColumns));
}
}

}, [tableId, state.showColumns]);
}

Expand All @@ -74,3 +89,22 @@ export function useSavedState<T>(id: string, defaultValue: T) {

return [state, setState] as const;
}

export function updateURLHash(Id: string, value: string) {
const params = new URLSearchParams(window.location.hash.substring(1));
if (!params.has(Id)) {
params.append(Id, value)
}
params.set(Id, value);
window.location.hash = params.toString();
}

function getHashProperty(Id: string) {
const hash = new URLSearchParams(window.location.hash.substring(1));
return hash.get(Id);
}

function hasHashProperty(property: string): boolean {
const hash = new URLSearchParams(window.location.hash.substring(1));
return hash.has(property);
}