QUI React Table3.0.0

Column Definitions

API

AccessorColumnDef

Name & DescriptionOption(s)Default
accessorKey
Key
| string
| keyof TData
aggregatedCell
The cell to display each row for the column if the cell is an aggregate.
| string
| ((props: {
    cell: Cell
    column: Column
    getValue: () => TValue
    row: Row<TData>
    table: Table<TData>
  }) => any)
aggregationFn
The resolved aggregation function for the column.
AggregationFnOption<TData>
enableColumnFilter
Enables/disables the **column** filter for this column.
boolean
enableGlobalFilter
Enables/disables the **global** filter for this column.
boolean
enableGrouping
Enables/disables grouping for this column.
boolean
enableHiding
Enables/Disables hiding the column.
boolean
enableMultiSort
Enables/Disables multi-sorting for this column.
boolean
enablePinning
Enables/disables column pinning for this column. Defaults to true.
boolean
enableResizing
Enables or disables column resizing for the column.
boolean
enableSorting
Enables/Disables sorting for this column.
boolean
filterFn
The filter function to use with this column. Can be the name of a built-in filter function or a custom filter function.
| 'auto'
| 'arrIncludes'
| 'arrIncludesAll'
| 'arrIncludesSome'
| 'equals'
| 'equalsString'
| 'inNumberRange'
| 'includesString'
| 'includesStringSensitive'
| 'weakEquals'
| signature
getGroupingValue
Specify a value to be used for grouping rows on this column. If this option is not specified, the value derived from accessorKey / accessorFn will be used instead.
      (
        row: TData,
      ) => any
      header
      Header definition.
      | string
      | ((props: {
          column: Column
          header: Header
          table: Table<TData>
        }) => any)
      id
      ID of the column
      string
      invertSorting
      Inverts the order of the sorting for this column. This is useful for values that have an inverted best/worst scale where lower numbers are better, eg. a ranking (1st, 2nd, 3rd) or golf-like scoring
      boolean
      maxSize
      The maximum allowed size for the column
      number
      meta
      Column Meta
      any
      minSize
      The minimum allowed size for the column
      number
      size
      The desired size for the column
      number
      sortDescFirst
      Set to true for sorting toggles on this column to start in the descending direction.
      boolean
      sortingFn
      The sorting function to use with this column.
      - A       string referencing a built-in sorting function
      - A custom sorting function
      | 'auto'
      | 'alphanumeric'
      | 'alphanumericCaseSensitive'
      | 'basic'
      | 'datetime'
      | 'text'
      | 'textCaseSensitive'
      | any
      sortUndefined
      Configure how undefined values are sorted for this column.
      • false: Undefined values will be considered tied and need to be sorted by the next column filter or original index (whichever applies).
      • -1: Undefined values will be sorted with higher priority (ascending) (if ascending, undefined will appear on the beginning of the list)
      • 1: Undefined values will be sorted with lower priority (descending) (if ascending, undefined will appear on the end of the list)
      false | 1 | -1
      Type
      | string
      | keyof TData
      Description
      Key
      Type
      | string
      | ((props: {
          cell: Cell
          column: Column
          getValue: () => TValue
          row: Row<TData>
          table: Table<TData>
        }) => any)
      Description
      The cell to display each row for the column if the cell is an aggregate.
      Type
      AggregationFnOption<TData>
      Description
      The resolved aggregation function for the column.
      Type
      boolean
      Description
      Enables/disables the **column** filter for this column.
      Type
      boolean
      Description
      Enables/disables the **global** filter for this column.
      Type
      boolean
      Description
      Enables/disables grouping for this column.
      Type
      boolean
      Description
      Enables/Disables hiding the column.
      Type
      boolean
      Description
      Enables/Disables multi-sorting for this column.
      Type
      boolean
      Description
      Enables/disables column pinning for this column. Defaults to true.
      Type
      boolean
      Description
      Enables or disables column resizing for the column.
      Type
      boolean
      Description
      Enables/Disables sorting for this column.
      Type
      | 'auto'
      | 'arrIncludes'
      | 'arrIncludesAll'
      | 'arrIncludesSome'
      | 'equals'
      | 'equalsString'
      | 'inNumberRange'
      | 'includesString'
      | 'includesStringSensitive'
      | 'weakEquals'
      | signature
      Description
      The filter function to use with this column. Can be the name of a built-in filter function or a custom filter function.
      Type
      (
        row: TData,
      ) => any
      Description
      Specify a value to be used for grouping rows on this column. If this option is not specified, the value derived from accessorKey / accessorFn will be used instead.
          Type
          | string
          | ((props: {
              column: Column
              header: Header
              table: Table<TData>
            }) => any)
          Description
          Header definition.
          Type
          string
          Description
          ID of the column
          Type
          boolean
          Description
          Inverts the order of the sorting for this column. This is useful for values that have an inverted best/worst scale where lower numbers are better, eg. a ranking (1st, 2nd, 3rd) or golf-like scoring
          Type
          number
          Description
          The maximum allowed size for the column
          Type
          any
          Description
          Column Meta
          Type
          number
          Description
          The minimum allowed size for the column
          Type
          number
          Description
          The desired size for the column
          Type
          boolean
          Description
          Set to true for sorting toggles on this column to start in the descending direction.
          Type
          | 'auto'
          | 'alphanumeric'
          | 'alphanumericCaseSensitive'
          | 'basic'
          | 'datetime'
          | 'text'
          | 'textCaseSensitive'
          | any
          Description
          The sorting function to use with this column.
          - A           string referencing a built-in sorting function
          - A custom sorting function
          Type
          false | 1 | -1
          Description
          Configure how undefined values are sorted for this column.
          • false: Undefined values will be considered tied and need to be sorted by the next column filter or original index (whichever applies).
          • -1: Undefined values will be sorted with higher priority (ascending) (if ascending, undefined will appear on the beginning of the list)
          • 1: Undefined values will be sorted with lower priority (descending) (if ascending, undefined will appear on the end of the list)

          ColumnSizingColumnDef

          Name & DescriptionOption(s)Default
          enableResizing
          Enables or disables column resizing for the column.
          boolean
          maxSize
          The maximum allowed size for the column
          number
          minSize
          The minimum allowed size for the column
          number
          size
          The desired size for the column
          number
          Type
          boolean
          Description
          Enables or disables column resizing for the column.
          Type
          number
          Description
          The maximum allowed size for the column
          Type
          number
          Description
          The minimum allowed size for the column
          Type
          number
          Description
          The desired size for the column

          FiltersColumnDef

          Name & DescriptionOption(s)Default
          enableColumnFilter
          Enables/disables the **column** filter for this column.
          boolean
          enableGlobalFilter
          Enables/disables the **global** filter for this column.
          boolean
          filterFn
          The filter function to use with this column. Can be the name of a built-in filter function or a custom filter function.
          | 'auto'
          | 'arrIncludes'
          | 'arrIncludesAll'
          | 'arrIncludesSome'
          | 'equals'
          | 'equalsString'
          | 'inNumberRange'
          | 'includesString'
          | 'includesStringSensitive'
          | 'weakEquals'
          | signature
          Type
          boolean
          Description
          Enables/disables the **column** filter for this column.
          Type
          boolean
          Description
          Enables/disables the **global** filter for this column.
          Type
          | 'auto'
          | 'arrIncludes'
          | 'arrIncludesAll'
          | 'arrIncludesSome'
          | 'equals'
          | 'equalsString'
          | 'inNumberRange'
          | 'includesString'
          | 'includesStringSensitive'
          | 'weakEquals'
          | signature
          Description
          The filter function to use with this column. Can be the name of a built-in filter function or a custom filter function.

          GroupingColumnDef

          Name & DescriptionOption(s)Default
          aggregatedCell
          The cell to display each row for the column if the cell is an aggregate.
          | string
          | ((props: {
              cell: Cell
              column: Column
              getValue: () => TValue
              row: Row<TData>
              table: Table<TData>
            }) => any)
          aggregationFn
          The resolved aggregation function for the column.
          AggregationFnOption<TData>
          enableGrouping
          Enables/disables grouping for this column.
          boolean
          getGroupingValue
          Specify a value to be used for grouping rows on this column. If this option is not specified, the value derived from accessorKey / accessorFn will be used instead.
              (
                row: TData,
              ) => any
              Type
              | string
              | ((props: {
                  cell: Cell
                  column: Column
                  getValue: () => TValue
                  row: Row<TData>
                  table: Table<TData>
                }) => any)
              Description
              The cell to display each row for the column if the cell is an aggregate.
              Type
              AggregationFnOption<TData>
              Description
              The resolved aggregation function for the column.
              Type
              boolean
              Description
              Enables/disables grouping for this column.
              Type
              (
                row: TData,
              ) => any
              Description
              Specify a value to be used for grouping rows on this column. If this option is not specified, the value derived from accessorKey / accessorFn will be used instead.

                  SortingColumnDef

                  Name & DescriptionOption(s)Default
                  enableMultiSort
                  Enables/Disables multi-sorting for this column.
                  boolean
                  enableSorting
                  Enables/Disables sorting for this column.
                  boolean
                  invertSorting
                  Inverts the order of the sorting for this column. This is useful for values that have an inverted best/worst scale where lower numbers are better, eg. a ranking (1st, 2nd, 3rd) or golf-like scoring
                  boolean
                  sortDescFirst
                  Set to true for sorting toggles on this column to start in the descending direction.
                  boolean
                  sortingFn
                  The sorting function to use with this column.
                  - A                   string referencing a built-in sorting function
                  - A custom sorting function
                  | 'auto'
                  | 'alphanumeric'
                  | 'alphanumericCaseSensitive'
                  | 'basic'
                  | 'datetime'
                  | 'text'
                  | 'textCaseSensitive'
                  | any
                  sortUndefined
                  Configure how undefined values are sorted for this column.
                  • false: Undefined values will be considered tied and need to be sorted by the next column filter or original index (whichever applies).
                  • -1: Undefined values will be sorted with higher priority (ascending) (if ascending, undefined will appear on the beginning of the list)
                  • 1: Undefined values will be sorted with lower priority (descending) (if ascending, undefined will appear on the end of the list)
                  false | 1 | -1
                  Type
                  boolean
                  Description
                  Enables/Disables multi-sorting for this column.
                  Type
                  boolean
                  Description
                  Enables/Disables sorting for this column.
                  Type
                  boolean
                  Description
                  Inverts the order of the sorting for this column. This is useful for values that have an inverted best/worst scale where lower numbers are better, eg. a ranking (1st, 2nd, 3rd) or golf-like scoring
                  Type
                  boolean
                  Description
                  Set to true for sorting toggles on this column to start in the descending direction.
                  Type
                  | 'auto'
                  | 'alphanumeric'
                  | 'alphanumericCaseSensitive'
                  | 'basic'
                  | 'datetime'
                  | 'text'
                  | 'textCaseSensitive'
                  | any
                  Description
                  The sorting function to use with this column.
                  - A                   string referencing a built-in sorting function
                  - A custom sorting function
                  Type
                  false | 1 | -1
                  Description
                  Configure how undefined values are sorted for this column.
                  • false: Undefined values will be considered tied and need to be sorted by the next column filter or original index (whichever applies).
                  • -1: Undefined values will be sorted with higher priority (ascending) (if ascending, undefined will appear on the beginning of the list)
                  • 1: Undefined values will be sorted with lower priority (descending) (if ascending, undefined will appear on the end of the list)

                  VisibilityColumnDef

                  Name & DescriptionOption(s)Default
                  enableHiding
                  Enables/Disables hiding the column.
                  boolean
                  Type
                  boolean
                  Description
                  Enables/Disables hiding the column.
                  Previous
                  Column
                  Next
                  Header
                  API
                  AccessorColumnDef
                  ColumnSizingColumnDef
                  FiltersColumnDef
                  GroupingColumnDef
                  SortingColumnDef
                  VisibilityColumnDef
                  Copyright © 2025 QUALCOMM incorporated. All rights reserved. This site is built using QUI Docs. Head over to the template repository to start building.