table: ColumnDef types gives typescript error

Describe the bug

Looking at the examples and docs I expect this to correctly type my columns for me. Instead I get a large error with this code:

  type Example = {
    name: string
    age: number
  }

  const columnHelper = createColumnHelper<Example>()

  const columns = useMemo<ColumnDef<Example>[]>(
    () => [
      columnHelper.accessor("name", {
        cell: (info) => info.getValue(),
      }),
      columnHelper.accessor("age", {
        cell: (info) => info.getValue(),
      }),
    ],
    [columnHelper],
  )
bild

Am I doing something wrong here?

Regards Jonathan

Your minimal, reproducible example

https://codesandbox.io/s/typescript-playground-export-forked-iqm265?file=/index.tsx

Steps to reproduce

  1. Create a type with two different types, string and name for example.
  2. Use the createColumnHelper with the type
  3. Define columns with columnHelper and type them with ColumnDef<type>

Expected behavior

I expected the Columdef to correctly type my columns.

How often does this bug happen?

Every time

Screenshots or Videos

bild

Platform

Mac OS

react-table version

v8.5.13

TypeScript version

v4.8.2

Additional context

No response

Terms & Code of Conduct

  • I agree to follow this project’s Code of Conduct
  • I understand that if my bug cannot be reliable reproduced in a debuggable environment, it will probably not be fixed and this issue may even be closed.

About this issue

  • Original URL
  • State: open
  • Created 4 years ago
  • Reactions: 74
  • Comments: 61 (2 by maintainers)

Commits related to this issue

Most upvoted comments

Getting the same here, trying to convince our team to migrate to @tanstack/react-table and this is certainly getting in the way of that. I’ve defined columns as such: (nothing revolutionary)

  const columnHelper = createColumnHelper<Coffee>();

  const columns = [
    columnHelper.accessor(data => data.id, {
      id: 'id',
      cell: info => info.getValue()
    })
  ];

and have typed my generic table component as:

interface TableProps<T extends object> {
  data: T[];
  columns: ColumnDef<T>[];
}

export default function index<T extends object>({ columns, data }: TableProps<T>) {
  const table = useReactTable({
    data,
    columns,
    getCoreRowModel: getCoreRowModel()
  });

(...)

But am then getting the following Type Error when passing my columns as a prop:

        Property 'accessorFn' is missing in type 'ColumnDefBase<Coffee, number> & StringHeaderIdentifier' but required in type 'AccessorFnColumnDefBase<Coffee, unknown>'.ts(2322)
types.d.ts(83, 5): 'accessorFn' is declared here.
index.tsx(6, 3): The expected type comes from property 'columns' which is declared here on type 'IntrinsicAttributes & TableProps<Coffee>'

Any advice is appreciated

react-table version: 8.10.7 @types/react-table version: 7.7.18

Hey @tannerlinsley 👋 I there any update on “any” type issue? It seems this issue is dead without being resolved for long time than I would expect. Should I open separated issue instead? We really love this library but having proper type instead of any would really help us.

I am having the same issue here. Is there a way to avoid typing any?

type Props<T> = {
  data: T[];
  columns: ColumnDef<T, any>[];
};

Still facing this issue

A common but subtly incorrect approach^1 to define the component properties of a table is:

interface DataTableProps<TData, TValue> {
  columns: ColumnDef<TData, TValue>[]
  data: TData[]
}
 
export function DataTable<TData, TValue>({
  columns,
  data,
}: DataTableProps<TData, TValue>) {
  ...
}

When using createColumnHelper, since TValue depends on which column is being accessed, columns: ColumnDef<TData, TValue>[] is not specific enough to satisfy the constraints imposed by createColumnHelper.

The following approach passes typechecking without the use of any:

interface DataTableProps<TData> {
  columns: {
    [K in keyof TData]: ColumnDef<TData, TData[K]>;
  }[keyof TData][];
  data: TData[];
}

export function DataTable<TData>({
  columns,
  data,
}: DataTableProps<TData>) {
  ...
}

It’s not particularly readable, but it will satisfy your linter!

Pre-typing would be helpful for public interfaces e.g. if we create a wrapper components with columns and data props. I am using this here right now:

interface DataTableProps {
  // FIXME: Can we figure out something more type restrictive which actually works?
  data: unknown[]
  columns: ColumnDef<any, any>[];
}

That makes TypeScript “happy”… but I would prefer something more strict.

I guess I was looking for a typed CustomTableComponent example which uses TanStack/Table underneath.

I am having the same issue here. Is there a way to avoid typing any?

type Props<T> = {
  data: T[];
  columns: ColumnDef<T, any>[];
};

It becomes an issue when passing columns to a component as a prop.

We skipped using columnDef, it still works as good and gives type help.

  const columns = [
      columnHelper.accessor("name", {
        cell: (info) => info.getValue(),
      }),
      columnHelper.accessor("age", {
        cell: (info) => info.getValue(),
      }),
    ]

Any updates? Two years have already passed

Bump.

You should only be using the column helper and not pre-typing anything.

I thought I was going crazy, followed the docs to a T, defined some straightforward columns, but can’t make a generic table component and pass the columns to them with type safety for the life of me. Glad to see I’m not alone I guess.

Pre-typing would be helpful for public interfaces e.g. if we create a wrapper components with columns and data props. I am using this here right now:

This! We’re making a custom MyTableComponent and expose columns as prop that is pre-typed.

This is the way.

Fix mentioned by @jack-davies works almost all the time. The only problem is data with optional fields.

Adding Required fixes it.

interface DataTableProps<TData> {
  columns: {
    [K in keyof Required<TData>]: ColumnDef<TData, TData[K]>;
  }[keyof TData][];
  data: TData[];
}

It removes undefined from DataTableProps['columns'] type which finally satisfies ColumnDef<TData, any>[] from TableOptions<TData>['columns']

Hello, I am still facing the same issue on 8.15.0 and 8.15.3. I am following the shadcn example (Preview / Code) Can’t make it work with

const columns: ColumnDef<Task, any>[] = [

nor

const columns: ColumnDef<Task>[] = [

I am still getting the following error:

Type 'ColumnDef<Task, any>[]' is not assignable to type 'ColumnDef<unknown, any>[]'.
  Type 'ColumnDef<Task, any>' is not assignable to type 'ColumnDef<unknown, any>'.
    Type 'ColumnDefBase<Task, any> & StringHeaderIdentifier' is not assignable to type 'ColumnDef<unknown, any>'.
      Type 'ColumnDefBase<Task, any> & StringHeaderIdentifier' is not assignable to type 'AccessorFnColumnDefBase<unknown, any> & IdIdentifier<unknown, any>'.
        Property 'accessorFn' is missing in type 'ColumnDefBase<Task, any> & StringHeaderIdentifier' but required in type 'AccessorFnColumnDefBase<unknown, any>'.

The only workaround I use for now is:

columns: columns as ColumnDef<unknown>[],

still waiting for the official fix lol

@tannerlinsley if you’re saying @Jontii 's solution is the right way, you might want to change the Column Defs page in the docs to not use a column helper and a typed array. That is what you’re saying right, either use one or the other?

If you are still looking for a solution I managed to dodge the typescript type issue by exporting the columns like this:

columns.tsx

const columnHelper = createColumnHelper<MyModel>();

const proxyColumns = [
   // All your columns with 100% type safety
   columnHelper.display({
    id: "actions",
    header: () => <SearchBar />,
    cell: ({ row }) => <Actions data={row.original} />,
  }),
   ...
];

export const columns = proxyColumns as ColumnDef<MyModel>[];

This way you are not loosing types when defining the columns.

I solved it by using a type assertion.

<DataTable columns={columns as ColumnDef<YourDataType | null, any>[]} data={balanceData}></DataTable>

It may not be a proper solution, but it works for me.

Any progress here? Going to have to drop react-table if this isn’t fixed, unfortunately.

That’s very excessive, just put any for the second argument and it’ll still work really well.

Waiting for the solution to this issue too.

Only way I’ve found to get around this is to add a as string or some other primitive type after info.getValue()

Any updates how to fix correct?

@4ndrs That’s what I did previously, it’s not ideal but it work’s perfectly fine tbh.

This is my demo from what I created a tanstack table at my last role, see this

I wish people would stop spamming this thread 😆 There a good few answers here now, give them a go and see if any of them help you out.

@tannerlinsley and all the other maintainers/typescript wizards have done an incredible job with this library especially after it got a massive upgrade in ❤️ It’s really difficult to get this sort stuff right so I’m sure in this particular case an “any” or “unknown” cast will do the trick everything else works great last time I checked.

I’m going to unsubscribe from this thread as I keep getting emails about it 🤣

@RestartDK

I have been using the any approach when defining my table props:

// table component
type Props<T> = {
  data: T[];
  columns: ColumnDef<T, any>[];
};
// when using the table component

const columnHelper = createColumnHelper<Vehicle>();

const columns = [
  columnHelper.accessor("brand", {
    header: "Marca",
  }),
  columnHelper.accessor("model", {
    header: "Modello",
  }),
]

const Testing = () => {
  const vehicles = useVehicles();

  return (
      <Table data={vehicles} columns={columns} />
  );
};

I haven’t had any issues with inference or missing types so far.

@tanstack/react-table: “^8.15.3”

I had something similar to this when I tried to pass the columns and define them between components

Type 'PostColumn[]' is not assignable to type 'ColumnDef<Record<string, unknown>, unknown>[]'.
  Type 'PostColumn' is not assignable to type 'ColumnDef<Record<string, unknown>, unknown>'.
    Type 'ColumnDefBase<Post, unknown> & StringHeaderIdentifier' is not assignable to type 'ColumnDef<Record<string, unknown>, unknown>'.
      Type 'ColumnDefBase<Post, unknown> & StringHeaderIdentifier' is not assignable to type 'AccessorFnColumnDefBase<Record<string, unknown>, unknown> & IdIdentifier<Record<string, unknown>, unknown>'.
        Property 'accessorFn' is missing in type 'ColumnDefBase<Post, unknown> & StringHeaderIdentifier' but required in type 'AccessorFnColumnDefBase<Record<string, unknown>, unknown>'.ts(2322)
types.d.ts(98, 5): 'accessorFn' is declared here.
index.jsx(26, 2): The expected type comes from property 'columns' which is declared here on type 'IntrinsicAttributes & ApiDataTableStoreProps<"posts.getMany", Record<string, unknown>, unknown>'

For some reason it worked with me when I changed the type that will be used on the ColumnDef from being defined by interface to be defined by type, for example:

From

interface Post {
 id: string;
 title: string;
 content: string;
}

To

type Post = {
 id: string;
 title: string;
 content: string;
}

And I have no idea of why and how

Yeah… we should fix that. On Oct 5, 2022 at 11:40 AM -0700, Chris Sandvik @.***>, wrote:

@tannerlinsley This is the first example in the Column Defs guide page: // Define your row shape type Person = { firstName: string lastName: string age: number visits: number status: string progress: number }

const columnHelper = createColumnHelper<Person>()

// Make some columns! const defaultColumns: ColumnDef<Person>[] = [ // <- Pre typed Array // Display Column columnHelper.display({ // <- While using column helper id: ‘actions’, cell: props => <RowActions row={props.row} />, }), // Grouping Column columnHelper.group({ header: ‘Name’, footer: props => props.column.id, columns: [ // Accessor Column columnHelper.accessor(‘firstName’, { cell: info => info.getValue(), footer: props => props.column.id, }), // Accessor Column columnHelper.accessor(row => row.lastName, { id: ‘lastName’, cell: info => info.getValue(), header: () => <span>Last Name</span>, footer: props => props.column.id, }), ], }), // … It has the column array pre-typed and throws errors if any of these accessor columns are top level. — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: @.***>

@tannerlinsley This is the first example in the Column Defs guide page:

// Define your row shape
type Person = {
  firstName: string
  lastName: string
  age: number
  visits: number
  status: string
  progress: number
}

const columnHelper = createColumnHelper<Person>()

// Make some columns!
const defaultColumns: ColumnDef<Person>[] = [  // <- Pre typed Array
  // Display Column
  columnHelper.display({ // <- While using column helper
    id: 'actions',
    cell: props => <RowActions row={props.row} />,
  }),
  // Grouping Column
  columnHelper.group({
    header: 'Name',
    footer: props => props.column.id,
    columns: [
      // Accessor Column
      columnHelper.accessor('firstName', {
        cell: info => info.getValue(),
        footer: props => props.column.id,
      }),
      // Accessor Column
      columnHelper.accessor(row => row.lastName, {
        id: 'lastName',
        cell: info => info.getValue(),
        header: () => <span>Last Name</span>,
        footer: props => props.column.id,
      }),
    ],
  }),
  // ...

It has the column array pre-typed and throws errors if any of these accessor columns are top level.

I think I’ve managed to fix this without falling back to any by modifying the ColumnHelper type! PR here.

Hey, I was facing the exact same issue but since I use the 8.21.2 version and type my data and columns props with this type definition, the error is gone.

export type DataGridProps<TData> = Pick<TableOptions<TData>, 'data' | 'columns'> 

I’m maybe missing something but it can maybe help some of you

This is what I ended up doing:

import type { CoreOptions } from "@tanstack/vue-table";

const { data, columns } = defineProps<{
  data: CoreOptions<TData>["data"];
  columns: CoreOptions<TData>["columns"];
}>();

whatever is the type coming fromdata and columns array, are what my component will expect to receive.

columns is still of type ColumnDef<TData, any>[] and it’s fine for me.

Hello, I am still facing the same issue on 8.15.0 and 8.15.3. I am following the shadcn example (Preview / Code) Can’t make it work with

const columns: ColumnDef<Task, any>[] = [

nor

const columns: ColumnDef<Task>[] = [

I am still getting the following error:

Type 'ColumnDef<Task, any>[]' is not assignable to type 'ColumnDef<unknown, any>[]'.
  Type 'ColumnDef<Task, any>' is not assignable to type 'ColumnDef<unknown, any>'.
    Type 'ColumnDefBase<Task, any> & StringHeaderIdentifier' is not assignable to type 'ColumnDef<unknown, any>'.
      Type 'ColumnDefBase<Task, any> & StringHeaderIdentifier' is not assignable to type 'AccessorFnColumnDefBase<unknown, any> & IdIdentifier<unknown, any>'.
        Property 'accessorFn' is missing in type 'ColumnDefBase<Task, any> & StringHeaderIdentifier' but required in type 'AccessorFnColumnDefBase<unknown, any>'.

The only workaround I use for now is:

columns: columns as ColumnDef<unknown>[],

I am getting the below error while using like this. Type ‘ColumnDef<unknown>[]’ is not assignable to type ‘never’.

👀

This still happens only when you have multiple types on your object property

export type User = {
  id: number;
  name: string;
  email: string;
  role: "admin" | "member";
  status: "active" | "pending";
};

// changing everything with type of string fixed the issue but whats the point of using typescript here
export type User = {
  id: string;
  name: string;
  email: string;
  role: string;
  status: string;
};

Any update on this issue? Running into the same issue. My solution is to use any for the type and individually define the types for each cell:

type BillingDetails = {
  id: number;
  service: string;
  talentName: string;
  amount: number;
  createdAt: string;
};

// eslint-disable-next-line @typescript-eslint/no-explicit-any 
const columns: ColumnDef<BillingDetails, any>[] = [
  columnHelper.accessor('service', {
    id: 'service',
    cell: (props) => props.getValue() as string,
    header: 'Service',
    enableSorting: false,
  }),
  columnHelper.accessor('talentName', {
    id: 'talentName',
    cell: (props) => props.getValue() as string,
    header: 'Talent name',
    enableSorting: false,
  }),
  columnHelper.accessor('amount', {
    id: 'amount',
    cell: (props) => props.getValue() as number,
    header: 'Amount',
    enableSorting: false,
  }),
  columnHelper.accessor('createdAt', {
    id: 'createdAt',
    cell: (props) => props.getValue() as string,
    header: 'Created at',
    enableSorting: false,
  }),
]

Same use case as above, useTable is wrapped in a reuseable component that takes in columns as a prop. Trying to use columHelper to create the definitions in the parent and it causes a typescript error.

I just encountered the same issue, which forced me to turn off no-explicit-any.