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
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -160,13 +160,13 @@ When the breakpoint is reached the column will be hidden. These are the built-in
160
160
| style | object | no || override the style on the Table wrapper |
161
161
| responsive | bool | no | true | makes the table horizontally scrollable on smaller screen widths |
162
162
| disabled | bool | no | false | disables the Table section |
163
-
| onRowClicked | func | no || callback to access the row, event on row click. <br /> Note that if you are using custom cells (`column[].cell`), you will need to apply the `data-tag="allowRowEvents"` to the innermost element or on the elements you want to propagate the `onRowClicked` event to. |
164
-
| onRowDoubleClicked | func | no || callback to access the row, event on row double click. <br />Note that if you are using custom cells (`column[].cell`), you will need to apply the `data-tag="allowRowEvents"` to the innermost element or on the elements you want to propagate the `onRowDoubleClicked` event to. |
163
+
| onRowClicked | func | no || callback to access the row, event on row click. <br /> <br /><br />**Note** that if you are using custom cells (`column[].cell`), you will need to apply the `data-tag="allowRowEvents"` to the innermost element or on the elements you want to propagate the `onRowClicked` event to. |
164
+
| onRowDoubleClicked | func | no || callback to access the row, event on row double click. <br /><br />**Note** that if you are using custom cells (`column[].cell`), you will need to apply the `data-tag="allowRowEvents"` to the innermost element or on the elements you want to propagate the `onRowDoubleClicked` event to. |
165
165
| overflowY | bool | no | false | if a table is responsive, items such as layovers/menus/dropdowns will be clipped on the last row(s) due to to [overflow-x-y behavior](https://www.brunildo.org/test/Overflowxy2.html) - setting this value ensures there is invisible space below the table to prevent "clipping". However, if possible, the **correct approach is to use menus/layovers/dropdowns that support smart positioning**. **If used, the table parent element must have a fixed `height` or `height: 100%`**. |
166
166
| overflowYOffset | string | no | 250px | used with overflowY to "fine tune" the offset |
167
-
| dense | bool | no | false | compacts the row height. can be overridden via theming `rows.denseHeight`. note that if any custom elements exceed the dense height then the row will only compact to the tallest element any of your cells |
167
+
| dense | bool | no | false | compacts the row height. can be overridden via theming `rows.denseHeight`. <br /><br />**Note** that if any custom elements exceed the dense height then the row will only compact to the tallest element any of your cells |
168
168
| noTableHead | bool | no | false | hides the the sort columns and titles (TableHead) - this will obviously negate sorting |
169
-
| persistTableHead | bool | no || Show the table head (columns) even when `progressPending` is true. Note that the `noTableHead` will always hide the table head (columns) even when using `persistTableHead`|
169
+
| persistTableHead | bool | no || Show the table head (columns) even when `progressPending` is true. <br /><br />**Note** that the `noTableHead` will always hide the table head (columns) even when using `persistTableHead`|
170
170
| direction | string | no | auto | Accepts: `ltr, rtl, or auto`. When set to `auto` (default), RDT will attempt to detect direction by checking the HTML and DIV tags. For cases where you need to force rtl, or ltr just set this option manually (i.e. SSR) |
171
171
172
172
#### Row Selection
@@ -178,7 +178,7 @@ When the breakpoint is reached the column will be hidden. These are the built-in
178
178
| selectableRowsHighlight | bool | no | false | Highlight a row when it is selected |
179
179
| selectableRowsNoSelectAll | bool | no | false | Whether to show the select all rows checkbox |
180
180
| clearSelectedRows | bool | no | false | Toggling this property clears the selectedRows. If you use redux or react state you need to make sure that you pass a toggled value or the component will not update. See [Clearing Selected Rows](#clearing-selected-rows)|
181
-
| onSelectedRowsChange | func | no || Callback that fires anytime the rows selected state changes. Returns ({ allSelected, selectedCount, selectedRows }).<br />**note** It's highly recommended that you memoize the callback that you pass to `onSelectedRowsChange` if it updates the state of your parent component. This prevents `DataTable` from unnecessary re-renders every time your parent component is re-rendered |
181
+
| onSelectedRowsChange | func | no || Callback that fires anytime the rows selected state changes. Returns ({ allSelected, selectedCount, selectedRows }).<br /><br />**Note** It's highly recommended that you memoize the callback that you pass to `onSelectedRowsChange` if it updates the state of your parent component. This prevents `DataTable` from unnecessary re-renders every time your parent component is re-rendered |
182
182
| selectableRowsComponent | func | no || Override the default checkbox component - must be passed as a function (e.g. `Checkbox` not `<Checkbox />`). You can also find UI Library Integration examples [here](#ui-library-integration)|
183
183
| selectableRowsComponentProps | object | no || Additional props you want to pass to `selectableRowsComponent`. See [Overriding with Ui Component Library](#overriding-with-ui-component-library) to learn how you can override indeterminate state |
184
184
| selectableRowSelected | func | no || Select a row based on a property in your data. e.g. `row => row.isSelected`. `selectableRowSelected` must return a boolean to determine if the row should be programatically selected. Note that changing the state of selectableRowSelected will NOT re-render RDT, instead you should change your data if you want to update the items that are selected. |
@@ -226,10 +226,10 @@ When the breakpoint is reached the column will be hidden. These are the built-in
226
226
| onChangeRowsPerPage | func | no | null | callback when rows per page is changed returns `onChangeRowsPerPage(currentRowsPerPage, currentPage)`|
227
227
| paginationComponent | component | no |[Pagination](src/DataTable/Pagination.js)| a component that overrides the default pagination component. It must satisfy the following API: ```{ rowsPerPage: PropTypes.number.isRequired, rowCount: PropTypes.number.isRequired, onChangePage: PropTypes.func.isRequired, onChangeRowsPerPage: PropTypes.func.isRequired, currentPage: PropTypes.number.isRequired };```|
228
228
| paginationComponentOptions | object | no |`{ rowsPerPageText: 'Rows per page:', rangeSeparatorText: 'of', noRowsPerPage: false, selectAllRowsItem: false, selectAllRowsItemText: 'All' }`| override options for the built in pagination component. *Note that this prop only works with the built-in Pagination component*|
229
-
| paginationIconFirstPage || no | JSX | a component that overrides the first page icon for the pagination. *Note that this prop only works with the build in Pagination component*|
230
-
| paginationIconLastPage || no | JSX | a component that overrides the last page icon for the pagination. *Note that this prop only works with the build in Pagination component*|
231
-
| paginationIconNext || no | JSX | a component that overrides the next page icon for the pagination. *Note that this prop only works with the build in Pagination component*|
232
-
| paginationIconPrevious || no | JSX | a component that overrides the previous page icon for the pagination. *Note that this prop only works with the build in Pagination component*|
229
+
| paginationIconFirstPage || no | JSX | a component that overrides the first page icon for the pagination. <br /><br />**Note** that this prop only works with the build in Pagination component*|
230
+
| paginationIconLastPage || no | JSX | a component that overrides the last page icon for the pagination. <br /><br />**Note** that this prop only works with the build in Pagination component*|
231
+
| paginationIconNext || no | JSX | a component that overrides the next page icon for the pagination. <br /><br />**Note** that this prop only works with the build in Pagination component*|
232
+
| paginationIconPrevious || no | JSX | a component that overrides the previous page icon for the pagination. <br /><br />**Note** that this prop only works with the build in Pagination component*|
233
233
234
234
#### Header
235
235
@@ -273,7 +273,7 @@ You can easily toggle to dark mode by setting `theme="dark"`
273
273
274
274
##### Defining Your Own Theme Using `createTheme`
275
275
276
-
You can create your very own theme using the `createTheme` helper. Note that `createTheme` inherits from the default theme. Note that this theme will now be available to all DataTables across your project so you may want to define your custom themes in a seperate file.
276
+
You can create your very own theme using the `createTheme` helper. <br /><br />**Note** that `createTheme` inherits from the default theme. Also, this theme will now be available to all DataTables across your project so you may want to define your custom themes in a seperate file.
277
277
278
278
Refer to [themes.js](https://github.com/jbetancur/react-data-table-component/blob/master/src/DataTable/themes.js) for properties you can use to create your own color theme.
0 commit comments