v7.0.0-beta.8

Added instance.selectedFlatRows to know which row objects are currently selecte

docs/api.md

@@ -209,10 +209,6 @@ The following properties are available on the table instance returned from `useT
   - **Required**
   - This function is responsible for lazily preparing a row for rendering. Any row that you intend to render in your table needs to be passed to this function **before every render**.
   - **Why?** Since table data could potentially be very large, it can become very expensive to compute all of the necessary state for every row to be rendered regardless if it actually is rendered or not (for example if you are paginating or virtualizing the rows, you may only have a few rows visible at any given moment). This function allows only the rows you intend to display to be computed and prepped with the correct state.
-- `rowPaths: Array<string>`
-  - An array containing the stringified `path` of every original row in the table. eg. If a row has a path of `[0, 3, 2]`, its stringified path would be `0.3.2`.
-  - This array is used by many plugin hooks including `useRowSelect` to manage row selection state
-  - Only rows that exist on the original `data` array will have a path in this array. Rows created by `useGroupBy`'s aggregations and grouping are not included in this array, since they do not reference an original data row.
 - `flatRows: Array<Row>`
   - An array of all rows, including subRows which have been flattened into the order in which they were detected (depth first)
   - This can be helpful in calculating total row counts that must include subRows
@@ -784,7 +780,7 @@ The following values are provided to the table `instance`:
 
 The following options are supported via the main options object passed to `useTable(options)`
 
-- `state[0].selectedRows: Array<RowPathKey>`
+- `state[0].selectedRowsPaths: Array<RowPathKey>`
   - Optional
   - Defaults to `[]`
   - If a row's path key (eg. a row path of `[1, 3, 2]` would have a path key of `1.3.2`) is found in this array, it will have a selected state.
@@ -813,6 +809,8 @@ The following values are provided to the table `instance`:
 - `isAllRowsSelected: Bool`
   - Will be `true` if all rows are selected.
   - If at least one row is not selected, will be `false`
+- `selectedFlatRows: Array<Row>`
+  - The flat array of rows that are currently selected
 
 ### Row Properties
 

examples/kitchen-sink-controlled/src/App.js

@@ -285,7 +285,9 @@ function Table({ columns, data, updateMyData, disablePageResetOnDataChange }) {
     nextPage,
     previousPage,
     setPageSize,
-    state: [{ pageIndex, pageSize, groupBy, expanded, filters, selectedRows }],
+    state: [
+      { pageIndex, pageSize, groupBy, expanded, filters, selectedRowPaths },
+    ],
   } = useTable(
     {
       columns,
@@ -438,7 +440,7 @@ function Table({ columns, data, updateMyData, disablePageResetOnDataChange }) {
               groupBy,
               expanded,
               filters,
-              selectedRows,
+              selectedRowPaths,
             },
             null,
             2

examples/kitchen-sink/src/App.js

@@ -285,7 +285,9 @@ function Table({ columns, data, updateMyData, disablePageResetOnDataChange }) {
     nextPage,
     previousPage,
     setPageSize,
-    state: [{ pageIndex, pageSize, groupBy, expanded, filters, selectedRows }],
+    state: [
+      { pageIndex, pageSize, groupBy, expanded, filters, selectedRowPaths },
+    ],
   } = useTable(
     {
       columns,
@@ -438,7 +440,7 @@ function Table({ columns, data, updateMyData, disablePageResetOnDataChange }) {
               groupBy,
               expanded,
               filters,
-              selectedRows,
+              selectedRowPaths,
             },
             null,
             2

examples/row-selection/src/App.js

@@ -41,7 +41,8 @@ function Table({ columns, data }) {
     headerGroups,
     rows,
     prepareRow,
-    state: [{ selectedRows }],
+    selectedFlatRows,
+    state: [{ selectedRowPaths }],
   } = useTable(
     {
       columns,
@@ -78,9 +79,20 @@ function Table({ columns, data }) {
           )}
         </tbody>
       </table>
-      <p>Selected Rows: {selectedRows.length}</p>
+      <p>Selected Rows: {selectedRowPaths.length}</p>
       <pre>
-        <code>{JSON.stringify({ selectedRows }, null, 2)}</code>
+        <code>
+          {JSON.stringify(
+            {
+              selectedRowPaths,
+              'selectedFlatRows[].original': selectedFlatRows.map(
+                d => d.original
+              ),
+            },
+            null,
+            2
+          )}
+        </code>
       </pre>
     </>
   )

examples/virtualized-rows/sandbox.config.json

@@ -0,0 +1,5 @@
+{
+  "infiniteLoopProtection": false,
+  "hardReloadOnChange": false,
+  "view": "browser"
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-table",
-  "version": "7.0.0-beta.6",
+  "version": "7.0.0-beta.8",
   "description": "A fast, lightweight, opinionated table and datagrid built on React",
   "license": "MIT",
   "homepage": "https://github.com/tannerlinsley/react-table#readme",

src/hooks/useTable.js

@@ -137,12 +137,11 @@ export const useTable = (props, ...plugins) => {
   })
 
   // Access the row model
-  const [rows, rowPaths, flatRows] = React.useMemo(() => {
+  const [rows, flatRows] = React.useMemo(() => {
     if (process.env.NODE_ENV === 'development' && debug)
       console.time('getAccessedRows')
 
-    let flatRows = 0
-    const rowPaths = []
+    let flatRows = []
 
     // Access the row's data
     const accessRow = (originalRow, i, depth = 0, parentPath = []) => {
@@ -154,23 +153,21 @@ export const useTable = (props, ...plugins) => {
       // Make the new path for the row
       const path = [...parentPath, rowID]
 
-      flatRows++
-      rowPaths.push(path.join('.'))
+      const row = {
+        original,
+        index: i,
+        path, // used to create a key for each row even if not nested
+        depth,
+        cells: [{}], // This is a dummy cell
+      }
+
+      flatRows.push(row)
 
       // Process any subRows
       let subRows = getSubRows(originalRow, i)
 
       if (subRows) {
-        subRows = subRows.map((d, i) => accessRow(d, i, depth + 1, path))
-      }
-
-      const row = {
-        original,
-        index: i,
-        path, // used to create a key for each row even if not nested
-        subRows,
-        depth,
-        cells: [{}], // This is a dummy cell
+        row.subRows = subRows.map((d, i) => accessRow(d, i, depth + 1, path))
       }
 
       // Override common array functions (and the dummy cell's getCellProps function)
@@ -200,11 +197,10 @@ export const useTable = (props, ...plugins) => {
     const accessedData = data.map((d, i) => accessRow(d, i))
     if (process.env.NODE_ENV === 'development' && debug)
       console.timeEnd('getAccessedRows')
-    return [accessedData, rowPaths, flatRows]
+    return [accessedData, flatRows]
   }, [debug, data, getRowID, getSubRows, flatColumns])
 
   instanceRef.current.rows = rows
-  instanceRef.current.rowPaths = rowPaths
   instanceRef.current.flatRows = flatRows
 
   // Determine column visibility

src/plugin-hooks/tests/__snapshots__/useRowSelect.test.js.snap

@@ -485,8 +485,8 @@ Snapshot Diff:
     <pre>
       <code>
         {
--   "selectedRows": []
-+   "selectedRows": [
+-   "selectedRowPaths": []
++   "selectedRowPaths": [
 +     "0",
 +     "1",
 +     "2",
@@ -1015,7 +1015,7 @@ Snapshot Diff:
     <pre>
       <code>
         {
--   "selectedRows": [
+-   "selectedRowPaths": [
 -     "0",
 -     "1",
 -     "2",
@@ -1053,7 +1053,7 @@ Snapshot Diff:
 -     "22.1",
 -     "23"
 -   ]
-+   "selectedRows": []
++   "selectedRowPaths": []
   }
       </code>
     </pre>
@@ -1129,8 +1129,8 @@ Snapshot Diff:
     <pre>
       <code>
         {
--   "selectedRows": []
-+   "selectedRows": [
+-   "selectedRowPaths": []
++   "selectedRowPaths": [
 +     "0",
 +     "2",
 +     "2.0",
@@ -1198,7 +1198,7 @@ Snapshot Diff:
     <pre>
       <code>
         {
-    "selectedRows": [
+    "selectedRowPaths": [
 -     "0",
 -     "2",
 -     "2.0",
@@ -1241,7 +1241,7 @@ Snapshot Diff:
     <pre>
       <code>
         {
-    "selectedRows": [
+    "selectedRowPaths": [
 -     "0"
 +     "0",
 +     "2.0"
@@ -1282,7 +1282,7 @@ Snapshot Diff:
     <pre>
       <code>
         {
-    "selectedRows": [
+    "selectedRowPaths": [
       "0",
 -     "2.0"
 +     "2.0",
@@ -1324,7 +1324,7 @@ Snapshot Diff:
     <pre>
       <code>
         {
-    "selectedRows": [
+    "selectedRowPaths": [
       "0",
 -     "2.0",
 -     "2.1"

src/plugin-hooks/tests/useRowSelect.test.js

@@ -75,7 +75,7 @@ function Table({ columns, data }) {
     headerGroups,
     rows,
     prepareRow,
-    state: [{ selectedRows }],
+    state: [{ selectedRowPaths }],
   } = useTable(
     {
       columns,
@@ -113,9 +113,9 @@ function Table({ columns, data }) {
           )}
         </tbody>
       </table>
-      <p>Selected Rows: {selectedRows.length}</p>
+      <p>Selected Rows: {selectedRowPaths.length}</p>
       <pre>
-        <code>{JSON.stringify({ selectedRows }, null, 2)}</code>
+        <code>{JSON.stringify({ selectedRowPaths }, null, 2)}</code>
       </pre>
     </>
   )

src/plugin-hooks/useExpanded.js

@@ -87,7 +87,14 @@ function useMain(instance) {
     }
 
     return rows
-  }, [debug, paginateExpandedRows, rows, manualExpandedKey, expanded])
+  }, [
+    debug,
+    paginateExpandedRows,
+    rows,
+    manualExpandedKey,
+    expanded,
+    expandSubRows,
+  ])
 
   const expandedDepth = findExpandedDepth(expanded)
 

src/plugin-hooks/useFilters.js

@@ -33,6 +33,7 @@ function useMain(instance) {
   const {
     debug,
     rows,
+    flatRows,
     flatColumns,
     filterTypes: userFilterTypes,
     manualFilters,
@@ -41,6 +42,7 @@ function useMain(instance) {
   } = instance
 
   const preFilteredRows = rows
+  const preFilteredFlatRows = flatRows
 
   const setFilter = (id, updater) => {
     const column = flatColumns.find(d => d.id === id)
@@ -129,11 +131,16 @@ function useMain(instance) {
   // cache for each row group (top-level rows, and each row's recursive subrows)
   // This would make multi-filtering a lot faster though. Too far?
 
-  const filteredRows = React.useMemo(() => {
+  const { filteredRows, filteredFlatRows } = React.useMemo(() => {
     if (manualFilters || !Object.keys(filters).length) {
-      return rows
+      return {
+        filteredRows: rows,
+        filteredFlatRows: flatRows,
+      }
     }
 
+    const filteredFlatRows = []
+
     if (process.env.NODE_ENV === 'development' && debug)
       console.info('getFilteredRows')
 
@@ -179,6 +186,7 @@ function useMain(instance) {
       // but that would severely hinder the API for the user, since they
       // would be required to do that recursion in some scenarios
       filteredRows = filteredRows.map(row => {
+        filteredFlatRows.push(row)
         if (!row.subRows) {
           return row
         }
@@ -194,8 +202,19 @@ function useMain(instance) {
       return filteredRows
     }
 
-    return filterRows(rows)
-  }, [manualFilters, filters, debug, rows, flatColumns, userFilterTypes])
+    return {
+      filteredRows: filterRows(rows),
+      filteredFlatRows,
+    }
+  }, [
+    manualFilters,
+    filters,
+    debug,
+    rows,
+    flatRows,
+    flatColumns,
+    userFilterTypes,
+  ])
 
   React.useMemo(() => {
     // Now that each filtered column has it's partially filtered rows,
@@ -216,7 +235,9 @@ function useMain(instance) {
     setFilter,
     setAllFilters,
     preFilteredRows,
+    preFilteredFlatRows,
     rows: filteredRows,
+    flatRows: filteredFlatRows,
   }
 }
 

src/plugin-hooks/usePagination.js

@@ -105,6 +105,7 @@ function useMain(instance) {
     return expandRows(page, { manualExpandedKey, expanded, expandSubRows })
   }, [
     debug,
+    expandSubRows,
     expanded,
     manualExpandedKey,
     manualPagination,

src/plugin-hooks/useRowSelect.js

@@ -1,10 +1,11 @@
+import React from 'react'
 import PropTypes from 'prop-types'
 
 import { mergeProps, applyPropHooks, ensurePluginOrder } from '../utils'
 import { addActions, actions } from '../actions'
 import { defaultState } from '../hooks/useTableState'
 
-defaultState.selectedRows = []
+defaultState.selectedRowPaths = []
 
 addActions('toggleRowSelected', 'toggleRowSelectedAll')
 
@@ -15,11 +16,41 @@ const propTypes = {
 export const useRowSelect = hooks => {
   hooks.getToggleRowSelectedProps = []
   hooks.getToggleAllRowsSelectedProps = []
+  hooks.useRows.push(useRows)
   hooks.useMain.push(useMain)
 }
 
 useRowSelect.pluginName = 'useRowSelect'
 
+function useRows(rows, instance) {
+  PropTypes.checkPropTypes(propTypes, instance, 'property', 'useRowSelect')
+
+  const {
+    state: [{ selectedRowPaths }],
+  } = instance
+
+  instance.selectedFlatRows = React.useMemo(() => {
+    const selectedFlatRows = []
+    rows.forEach(row => {
+      if (row.isAggregated) {
+        const subRowPaths = row.subRows.map(row => row.path)
+        row.isSelected = subRowPaths.every(path =>
+          selectedRowPaths.includes(path.join('.'))
+        )
+      } else {
+        row.isSelected = selectedRowPaths.includes(row.path.join('.'))
+      }
+      if (row.isSelected) {
+        selectedFlatRows.push(row)
+      }
+    })
+
+    return selectedFlatRows
+  }, [rows, selectedRowPaths])
+
+  return rows
+}
+
 function useMain(instance) {
   PropTypes.checkPropTypes(propTypes, instance, 'property', 'useRowSelect')
 
@@ -27,8 +58,8 @@ function useMain(instance) {
     hooks,
     manualRowSelectedKey = 'isSelected',
     plugins,
-    rowPaths,
-    state: [{ selectedRows }, setState],
+    flatRows,
+    state: [{ selectedRowPaths }, setState],
   } = instance
 
   ensurePluginOrder(
@@ -38,34 +69,44 @@ function useMain(instance) {
     []
   )
 
-  const isAllRowsSelected = rowPaths.length > 0 && rowPaths.length === selectedRows.length
+  const flatRowPaths = flatRows.map(d => d.path.join('.'))
+
+  let isAllRowsSelected = !!flatRowPaths.length && !!selectedRowPaths.length
+
+  if (isAllRowsSelected) {
+    if (flatRowPaths.some(d => !selectedRowPaths.includes(d))) {
+      isAllRowsSelected = false
+    }
+  }
 
   const toggleRowSelectedAll = set => {
     setState(old => {
       const selectAll = typeof set !== 'undefined' ? set : !isAllRowsSelected
       return {
         ...old,
-        selectedRows: selectAll ? [...rowPaths] : [],
+        selectedRowPaths: selectAll ? flatRowPaths : [],
       }
     }, actions.toggleRowSelectedAll)
   }
 
-  const updateParentRow = (selectedRows, path) => {
+  const updateParentRow = (selectedRowPaths, path) => {
     const parentPath = path.slice(0, path.length - 1)
     const parentKey = parentPath.join('.')
     const selected =
-      rowPaths.filter(
-        path =>
+      flatRowPaths.filter(rowPath => {
+        const path = rowPath
+        return (
           path !== parentKey &&
           path.startsWith(parentKey) &&
-          !selectedRows.has(path)
-      ).length === 0
+          !selectedRowPaths.has(path)
+        )
+      }).length === 0
     if (selected) {
-      selectedRows.add(parentKey)
+      selectedRowPaths.add(parentKey)
     } else {
-      selectedRows.delete(parentKey)
+      selectedRowPaths.delete(parentKey)
     }
-    if (parentPath.length > 1) updateParentRow(selectedRows, parentPath)
+    if (parentPath.length > 1) updateParentRow(selectedRowPaths, parentPath)
   }
 
   const toggleRowSelected = (path, set) => {
@@ -76,18 +117,18 @@ function useMain(instance) {
       // Join the paths of deep rows
       // to make a key, then manage all of the keys
       // in a flat object
-      const exists = old.selectedRows.includes(key)
+      const exists = old.selectedRowPaths.includes(key)
       const shouldExist = typeof set !== 'undefined' ? set : !exists
-      let newSelectedRows = new Set(old.selectedRows)
+      let newSelectedRows = new Set(old.selectedRowPaths)
 
       if (!exists && shouldExist) {
-        rowPaths.forEach(rowPath => {
+        flatRowPaths.forEach(rowPath => {
           if (rowPath === key || rowPath.startsWith(childRowPrefixKey)) {
             newSelectedRows.add(rowPath)
           }
         })
       } else if (exists && !shouldExist) {
-        rowPaths.forEach(rowPath => {
+        flatRowPaths.forEach(rowPath => {
           if (rowPath === key || rowPath.startsWith(childRowPrefixKey)) {
             newSelectedRows.delete(rowPath)
           }
@@ -102,7 +143,7 @@ function useMain(instance) {
 
       return {
         ...old,
-        selectedRows: [...newSelectedRows.values()],
+        selectedRowPaths: [...newSelectedRows.values()],
       }
     }, actions.toggleRowSelected)
   }
@@ -128,9 +169,6 @@ function useMain(instance) {
     // Aggregate rows have entirely different select logic
     if (row.isAggregated) {
       const subRowPaths = row.subRows.map(row => row.path)
-      row.isSelected = subRowPaths.every(path =>
-        selectedRows.includes(path.join('.'))
-      )
       row.toggleRowSelected = set => {
         set = typeof set !== 'undefined' ? set : !row.isSelected
         subRowPaths.forEach(path => {
@@ -166,7 +204,6 @@ function useMain(instance) {
         )
       }
     } else {
-      row.isSelected = selectedRows.includes(row.path.join('.'))
       row.toggleRowSelected = set => toggleRowSelected(row.path, set)
       row.getToggleRowSelectedProps = props => {
         let checked = false