docs: create react state guide and reorg sidebar guides (#5389)

Author: KevinVandy

docs/config.json

@@ -32,14 +32,14 @@
       ]
     },
     {
-      "label": "Guides",
+      "label": "Core Guides",
       "children": [
         {
           "label": "Migrating to V8",
           "to": "guide/migrating"
         },
         {
-          "label": "Tables (Getting Started)",
+          "label": "Table Instance",
           "to": "guide/tables"
         },
         {
@@ -61,7 +61,12 @@
         {
           "label": "Cells",
           "to": "guide/cells"
-        },
+        }
+      ]
+    },
+    {
+      "label": "Feature Guides",
+      "children": [
         {
           "label": "Features",
           "to": "guide/features"
@@ -229,6 +234,15 @@
             }
           ]
         },
+        {
+          "label": "Core Guides",
+          "children": [
+            {
+              "label": "Table State (React)",
+              "to": "framework/react/guide/table-state"
+            }
+          ]
+        },
         {
           "label": "Examples",
           "children": [

docs/framework/react/guide/table-state.md

@@ -0,0 +1,204 @@
+---
+title: Table State (React) Guide
+---
+
+## Examples
+
+Want to skip to the implementation? Check out these examples:
+
+- [kitchen sink](../examples/kitchen-sink)
+- [fully controlled](../examples/fully-controlled)
+
+## Table State (React) Guide
+
+TanStack Table has a simple underlying internal state management system to store and manage the state of the table. It also lets you selectively pull out any state that you need to manage in your own state management. This guide will walk you through the different ways in which you can interact with and manage the state of the table.
+
+### Accessing Table State
+
+You do not need to set up anything special in order for the table state to work. If you pass noting into either `state`, `initialState`, or any of the `on[State]Change` table options, the table will manage its own state internally. You can access any part of this internal state by using the `table.getState()` table instance API.
+
+```jsx
+const table = useReactTable({
+  columns,
+  data,
+  //...
+})
+
+console.log(table.getState()) //access the entire internal state
+console.log(table.getState().rowSelection) //access just the row selection state
+```
+
+### Custom Initial State
+
+If all you need to do for certain states is customize their initial default values, you still do not need to manage any of the state yourself. You can simply set values in the `initialState` option of the table instance.
+
+```jsx
+const table = useReactTable({
+  columns,
+  data,
+  initialState: {
+    columnOrder: ['age', 'firstName', 'lastName'], //customize the initial column order
+    columnVisibility: {
+      id: false //hide the id column by default
+    },
+    expanded: true, //expand all rows by default
+    sorting: [
+      {
+        id: 'age',
+        desc: true //sort by age in descending order by default
+      }
+    ]
+  },
+  //...
+})
+```
+
+> **Note**: Only specify each particular state in either `initialState` or `state`, but not both. If you pass in a particular state value to both `initialState` and `state`, the initialized state in `state` will take overwrite any corresponding value in `initialState`.
+
+### Controlled State
+
+If you need easy access to the table state in other areas of your application, TanStack Table makes it easy to control and manage any or all of the table state in your own state management system. You can do this by passing in your own state and state management functions to the `state` and `on[State]Change` table options.
+
+#### Individual Controlled State
+
+You can control just the state that you need easy access to. You do NOT have to control all of the table state if you do not need to. It is recommended to only control the state that you need on a case-by-case basis.
+
+In order to control a particular state, you need to both pass in the corresponding `state` value and the `on[State]Change` function to the table instance.
+
+Let's take filtering, sorting, and pagination as an example in a "manual" server-side data fetching scenario. You can store the filtering, sorting, and pagination state in your own state management, but leave out any other state like column order, column visibility, etc. if your API does not care about those values.
+
+```jsx
+const [columnFilters, setColumnFilters] = React.useState([]) //no default filters
+const [sorting, setSorting] = React.useState([{
+  id: 'age',
+  desc: true, //sort by age in descending order by default
+}]) 
+const [pagination, setPagination] = React.useState({ pageIndex: 0, pageSize: 15 })
+
+//Use our controlled state values to fetch data
+const tableQuery = useQuery({
+  queryKey: ['users', columnFilters, sorting, pagination],
+  queryFn: () => fetchUsers(columnFilters, sorting, pagination),
+  //...
+})
+
+const table = useReactTable({
+  columns,
+  data: tableQuery.data,
+  //...
+  state: {
+    columnFilters, //pass controlled state back to the table (overrides internal state)
+    sorting,
+    pagination
+  },
+  onColumnFiltersChange: setColumnFilters, //hoist columnFilters state into our own state management
+  onSortingChange: setSorting,
+  onPaginationChange: setPagination,
+})
+//...
+```
+
+#### Fully Controlled State
+
+Alternatively, you can control the entire table state with the `onStateChange` table option. It will hoist out the entire table state into your own state management system. Be careful with this approach, as you might find that raising some frequently changing state values up a react tree, like `columnSizingInfo` state`, might cause bad performance issues.
+
+A couple of more tricks may be needed to make this work. If you use the `onStateChange` table option, the initial values of the `state` must be populated with all of the relevant state values for all of the features that you want to use. You can either manually type out all of the initial state values, or use the `table.setOptions` API in a special way as shown below.
+
+```jsx
+//create a table instance with default state values
+const table = useReactTable({
+  columns,
+  data,
+  //... Note: `state` values are NOT passed in yet
+})
+
+
+const [state, setState] = React.useState({
+  ...table.initialState, //populate the initial state with all of the default state values from the table instance
+  pagination: {
+    pageIndex: 0,
+    pageSize: 15 //optionally customize the initial pagination state.
+  }
+})
+
+//Use the table.setOptions API to merge our fully controlled state onto the table instance
+table.setOptions(prev => ({
+  ...prev, //preserve any other options that we have set up above
+  state, //our fully controlled state overrides the internal state
+  onStateChange: setState //any state changes will be pushed up to our own state management
+}))
+```
+
+### On State Change Callbacks
+
+So far, we have seen the `on[State]Change` and `onStateChange` table options work to "hoist" the table state changes into our own state management. However, there are a few things about these using these options that you should be aware of.
+
+#### 1. **State Change Callbacks MUST have their corresponding state value in the `state` option**.
+
+Specifying an `on[State]Change` callback tells the table instance that this will be a controlled state. If you do not specify the corresponding `state` value, that state will be "frozen" with its initial value.
+
+```jsx
+const [sorting, setSorting] = React.useState([])
+//...
+const table = useReactTable({
+  columns,
+  data,
+  //...
+  state: {
+    sorting, //required because we are using `onSortingChange`
+  },
+  onSortingChange: setSorting, //makes the `state.sorting` controlled
+})
+```
+
+#### 2. **Updaters can either be raw values or callback functions**.
+
+The `on[State]Change` and `onStateChange` callbacks work exactly like the `setState` functions in React. The updater values can either be a new state value or a callback function that takes the previous state value and returns the new state value.
+
+What implications does this have? It means that if you want to add in some extra logic in any of the `on[State]Change` callbacks, you can do so, but you need to check whether or not the new incoming updater value is a function or value.
+
+```jsx
+const [sorting, setSorting] = React.useState([])
+const [pagination, setPagination] = React.useState({ pageIndex: 0, pageSize: 10 })
+
+const table = useReactTable({
+  columns,
+  data,
+  //...
+  state: {
+    pagination,
+    sorting,
+  }
+  //syntax 1
+  onPaginationChange: (updater) => {
+    setPagination(old => {
+      const newPaginationValue = updater instanceof Function ? updater(old) : updater
+      //do something with the new pagination value
+      //...
+      return newPaginationValue
+    })
+  },
+  //syntax 2
+  onSortingChange: (updater) => {
+    const newSortingValue = updater instanceof Function ? updater(sorting) : updater
+    //do something with the new sorting value
+    //...
+    setSorting(updater) //normal state update
+  }
+})
+```
+
+### State Types
+
+All complex states in TanStack Table have their own TypeScript types that you can import and use. This can be handy for ensuring that you are using the correct data structures and properties for the state values that you are controlling.
+
+```tsx
+import { useReactTable, SortingState } from '@tanstack/react-table'
+//...
+const [sorting, setSorting] = React.useState<SortingState[]>([
+  {
+    id: 'age', //you should get autocomplete for the `id` and `desc` properties
+    desc: true,
+  }
+])
+```

docs/guide/tables.md

@@ -1,5 +1,5 @@
 ---
-title: Tables Guide
+title: Table Instance Guide
 ---
 
 ## API