Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

1.8 KB
Raw Blame
import type {
  ColumnDef,
  PaginationState,
  VisibilityState,
} from '@tanstack/react-table';
import { parseAsInteger, useQueryState } from 'nuqs';
import { useEffect } from 'react';
import { useLocalStorage, useReadLocalStorage } from 'usehooks-ts';

export const useDataTablePagination = (pageSize = 10) => {
  const [page, setPage] = useQueryState(
    'page',
    parseAsInteger.withDefault(1).withOptions({
      clearOnDefault: true,
      history: 'push',
    })
  );
  const state: PaginationState = {
    pageIndex: page - 1,
    pageSize,
  };
  return { page, setPage, state };
};

export const useReadColumnVisibility = (persistentKey: string) => {
  return useReadLocalStorage<Record<string, boolean>>(
    `@op:${persistentKey}-column-visibility`
  );
};

export const useDataTableColumnVisibility = <TData,>(
  columns: ColumnDef<TData>[],
  persistentKey: string
) => {
  const [columnVisibility, setColumnVisibility] = useLocalStorage<
    Record<string, boolean>
  >(
    `@op:${persistentKey}-column-visibility`,
    columns.reduce((acc, column) => {
      // Use accessorKey as fallback if id is not provided
      const columnId = column.id || (column as any).accessorKey;
      if (columnId) {
        acc[columnId] =
          typeof column.meta?.hidden === 'boolean'
            ? !column.meta?.hidden
            : true;
      }
      return acc;
    }, {} as VisibilityState)
  );

  // somewhat hack
  // Set initial column visibility,
  // otherwise will not useReadColumnVisibility be updated
  useEffect(() => {
    setColumnVisibility(columnVisibility);
  }, []);

  const [columnOrder, setColumnOrder] = useLocalStorage<string[]>(
    `@op:${persistentKey}-column-order`,
    columns.map((column) => column.id!)
  );

  return { columnVisibility, setColumnVisibility, columnOrder, setColumnOrder };
};