Compare commits

...
Author SHA1 Message Date
Tanner Linsley fb94eaf103 v7.0.0-beta.12 2019-10-09 15:43:14 -06:00
Tanner Linsley 409c050cbf Merge branch 'master' of https://github.com/react-tools/react-table 2019-10-09 15:42:24 -06:00
ggascoigneandTanner Linsley cee24c74d8 Add typescript docs (#1564)
* Add typescript docs

* update for beta.10 and feedback
2019-10-09 15:42:09 -06:00
Michael StramelandTanner Linsley 499f21c349 Remove package-lock.json (#1579) 2019-10-09 15:19:04 -06:00
Tanner Linsley 2a39d5a21c v7.0.0-beta.11 2019-10-09 15:15:39 -06:00
36ba233e27 Updating types (#1535)
* Attempt to bring into alignment

fix plugin hook definitions

Remove old prop

Format

fix Header and Cell props

Rename prop

Abstract props to definitions

fix bad generic

fix typo

Revert "fix typo"

This reverts commit 1ca58c5d8fb017bb0af79dd4aa4f0cd296e7a7e8.

fix

* Remove documented prop

* Tweaks

* Re-add comment

* Some updates

* more changes

* Convert to interfaces

* more fixes

* rename sortByFn params

* Fixes

* Fix setFilter

* Hopefully the last changes

* Bump TypeScript Version for declaration file

Co-Authored-By: Christian Murphy <christian.murphy.42@gmail.com>

* format

* Linting

* fix typo

* expose defaultState

* swap aggregatedValue

* Allow cellvalue for accessor function return

* modifications

* manually added changes from ggascoigne

* remove changes from examples folder
2019-10-09 15:15:00 -06:00
Christian MurphyandTanner Linsley c7dfc45e2e ci: test cross platform (#1559)
* ci: test cross platform

Test on Node.js 10 and 12, long term release support versions.
Test on Linux, Mac, and Windows machines.

* fix: update ic-ci-cli to version 2

includes fixes to support windows

* ci: disable yarn gpg

* ci: double quote string for windows ci
2019-10-09 15:13:17 -06:00
Tanner LinsleyandGitHub 9dd36263fb Update README.md 2019-10-08 10:17:45 -06:00
Tanner Linsley 227f7905b0 Upgrade controlled pagination example for deduped fetching 2019-10-08 09:49:23 -06:00
Tanner Linsley f1ad032587 Update controlled pagination example 2019-10-08 09:46:06 -06:00
Tanner LinsleyandGitHub 93703d027c Update README.md 2019-10-08 09:38:30 -06:00
GeoffandTanner Linsley 75fb61a17f Update concepts.md (#1572)
Some grammatical errors are fixed.
2019-10-07 20:43:53 -06:00
Andrey IvlevandTanner Linsley 7c73a7a631 Fix isClassComponent function (#1571)
`Object.getPrototypeOf(component)` returns React `function Component()` function itself, not `Component.prototype`.
2019-10-07 12:17:22 -06:00
tannerlinsley cbb18368b2 v7.0.0-beta.10 2019-10-07 10:27:56 -06:00
tannerlinsley 4842bc061d fix: fix includeAll filter type, add filteredRows 2019-10-07 10:27:18 -06:00
tannerlinsley 0477ef26ca Merge branch 'master' of https://github.com/react-tools/react-table 2019-10-05 20:50:29 -06:00
tannerlinsley 82734fc898 v7.0.0-beta.9 2019-10-05 20:49:21 -06:00
tannerlinsley bbfc6428b7 refactor(usetable/usetablestate): integrate useTableState into useTable
useTableState was an early and hasty abstraction that hasn't proved useful in many ways. Anything
you could do with useTableState, you could easily do using the same options (assuming they exist) in
the useTable hook. For this reason, state is now a first class citizen of the useTable hook, along
with more sane properties and option locations for anything pertaining to state.
2019-10-05 20:48:28 -06:00
eclissi91andTanner Linsley 280ef16a75 Update api.md (#1567)
I have corrected typo of this issue #1565
2019-10-04 09:01:19 -06:00
tannerlinsley 7db7d59b3d v7.0.0-beta.8 2019-10-03 15:33:00 -06:00
tannerlinsley e43968c684 feat(userowselect): add selectedFlatRows, rename state.selectedRows
Added instance.selectedFlatRows to know which row objects are currently selecte
2019-10-03 14:08:34 -06:00
tannerlinsley e5c04614c1 v7.0.0-beta.7 2019-10-03 13:40:22 -06:00
tannerlinsley 0ef0bc4126 fix(userowselect): useRowSelect fixed to take into account filters
useRowSelect now takes into account filtered data when doing selectAll toggling and
isAllRowsSelected state.
2019-10-03 13:39:35 -06:00
tannerlinsley ef67b15c07 Merge branch 'master' of https://github.com/react-tools/react-table 2019-10-03 08:39:12 -06:00
Tanner Linsley d248be8877 Fix sandbox loop protection 2019-10-03 08:38:33 -06:00
47 changed files with 1231 additions and 12187 deletions
+1
View File
@@ -10,3 +10,4 @@ react-table.css
.idea
.DS_Store
.history
package-lock.json
+1
View File
@@ -0,0 +1 @@
package-lock=false
+13 -2
View File
@@ -1,7 +1,18 @@
language: node_js
node_js:
- "10"
- 10
- 12
os:
- linux
- osx
- windows
env:
global:
- YARN_GPG=no
cache: yarn
script: npm test
script: yarn test
+6 -5
View File
@@ -85,7 +85,7 @@ The differences between the 2 versions are incredibly massive. Unfortunately, I
**React Table v7** is being built and maintained by me, @tannerlinsley and I am always in need of more Patreon support to keep this project afloat. If you would like to contribute to my Patreon goal for v7 and beyond, [visit my Patreon and help me out!](https://patreon.com/tannerlinsley)
<table>
<tbody {...getTableBodyProps()}>
<tbody>
<tr>
<td align="center" valign="middle">
<a href="https://patreon.com/tannerlinsley" target="_blank">
@@ -107,7 +107,7 @@ The differences between the 2 versions are incredibly massive. Unfortunately, I
</table>
<table>
<tbody {...getTableBodyProps()}>
<tbody>
<tr>
<td align="center" valign="middle">
<a href="https://patreon.com/tannerlinsley" target="_blank">
@@ -129,7 +129,7 @@ The differences between the 2 versions are incredibly massive. Unfortunately, I
</table>
<table>
<tbody {...getTableBodyProps()}>
<tbody>
<tr>
<td align="center" valign="middle">
<a href="https://patreon.com/tannerlinsley" target="_blank">
@@ -146,7 +146,7 @@ The differences between the 2 versions are incredibly massive. Unfortunately, I
</table>
<table>
<tbody {...getTableBodyProps()}>
<tbody>
<tr>
<td valign="top">
<a href="https://patreon.com/tannerlinsley">
@@ -156,13 +156,14 @@ The differences between the 2 versions are incredibly massive. Unfortunately, I
<td>
<div><a href="https://www.metso.com/">Pekka</a></div>
<div>Jon Eickmeier</div>
<div><a href="https://github.com/Shah-Sahab">Syed Hussain<a></div>
</td>
</tr>
</tbody>
</table>
<table>
<tbody {...getTableBodyProps()}>
<tbody>
<tr>
<td valign="top">
<a href="https://patreon.com/tannerlinsley">
+39
View File
@@ -0,0 +1,39 @@
# Using TypeScript with React-Table
React-table is a very flexible library, because of this, the shape of data at almost every contact point is defined by the specific set of plugins that you choose to pass to `useTable`.
Tto get started, copy the file `react-table-config.d.ts` into your source tree (e.g. into a types folder). This expands the default types with all of the plugin extensions currently in the type definitions.
You can stop here if you like, but while this is simple, it's a bit misleading. Out of the box, these types will suggest that you have access to values that come from plugins that you aren't using, i.e. the error checking is weakened.
To bring the resulting types into better alignment with your plugins, you should edit your local copy of `react-table-config.d.ts` and comment out all of the interfaces that don't apply to your chosen set of plugins.
e.g.
if you are only using `useSortBy` and `usePagination` then you would take this:
```tsx
extends UseExpandedOptions<D>,
UseFiltersOptions<D>,
UseGroupByOptions<D>,
UsePaginationOptions<D>,
UseRowSelectOptions<D>,
UseSortByOptions<D>,
UseFiltersOptions<D>,
UseResizeColumnsOptions<D>,
Record<string, any> {}
```
and convert it to this:
```tsx
export interface TableOptions<D extends object>
extends UsePaginationOptions<D>,
UseSortByOptions<D> {}
```
Then follow the same pattern for all of the other interfaces in the file. You'll notice that many plugins don't extends all of the top level interfaces.
## Caveat
The interfaces are all global. If you have several different configurations for the table, you should create interfaces using the union of all of the plugins that you are using.
View File
+74 -107
View File
@@ -20,8 +20,6 @@ React Table is essentially a compatible collection of **custom React hooks**:
- [`useBlockLayout`](#useBlockLayout)
- [`useAbsoluteLayout`](#useAbsoluteLayout)
- [`useResizeColumns`](#useResizeColumns)
- Utility Hooks
- [`useTableState`](#useTableState)
- 3rd Party Plugin Hooks
- Want your custom plugin hook listed here? [Submit a PR!](https://github.com/tannerlinsley/react-table/compare)
@@ -54,11 +52,11 @@ const instance = useTable(
This multi-stage process is the secret sauce that allows React Table plugin hooks to work together and compose nicely, while not stepping on each others toes.
To dive deeper into plugins, see [Plugins](TODO) and the [Plugin Guide](TODO)
To dive deeper into plugins, see Plugins](TODO) and the [Plugin Guide
### Plugin Hook Order & Consistency
The order and usage of plugin hooks must follow [The Laws of Hooks](TODO), just like any other custom hook. They must always be unconditionally called in the same order.
The order and usage of plugin hooks must follow The Laws of Hooks, just like any other custom hook. They must always be unconditionally called in the same order.
> **NOTE: In the event that you want to programmatically enable or disable plugin hooks, most of them provide options to disable their functionality, eg. `options.disableSorting`**
@@ -85,12 +83,19 @@ The following options are supported via the main options object passed to `useTa
- Required
- Must be **memoized**
- The data array that you want to display on the table.
- `state: TableStateTuple[stateObject, stateUpdater]`
- `initialState: Object`
- Optional
- Must be **memoized** table state tuple. See [`useTableState`](#usetablestate) for more information.
- The state/updater pair for the table instance. You would want to override this if you plan on controlling or hoisting table state into your own code.
- Defaults to using an internal `useTableState()` instance if not defined.
- See [Controlling and Hoisting Table State](#controlling-and-hoisting-table-state)
- The initial state object for the table.
- Upon table initialization, this object is **merged over the table's `defaultState` object** (eg. `{...defaultState, ...initialState}`) that React Table and its hooks use to register default state to produce the final initial state object passed to the `React.useState` hook internally.
- `state: Object`
- Optional
- Must be **memoized**
- When either the internal `state` or this `state` object change, this object is **always merged over the internal table state** (eg. `{...state, ...overrides}`) to produce the final state object that is then passed to the `useTable` options.
- `reducer: Function(oldState, newState) => finalState`
- Optional
- Inspired by Kent C. Dodd's [State Reducer Pattern](https://kentcdodds.com/blog/the-state-reducer-pattern-with-react-hooks)
- With every `setState` call to the table's internal `React.useState` instance, this reducer is called and is allowed to modify the final state object for updating.
- It is passed the `oldState`, the `newState`, and when provided, an optional action `type`.
- `defaultColumn: Object`
- Optional
- Defaults to `{}`
@@ -175,6 +180,19 @@ The following options are supported on any column object you can pass to `column
The following properties are available on the table instance returned from `useTable`
- `state: Object`
- **Memoized** - This object reference will not change unless either the internal state or the `state` overrides option provided change.
- This is the final state object of the table, which is the product of the `initialState`, internal state, optional `state` overrides option and the `reducer` option (if applicable).
- `setState: Function(updater, type) => void`
- **Memoized** - This function reference will not change unless the internal state `reducer` is changed
- This function is used both internally by React Table, and optionally by you (the developer) to update the table state programmatically.
- `updater: Function`
- This parameter is identical to the `setState` API exposed by `React.useState`.
- If a function is passed, that function will be called with the previous state and is expected to return a new version of the state.
- If a value is passed, it will replace the state entirely.
- `type: String`
- Optional
- The action type corresponding to what action being taken against the state.
- `columns: Array<Column>`
- A **nested** array of final column objects, **similar in structure to the original columns configuration option**.
- See [Column Properties](#column-properties) for more information
@@ -209,10 +227,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
@@ -337,9 +351,11 @@ The following additional properties are available on every `Cell` object returne
The following options are supported via the main options object passed to `useTable(options)`
- `state[0].sortBy: Array<Object<id: columnID, desc: Bool>>`
- `state.sortBy: Array<Object<id: columnID, desc: Bool>>`
- Must be **memoized**
- An array of sorting objects. If there is more than one object in the array, multi-sorting will be enabled. Each sorting object should contain an `id` key with the corresponding column ID to sort by. An optional `desc` key may be set to true or false to indicated ascending or descending sorting for that column. This information is stored in state since the table is allowed to manipulate the filter through user interaction.
- `initialState.sortBy`
- Identical to the `state.sortBy` option above
- `manualSorting: Bool`
- Enables sorting detection functionality, but does not automatically perform row sorting. Turn this on if you wish to implement your own sorting outside of the table (eg. server-side or manual row grouping/nesting)
- `disableSorting: Bool`
@@ -357,12 +373,12 @@ The following options are supported via the main options object passed to `useTa
- If true, the un-sorted state will not be available to multi-sorted columns.
- `orderByFn: Function`
- Must be **memoized**
- Defaults to the built-in [default orderBy function](TODO)
- Defaults to the built-in default orderBy function
- This function is responsible for composing multiple sorting functions together for multi-sorting, and also handles both the directional sorting and stable-sorting tie breaking. Rarely would you want to override this function unless you have a very advanced use-case that requires it.
- `sortTypes: Object<sortKey: sortType>`
- Must be **memoized**
- Allows overriding or adding additional sort types for columns to use. If a column's sort type isn't found on this object, it will default to using the [built-in sort types](TODO).
- For more information on sort types, see [Sorting](TODO)
- Allows overriding or adding additional sort types for columns to use. If a column's sort type isn't found on this object, it will default to using the built-in sort types.
- For more information on sort types, see Sorting
### Column Options
@@ -384,11 +400,11 @@ The following options are supported on any `Column` object passed to the `column
- `sortType: String | Function`
- Used to compare 2 rows of data and order them correctly.
- If a **function** is passed, it must be **memoized**
- String options: `basic`, `datetime`, `alphanumeric`. Defaults to [`alphanumeric`](TODO).
- String options: `basic`, `datetime`, `alphanumeric`. Defaults to `alphanumeric`.
- The resolved function from the this string/function will be used to sort the this column's data.
- If a `string` is passed, the function with that name located on either the custom `sortTypes` option or the built-in sorting types object will be used.
- If a `function` is passed, it will be used.
- For more information on sort types, see [Sorting](TODO)
- For more information on sort types, see Sorting
### Instance Properties
@@ -444,16 +460,11 @@ The following properties are available on every `Column` object returned by the
The following options are supported via the main options object passed to `useTable(options)`
- `state[0].filters: Object<columnID: filterValue>`
- `state.filters: Object<columnID: filterValue>`
- Must be **memoized**
- An object of columnID's and their corresponding filter values. This information is stored in state since the table is allowed to manipulate the filter through user interaction.
- `defaultFilter: String | Function`
- If a **function** is passed, it must be **memoized**
- Defaults to [`text`](TODO)
- The function (or resolved function from the string) will be used as the default/fallback filter method for every column that has filtering enabled.
- If a `string` is passed, the function with that name located on the `filterTypes` option object will be used.
- If a `function` is passed, it will be used.
- For more information on filter types, see [Filtering](TODO)
- `initialState.filters`
- Identical to the `state.filters` option above
- `manualFilters: Bool`
- Enables filter detection functionality, but does not automatically perform row filtering.
- Turn this on if you wish to implement your own row filter outside of the table (eg. server-side or manual row grouping/nesting)
@@ -461,8 +472,8 @@ The following options are supported via the main options object passed to `useTa
- Disables filtering for every column in the entire table.
- `filterTypes: Object<filterKey: filterType>`
- Must be **memoized**
- Allows overriding or adding additional filter types for columns to use. If a column's filter type isn't found on this object, it will default to using the [built-in filter types](TODO).
- For more information on filter types, see [Filtering](TODO)
- Allows overriding or adding additional filter types for columns to use. If a column's filter type isn't found on this object, it will default to using the built-in filter types.
- For more information on filter types, see Filtering
### Column Options
@@ -478,11 +489,11 @@ The following options are supported on any `Column` object passed to the `column
- If set to `true`, will disable filtering for this column
- `filter: String | Function`
- Optional
- Defaults to [`text`](TODO)
- Defaults to `text`
- The resolved function from the this string/function will be used to filter the this column's data.
- If a `string` is passed, the function with that name located on either the custom `filterTypes` option or the built-in filtering types object will be used. If
- If a `function` is passed, it will be used directly.
- For more information on filter types, see [Filtering](TODO)
- For more information on filter types, see Filtering
- If a **function** is passed, it must be **memoized**
### Instance Properties
@@ -509,9 +520,12 @@ The following properties are available on every `Column` object returned by the
- An column-level function used to update the filter value for this column
- `filterValue: any`
- The current filter value for this column, resolved from the table state's `filters` object
- `preFilteredColumnRows: Array<row>`
- `preFilteredRows: Array<row>`
- The array of rows that were originally passed to this columns filter **before** they were filtered.
- This array of rows can be useful if building faceted filter options.
- `filteredRows: Array<row>`
- The resulting array of rows received from this columns filter **after** they were filtered.
- This array of rows can be useful if building faceted filter options.
### Example
@@ -532,9 +546,11 @@ The following properties are available on every `Column` object returned by the
The following options are supported via the main options object passed to `useTable(options)`
- `state[0].groupBy: Array<String>`
- `state.groupBy: Array<String>`
- Must be **memoized**
- An array of groupBy ID strings, controlling which columns are used to calculate row grouping and aggregation. This information is stored in state since the table is allowed to manipulate the groupBy through user interaction.
- `initialState.groupBy`
- Identical to the `state.groupBy` option above
- `manualGroupBy: Bool`
- Enables groupBy detection and functionality, but does not automatically perform row grouping.
- Turn this on if you wish to implement your own row grouping outside of the table (eg. server-side or manual row grouping/nesting)
@@ -542,10 +558,10 @@ The following options are supported via the main options object passed to `useTa
- Disables groupBy for the entire table.
- `aggregations: Object<aggregationKey: aggregationFn>`
- Must be **memoized**
- Allows overriding or adding additional aggregation functions for use when grouping/aggregating row values. If an aggregation key isn't found on this object, it will default to using the [built-in aggregation functions](TODO)
- Allows overriding or adding additional aggregation functions for use when grouping/aggregating row values. If an aggregation key isn't found on this object, it will default to using the built-in aggregation functions
- `groupByFn: Function`
- Must be **memoized**
- Defaults to [`defaultGroupByFn`](TODO)
- Defaults to `defaultGroupByFn`
- This function is responsible for grouping rows based on the `state.groupBy` keys provided. It's very rare you would need to customize this function.
### Column Options
@@ -642,13 +658,15 @@ The following additional properties are available on every `Cell` object returne
The following options are supported via the main options object passed to `useTable(options)`
- `state[0].expanded: Array<pathKey: String>`
- `state.expanded: Array<pathKey: String>`
- Optional
- Must be **memoized**
- An array of expanded path keys.
- If a row's path key (`row.path.join('.')`) is present in this array, that row will have an expanded state. For example, if `['3']` was passed as the `expanded` state, the **4th row in the original data array** would be expanded.
- For nested expansion, you may **join the row path with a `.`** to expand sub rows. For example, if `['3', '3.5']` was passed as the `expanded` state, then the **6th subRow of the 4th row and also the 4th row of the original data array** would be expanded.
- This information is stored in state since the table is allowed to manipulate the filter through user interaction.
- `initialState.expanded`
- Identical to the `state.expanded` option above
- `getSubRows: Function(row, relativeIndex) => Rows[]`
- Optional
- See the [useTable hook](#table-options) for more details
@@ -689,7 +707,7 @@ The following additional properties are available on every `row` object returned
- Plugin Hook
- Optional
`usePagination` is the hook that implements **row pagination**. It can be used for both client-side pagination or server-side pagination. For more information on pagination, see [Pagination](TODO)
`usePagination` is the hook that implements **row pagination**. It can be used for both client-side pagination or server-side pagination. For more information on pagination, see Pagination
> **NOTE** Some server-side pagination implementations do not use page index and instead use **token based pagination**! If that's the case, please use the `useTokenPagination` plugin instead.
@@ -697,14 +715,18 @@ The following additional properties are available on every `row` object returned
The following options are supported via the main options object passed to `useTable(options)`
- `state[0].pageSize: Int`
- `state.pageSize: Int`
- **Required**
- Defaults to `10`
- Determines the amount of rows on any given page
- `state[0].pageIndex: Int`
- `initialState.pageSize`
- Identical to the `state.pageSize` option above
- `state.pageIndex: Int`
- **Required**
- Defaults to `0`
- The index of the page that should be displayed via the `page` instance value
- `initialState.pageIndex`
- Identical to the `state.pageIndex` option above
- `pageCount: Int`
- **Required if `manualPagination` is set to `true`**
- If `manualPagination` is `true`, then this value used to determine the amount of pages available. This amount is then used to materialize the `pageOptions` and also compute the `canNextPage` values on the table instance.
@@ -769,7 +791,7 @@ The following values are provided to the table `instance`:
- Plugin Hook
- Optional
`useTokenPagination` is the hook that **aids in implementing row pagination using tokens**. It is useful for server-side pagination implementations that use **tokens** instead of page index. For more information on pagination, see [Pagination](TODO)
`useTokenPagination` is the hook that **aids in implementing row pagination using tokens**. It is useful for server-side pagination implementations that use **tokens** instead of page index. For more information on pagination, see Pagination
> Documentation Coming Soon...
@@ -778,16 +800,18 @@ The following values are provided to the table `instance`:
- Plugin Hook
- Optional
`useRowSelect` is the hook that implements **basic row selection**. For more information on row selection, see [Row Selection](TODO)
`useRowSelect` is the hook that implements **basic row selection**. For more information on row selection, see Row Selection
### Table Options
The following options are supported via the main options object passed to `useTable(options)`
- `state[0].selectedRows: Array<RowPathKey>`
- `state.selectedRowPaths: 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.
- `initialState.selectedRowPaths`
- Identical to the `state.selectedRowPaths` option above
- `manualRowSelectedKey: String`
- Optional
- Defaults to `isSelected`
@@ -813,6 +837,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
@@ -840,12 +866,14 @@ The following additional properties are available on every **prepared** `row` ob
The following options are supported via the main options object passed to `useTable(options)`
- `state[0].rowState: Object<RowPathKey:Object<any, cellState: {columnID: Object}>>`
- `state.rowState: Object<RowPathKey:Object<any, cellState: {columnID: Object}>>`
- 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 the state of the value corresponding to that key.
- Individual row states can contain anything, but they also contain a `cellState` key, which provides cell-level state based on column ID's to every
**prepared** cell in the table.
- `initialState.rowState`
- Identical to the `state.rowState` option above
- `initialRowStateAccessor: Function`
- Optional
- This function may optionally return the initial state for a row.
@@ -1000,10 +1028,12 @@ The core column options `width`, `minWidth` and `maxWidth` are used to calculate
The following options are supported via the main options object passed to `useTable(options)`
- `state[0].columnOrder: Array<ColumnID>`
- `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
@@ -1016,66 +1046,3 @@ The following values are provided to the table `instance`:
- [Source](https://github.com/tannerlinsley/react-table/tree/master/examples/column-ordering)
- [Open in CodeSandbox](https://codesandbox.io/s/github/tannerlinsley/react-table/tree/master/examples/column-ordering)
# `useTableState`
- Optional
`useTableState` is a hook that allows you to hoist the table state out of the table into your own code. You should use this hook if you need to:
- Know about the internal table state
- React to changes to the internal table state
- Manually control or override the internal table state
Some common use cases for this hook are:
- Reacting to `pageIndex` and `pageSize` changes for server-side pagination to fetch new data
- Disallowing specific states via a custom state reducer
- Enabling parent/unrelated components to manipulate the table state
### Hook Options
The following options are supported via the main options object passed to `useTable(options)`
- `initialState: Object`
- Optional
- The initial state object for the table.
- This object is **merged over the `defaultState` object** (eg. `{...defaultState, ...initialState}`) that React Table and its hooks use to register default state to produce the final initial state object passed to the resolved `useState` hook.
- `overrides: Object`
- Optional
- Must be **memoized**
- This object is **merged over the current table state** (eg. `{...state, ...overrides}`) to produce the final state object that is then passed to the `useTable` options
- `options: Object`
- `reducer: Function(oldState, newState) => finalState`
- Optional
- Inspired by Kent C. Dodd's [State Reducer Pattern](https://kentcdodds.com/blog/the-state-reducer-pattern-with-react-hooks)
- With every `setState` call to a table state (even internally), this reducer is called and is allowed to modify the final state object for updating.
- It is passed the `oldState`, the `newState`, and an optional action `type`.
- `useState`
- Optional
- Defaults to `React.useState`
- This function, if defined will be used as the state hook internally instead of the default `React.useState`. This can be useful for implementing custom state storage hooks like useLocalStorage, etc.
### Output
- `tableStateTuple: [tableState, setTableState]`
- Similar in structure to the result of `React.useState`
- **Memoized** - This tuple array will not change between renders unless the state or `useTableState` options change.
- `tableState: Object`
- **Memoized** - This object reference will not change unless the state changes.
- This is the final state object of the table, which is the product of the `initialState`, `overrides` and the `reducer` options (if applicable)
- `setTableState: Function(updater, type) => void`
- **Memoized** - This function reference will not change unless the internal state `reducer` is changed
- This function is used both internally by React Table, and optionally by you (the developer) to update the table state programmatically.
- `updater: Function`
- This function signature is **almost** (see next point) identical to the functional API exposed by `React.setState`. It is passed the previous state and is expected to return a new version of the state.
- **NOTE: `updater` must be a function. Passing a replacement object is not supported as it is with React.useState**
- `type: String`
- Optional
- The [action type](TODO) corresponding to what action being taken against the state.
### Example
- As used in Controlled Pagination
- [Source](https://github.com/tannerlinsley/react-table/tree/master/examples/pagination-controlled)
- [Open in CodeSandbox](https://codesandbox.io/s/github/tannerlinsley/react-table/tree/master/examples/pagination-controlled)
+3 -3
View File
@@ -2,7 +2,7 @@
## React Table is a "headless" UI library
React Table is a headless utility, which means out of the box, it doesn't render or supply any actual UI elements. You are in charge of utilizing the state and callbacks of the hooks provided by this library to render your own table markup. [Read this article to understand why React Table is built this way.](https://medium.com/merrickchristensen/headless-user-interface-components-565b0c0f2e18). If you don't want to, then here's a quick rundown anyway:
React Table is a headless utility, which means out of the box, it doesn't render or supply any actual UI elements. You are in charge of utilizing the state and callbacks of the hooks provided by this library to render your own table markup. [Read this article to understand why React Table is built this way](https://medium.com/merrickchristensen/headless-user-interface-components-565b0c0f2e18). If you don't want to, then here's a quick rundown anyway:
- Separation of Concerns - Not that superficial kind you read about all the time. The real kind. React Table as a library honestly has no business being in charge of your UI. The look, feel, and overall experience of your table is what makes your app or product great. The less React Table gets in the way of that, the better!
- Maintenance - By removing the massive (and seemingly endless) API surface area required to support every UI use-case, React Table can remain small, easy-to-use and simple to update/maintain.
@@ -10,7 +10,7 @@ React Table is a headless utility, which means out of the box, it doesn't render
## The React Table instance
At the heart of every React Table is the `useTable` hook and the table `instance` object that it returns. This `instance` object contains everything you'll ever need to build a table and interact with it's state. This includes, but is not limited to:
At the heart of every React Table is the `useTable` hook and the table `instance` object that it returns. This `instance` object contains everything you'll ever need to build a table and interact with its state. This includes, but is not limited to:
- Columns
- Materialized Data
@@ -23,7 +23,7 @@ At the heart of every React Table is the `useTable` hook and the table `instance
## Rendering your own UI
As of React Table v7, **you the developer** are responsible for rendering your own UI, but don't let that intimidate you! Table UI's are fun and React Table makes it so easy to wire up your own table UI. The easiest way to learn how to build your own table UI is to [see some existing React Table examples](./examples.md)!
As of React Table v7, **you the developer** are responsible for rendering your own UI, but don't let that intimidate you! Table UIs are fun and React Table makes it so easy to wire up your own table UI. The easiest way to learn how to build your own table UI is to [see some existing React Table examples](./examples.md)!
---
+1 -1
View File
@@ -38,7 +38,7 @@
- The "Kitchen Sink"
- [Source](https://github.com/tannerlinsley/react-table/tree/master/examples/kitchen-sink)
- [Open in CodeSandbox](https://codesandbox.io/s/github/tannerlinsley/react-table/tree/master/examples/kitchen-sink)
- **Controlled via `useTableState`** - These examples are more advanced because they demonstrate how to manually control and respond to the state of the table using the `useTableState` hook.
- **Controlled** - These examples are more advanced because they demonstrate how to manually control and respond to the state of the table.
- Pagination (Controlled)
- [Source](https://github.com/tannerlinsley/react-table/tree/master/examples/pagination-controlled)
- [Open in CodeSandobx](https://codesandbox.io/s/github/tannerlinsley/react-table/tree/master/examples/pagination-controlled)
+1 -1
View File
@@ -294,7 +294,7 @@ function Table({ columns, data }) {
</tbody>
</table>
<pre>
<code>{JSON.stringify(state[0], null, 2)}</code>
<code>{JSON.stringify(state, null, 2)}</code>
</pre>
</>
)
+1 -1
View File
@@ -95,7 +95,7 @@ function Table({ columns, data }) {
</tbody>
</table>
<pre>
<code>{JSON.stringify(state[0], null, 2)}</code>
<code>{JSON.stringify(state, null, 2)}</code>
</pre>
</>
)
+1 -1
View File
@@ -95,7 +95,7 @@ function Table({ columns, data, updateMyData, disablePageResetOnDataChange }) {
nextPage,
previousPage,
setPageSize,
state: [{ pageIndex, pageSize }],
state: { pageIndex, pageSize },
} = useTable(
{
columns,
+1 -1
View File
@@ -40,7 +40,7 @@ function Table({ columns: userColumns, data }) {
headerGroups,
rows,
prepareRow,
state: [{ expanded }],
state: { expanded },
} = useTable(
{
columns: userColumns,
+1 -1
View File
@@ -235,7 +235,7 @@ function Table({ columns, data }) {
<>
<div>
<pre>
<code>{JSON.stringify(state[0].filters, null, 2)}</code>
<code>{JSON.stringify(state.filters, null, 2)}</code>
</pre>
</div>
<table {...getTableProps()}>
+1 -1
View File
@@ -40,7 +40,7 @@ function Table({ columns, data }) {
headerGroups,
rows,
prepareRow,
state: [{ groupBy, expanded }],
state: { groupBy, expanded },
} = useTable(
{
columns,
+10 -6
View File
@@ -8,7 +8,6 @@ import {
useGroupBy,
useExpanded,
useRowSelect,
useTableState,
} from 'react-table'
import matchSorter from 'match-sorter'
@@ -265,8 +264,6 @@ function Table({ columns, data, updateMyData, disablePageResetOnDataChange }) {
[]
)
const tableState = useTableState({ pageIndex: 2 })
// Use the state and functions returned from useTable to build your UI
const {
getTableProps,
@@ -285,7 +282,14 @@ 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,
@@ -293,7 +297,7 @@ function Table({ columns, data, updateMyData, disablePageResetOnDataChange }) {
defaultColumn,
filterTypes,
// nestExpandedRows: true,
state: tableState,
initialState: { pageIndex: 2 },
// updateMyData isn't part of the API, but
// anything we put into these options will
// automatically be available on the instance.
@@ -438,7 +442,7 @@ function Table({ columns, data, updateMyData, disablePageResetOnDataChange }) {
groupBy,
expanded,
filters,
selectedRows,
selectedRowPaths,
},
null,
2
+10 -6
View File
@@ -8,7 +8,6 @@ import {
useGroupBy,
useExpanded,
useRowSelect,
useTableState,
} from 'react-table'
import matchSorter from 'match-sorter'
@@ -265,8 +264,6 @@ function Table({ columns, data, updateMyData, disablePageResetOnDataChange }) {
[]
)
const tableState = useTableState({ pageIndex: 2 })
// Use the state and functions returned from useTable to build your UI
const {
getTableProps,
@@ -285,7 +282,14 @@ 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,
@@ -293,7 +297,7 @@ function Table({ columns, data, updateMyData, disablePageResetOnDataChange }) {
defaultColumn,
filterTypes,
// nestExpandedRows: true,
state: tableState,
initialState: { pageIndex: 2 },
// updateMyData isn't part of the API, but
// anything we put into these options will
// automatically be available on the instance.
@@ -438,7 +442,7 @@ function Table({ columns, data, updateMyData, disablePageResetOnDataChange }) {
groupBy,
expanded,
filters,
selectedRows,
selectedRowPaths,
},
null,
2
+94 -82
View File
@@ -1,8 +1,8 @@
import React from 'react'
import styled from 'styled-components'
import { useTable, useTableState, usePagination } from 'react-table'
import React from "react";
import styled from "styled-components";
import { useTable, usePagination } from "react-table";
import makeData from './makeData'
import makeData from "./makeData";
const Styles = styled.div`
padding: 1rem;
@@ -35,7 +35,7 @@ const Styles = styled.div`
.pagination {
padding: 0.5rem;
}
`
`;
// Let's add a fetchData method to our Table component that will be used to fetch
// new data when pagination state changes
@@ -45,19 +45,8 @@ function Table({
data,
fetchData,
loading,
pageCount: controlledPageCount,
pageCount: controlledPageCount
}) {
// Use useTableState to hoist the state (and state updater) out of the table and control it
const tableState = useTableState({ pageIndex: 0 })
// Now we can get our table state from the hoisted table state tuple
const [{ pageIndex, pageSize }] = tableState
// Listen for changes in pagination and use the state to fetch our new data
React.useEffect(() => {
fetchData({ pageIndex, pageSize })
}, [fetchData, pageIndex, pageSize])
const {
getTableProps,
getTableBodyProps,
@@ -72,19 +61,30 @@ function Table({
nextPage,
previousPage,
setPageSize,
rows,
// Get the state from the instance
state: { pageIndex, pageSize }
} = useTable(
{
columns,
data,
state: tableState, // Pass our hoisted table state
initialState: { pageIndex: 0 }, // Pass our hoisted table state
manualPagination: true, // Tell the usePagination
// hook that we'll handle our own data fetching
// This means we'll also have to provide our own
// pageCount.
pageCount: controlledPageCount,
pageCount: controlledPageCount
},
usePagination
)
);
// Now we can get our table state from the hoisted table state tuple
// Listen for changes in pagination and use the state to fetch our new data
React.useEffect(() => {
console.log(pageIndex);
fetchData({ pageIndex, pageSize });
}, [fetchData, pageIndex, pageSize]);
// Render the UI for your table
return (
@@ -97,7 +97,7 @@ function Table({
pageSize,
pageCount,
canNextPage,
canPreviousPage,
canPreviousPage
},
null,
2
@@ -109,7 +109,7 @@ function Table({
{headerGroups.map(headerGroup => (
<tr {...headerGroup.getHeaderGroupProps()}>
{headerGroup.headers.map(column => (
<th {...column.getHeaderProps()}>{column.render('Header')}</th>
<th {...column.getHeaderProps()}>{column.render("Header")}</th>
))}
</tr>
))}
@@ -121,18 +121,23 @@ function Table({
<tr {...row.getRowProps()}>
{row.cells.map(cell => {
return (
<td {...cell.getCellProps()}>{cell.render('Cell')}</td>
)
<td {...cell.getCellProps()}>{cell.render("Cell")}</td>
);
})}
</tr>
)
)}
{loading ? (
// Use our custom loading state to show a loading indicator
<tr>
<tr>
{loading ? (
// Use our custom loading state to show a loading indicator
<td>Loading...</td>
</tr>
) : null}
) : (
<td>
Showing {page.length} of ~{controlledPageCount * pageSize}{" "}
results
</td>
)}
</tr>
</tbody>
</table>
{/*
@@ -141,39 +146,39 @@ function Table({
*/}
<div className="pagination">
<button onClick={() => gotoPage(0)} disabled={!canPreviousPage}>
{'<<'}
</button>{' '}
{"<<"}
</button>{" "}
<button onClick={() => previousPage()} disabled={!canPreviousPage}>
{'<'}
</button>{' '}
{"<"}
</button>{" "}
<button onClick={() => nextPage()} disabled={!canNextPage}>
{'>'}
</button>{' '}
{">"}
</button>{" "}
<button onClick={() => gotoPage(pageCount - 1)} disabled={!canNextPage}>
{'>>'}
</button>{' '}
{">>"}
</button>{" "}
<span>
Page{' '}
Page{" "}
<strong>
{pageIndex + 1} of {pageOptions.length}
</strong>{' '}
</strong>{" "}
</span>
<span>
| Go to page:{' '}
| Go to page:{" "}
<input
type="number"
defaultValue={pageIndex + 1}
onChange={e => {
const page = e.target.value ? Number(e.target.value) - 1 : 0
gotoPage(page)
const page = e.target.value ? Number(e.target.value) - 1 : 0;
gotoPage(page);
}}
style={{ width: '100px' }}
style={{ width: "100px" }}
/>
</span>{' '}
</span>{" "}
<select
value={pageSize}
onChange={e => {
setPageSize(Number(e.target.value))
setPageSize(Number(e.target.value));
}}
>
{[10, 20, 30, 40, 50].map(pageSize => (
@@ -184,79 +189,86 @@ function Table({
</select>
</div>
</>
)
);
}
// Let's simulate a large dataset on the server (outside of our component)
const serverData = makeData(10000)
const serverData = makeData(10000);
function App() {
const columns = React.useMemo(
() => [
{
Header: 'Name',
Header: "Name",
columns: [
{
Header: 'First Name',
accessor: 'firstName',
Header: "First Name",
accessor: "firstName"
},
{
Header: 'Last Name',
accessor: 'lastName',
},
],
Header: "Last Name",
accessor: "lastName"
}
]
},
{
Header: 'Info',
Header: "Info",
columns: [
{
Header: 'Age',
accessor: 'age',
Header: "Age",
accessor: "age"
},
{
Header: 'Visits',
accessor: 'visits',
Header: "Visits",
accessor: "visits"
},
{
Header: 'Status',
accessor: 'status',
Header: "Status",
accessor: "status"
},
{
Header: 'Profile Progress',
accessor: 'progress',
},
],
},
Header: "Profile Progress",
accessor: "progress"
}
]
}
],
[]
)
);
// We'll start our table without any data
const [data, setData] = React.useState([])
const [loading, setLoading] = React.useState(false)
const [pageCount, setPageCount] = React.useState(0)
const [data, setData] = React.useState([]);
const [loading, setLoading] = React.useState(false);
const [pageCount, setPageCount] = React.useState(0);
const fetchIdRef = React.useRef(0);
const fetchData = React.useCallback(({ pageSize, pageIndex }) => {
// This will get called when the table needs new data
// You could fetch your data from literally anywhere,
// even a server. But for this example, we'll just fake it.
// Give this fetch an ID
const fetchID = ++fetchIdRef.current;
// Set the loading state
setLoading(true)
setLoading(true);
// We'll even set a delay to simulate a server here
setTimeout(() => {
const startRow = pageSize * pageIndex
const endRow = startRow + pageSize
setData(serverData.slice(startRow, endRow))
// Only update the data if this is the latest fetch
if (fetchID === fetchIdRef.current) {
const startRow = pageSize * pageIndex;
const endRow = startRow + pageSize;
setData(serverData.slice(startRow, endRow));
// Your server could send back total page count.
// For now we'll just fake it, too
setPageCount(Math.ceil(serverData.length / pageSize))
// Your server could send back total page count.
// For now we'll just fake it, too
setPageCount(Math.ceil(serverData.length / pageSize));
setLoading(false)
}, 1000)
}, [])
setLoading(false);
}
}, 1000);
}, []);
return (
<Styles>
@@ -268,7 +280,7 @@ function App() {
pageCount={pageCount}
/>
</Styles>
)
);
}
export default App
export default App;
+1 -1
View File
@@ -42,7 +42,7 @@ function MyTable(props) {
prepareRow,
+ pageOptions,
+ page,
+ state: [{ pageIndex, pageSize }],
+ state: { pageIndex, pageSize },
+ gotoPage,
+ previousPage,
+ nextPage,
+3 -5
View File
@@ -1,6 +1,6 @@
import React from 'react'
import styled from 'styled-components'
import { useTable, usePagination, useTableState } from 'react-table'
import { useTable, usePagination } from 'react-table'
import makeData from './makeData'
@@ -38,8 +38,6 @@ const Styles = styled.div`
`
function Table({ columns, data }) {
const tableState = useTableState({ pageIndex: 2 })
// Use the state and functions returned from useTable to build your UI
const {
getTableProps,
@@ -58,12 +56,12 @@ function Table({ columns, data }) {
nextPage,
previousPage,
setPageSize,
state: [{ pageIndex, pageSize }],
state: { pageIndex, pageSize },
} = useTable(
{
columns,
data,
state: tableState,
initialState: { pageIndex: 2 },
},
usePagination
)
+15 -3
View File
@@ -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>
</>
)
+1 -1
View File
@@ -44,7 +44,7 @@ function Table({ columns: userColumns, data, renderRowSubComponent }) {
rows,
prepareRow,
flatColumns,
state: [{ expanded }],
state: { expanded },
} = useTable(
{
columns: userColumns,
@@ -0,0 +1,5 @@
{
"infiniteLoopProtection": false,
"hardReloadOnChange": false,
"view": "browser"
}
Vendored
+615 -273
View File
@@ -1,288 +1,630 @@
declare module 'react-table' {
import { ReactNode, useState } from 'react'
// TypeScript Version: 3.5
type StringKey<D> = Extract<keyof D, string>
type IdType<D> = StringKey<D> | string
import { ReactNode, ComponentType, MouseEvent } from 'react'
type SortingRule<D> = {
id: IdType<D>
desc: boolean
}
/**
* The empty definitions of below provides a base definition for the parts used by useTable, that can then be extended in the users code.
*
* @example
* export interface TableOptions<D extends object = {}}>
* extends
* UseExpandedOptions<D>,
* UseFiltersOptions<D> {}
*/
export interface TableOptions<D extends object> extends UseTableOptions<D> {}
export type SortingRules<D> = SortingRule<D>[]
export interface TableInstance<D extends object = {}>
extends Omit<TableOptions<D>, 'columns' | 'state'>,
UseTableInstanceProps<D> {}
export type SortByFn = (a: any, b: any, desc: boolean) => 0 | 1 | -1
export interface TableState<
D extends object = {}
> {} /* tslint:disable-line no-empty-interface */ // eslint-disable-line @typescript-eslint/no-empty-interface
export type Filters<D> = Record<IdType<D>, string>
export interface Hooks<D extends object = {}> extends UseTableHooks<D> {}
export interface Cell<D = {}> extends TableInstance<D> {
cell: { value: any }
column: Column<D>
row: Row<D>
render: (type: 'Cell' | 'Aggregated', userProps?: any) => any
isGrouped?: boolean
isAggregated?: boolean
isRepeatedValue?: boolean
getCellProps: () => any
}
export interface Cell<D extends object = {}> extends UseTableCellProps<D> {}
export interface Row<D = {}> {
index: number
cells: Cell<D>[]
getRowProps: (userProps?: any) => any
original: D
path: any[]
values: any[]
depth: number
}
export interface Column<D extends object = {}>
extends UseTableColumnOptions<D> {}
export interface UseExpandedRow<D = {}> {
subRows?: D[]
groupByID?: string | number
toggleExpanded?: () => any
isExpanded?: boolean
isAggregated?: boolean
}
export interface ColumnInstance<D extends object = {}>
extends Omit<Column<D>, 'id'>,
UseTableColumnProps<D> {}
export type AccessorFn<D> = (
originalRow: D,
index: number,
sub: {
subRows: [D]
depth: number
data: [D]
}
) => unknown
export interface HeaderGroup<D extends object = {}>
extends ColumnInstance<D>,
UseTableHeaderGroupProps<D> {}
export interface HeaderColumn<D> {
/**
* This string/function is used to build the data model for your column.
*/
accessor: IdType<D> | AccessorFn<D>
Header?: ReactNode | ((props: TableInstance<D>) => ReactNode)
Filter?: ReactNode | ((props: TableInstance<D>) => ReactNode)
Cell?: ReactNode | ((cell: Cell<D>) => ReactNode)
/**
* This is the unique ID for the column. It is used by reference in things like sorting, grouping, filtering etc.
*/
id?: IdType<D>
minWidth?: string | number
maxWidth?: string | number
width?: string | number
disableSorting?: boolean
canSortBy?: boolean
sortByFn?: SortByFn
defaultSortDesc?: boolean
isAggregated?: any
}
export interface Row<D extends object = {}> extends UseTableRowProps<D> {}
export interface Column<D> extends HeaderColumn<D> {
show?: boolean | ((instance: TableInstance<D>) => boolean)
columns?: Column<D>[]
}
/* #region useTable */
export function useTable<D extends object = {}>(
options: TableOptions<D>,
...plugins: PluginHook<D>[]
): TableInstance<D>
export type Page<D = {}> = Row<D>[]
/**
* NOTE: To use custom options, use "Interface Merging" to add the custom options
*/
export type UseTableOptions<D extends object> = {
columns: Column<D>[]
data: D[]
} & Partial<{
initialState: Partial<TableState<D>>
state: Partial<TableState<D>>
reducer: (
oldState: TableState<D>,
newState: TableState<D>,
type: string
) => TableState<D>
defaultColumn: Partial<Column<D>>
initialRowStateKey: IdType<D>
getSubRows: (row: Row<D>, relativeIndex: number) => Row<D>[]
getRowID: (row: Row<D>, relativeIndex: number) => string
debug: boolean
}>
export interface EnhancedColumn<D>
extends Omit<Column<D>, 'columns'>,
TableInstance<D> {
id: IdType<D>
column: Column<D>
render: (type: 'Header' | 'Filter', userProps?: any) => any
getHeaderProps: (userProps?: any) => any
getSortByToggleProps: (userProps?: any) => any
isSorted: boolean
isSortedDesc: boolean
sortedIndex: number
isVisible: boolean
canSort?: boolean
}
export interface UseTableHooks<D extends object> {
columnsBeforeHeaderGroups: ((
flatColumns: Column<D>[],
instance: TableInstance<D>
) => Column<D>[])[]
columnsBeforeHeaderGroupsDeps: ((
deps: any[],
instance: TableInstance<D>
) => any[])[]
useMain: ((instance: TableInstance<D>) => TableInstance<D>)[]
useRows: ((rows: Row<D>[], instance: TableInstance<D>) => Row<D>[])[]
prepareRow: ((row: Row<D>, instance: TableInstance<D>) => Row<D>)[]
export interface HeaderGroup<D = {}> {
headers: EnhancedColumn<D>[]
getHeaderGroupProps: (userProps?: any) => any
}
export interface Hooks {
columnsBeforeHeaderGroups: any[]
columnsBeforeHeaderGroupsDeps: any[]
useMain: any[]
useColumns: any[]
useHeaders: any[]
useHeaderGroups: any[]
useRows: any[]
prepareRow: any[]
getTableProps: any[]
getRowProps: any[]
getHeaderGroupProps: any[]
getHeaderProps: any[]
getCellProps: any[]
}
export interface RowsProps {
subRowsKey: string
}
export interface FiltersProps {
filterFn: () => void
manualFilters: boolean
disableFilters: boolean
setFilter: () => any
setAllFilters: () => any
}
export interface UsePaginationState {
pageIndex: number
pageSize: number
pageCount: number
rowCount: number
}
export interface UsePaginationValues<D = {}> {
page: Page<D>
pageIndex: number // yes, this is on instance and state
pageSize: number // yes, this is on instance and state
canPreviousPage: boolean
canNextPage: boolean
nextPage: () => any
previousPage: () => any
setPageSize: (size: number) => any
pageOptions: any[]
manualPagination: boolean
paginateExpandedRows: boolean
disablePageResetOnDataChange: boolean
pageCount: number
gotoPage: (page: number) => any
}
export interface UseFiltersState<D> {
filters?: Filters<D>
}
export interface UseFiltersValues<D> {
setFilter: (columnID: keyof D, value: string) => void
setAllFilters: (values: Filters<D>) => void
disableFilters: boolean
}
export interface UseGroupByValues {
groupByFn: any
manualGroupBy: boolean
disableGrouping: boolean
aggregations: any
}
export interface UseGroupByState {
groupBy: string[]
isAggregated?: boolean
}
export interface UseExpandedValues {
toggleExpanded?: () => any
}
export interface UseSortbyOptions {
sortByFn?: SortByFn
manualSorting?: boolean
disableSorting?: boolean
defaultSortDesc?: boolean
disableMultiSort?: boolean
}
export interface UseSortbyState<D> {
sortBy?: SortingRules<D>
}
export interface TableInstance<D = {}> extends TableOptions<D> {
hooks: Hooks
rows: Row<D>[]
columns: EnhancedColumn<D>[]
headerGroups: HeaderGroup<D>[]
headers: HeaderGroup<D>[]
getTableProps: (userProps?: any) => any
getRowProps: (userProps?: any) => any
prepareRow: (row: Row<D>) => any
}
export interface TableOptions<D = {}> {
data: D[]
columns: HeaderColumn<D>[]
state: State<D>
debug?: boolean
loading: boolean
defaultColumn?: Partial<Column<D>>
}
// The empty definition of TableState is not an error. It provides a definition
// for the state, that can then be extended in the users code.
//
// e.g.
//
// export interface TableState<D = {}}>
// extends UsePaginationState,
// UseGroupByState,
// UseSortbyState<D>,
// UseFiltersState<D> {}
// eslint-disable-next-line @typescript-eslint/no-empty-interface
export interface TableState<D = {}> {}
export type SetState<D> = (
updater: (old: TableState<D>) => TableState<D>,
actions: any
) => void
export type State<D> = [TableState<D>, SetState<D>]
export function useTable<D = {}>(
props: TableOptions<D>,
...plugins: any[]
): TableInstance<D>
export function useFilters<D = {}>(
props: TableOptions<D>
): TableOptions<D> & {
rows: Row<D>[]
}
export function useSortBy<D = {}>(
props: TableOptions<D>
): TableOptions<D> & {
rows: Row<D>[]
}
export function useGroupBy<D = {}>(
props: TableOptions<D>
): TableOptions<D> & { rows: Row<D>[] }
export function usePagination<D = {}>(
props: TableOptions<D>
): UsePaginationValues<D>
export function useExpanded<D = {}>(
props: TableOptions<D>
): TableOptions<D> & {
toggleExpandedByPath: () => any
expandedDepth: []
rows: Row<D>[]
}
export function useTableState<D = {}>(
initialState?: Partial<TableState<D>>,
overriddenState?: Partial<TableState<D>>,
options?: {
reducer?: (
oldState: TableState<D>,
newState: TableState<D>,
type: string
) => any
useState?: typeof useState
}
): State<D>
export const actions: Record<string, string>
export function addActions(...actions: string[]): void
export const defaultState: Record<string, any>
// Prop Hooks
getTableProps: ((instance: TableInstance<D>) => object)[]
getTableBodyProps: ((instance: TableInstance<D>) => object)[]
getRowProps: ((row: Row<D>, instance: TableInstance<D>) => object)[]
getHeaderGroupProps: ((
headerGroup: HeaderGroup<D>,
instance: TableInstance<D>
) => object)[]
getHeaderProps: ((column: Column<D>, instance: TableInstance<D>) => object)[]
getCellProps: ((cell: Cell<D>, instance: TableInstance<D>) => object)[]
}
export interface UseTableColumnOptions<D extends object>
extends Accessor<D>,
Partial<{
columns: Column<D>[]
show: boolean | ((instance: TableInstance<D>) => boolean)
Header: Renderer<HeaderProps<D>>
Cell: Renderer<CellProps<D>>
width?: number
minWidth?: number
maxWidth?: number
}> {}
export interface UseTableInstanceProps<D extends object> {
columns: ColumnInstance<D>[]
flatColumns: ColumnInstance<D>[]
headerGroups: HeaderGroup<D>[]
headers: ColumnInstance<D>[]
flatHeaders: ColumnInstance<D>[]
rows: Row<D>[]
getTableProps: (props?: object) => object
getTableBodyProps: (props?: object) => object
prepareRow: (row: Row<D>) => void
rowPaths: string[]
flatRows: Row<D>[]
state: TableState<D>
setState: SetState<D>
totalColumnsWidth: number
}
export interface UseTableHeaderGroupProps<D extends object> {
headers: ColumnInstance<D>[]
getHeaderGroupProps: (props?: object) => object
totalHeaderCount: number
}
export interface UseTableColumnProps<D extends object> {
id: IdType<D>
isVisible: boolean
render: (type: 'Header' | string, props?: object) => ReactNode
getHeaderProps: (props?: object) => object
parent: ColumnInstance<D>
depth: number
index: number
}
export interface UseTableRowProps<D extends object> {
cells: Cell<D>[]
values: Record<IdType<D>, CellValue>
getRowProps: (props?: object) => object
index: number
original: D
path: IdType<D>[]
subRows: Row<D>[]
}
export interface UseTableCellProps<D extends object> {
column: ColumnInstance<D>
row: Row<D>
value: CellValue
getCellProps: (props?: object) => object
render: (type: 'Cell' | string, userProps?: object) => ReactNode
}
export type HeaderProps<D extends object> = TableInstance<D> & {
column: ColumnInstance<D>
} & Record<string, any>
export type CellProps<D extends object> = TableInstance<D> & {
column: ColumnInstance<D>
row: Row<D>
cell: Cell<D>
} & Record<string, any>
// NOTE: At least one of (id | accessor | Header as string) required
export interface Accessor<D extends object> {
accessor?:
| IdType<D>
| ((
originalRow: D,
index: number,
sub: {
subRows: D[]
depth: number
data: D[]
}
) => CellValue)
id?: IdType<D>
}
/* #endregion */
// Plugins
/* #region useColumnOrder */
export function useColumnOrder<D extends object = {}>(hooks: Hooks<D>): void
export namespace useColumnOrder {
const pluginName = 'useColumnOrder'
}
export interface UseColumnOrderState<D extends object> {
columnOrder: IdType<D>[]
}
export interface UseColumnOrderInstanceProps<D extends object> {
setColumnOrder: (updater: (columnOrder: IdType<D>[]) => IdType<D>[]) => void
}
/* #endregion */
/* #region useExpanded */
export function useExpanded<D extends object = {}>(hooks: Hooks<D>): void
export namespace useExpanded {
const pluginName = 'useExpanded'
}
export type UseExpandedOptions<D extends object> = Partial<{
getSubRows: (row: Row<D>, relativeIndex: number) => Row<D>[]
manualExpandedKey: IdType<D>
paginateExpandedRows: boolean
}>
export interface UseExpandedHooks<D extends object> {
getExpandedToggleProps: ((
row: Row<D>,
instance: TableInstance<D>
) => object)[]
}
export interface UseExpandedState<D extends object> {
expanded: IdType<D>[]
}
export interface UseExpandedInstanceProps<D extends object> {
rows: Row<D>[]
toggleExpandedByPath: (path: IdType<D>[], isExpanded: boolean) => void
expandedDepth: number
}
export interface UseExpandedRowProps<D extends object> {
isExpanded: boolean
canExpand: boolean
subRows: Row<D>[]
toggleExpanded: (isExpanded?: boolean) => void
getExpandedToggleProps: (props?: object) => object
}
/* #endregion */
/* #region useFilters */
export function useFilters<D extends object = {}>(hooks: Hooks<D>): void
export namespace useFilters {
const pluginName = 'useFilters'
}
export type UseFiltersOptions<D extends object> = Partial<{
manualFilters: boolean
disableFilters: boolean
filterTypes: Filters<D>
}>
export interface UseFiltersState<D extends object> {
filters: Filters<D>
}
export type UseFiltersColumnOptions<D extends object> = Partial<{
disableFilters: boolean
Filter: Renderer<FilterProps<D>>
filter: FilterType<D> | DefaultFilterTypes | keyof Filters<D>
}>
export interface UseFiltersInstanceProps<D extends object> {
rows: Row<D>[]
preFilteredRows: Row<D>[]
setFilter: (
columnId: IdType<D>,
updater: ((filterValue: FilterValue) => FilterValue) | FilterValue
) => void
setAllFilters: (
updater: Filters<D> | ((filters: Filters<D>) => Filters<D>)
) => void
}
export interface UseFiltersColumnProps<D extends object> {
canFilter: boolean
setFilter: (
updater: ((filterValue: FilterValue) => FilterValue) | FilterValue
) => void
filterValue: FilterValue
preFilteredRows: Row<D>[]
filteredRows: Row<D>[]
}
export type FilterProps<D extends object> = HeaderProps<D>
export type FilterValue = any
export type Filters<D extends object> = Record<IdType<D>, FilterValue>
export type DefaultFilterTypes =
| 'text'
| 'exactText'
| 'exactTextCase'
| 'includes'
| 'includesAll'
| 'exact'
| 'equals'
| 'between'
export interface FilterType<D extends object> {
(
rows: Row<D>[],
columnId: IdType<D>,
filterValue: FilterValue,
column: ColumnInstance<D>
): Row<D>[]
autoRemove?: (filterValue: FilterValue) => boolean
}
/* #endregion */
/* #region useGroupBy */
export function useGroupBy<D extends object = {}>(hooks: Hooks<D>): void
export namespace useGroupBy {
const pluginName = 'useGroupBy'
}
export type UseGroupByOptions<D extends object> = Partial<{
manualGroupBy: boolean
disableGrouping: boolean
aggregations: Record<string, AggregatorFn<D>>
groupByFn: (rows: Row<D>[], columnId: IdType<D>) => Record<string, Row<D>>
}>
export interface UseGroupByHooks<D extends object> {
getGroupByToggleProps: ((
header: HeaderGroup<D>,
instance: TableInstance<D>
) => object)[]
}
export interface UseGroupByState<D extends object> {
groupBy: IdType<D>[]
}
export type UseGroupByColumnOptions<D extends object> = Partial<{
aggregate: Aggregator<D> | Aggregator<D>[]
Aggregated: Renderer<CellProps<D>>
disableGrouping: boolean
groupByBoundary: boolean
}>
export interface UseGroupByInstanceProps<D extends object> {
rows: Row<D>[]
preGroupedRows: Row<D>[]
toggleGroupBy: (columnId: IdType<D>, toggle: boolean) => void
}
export interface UseGroupByColumnProps<D extends object> {
canGroupBy: boolean
isGrouped: boolean
groupedIndex: number
toggleGroupBy: () => void
}
export interface UseGroupByHeaderProps<D extends object> {
getGroupByToggleProps: (props?: object) => object
}
export interface UseGroupByRowProps<D extends object> {
isAggregated: boolean
groupByID: IdType<D>
groupByVal: string
values: Record<IdType<D>, AggregatedValue>
subRows: Row<D>[]
depth: number
path: IdType<D>[]
index: number
}
export interface UseGroupByCellProps<D extends object> {
isGrouped: boolean
isRepeatedValue: boolean
isAggregated: boolean
}
export type DefaultAggregators =
| 'sum'
| 'average'
| 'median'
| 'uniqueCount'
| 'count'
export type AggregatorFn<D extends object> = (
columnValues: CellValue[],
rows: Row<D>[]
) => AggregatedValue
export type Aggregator<D extends object> =
| AggregatorFn<D>
| DefaultAggregators
| string
export type AggregatedValue = any
/* #endregion */
/* #region usePagination */
export function usePagination<D extends object = {}>(hooks: Hooks<D>): void
export namespace usePagination {
const pluginName = 'usePagination'
}
export type UsePaginationOptions<D extends object> = Partial<{
pageCount: number
manualPagination: boolean
disablePageResetOnDataChange: boolean
paginateExpandedRows: boolean
}>
export interface UsePaginationState<D extends object> {
pageSize: number
pageIndex: number
}
export interface UsePaginationInstanceProps<D extends object> {
page: Row<D>[]
pageCount: number
pageOptions: number[]
canPreviousPage: boolean
canNextPage: boolean
gotoPage: (updater: ((pageIndex: number) => number) | number) => void
previousPage: () => void
nextPage: () => void
setPageSize: (pageSize: number) => void
pageIndex: number
pageSize: number
}
/* #endregion */
/* #region useRowSelect */
export function useRowSelect<D extends object = {}>(hooks: Hooks<D>): void
export namespace useRowSelect {
const pluginName = 'useRowSelect'
}
export type UseRowSelectOptions<D extends object> = Partial<{
manualRowSelectedKey: IdType<D>
}>
export interface UseRowSelectHooks<D extends object> {
getToggleRowSelectedProps: ((
row: Row<D>,
instance: TableInstance<D>
) => object)[]
getToggleAllRowsSelectedProps: ((instance: TableInstance<D>) => object)[]
}
export interface UseRowSelectState<D extends object> {
selectedRows: IdType<D>[]
}
export interface UseRowSelectInstanceProps<D extends object> {
toggleRowSelected: (rowPath: IdType<D>, set?: boolean) => void
toggleRowSelectedAll: (set?: boolean) => void
getToggleAllRowsSelectedProps: (props?: object) => object
isAllRowsSelected: boolean
}
export interface UseRowSelectRowProps<D extends object> {
isSelected: boolean
toggleRowSelected: (set?: boolean) => void
getToggleRowSelectedProps: (props?: object) => object
}
/* #endregion */
/* #region useRowState */
export function useRowState<D extends object = {}>(hooks: Hooks<D>): void
export namespace useRowState {
const pluginName = 'useRowState'
}
export type UseRowStateOptions<D extends object> = Partial<{
initialRowStateAccessor: (row: Row<D>) => UseRowStateLocalState<D>
}>
export interface UseRowStateState<D extends object> {
rowState: Partial<{
cellState: UseRowStateLocalState<D>
rowState: UseRowStateLocalState<D>
}>
}
export interface UseRowStateInstanceProps<D extends object> {
setRowState: (rowPath: string[], updater: UseRowUpdater) => void // Purposely not exposing action
setCellState: (
rowPath: string[],
columnID: IdType<D>,
updater: UseRowUpdater
) => void
}
export interface UseRowStateRowProps<D extends object> {
state: UseRowStateLocalState<D>
setState: (updater: UseRowUpdater) => void
}
export interface UseRowStateCellProps<D extends object> {
state: UseRowStateLocalState<D>
setState: (updater: UseRowUpdater) => void
}
export type UseRowUpdater<T = unknown> = T | ((prev: T) => T)
export type UseRowStateLocalState<D extends object, T = unknown> = Record<
IdType<D>,
T
>
/* #endregion */
/* #region useSortBy */
export function useSortBy<D extends object = {}>(hooks: Hooks<D>): void
export namespace useSortBy {
const pluginName = 'useSortBy'
}
export type UseSortByOptions<D extends object> = Partial<{
manualSorting: boolean
disableSorting: boolean
disableMultiSort: boolean
isMultiSortEvent: (e: MouseEvent) => boolean
maxMultiSortColCount: number
disableSortRemove: boolean
disabledMultiRemove: boolean
orderByFn: (
rows: Row<D>[],
sortFns: SortByFn<D>[],
directions: boolean[]
) => Row<D>[] // CHECK
sortTypes: Record<string, SortByFn<D>>
}>
export interface UseSortByHooks<D extends object> {
getSortByToggleProps: ((
column: Column<D>,
instance: TableInstance<D>
) => object)[]
}
export interface UseSortByState<D extends object> {
sortBy: SortingRule<D>[]
}
export type UseSortByColumnOptions<D extends object> = Partial<{
disableSorting: boolean
sortDescFirst: boolean
sortInverted: boolean
sortType: SortByFn<D> | DefaultSortTypes | string
}>
export interface UseSortByInstanceProps<D extends object> {
rows: Row<D>[]
preSortedRows: Row<D>[]
toggleSortBy: (
columnId: IdType<D>,
descending: boolean,
isMulti: boolean
) => void
}
export interface UseSortByColumnProps<D extends object> {
canSort: boolean
toggleSortBy: (descending: boolean, multi: boolean) => void
getSortByToggleProps: (props?: object) => object
clearSorting: () => void
isSorted: boolean
sortedIndex: number
isSortedDesc: boolean | undefined
}
export type SortByFn<D extends object> = (
rowA: Row<D>,
rowB: Row<D>,
columnId: IdType<D>
) => 0 | 1 | -1
export type DefaultSortTypes = 'alphanumeric' | 'datetime' | 'basic'
export interface SortingRule<D> {
id: IdType<D>
desc?: boolean
}
/* #endregion */
/* #region useAbsoluteLayout */
export function useAbsoluteLayout<D extends object = {}>(hooks: Hooks<D>): void
export namespace useAbsoluteLayout {
const pluginName = 'useAbsoluteLayout'
}
/* #endregion */
/* #region useBlockLayout */
export function useBlockLayout<D extends object = {}>(hooks: Hooks<D>): void
export namespace useBlockLayout {
const pluginName = 'useBlockLayout'
}
/* #endregion */
/* #region useResizeColumns */
export function useResizeColumns<D extends object = {}>(hooks: Hooks<D>): void
export namespace useResizeColumns {
const pluginName = 'useResizeColumns'
}
export interface UseResizeColumnsOptions<D extends object> {
disableResizing?: boolean
}
export interface UseResizeColumnsColumnOptions<D extends object> {
disableResizing?: boolean
}
export interface UseResizeColumnsHeaderProps<D extends object> {
getResizerProps: (props?: object) => object
canResize: boolean
isResizing: boolean
}
/* #endregion */
// Additional API
export const actions: Record<string, string>
export function addActions(...actions: string[]): void
export const defaultState: Record<string, any>
// Helpers
export type StringKey<D> = Extract<keyof D, string>
export type IdType<D> = StringKey<D> | string
export type CellValue = any
export type Renderer<Props> = ComponentType<Props> | ReactNode
export interface PluginHook<D extends object> {
(hooks: Hooks<D>): void
pluginName: string
}
export type SetState<D extends object> = (
updater: (old: TableState<D>) => TableState<D>,
type: keyof typeof actions
) => void
-11527
View File
File diff suppressed because it is too large Load Diff
+3 -3
View File
@@ -1,6 +1,6 @@
{
"name": "react-table",
"version": "7.0.0-beta.6",
"version": "7.0.0-beta.12",
"description": "A fast, lightweight, opinionated table and datagrid built on React",
"license": "MIT",
"homepage": "https://github.com/tannerlinsley/react-table#readme",
@@ -20,7 +20,7 @@
"sideEffects": false,
"scripts": {
"commit": "git add . && git-cz",
"test": "is-ci 'test:ci' 'test:dev'",
"test": "is-ci \"test:ci\" \"test:dev\"",
"test:dev": "jest --watch",
"test:ci": "jest",
"build": "rollup -c",
@@ -75,7 +75,7 @@
"eslint-plugin-react-hooks": "1.7.0",
"eslint-plugin-standard": "^4.0.0",
"husky": "^3.0.3",
"is-ci-cli": "^1.1.1",
"is-ci-cli": "^2.0.0",
"jest": "^24.8.0",
"jest-cli": "^24.8.0",
"jest-runner-eslint": "^0.7.4",
+59
View File
@@ -0,0 +1,59 @@
declare module 'react-table' {
// take this file as-is, or comment out the sections that don't apply to your plugin configuration
export interface TableOptions<D extends object>
extends UseExpandedOptions<D>,
UseFiltersOptions<D>,
UseGroupByOptions<D>,
UsePaginationOptions<D>,
UseRowSelectOptions<D>,
UseSortByOptions<D>,
UseFiltersOptions<D>,
UseResizeColumnsOptions<D>,
// note that having Record here allows you to add anything to the options, this matches the spirit of the
// underlying js library, but might be cleaner if it's replaced by a more specific type that matches your
// feature set, this is a safe default.
Record<string, any> {}
export interface TableInstance<D extends object = {}>
extends UseColumnOrderInstanceProps<D>,
UseExpandedInstanceProps<D>,
UseFiltersInstanceProps<D>,
UseGroupByInstanceProps<D>,
UsePaginationInstanceProps<D>,
UseRowSelectInstanceProps<D>,
UseRowStateInstanceProps<D>,
UseSortByInstanceProps<D> {}
export interface TableState<D extends object = {}>
extends UseColumnOrderState<D>,
UseExpandedState<D>,
UseFiltersState<D>,
UseGroupByState<D>,
UsePaginationState<D>,
UseRowSelectState<D>,
UseSortByState<D> {}
export interface Column<D extends object = {}>
extends UseFiltersColumnOptions<D>,
UseGroupByColumnOptions<D>,
UseSortByColumnOptions<D>,
UseResizeColumnsColumnOptions<D> {}
export interface ColumnInstance<D extends object = {}>
extends UseFiltersColumnProps<D>,
UseGroupByColumnProps<D>,
UseSortByColumnProps<D>,
UseResizeColumnsHeaderProps<D> {}
export interface Cell<D extends object = {}>
extends UseTableCellProps<D>,
UseGroupByCellProps<D>,
UseRowStateCellProps<D> {}
export interface Row<D extends object = {}>
extends UseExpandedRowProps<D>,
UseGroupByRowProps<D>,
UseRowSelectRowProps<D>,
UseRowStateRowProps<D> {}
}
+5 -1
View File
@@ -44,7 +44,11 @@ includes.autoRemove = val => !val || !val.length
export const includesAll = (rows, id, filterValue) => {
return rows.filter(row => {
const rowValue = row.values[id]
return filterValue.every(val => rowValue.includes(val))
return (
rowValue &&
rowValue.length &&
filterValue.every(val => rowValue.includes(val))
)
})
}
+49 -26
View File
@@ -12,8 +12,6 @@ import {
determineHeaderVisibility,
} from '../utils'
import { useTableState } from './useTableState'
const propTypes = {
// General
data: PropTypes.array.isRequired,
@@ -27,8 +25,11 @@ const propTypes = {
const renderErr =
'You must specify a valid render component. This could be "column.Cell", "column.Header", "column.Filter", "column.Aggregated" or any other custom renderer component.'
const defaultColumnInstance = {}
export const defaultState = {}
const defaultInitialState = {}
const defaultColumnInstance = {}
const defaultReducer = (old, newState) => newState
const defaultGetSubRows = (row, index) => row.subRows || []
const defaultGetRowID = (row, index) => index
@@ -39,21 +40,46 @@ export const useTable = (props, ...plugins) => {
// Destructure props
let {
data,
state: userState,
columns: userColumns,
initialState = defaultInitialState,
state: userState,
defaultColumn = defaultColumnInstance,
getSubRows = defaultGetSubRows,
getRowID = defaultGetRowID,
reducer = defaultReducer,
debug,
} = props
debug = process.env.NODE_ENV === 'production' ? false : debug
// Always provide a default table state
const defaultState = useTableState()
// But use the users table state if provided
const state = userState || defaultState
let [originalState, originalSetState] = React.useState({
...defaultState,
...initialState,
})
const state = React.useMemo(() => {
if (userState) {
const newState = {
...originalState,
}
Object.keys(userState).forEach(key => {
newState[key] = userState[key]
})
return newState
}
return originalState
}, [originalState, userState])
const setState = React.useCallback(
(updater, type) => {
return originalSetState(old => {
const newState = typeof updater === 'function' ? updater(old) : updater
return reducer(old, newState, type)
})
},
[reducer]
)
// The table instance ref
let instanceRef = React.useRef({})
@@ -61,7 +87,8 @@ export const useTable = (props, ...plugins) => {
Object.assign(instanceRef.current, {
...props,
data, // The raw data
state, // The resolved table state
state,
setState, // The resolved table state
plugins, // All resolved plugins
hooks: {
columnsBeforeHeaderGroups: [],
@@ -137,12 +164,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 +180,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 +224,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
-46
View File
@@ -1,46 +0,0 @@
import React from 'react'
//
export const defaultState = {}
const defaultReducer = (old, newState) => newState
export const useTableState = (
initialState = {},
overrides,
{ reducer = defaultReducer, useState: userUseState = React.useState } = {}
) => {
let [state, setState] = userUseState({
...defaultState,
...initialState,
})
const overriddenState = React.useMemo(() => {
const newState = {
...state,
}
if (overrides) {
Object.keys(overrides).forEach(key => {
newState[key] = overrides[key]
})
}
return newState
}, [overrides, state])
const overriddenStateRef = React.useRef()
overriddenStateRef.current = overriddenState
const reducedSetState = React.useCallback(
(updater, type) => {
return setState(old => {
const newState = updater(old)
return reducer(old, newState, type)
})
},
[reducer, setState]
)
return React.useMemo(() => [overriddenState, reducedSetState], [
overriddenState,
reducedSetState,
])
}
+1 -2
View File
@@ -1,8 +1,7 @@
import * as utils from './utils'
export { utils }
export { defaultColumn } from './utils'
export { useTable } from './hooks/useTable'
export { useTableState, defaultState } from './hooks/useTableState'
export { useTable, defaultState } from './hooks/useTable'
export { useExpanded } from './plugin-hooks/useExpanded'
export { useFilters } from './plugin-hooks/useFilters'
export { useGroupBy } from './plugin-hooks/useGroupBy'
@@ -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"
+1 -1
View File
@@ -52,7 +52,7 @@ function Table({ columns: userColumns, data, SubComponent }) {
rows,
prepareRow,
flatColumns,
state: [{ expanded }],
state: { expanded },
} = useTable(
{
columns: userColumns,
+2 -5
View File
@@ -1,7 +1,6 @@
import React from 'react'
import { render, fireEvent } from '@testing-library/react'
import { useTable } from '../../hooks/useTable'
import { useTableState } from '../../hooks/useTableState'
import { usePagination } from '../usePagination'
const data = [...new Array(100)].map((d, i) => ({
@@ -14,8 +13,6 @@ const data = [...new Array(100)].map((d, i) => ({
}))
function Table({ columns, data }) {
const tableState = useTableState({ pageIndex: 2 })
const {
getTableProps,
getTableBodyProps,
@@ -30,12 +27,12 @@ function Table({ columns, data }) {
nextPage,
previousPage,
setPageSize,
state: [{ pageIndex, pageSize }],
state: { pageIndex, pageSize },
} = useTable(
{
columns,
data,
state: tableState,
initialState: { pageIndex: 2 },
},
usePagination
)
+3 -3
View File
@@ -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>
</>
)
+4 -6
View File
@@ -2,7 +2,7 @@ import React from 'react'
import PropTypes from 'prop-types'
import { addActions, actions } from '../actions'
import { defaultState } from '../hooks/useTableState'
import { defaultState } from '../hooks/useTable'
defaultState.columnOrder = []
@@ -14,7 +14,7 @@ const propTypes = {
export const useColumnOrder = hooks => {
hooks.columnsBeforeHeaderGroupsDeps.push((deps, instance) => {
return [...deps, instance.state[0].columnOrder]
return [...deps, instance.state.columnOrder]
})
hooks.columnsBeforeHeaderGroups.push(columnsBeforeHeaderGroups)
hooks.useMain.push(useMain)
@@ -24,7 +24,7 @@ useColumnOrder.pluginName = 'useColumnOrder'
function columnsBeforeHeaderGroups(columns, instance) {
const {
state: [{ columnOrder }],
state: { columnOrder },
} = instance
// If there is no order, return the normal columns
@@ -56,9 +56,7 @@ function columnsBeforeHeaderGroups(columns, instance) {
function useMain(instance) {
PropTypes.checkPropTypes(propTypes, instance, 'property', 'useColumnOrder')
const {
state: [, setState],
} = instance
const { setState } = instance
const setColumnOrder = React.useCallback(
updater => {
+11 -3
View File
@@ -3,7 +3,7 @@ import PropTypes from 'prop-types'
import { mergeProps, applyPropHooks, expandRows } from '../utils'
import { addActions, actions } from '../actions'
import { defaultState } from '../hooks/useTableState'
import { defaultState } from '../hooks/useTable'
defaultState.expanded = []
@@ -31,7 +31,8 @@ function useMain(instance) {
paginateExpandedRows = true,
expandSubRows = true,
hooks,
state: [{ expanded }, setState],
state: { expanded },
setState,
} = instance
const toggleExpandedByPath = (path, set) => {
@@ -87,7 +88,14 @@ function useMain(instance) {
}
return rows
}, [debug, paginateExpandedRows, rows, manualExpandedKey, expanded])
}, [
debug,
paginateExpandedRows,
rows,
manualExpandedKey,
expanded,
expandSubRows,
])
const expandedDepth = findExpandedDepth(expanded)
+37 -7
View File
@@ -4,7 +4,7 @@ import PropTypes from 'prop-types'
import { getFirstDefined, isFunction } from '../utils'
import * as filterTypes from '../filterTypes'
import { addActions, actions } from '../actions'
import { defaultState } from '../hooks/useTableState'
import { defaultState } from '../hooks/useTable'
defaultState.filters = {}
@@ -33,14 +33,17 @@ function useMain(instance) {
const {
debug,
rows,
flatRows,
flatColumns,
filterTypes: userFilterTypes,
manualFilters,
disableFilters,
state: [{ filters }, setState],
state: { filters },
setState,
} = instance
const preFilteredRows = rows
const preFilteredFlatRows = flatRows
const setFilter = (id, updater) => {
const column = flatColumns.find(d => d.id === id)
@@ -129,11 +132,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')
@@ -169,7 +177,14 @@ function useMain(instance) {
// Pass the rows, id, filterValue and column to the filterMethod
// to get the filtered rows back
return filterMethod(filteredSoFar, columnID, filterValue, column)
column.filteredRows = filterMethod(
filteredSoFar,
columnID,
filterValue,
column
)
return column.filteredRows
},
rows
)
@@ -179,6 +194,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 +210,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,
@@ -208,6 +235,7 @@ function useMain(instance) {
// using every column's preFilteredRows value
nonFilteredColumns.forEach(column => {
column.preFilteredRows = filteredRows
column.filteredRows = filteredRows
})
}, [filteredRows, filters, flatColumns])
@@ -216,7 +244,9 @@ function useMain(instance) {
setFilter,
setAllFilters,
preFilteredRows,
preFilteredFlatRows,
rows: filteredRows,
flatRows: filteredFlatRows,
}
}
+5 -4
View File
@@ -3,7 +3,7 @@ import PropTypes from 'prop-types'
import * as aggregations from '../aggregations'
import { addActions, actions } from '../actions'
import { defaultState } from '../hooks/useTableState'
import { defaultState } from '../hooks/useTable'
import {
mergeProps,
applyPropHooks,
@@ -40,7 +40,7 @@ const propTypes = {
export const useGroupBy = hooks => {
hooks.columnsBeforeHeaderGroups.push(columnsBeforeHeaderGroups)
hooks.columnsBeforeHeaderGroupsDeps.push((deps, instance) => {
deps.push(instance.state[0].groupBy)
deps.push(instance.state.groupBy)
return deps
})
hooks.useMain.push(useMain)
@@ -48,7 +48,7 @@ export const useGroupBy = hooks => {
useGroupBy.pluginName = 'useGroupBy'
function columnsBeforeHeaderGroups(flatColumns, { state: [{ groupBy }] }) {
function columnsBeforeHeaderGroups(flatColumns, { state: { groupBy } }) {
// Sort grouped columns to the start of the column list
// before the headers are built
@@ -80,7 +80,8 @@ function useMain(instance) {
aggregations: userAggregations = {},
hooks,
plugins,
state: [{ groupBy }, setState],
state: { groupBy },
setState,
} = instance
ensurePluginOrder(plugins, [], 'useGroupBy', ['useSortBy', 'useExpanded'])
+4 -5
View File
@@ -3,7 +3,7 @@ import PropTypes from 'prop-types'
//
import { addActions, actions } from '../actions'
import { defaultState } from '../hooks/useTableState'
import { defaultState } from '../hooks/useTable'
import { ensurePluginOrder, safeUseLayoutEffect, expandRows } from '../utils'
defaultState.pageSize = 10
@@ -37,10 +37,8 @@ function useMain(instance) {
pageCount: userPageCount,
paginateExpandedRows = true,
expandSubRows = true,
state: [
{ pageSize, pageIndex, filters, groupBy, sortBy, expanded },
setState,
],
state: { pageSize, pageIndex, filters, groupBy, sortBy, expanded },
setState,
} = instance
ensurePluginOrder(
@@ -105,6 +103,7 @@ function useMain(instance) {
return expandRows(page, { manualExpandedKey, expanded, expandSubRows })
}, [
debug,
expandSubRows,
expanded,
manualExpandedKey,
manualPagination,
+3 -2
View File
@@ -2,7 +2,7 @@ import PropTypes from 'prop-types'
//
import { defaultState } from '../hooks/useTableState'
import { defaultState } from '../hooks/useTable'
import { defaultColumn, getFirstDefined } from '../utils'
import { mergeProps, applyPropHooks } from '../utils'
@@ -29,7 +29,8 @@ const useBeforeDimensions = instance => {
flatHeaders,
disableResizing,
hooks: { getHeaderProps },
state: [{ columnResizing }, setState],
state: { columnResizing },
setState,
} = instance
getHeaderProps.push(() => {
+91 -24
View File
@@ -1,10 +1,16 @@
import React from 'react'
import PropTypes from 'prop-types'
import { mergeProps, applyPropHooks, ensurePluginOrder } from '../utils'
import {
mergeProps,
applyPropHooks,
ensurePluginOrder,
safeUseLayoutEffect,
} from '../utils'
import { addActions, actions } from '../actions'
import { defaultState } from '../hooks/useTableState'
import { defaultState } from '../hooks/useTable'
defaultState.selectedRows = []
defaultState.selectedRowPaths = []
addActions('toggleRowSelected', 'toggleRowSelectedAll')
@@ -15,20 +21,53 @@ 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')
const {
hooks,
manualRowSelectedKey = 'isSelected',
disableSelectedRowsResetOnDataChange,
plugins,
rowPaths,
state: [{ selectedRows }, setState],
flatRows,
data,
state: { selectedRowPaths },
setState,
} = instance
ensurePluginOrder(
@@ -38,34 +77,66 @@ 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 isRowSelectedMountedRef = React.useRef()
// Bypass any effects from firing when this changes
const disableSelectedRowsResetOnDataChangeRef = React.useRef()
disableSelectedRowsResetOnDataChangeRef.current = disableSelectedRowsResetOnDataChange
safeUseLayoutEffect(() => {
if (
isRowSelectedMountedRef.current &&
!disableSelectedRowsResetOnDataChangeRef.current
) {
setState(
old => ({
...old,
selectedRowPaths: [],
}),
actions.pageChange
)
}
isRowSelectedMountedRef.current = true
}, [setState, data])
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 +147,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 +173,7 @@ function useMain(instance) {
return {
...old,
selectedRows: [...newSelectedRows.values()],
selectedRowPaths: [...newSelectedRows.values()],
}
}, actions.toggleRowSelected)
}
@@ -128,9 +199,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 +234,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
+3 -2
View File
@@ -2,7 +2,7 @@ import React from 'react'
import PropTypes from 'prop-types'
import { addActions, actions } from '../actions'
import { defaultState } from '../hooks/useTableState'
import { defaultState } from '../hooks/useTable'
defaultState.rowState = {}
@@ -25,7 +25,8 @@ function useMain(instance) {
hooks,
rows,
initialRowStateAccessor,
state: [{ rowState }, setState],
state: { rowState },
setState,
} = instance
const setRowState = React.useCallback(
+3 -2
View File
@@ -3,7 +3,7 @@ import PropTypes from 'prop-types'
import { ensurePluginOrder, defaultColumn } from '../utils'
import { addActions, actions } from '../actions'
import { defaultState } from '../hooks/useTableState'
import { defaultState } from '../hooks/useTable'
import * as sortTypes from '../sortTypes'
import {
mergeProps,
@@ -63,7 +63,8 @@ function useMain(instance) {
maxMultiSortColCount = Number.MAX_SAFE_INTEGER,
flatHeaders,
hooks,
state: [{ sortBy }, setState],
state: { sortBy },
setState,
plugins,
} = instance
+4 -1
View File
@@ -288,7 +288,10 @@ export function flexRender(Comp, props) {
function isClassComponent(component) {
return (
typeof component === 'function' &&
!!Object.getPrototypeOf(component).isReactComponent
!!(() => {
let proto = Object.getPrototypeOf(component)
return proto.prototype && proto.prototype.isReactComponent
})()
)
}
View File
+35 -6
View File
@@ -2374,6 +2374,15 @@ cross-spawn@^6.0.0, cross-spawn@^6.0.5:
shebang-command "^1.2.0"
which "^1.2.9"
cross-spawn@^7.0.0:
version "7.0.1"
resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.1.tgz#0ab56286e0f7c24e153d04cc2aa027e43a9a5d14"
integrity sha512-u7v4o84SwFpD32Z8IIcPZ6z1/ie24O6RU3RbtL5Y316l3KuHVPx9ItBgWQ6VlfAFnRnTtMUrsQ9MUUTuEZjogg==
dependencies:
path-key "^3.1.0"
shebang-command "^2.0.0"
which "^2.0.1"
css-select-base-adapter@^0.1.1:
version "0.1.1"
resolved "https://registry.yarnpkg.com/css-select-base-adapter/-/css-select-base-adapter-0.1.1.tgz#3b2ff4972cc362ab88561507a95408a1432135d7"
@@ -4016,12 +4025,13 @@ is-callable@^1.1.4:
resolved "https://registry.yarnpkg.com/is-callable/-/is-callable-1.1.4.tgz#1e1adf219e1eeb684d691f9d6a05ff0d30a24d75"
integrity sha512-r5p9sxJjYnArLjObpjA4xu5EKI3CuKHkJXMhT7kwbpUyIFD1n5PMAsoPvWnvtZiNz7LjkYDRZhd7FlI0eMijEA==
is-ci-cli@^1.1.1:
version "1.1.1"
resolved "https://registry.yarnpkg.com/is-ci-cli/-/is-ci-cli-1.1.1.tgz#2dc924d192fe8d76074dcb96a2122a7d00d0ee83"
integrity sha512-c8xV1IkPvcdB9fAKo3QZ4SmdzsgPHOZ8Xz88T9CCSMrksKMn41R4jUxUP1UbFNPYiYoz8XvHt3RZ3ODKIPyLYQ==
is-ci-cli@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/is-ci-cli/-/is-ci-cli-2.0.0.tgz#606dd5051c636ac80e1deb4c1c30aa5294220159"
integrity sha512-pgdXwbBaRfyG3XJ/+AYbgCb5WE10TZwj4pvoSYI1YrmGDslcS0lhvqvAKmZrSq2248/jGoZ2g9yC63APlBy1uQ==
dependencies:
is-ci "^1.0.10"
cross-spawn "^7.0.0"
is-ci "^2.0.0"
is-ci@^1.0.10:
version "1.2.1"
@@ -6171,7 +6181,7 @@ path-key@^2.0.0, path-key@^2.0.1:
resolved "https://registry.yarnpkg.com/path-key/-/path-key-2.0.1.tgz#411cadb574c5a140d3a4b1910d40d80cc9f40b40"
integrity sha1-QRyttXTFoUDTpLGRDUDYDMn0C0A=
path-key@^3.0.0:
path-key@^3.0.0, path-key@^3.1.0:
version "3.1.0"
resolved "https://registry.yarnpkg.com/path-key/-/path-key-3.1.0.tgz#99a10d870a803bdd5ee6f0470e58dfcd2f9a54d3"
integrity sha512-8cChqz0RP6SHJkMt48FW0A7+qUOn+OsnOsVtzI59tZ8m+5bCSk7hzwET0pulwOM2YMn9J1efb07KB9l9f30SGg==
@@ -7052,11 +7062,23 @@ shebang-command@^1.2.0:
dependencies:
shebang-regex "^1.0.0"
shebang-command@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/shebang-command/-/shebang-command-2.0.0.tgz#ccd0af4f8835fbdc265b82461aaf0c36663f34ea"
integrity sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==
dependencies:
shebang-regex "^3.0.0"
shebang-regex@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-1.0.0.tgz#da42f49740c0b42db2ca9728571cb190c98efea3"
integrity sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM=
shebang-regex@^3.0.0:
version "3.0.0"
resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172"
integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==
shelljs@0.7.6:
version "0.7.6"
resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.7.6.tgz#379cccfb56b91c8601e4793356eb5382924de9ad"
@@ -7873,6 +7895,13 @@ which@^1.2.14, which@^1.2.9, which@^1.3.0:
dependencies:
isexe "^2.0.0"
which@^2.0.1:
version "2.0.1"
resolved "https://registry.yarnpkg.com/which/-/which-2.0.1.tgz#f1cf94d07a8e571b6ff006aeb91d0300c47ef0a4"
integrity sha512-N7GBZOTswtB9lkQBZA4+zAXrjEIWAUOB93AvzUiudRzRxhUdLURQ7D/gAIMY1gatT/LTbmbcv8SiYazy3eYB7w==
dependencies:
isexe "^2.0.0"
wide-align@^1.1.0:
version "1.1.3"
resolved "https://registry.yarnpkg.com/wide-align/-/wide-align-1.1.3.tgz#ae074e6bdc0c14a431e804e624549c633b000457"