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
176986a07a
react-table/docs/api/useColumnOrder.md
Tanner Linsley 8ba553871f
Add useColumnVisibility as core hook (#1700) 
* Update utils.js

* Update useTable.js

* Create useColumnVisibility.js

* Update useColumnVisibility.js

* Update useColumnVisibility.js

* Convert to core hook, use new reducerHanndler/actions

* Add useColumnVisibility internal hook
2019-12-05 15:45:25 -05:00

1.2 KiB
Raw Blame History

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)

  • state.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
  • initialState.columnOrder
    • Identical to the state.columnOrder option above

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