Skip to content

Commit b493f93

Browse files
committed
updated API doc links
1 parent 871c2a7 commit b493f93

8 files changed

Lines changed: 27 additions & 27 deletions

File tree

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Relate by UI - Relatable
22
--------------------
33
This package is part of the [Relate by UI Kit](http://neo4j-apps.github.io/relate-by-ui), an opiniated collection of components and styles based on Semantic UI.
44

5-
This package provides an abstraction over the [react-table API](https://github.com/tannerlinsley/react-table/blob/master/docs/api.md) to facilitate creating performant data tables.
5+
This package provides an abstraction over the [react-table API](https://react-table.js.org/api) to facilitate creating performant data tables.
66

77
---
88

@@ -20,7 +20,7 @@ This package provides an abstraction over the [react-table API](https://github.c
2020
import React from 'react';
2121
import Relatable from '@relate-by-ui/relatable';
2222

23-
// see https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#usetable
23+
// see https://react-table.js.org/api/usetable
2424
const COLUMNS = []
2525
const DATA = []
2626

@@ -32,7 +32,7 @@ const ATable = () => <Relatable columns={COLUMNS} data={DATA}/>
3232
import React from 'react';
3333
import Relatable, {Table, Toolbar, Pagination} from '@relate-by-ui/relatable';
3434

35-
// see https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#usetable
35+
// see https://react-table.js.org/api/usetable
3636
const COLUMNS = []
3737
const DATA = []
3838

@@ -72,7 +72,7 @@ import {
7272
} from '@relate-by-ui/relatable'
7373

7474
export interface IRelatableProps {
75-
// see https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#usetable
75+
// see https://react-table.js.org/api/usetable
7676
columns: any[];
7777
data: any[];
7878
defaultColumn?: any;
@@ -156,7 +156,7 @@ function Toolbar(props: React.PropsWithChildren<MenuProps> = {}): JSX.Element;
156156
import React from 'react';
157157
import Relatable, {Table, Toolbar} from '@relate-by-ui/relatable';
158158

159-
// see https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#usetable
159+
// see https://react-table.js.org/api/usetable
160160
const COLUMNS = []
161161
const DATA = []
162162

@@ -173,7 +173,7 @@ const ATable = () => (
173173
import React from 'react';
174174
import Relatable, {Table, Toolbar, FilterableToolbar, GroupableToolbar} from '@relate-by-ui/relatable';
175175

176-
// see https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#usetable
176+
// see https://react-table.js.org/api/usetable
177177
const COLUMNS = []
178178
const DATA = []
179179

@@ -259,10 +259,10 @@ There are currently six add-ons available:
259259
4. [Paginated](#paginated)
260260
5. [Selectable](#selectable)
261261

262-
Please note that add-ons are ordinal, as defined by the [react-table API](https://github.com/tannerlinsley/react-table/blob/master/docs/api.md), and subject to the [Rules of Hooks](https://reactjs.org/docs/hooks-rules.html).
262+
Please note that add-ons are ordinal, as defined by the [react-table API](https://react-table.js.org/api//blob/master/docs/api.md), and subject to the [Rules of Hooks](https://reactjs.org/docs/hooks-rules.html).
263263

264264
### Filterable
265-
[react-table hook](https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#useFilters)
265+
[react-table hook](https://react-table.js.org/api/useFilters)
266266

267267
[Source](./src/add-ons/with-filters.add-on.ts)
268268

@@ -278,7 +278,7 @@ export interface IWithFiltersOptions<Data extends object = any> extends UseFilte
278278
defaultFilterFunc?: FilterFunc<Data>;
279279
onFilterChange?: FilterSetter<Data>;
280280

281-
// react-table state override https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#useFilters
281+
// react-table state override https://react-table.js.org/api/useFilters
282282
filters?: {id: IdType<Data>, value: any}[];
283283
}
284284
```
@@ -297,7 +297,7 @@ const FilterableTable = () => <Relatable
297297
```
298298

299299
### Groupable
300-
[react-table hook](https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#useGroupBy)
300+
[react-table hook](https://react-table.js.org/api/useGroupBy)
301301

302302
[Source](./src/add-ons/with-grouping.add-on.ts)
303303

@@ -313,7 +313,7 @@ export interface IWithGroupingOptions<Data extends object = any> extends UseGrou
313313
defaultAggregateCell?: React.FC<ICellProps>;
314314
onGroupChange?: GroupSetter<Data>;
315315

316-
// react-table state override https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#useGroupBy
316+
// react-table state override https://react-table.js.org/api/useGroupBy
317317
groupBy?: IdType<Data>[];
318318
}
319319
```
@@ -332,7 +332,7 @@ const GroupableTable = () => <Relatable
332332
```
333333

334334
### Sortable
335-
[react-table hook](https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#useSortBy)
335+
[react-table hook](https://react-table.js.org/api/useSortBy)
336336

337337
[Source](./src/add-ons/with-sorting.add-on.ts)
338338

@@ -346,7 +346,7 @@ import {SortSetter} from '@relate-by-ui/relatable';
346346
export interface IWithSortingOptions<Data extends object = any> extends UseSortByOptions<Data> {
347347
onSortChange?: SortSetter<Data>;
348348

349-
// react-table state override https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#useSortBy
349+
// react-table state override https://react-table.js.org/api/useSortBy
350350
sortBy?: SortingRule<Data>[];
351351
}
352352
```
@@ -364,7 +364,7 @@ const SortableTable = () => <Relatable
364364
```
365365

366366
### Expandable
367-
[react-table hook](https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#useExpanded)
367+
[react-table hook](https://react-table.js.org/api/useExpanded)
368368

369369
[Source](./src/add-ons/with-expanded.add-on.ts)
370370

@@ -379,7 +379,7 @@ export interface IWithExpandedOptions<Data extends object = any> extends UseExpa
379379
onExpandedChange?: ExpandSetter<Data>;
380380
expandedRowComponent?: React.FC<IRowProps>;
381381

382-
// react-table state override https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#useExpanded
382+
// react-table state override https://react-table.js.org/api/useExpanded
383383
expanded?: IdType<Data>[];
384384
}
385385
```
@@ -397,7 +397,7 @@ const ExpandableTable = () => <Relatable
397397
```
398398

399399
### Paginated
400-
[react-table hook](https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#usePagination)
400+
[react-table hook](https://react-table.js.org/api/usePagination)
401401

402402
[Source](./src/add-ons/with-pagination.add-on.ts)
403403

@@ -413,7 +413,7 @@ export interface IWithPaginationOptions<Data extends object = any> extends UsePa
413413
onPageSizeChange?: PageSizeSetter;
414414
pageSizeOptions?: number[];
415415

416-
// react-table state overrides https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#usePagination
416+
// react-table state overrides https://react-table.js.org/api/usePagination
417417
pageSize?: number;
418418
pageIndex?: number;
419419
}
@@ -432,7 +432,7 @@ const PaginatedTable = () => <Relatable
432432
```
433433

434434
### Selectable
435-
[react-table hook](https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#useRowSelect)
435+
[react-table hook](https://react-table.js.org/api/useRowSelect)
436436

437437
[Source](./src/add-ons/with-selection.add-on.ts)
438438

@@ -446,7 +446,7 @@ import { SelectSetter } from '@relate-by-ui/relatable';
446446
export interface IWithSelectionOptions<Data extends object = any> extends UseRowSelectOptions<Data> {
447447
onSelectionChange?: SelectSetter<Data>;
448448

449-
// react-table state override https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#useRowSelect
449+
// react-table state override https://react-table.js.org/api/useRowSelect
450450
selectedRowPaths?: {[id: string]: boolean};
451451
}
452452
```
@@ -468,7 +468,7 @@ const SelectableTable = () => <Relatable
468468
## Further Enhancements
469469

470470
### Cell Renderers
471-
The react-table API allows you to specify custom [Cells](https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#column-options), [Aggregates](https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#column-options-3), and [Filters](https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#column-options-2) for columns.
471+
The react-table API allows you to specify custom [Cells](https://react-table.js.org/api/column-options), [Aggregates](https://react-table.js.org/api/column-options-3), and [Filters](https://react-table.js.org/api/column-options-2) for columns.
472472
As a courtesy this library provides some standard components for this purpose.
473473
You can create your own simply by copying the implementation.
474474

src/add-ons/with-expanded.add-on.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export interface IWithExpandedOptions<Data extends object = any> extends UseExpa
1111
onExpandedChange?: ExpandSetter<Data>;
1212
expandedRowComponent?: React.FC<IRowProps>;
1313

14-
// react-table state override https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#useExpanded
14+
// react-table state override https://react-table.js.org/api/useExpanded
1515
expanded?: IdType<Data>[];
1616
}
1717

src/add-ons/with-filters.add-on.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface IWithFiltersOptions<Data extends object = any> extends UseFilte
2222
defaultFilterCell?: React.FC<IFilterFieldProps>;
2323
onFilterChange?: FilterSetter<Data>;
2424

25-
// react-table state override https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#useFilters
25+
// react-table state override https://react-table.js.org/api/useFilters
2626
// with custom filter value array
2727
filters?: Filters<Data>[];
2828
}

src/add-ons/with-grouping.add-on.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export interface IWithGroupingOptions<Data extends object = any> extends UseGrou
2020
defaultAggregateCell?: React.FC<ICellProps>;
2121
onGroupChange?: GroupSetter<Data>;
2222

23-
// react-table state override https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#useGroupBy
23+
// react-table state override https://react-table.js.org/api/useGroupBy
2424
groupBy?: IdType<Data>[];
2525
}
2626

src/add-ons/with-pagination.add-on.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export interface IWithPaginationOptions<Data extends object = any> extends UsePa
1111
onPageSizeChange?: PageSizeSetter;
1212
pageSizeOptions?: number[];
1313

14-
// react-table state overrides https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#usePagination
14+
// react-table state overrides https://react-table.js.org/api/usePagination
1515
pageSize?: number;
1616
pageIndex?: number;
1717
}

src/add-ons/with-selection.add-on.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import arrayHasItems from '../utils/array-has-items';
1313
export interface IWithSelectionOptions<Data extends object = any> extends UseRowSelectOptions<Data> {
1414
onSelectionChange?: SelectSetter<Data>;
1515

16-
// react-table state override https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#useRowSelect
16+
// react-table state override https://react-table.js.org/api/useRowSelect
1717
selectedRowIds?: {[id: string]: boolean};
1818
}
1919

src/add-ons/with-sorting.add-on.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { IRelatableStateInstance, SORT_ACTIONS, SortSetter, TableAddOnReturn } f
77
export interface IWithSortingOptions<Data extends object = any> extends UseSortByOptions<Data> {
88
onSortChange?: SortSetter<Data>;
99

10-
// react-table state override https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#useSortBy
10+
// react-table state override https://react-table.js.org/api/useSortBy
1111
sortBy?: SortingRule<Data>[];
1212
}
1313

src/components/relatable/relatable.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import Pagination from '../pagination';
1919
import { StyleWrapper } from './relatable.styled';
2020

2121
export interface IRelatableProps<Data extends object = any> {
22-
// see https://github.com/tannerlinsley/react-table/blob/master/docs/api.md#usetable
22+
// see https://react-table.js.org/api/usetable
2323
columns: Column<Data>[];
2424
data: Data[];
2525
defaultColumn?: Partial<Column<Data>>;

0 commit comments

Comments
 (0)