ChemPare Documentation - v0.0.0
    Preparing search index...

    Interface CustomColumn<TData, TValue>

    Extended column interface with additional metadata support. Used to enhance TanStack Table columns with custom metadata.

    // Example column with range filter metadata
    const column: CustomColumn<Product, number> = {
      id: "price",
      header: "Price",
      accessorKey: "price",
      columnDef: {
        meta: {
          filterVariant: "range",
          rangeValues: [0, 1000]
        }
      }
    };
    interface CustomColumn<TData extends RowData, TValue = unknown> {
        columnDef: { meta?: ColumnMeta<unknown, unknown> };
        getHeaderText?: () => string;
        getVisibleUniqueValues?: () => (string | number)[];
        getAllUniqueValues?: () => (string | number)[];
        getFullRange?: () => [number, number];
        getVisibleRange?: () => [number, number];
        setFilterValueDebounced?: (value: unknown) => void;
        setFilterValueThrottled?: (value: unknown) => void;
        setColumnVisibility?: (visible: boolean) => void;
    }

    Type Parameters

    • TData extends RowData

      The type of data in the table rows

    • TValue = unknown

      The type of value in the column cells

    Hierarchy

    Index

    Properties

    columnDef getHeaderText? getVisibleUniqueValues? getAllUniqueValues? getFullRange? getVisibleRange? setFilterValueDebounced? setFilterValueThrottled? setColumnVisibility?

    Properties

    columnDef: { meta?: ColumnMeta<unknown, unknown> }

    Extended column definition including metadata

    Type declaration

    • Optionalmeta?: ColumnMeta<unknown, unknown>

      Additional column configuration metadata

    getHeaderText?: () => string
    getVisibleUniqueValues?: () => (string | number)[]
    getAllUniqueValues?: () => (string | number)[]
    getFullRange?: () => [number, number]
    getVisibleRange?: () => [number, number]
    setFilterValueDebounced?: (value: unknown) => void
    setFilterValueThrottled?: (value: unknown) => void
    setColumnVisibility?: (visible: boolean) => void

    Settings

    Member Visibility

    On This Page

    Properties