You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -144,7 +144,7 @@ For example:
144
144
###### Public methods
145
145
146
146
`Grid` and `Collection` components can be forcefully re-rendered using [`forceUpdate`](https://facebook.github.io/react/docs/component-api.html#forceupdate).
147
-
For `FlexTable` and `List`, you'll need to call [`forceUpdateGrid`](https://github.com/bvaughn/react-virtualized/blob/master/docs/FlexTable.md#forceupdategrid)) to ensure that the inner `Grid` is also updated.
147
+
For `Table` and `List`, you'll need to call [`forceUpdateGrid`](https://github.com/bvaughn/react-virtualized/blob/master/docs/Table.md#forceupdategrid)) to ensure that the inner `Grid` is also updated.
148
148
149
149
Documentation
150
150
---------------
@@ -170,7 +170,7 @@ Here are some online demos of each component:
Copy file name to clipboardExpand all lines: docs/ArrowKeyStepper.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ The appearance of this wrapper element can be customized using the `className` p
12
12
|:---|:---|:---:|:---|
13
13
| children | Function | ✓ | Function respondible for rendering children. This function should implement the following signature: `({ onSectionRendered: Function, scrollToColumn: number, scrollToRow: number }) => PropTypes.element`|
14
14
| className | String || CSS class name to attach to the wrapper `<div>`. |
15
-
| columnCount | Number | ✓ | Number of columns in grid; for `FlexTable` and `List` this property should always be `1`. |
15
+
| columnCount | Number | ✓ | Number of columns in grid; for `Table` and `List` this property should always be `1`. |
16
16
| rowCount | Number | ✓ | Number of rows in grid. |
17
17
18
18
### Children function
@@ -27,7 +27,7 @@ The child function is passed the following named parameters:
27
27
28
28
### Examples
29
29
30
-
You can decorate any virtualized component (eg. `FlexTable`, `Grid`, or `List`) with arrow-key snapping like so:
30
+
You can decorate any virtualized component (eg. `Table`, `Grid`, or `List`) with arrow-key snapping like so:
Copy file name to clipboardExpand all lines: docs/Column.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
FlexColumn
1
+
Column
2
2
---------------
3
3
4
4
Describes the header and cell contents of a table column.
@@ -31,7 +31,7 @@ It should implement the following signature:
31
31
function ({ columnData: any, dataKey: string, rowData: any }): any
32
32
```
33
33
34
-
A [default `cellDataGetter`](https://github.com/bvaughn/react-virtualized/blob/master/source/FlexTable/defaultCellDataGetter.js) is provided that simply returns the attribute as a String.
34
+
A [default `cellDataGetter`](https://github.com/bvaughn/react-virtualized/blob/master/source/Table/defaultCellDataGetter.js) is provided that simply returns the attribute as a String.
35
35
This function expects to operate on either a vanilla Object or a Map-like object with a get method.
36
36
You should override this default method if your data is calculated or requires any custom processing.
37
37
@@ -44,7 +44,7 @@ It should implement the following signature:
44
44
function ({ cellData: any, columnData: any, dataKey: string, isScrolling: boolean, rowData: any, rowIndex: number }): node
45
45
```
46
46
47
-
A [default `cellRenderer`](https://github.com/bvaughn/react-virtualized/blob/master/source/FlexTable/defaultCellRenderer.js) is provided that displays an attribute as a simple string
47
+
A [default `cellRenderer`](https://github.com/bvaughn/react-virtualized/blob/master/source/Table/defaultCellRenderer.js) is provided that displays an attribute as a simple string
48
48
You should override this default method if your data is some other type of object or requires custom formatting.
49
49
50
50
#### headerRenderer
@@ -56,5 +56,5 @@ It should implement the following signature:
56
56
function ({ columnData: any, dataKey: string, disableSort: boolean, label: string, sortBy: string, sortDirection: SortDirection }): element
57
57
```
58
58
59
-
A [default `headerRenderer`](https://github.com/bvaughn/react-virtualized/blob/master/source/FlexTable/defaultHeaderRenderer.js) is provided that displays the column `label` along with a sort indicator if the column is sort-enabled and active.
59
+
A [default `headerRenderer`](https://github.com/bvaughn/react-virtualized/blob/master/source/Table/defaultHeaderRenderer.js) is provided that displays the column `label` along with a sort indicator if the column is sort-enabled and active.
60
60
You should override this default method if you want to customize the appearance of table columns.
Copy file name to clipboardExpand all lines: docs/ColumnSizer.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ High-order component that auto-calculates column-widths for `Grid` cells.
9
9
| children | Function | ✓ | Function respondible for rendering a virtualized Grid. This function should implement the following signature: `({ adjustedWidth: number, getColumnWidth: Function, registerChild: Function }) => PropTypes.element`|
10
10
| columnMaxWidth | Number || Optional maximum allowed column width |
Copy file name to clipboardExpand all lines: docs/Table.md
+31-31
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
FlexTable
1
+
Table
2
2
---------------
3
3
4
4
Table component with fixed headers and virtualized rows for improved performance with large data sets.
@@ -7,10 +7,10 @@ This component expects explicit width, height, and padding parameters.
7
7
### Prop Types
8
8
| Property | Type | Required? | Description |
9
9
|:---|:---|:---:|:---|
10
-
| children |[FlexColumn](FlexColumn.md)| ✓ | One or more FlexColumns describing the data displayed in this table |
11
-
| className | String || Optional custom CSS class name to attach to root `FlexTable` element. |
10
+
| children |[Column](Column.md)| ✓ | One or more Columns describing the data displayed in this table |
11
+
| className | String || Optional custom CSS class name to attach to root `Table` element. |
12
12
| disableHeader | Boolean || Do not render the table header (only the rows) |
13
-
| estimatedRowSize | Number || Used to estimate the total height of a `FlexTable` before all of its rows have actually been measured. The estimated total height is adjusted as rows are rendered. |
13
+
| estimatedRowSize | Number || Used to estimate the total height of a `Table` before all of its rows have actually been measured. The estimated total height is adjusted as rows are rendered. |
14
14
| gridClassName | String || Optional custom CSS class name to attach to inner Grid element |
15
15
| gridStyle | Object || Optional inline style to attach to inner Grid element |
16
16
| headerClassName | String || CSS class to apply to all column headers |
@@ -40,7 +40,7 @@ This component expects explicit width, height, and padding parameters.
40
40
| sort | Function || Sort function to be called if a sortable header is clicked. `({ sortBy: string, sortDirection: SortDirection }): void`|
41
41
| sortBy | String || Data is currently sorted by this `dataKey` (if it is sorted at all) |
42
42
| sortDirection |[SortDirection](SortDirection.md)|| Data is currently sorted in this direction (if it is sorted at all) |
43
-
| style | Object || Optional custom inline style to attach to root `FlexTable` element. |
43
+
| style | Object || Optional custom inline style to attach to root `Table` element. |
44
44
| tabIndex | Number || Optional override of inner `Grid` tab index default; defaults to `0`. |
45
45
| width | Number | ✓ | Width of the table |
46
46
@@ -49,67 +49,67 @@ This component expects explicit width, height, and padding parameters.
49
49
##### forceUpdateGrid
50
50
Forcefull re-render the inner `Grid` component.
51
51
52
-
Calling `forceUpdate` on `FlexTable` may not re-render the inner `Grid` since it uses `shallowCompare` as a performance optimization.
52
+
Calling `forceUpdate` on `Table` may not re-render the inner `Grid` since it uses `shallowCompare` as a performance optimization.
53
53
Use this method if you want to manually trigger a re-render.
54
54
This may be appropriate if the underlying row data has changed but the row sizes themselves have not.
55
55
56
56
##### measureAllRows
57
-
Pre-measure all rows in a `FlexTable`.
57
+
Pre-measure all rows in a `Table`.
58
58
59
59
Typically rows are only measured as needed and estimated heights are used for cells that have not yet been measured.
60
60
This method ensures that the next call to getTotalSize() returns an exact size (as opposed to just an estimated one).
61
61
62
62
##### recomputeRowHeights (index: number)
63
63
Recompute row heights and offsets after the specified index (defaults to 0).
64
64
65
-
`FlexTable` has no way of knowing when its underlying list data has changed since it only receives a `rowHeight` property.
65
+
`Table` has no way of knowing when its underlying list data has changed since it only receives a `rowHeight` property.
66
66
If the `rowHeight` is a number it can compare before and after values but if it is a function that comparison is error prone.
67
67
In the event that a dynamic `rowHeight` function is in use and the row heights have changed this function should be manually called by the "smart" container parent.
68
68
69
69
This method will also force a render cycle (via `forceUpdate`) to ensure that the updated measurements are reflected in the rendered table.
70
70
71
71
### Class names
72
72
73
-
The FlexTable component supports the following static class names
73
+
The Table component supports the following static class names
If you require greater customization, you may want to fork the [`defaultFlexTableRowRenderer`](https://github.com/bvaughn/react-virtualized/blob/master/source/FlexTable/defaultRowRenderer.js) function.
112
+
If you require greater customization, you may want to fork the [`defaultTableRowRenderer`](https://github.com/bvaughn/react-virtualized/blob/master/source/Table/defaultRowRenderer.js) function.
113
113
114
114
This function accepts the following named parameters:
115
115
@@ -118,7 +118,7 @@ This function accepts the following named parameters:
118
118
| className | Row-level class name |
119
119
| columns | Array of React nodes |
120
120
| index | Row index |
121
-
| isScrolling | Boolean flag indicating if `FlexTable` is currently being scrolled |
121
+
| isScrolling | Boolean flag indicating if `Table` is currently being scrolled |
@@ -128,12 +128,12 @@ This function accepts the following named parameters:
128
128
129
129
### Examples
130
130
131
-
Below is a very basic `FlexTable` example. This table has only 2 columns, each containing a simple string. Both have a fixed width and neither is sortable. [See here](../source/FlexTable/FlexTable.example.js) for a more full-featured example including custom cell renderers, sortable headers, and more.
131
+
Below is a very basic `Table` example. This table has only 2 columns, each containing a simple string. Both have a fixed width and neither is sortable. [See here](../source/Table/Table.example.js) for a more full-featured example including custom cell renderers, sortable headers, and more.
Copy file name to clipboardExpand all lines: docs/customizingStyles.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -13,11 +13,11 @@ You can also customize component styles.
13
13
Fork the react-virtualized `styles.css` file and load your own, totally custom styles.
14
14
15
15
#### Global CSS
16
-
Load an additional, external CSS file that defines global classes (eg. `FlexTable`, `FlexTable__row`) to append to default inline styles.
16
+
Load an additional, external CSS file that defines global classes (eg. `Table`, `Table__row`) to append to default inline styles.
17
17
18
18
Learn more about which class names a component supports in the [API docs](https://github.com/bvaughn/react-virtualized/blob/master/docs/).
19
19
20
20
#### CSS Modules
21
-
If you are using CSS modules you can specify custom class names to be appended to a component instance (eg. `FlexTable` supports `className`, `headerClassName`, and `rowClassName` properties).
21
+
If you are using CSS modules you can specify custom class names to be appended to a component instance (eg. `Table` supports `className`, `headerClassName`, and `rowClassName` properties).
22
22
23
23
Learn more about which class names are supported in the [API docs](https://github.com/bvaughn/react-virtualized/blob/master/docs/).
Copy file name to clipboardExpand all lines: docs/usingAutoSizer.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
Using AutoSizer
2
2
---------------
3
3
4
-
The `AutoSizer` component decorates a React element and automatically manages `width` and `height` properties so that decorated element fills the available space. This simplifies usage of components like `Grid`, `FlexTable`, and `List` that require explicit dimensions.
4
+
The `AutoSizer` component decorates a React element and automatically manages `width` and `height` properties so that decorated element fills the available space. This simplifies usage of components like `Grid`, `Table`, and `List` that require explicit dimensions.
5
5
6
6
This guide covers a few of the most commonly asked questions about using the component.
This high-order component decorates a <code>List</code>, <code>FlexTable</code>, or <code>Grid</code> and responds to arrow-key events by scrolling one row or column at a time.
30
+
This high-order component decorates a <code>List</code>, <code>Table</code>, or <code>Grid</code> and responds to arrow-key events by scrolling one row or column at a time.
31
31
Focus in the `Grid` below and use the left, right, up, or down arrow keys to move around within the grid.
This component decorates <code>List</code>, <code>FlexTable</code>, or any other component and automatically manages its width and height.
57
+
This component decorates <code>List</code>, <code>Table</code>, or any other component and automatically manages its width and height.
58
58
It uses Sebastian Decima's <ahref='https://github.com/sdecima/javascript-detect-element-resize'target='_blank'>element resize event</a> to determine the appropriate size.
59
59
In this example <code>AutoSizer</code> grows to fill the remaining width and height of this flex column.
0 commit comments