vhad/react-table
1
0
Fork 0
mirror of https://github.com/gosticks/react-table.git synced 2025-10-16 11:55:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
e73199a04d
react-table/docs/api/useColumnOrder.md
Jason Clark d2acfc4235
New documentation site built with Docz (#2013) 
* size-snapshot created?

* Added docz for documentation site

* Modified .gitignore to get rid of .docz internal stuff

* Update all doc links to point to proper paths with docz

* Removed .docz folder from Git

Co-authored-by: Jason Clark <jason.clark@tcnbroadcasting.com>
2020-03-25 14:29:56 -06:00

1.2 KiB
Raw Blame History

name route menu
useColumnOrder /api/useColumnOrder API

useColumnOrder

  • Plugin Hook
  • Optional

useColumnOrder is a plugin hook that implements basic column reordering. As columns are reordered, their header groups are reverse-engineered so as to never have orphaned header groups.

Table Options

The following options are supported via the main options object passed to useTable(options)

  • initialState.columnOrder: Array<ColumnId>
    • Optional
    • Defaults to []
    • Any column ID's not represented in this array will be naturally ordered based on their position in the original table's column structure

Instance Properties

The following values are provided to the table instance:

  • setColumnOrder: Function(updater: Function | Array<ColumnId>) => void

    • Use this function to programmatically update the columnOrder.
    • updater can be a function or value. If a function is passed, it will receive the current value and expect a new one to be returned.

  • Source

  • Open in CodeSandbox