Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

3.0 KB
Raw Blame
import type {
  ColumnDef,
  ColumnFiltersState,
  PaginationState,
  RowSelectionState,
  SortingState,
  Table,
  VisibilityState,
} from '@tanstack/react-table'
import { createContext, ReactNode, useContext, useMemo } from 'react'

import { DataTableFilterField } from '../DataTable.types'
import { RowSelectionModifiers } from '../rowSelection.utils'
import { ResponseError } from '@/types'

// REMINDER: read about how to move controlled state out of the useReactTable hook
// https://github.com/TanStack/table/discussions/4005#discussioncomment-7303569

interface DataTableStateContextType<TSearchParams = unknown> {
  columnFilters: ColumnFiltersState
  sorting: SortingState
  rowSelection: RowSelectionState
  columnOrder: string[]
  columnVisibility: VisibilityState
  pagination: PaginationState
  enableColumnOrdering: boolean
  searchParameters: TSearchParams
  hasPendingFilterChange?: boolean
  openRowId: string | undefined
  setOpenRowId: (id: string | undefined) => void
  onSelectRow?: (id: string, modifiers?: RowSelectionModifiers) => void
}

interface DataTableBaseContextType<TData = unknown, TValue = unknown> {
  table: Table<TData>
  error: ResponseError | null
  filterFields: DataTableFilterField<TData>[]
  columns: ColumnDef<TData, TValue>[]
  isFetching: boolean
  isError: boolean
  isLoading: boolean
  isLoadingCounts: boolean
  getFacetedUniqueValues?: (table: Table<TData>, columnId: string) => Map<string, number>
  getFacetedMinMaxValues?: (table: Table<TData>, columnId: string) => undefined | [number, number]
}

interface DataTableContextType<TData = unknown, TValue = unknown, TSearchParams = unknown>
  extends DataTableStateContextType<TSearchParams>, DataTableBaseContextType<TData, TValue> {}

export const DataTableContext = createContext<DataTableContextType<any, any, any> | null>(null)

export function DataTableProvider<TData, TValue, TSearchParams = unknown>({
  children,
  ...props
}: Partial<DataTableStateContextType<TSearchParams>> &
  DataTableBaseContextType<TData, TValue> & {
    children: ReactNode
  }) {
  const value = useMemo(
    () => ({
      ...props,
      columnFilters: props.columnFilters ?? [],
      sorting: props.sorting ?? [],
      rowSelection: props.rowSelection ?? {},
      columnOrder: props.columnOrder ?? [],
      columnVisibility: props.columnVisibility ?? {},
      pagination: props.pagination ?? { pageIndex: 0, pageSize: 10 },
      enableColumnOrdering: props.enableColumnOrdering ?? false,
      searchParameters: props.searchParameters ?? ({} as any),
      openRowId: props.openRowId,
      setOpenRowId: props.setOpenRowId ?? (() => {}),
    }),
    [props]
  )

  return <DataTableContext.Provider value={value}>{children}</DataTableContext.Provider>
}

export function useDataTable<TData, TValue, TSearchParams = unknown>() {
  const context = useContext(DataTableContext)

  if (!context) {
    throw new Error('useDataTable must be used within a DataTableProvider')
  }

  return context as DataTableContextType<TData, TValue, TSearchParams>
}