Skip to content

Persist DataTable column visibility in localStorage #61202

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

Open
sanchalitorpe-source wants to merge 2 commits into
base: main
Choose a base branch
from
+22 −2
Open

Persist DataTable column visibility in localStorage #61202

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e370eb
Persist DataTable column visibility in localStorage
sanchalitorpe-source Jan 27, 2026
d2ba86a
Merge branch 'main' into persist-datatable-column-visibility
sanchalitorpe-source Jan 29, 2026
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
24 changes: 22 additions & 2 deletions airflow-core/src/airflow/ui/src/components/DataTable/DataTable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,14 @@ import { ToggleTableDisplay } from "src/components/DataTable/ToggleTableDisplay"
import { createSkeletonMock } from "src/components/DataTable/skeleton";
import type { CardDef, MetaColumn, TableState } from "src/components/DataTable/types";
import { ProgressBar, Pagination, Toaster } from "src/components/ui";

const loadFromStorage = <T,>(key: string, fallback: T): T => {
try {
const raw = localStorage.getItem(key);
return raw ? JSON.parse(raw) : fallback;
} catch {
return fallback;
}
};
type DataTableProps<TData> = {
readonly allowFiltering?: boolean;
readonly cardDef?: CardDef<TData>;
Expand Down Expand Up @@ -83,6 +90,7 @@ export const DataTable = <TData,>({
skeletonCount = 10,
total = 0,
}: DataTableProps<TData>) => {
const storageKey = `airflow.datatable.${modelName}`;
"use no memo"; // remove if https://github.com/TanStack/table/issues/5567 is resolved

const { t: translate } = useTranslation(["common"]);
Expand All @@ -109,9 +117,21 @@ export const DataTable = <TData,>({
[onStateChange],
);

const [columnVisibility, setColumnVisibility] = useState<VisibilityState>(
const [columnVisibility, setColumnVisibility] = useState<VisibilityState>(() =>
loadFromStorage(
`${storageKey}.columnVisibility`,
initialState?.columnVisibility ?? {},
),
);

useEffect(() => {

localStorage.setItem(
`${storageKey}.columnVisibility`,
JSON.stringify(columnVisibility),
);
}, [columnVisibility, storageKey]);


const rest = Boolean(isLoading) ? createSkeletonMock(displayMode, skeletonCount, columns) : {};

Expand Down