From 4b7c85624b985ea64db6bae54cd8a903c2c10378 Mon Sep 17 00:00:00 2001 From: Michael Stramel Date: Mon, 14 Oct 2019 17:17:37 -0500 Subject: [PATCH] Add selectedFlatRows (#1597) --- TYPESCRIPT.md | 4 ++-- index.d.ts | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/TYPESCRIPT.md b/TYPESCRIPT.md index 9b7c0bc..8d228d3 100644 --- a/TYPESCRIPT.md +++ b/TYPESCRIPT.md @@ -2,7 +2,7 @@ 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. +To 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. @@ -32,7 +32,7 @@ export interface TableOptions UseSortByOptions {} ``` -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. +Then follow the same pattern for all of the other interfaces in the file. You'll notice that many plugins don't extend all of the top-level interfaces. ## Caveat diff --git a/index.d.ts b/index.d.ts index 7bc89c7..26ac6ba 100644 --- a/index.d.ts +++ b/index.d.ts @@ -452,6 +452,7 @@ export interface UseRowSelectInstanceProps { toggleRowSelectedAll: (set?: boolean) => void getToggleAllRowsSelectedProps: (props?: object) => object isAllRowsSelected: boolean + selectedFlatRows: Array> } export interface UseRowSelectRowProps { @@ -521,7 +522,7 @@ export type UseSortByOptions = Partial<{ rows: Array>, sortFns: Array>, directions: boolean[] - ) => Array> // CHECK + ) => Array> sortTypes: Record> }>