) }] ``` ## Styles - React-table ships with a minimal and clean stylesheet to get you on your feet quickly. - The stylesheet is located at `react-table/react-table.css`. - There are countless ways to import a stylesheet. If you have questions on how to do so, consult the documentation of your build system. #### Classes - Adding a `-striped` className to ReactTable will slightly color odd numbered rows for legibility - Adding a `-highlight` className to ReactTable will highlight any row as you hover over it #### CSS We think the default styles looks great! But, if you prefer a more custom look, all of the included styles are easily overridable. Every single component contains a unique class that makes it super easy to customize. Just go for it! #### JS Styles Every single react-table element and `get[ComponentName]Props` callback supports `classname` and `style` props. ## Custom Props #### Built-in Components Every single built-in component's props can be dynamically extended using any one of these prop-callbacks: ```javascript ``` These callbacks are executed with each render of the element with four parameters: 1. Table State 2. RowInfo (undefined if not applicable) 3. Column (undefined if not applicable) 4. React Table Instance This makes it extremely easy to add, say... a row click callback! ```javascript // When any Td element is clicked, we'll log out some information { return { onClick: e => { console.log('A Td Element was clicked!') console.log('it produced this event:', e) console.log('It was in this column:', column) console.log('It was in this row:', rowInfo) console.log('It was in this table instance:', instance) } } }} /> ``` You can use these callbacks for dynamic styling as well! ```javascript // Any Tr element will be green if its (row.age > 20) { return { style: { background: rowInfo.row.age > 20 ? 'green' : 'red' } } }} /> ``` #### Column Components Just as core components can have dynamic props, columns and column headers can too! You can utilize either of these prop callbacks on columns: ```javascript const columns = [{ getHeaderProps: () => (...), getProps: () => (...) }] ``` In a similar fashion these can be used to dynamically style just about anything! ```javascript // This columns cells will be red if (row.name === Santa Clause) const columns = [{ getProps: (state, rowInfo, column) => { return { style: { background: rowInfo.row.name === 'Santa Clause' ? 'red' : null } } } }] ``` ## Pivoting and Aggregation Pivoting the table will group records together based on their accessed values and allow the rows in that group to be expanded underneath it. To pivot, pass an array of `columnID`'s to `pivotBy`. Remember, a column's `id` is either the one that you assign it (when using a custom accessors) or its `accessor` string. ```javascript ``` Naturally when grouping rows together, you may want to aggregate the rows inside it into the grouped column. No aggregation is done by default, however, it is very simple to aggregate any pivoted columns: ```javascript // In this example, we use lodash to sum and average the values, but you can use whatever you want to aggregate. const columns = [{ header: 'Age', accessor: 'age', aggregate: (values, rows) => _.round(_.mean(values)), render: row => { // You can even render the cell differently if it's an aggregated cell return {row.aggregated ? `${row.value} (avg)` : row.value} } }, { header: 'Visits', accessor: 'visits', aggregate: (values, rows) => _.sum(values) }] ``` Pivoted columns can be sorted just like regular columns including holding down the `` button to multi-sort. ## Sub Tables and Sub Components By adding a `SubComponent` props, you can easily add an expansion level to all root-level rows: ```javascript { return (

You can put any component you want here, even another React Table! You even have access to the row-level data if you need! Spark-charts, drill-throughs, infographics... the possibilities are endless!

) }} /> ``` ## Server-side Data If you want to handle pagination, sorting, and filtering on the server, `react-table` makes it easy on you. 1. Feed React Table `data` from somewhere dynamic. eg. `state`, a redux store, etc... 1. Add `manual` as a prop. This informs React Table that you'll be handling sorting and pagination server-side 1. Subscribe to the `onChange` prop. This function is called at `compomentDidMount` and any time sorting or pagination is changed by the user 1. In the `onChange` callback, request your data using the provided information in the params of the function (state and instance) 1. Update your data with the rows to be displayed 1. Optionally set how many pages there are total ```javascript { // show the loading overlay this.setState({loading: true}) // fetch your data Axios.post('mysite.com/data', { page: state.page, pageSize: state.pageSize, sorting: state.sorting, filtering: state.filtering }) .then((res) => { // Update react-table this.setState({ data: res.data.rows, pages: res.data.pages, loading: false }) }) }} /> ``` For a detailed example, take a peek at our async table mockup ## Fully Controlled Component React Table by default works fantastically out of the box, but you can achieve even more control and customization if you choose to maintain the state yourself. It is very easy to do, even if you only want to manage *parts* of the state. Here are the props and their corresponding callbacks that control the state of the a table: ```javascript {...}} // Called when the page index is changed by the user onPageSizeChange={(pageSize, pageIndex) => {...}} // Called when the pageSize is changed by the user. The resolve page is also sent to maintain approximate position in the data onSortingChange={(column, shiftKey) => {...}} // Called when a sortable column header is clicked with the column itself and if the shiftkey was held. If the column is a pivoted column, `column` will be an array of columns onExpandRow={(index, event) => {...}} // Called when an expander is clicked. Use this to manage `expandedRows` onFilteringChange={(column, value) => {...}} // Called when a user enters a value into a filter input field or the value passed to the onFilterChange handler by the filterRender option. onResize={(column, event, isTouch) => {...}} // Called when a user clicks on a resizing component (the right edge of a column header) /> ``` ## Functional Rendering Possibly one of the coolest features of React-Table is its ability to expose internal components and state for custom render logic. The easiest way to do this is to pass a function as the child of ``. The function you pass will be called with the following items: - Fully-resolved state of the table - A function that returns the standard table component - The instance of the component You can then return any JSX or react you want! This turns out to be perfect for: - Accessing the internal state of the table without a `ref` - Decorating the table or extending it with your own UI - Building your own custom display logic Accessing internal state and wrapping with more UI: ```javascript {(state, makeTable, instance) => { return (

state.allVisibleColumns === {JSON.stringify(state.allVisibleColumns, null, 4)}

{makeTable()}

) }} ``` The possibilities are endless! ## Multi-Sort When clicking on a column header, hold shift to multi-sort! You can toggle `ascending` `descending` and `none` for multi-sort columns. Clicking on a header without holding shift will clear the multi-sort and replace it with the single sort of that column. It's quite handy! ## Filtering Filtering can be enabled by setting the `showFilters` option on the table. If you don't want particular column to be filtered you can set the `hideFilter` option on the column. By default the table tries to filter by checking if the row's value starts with the filter text. The default method for filtering the table can be set with the table's `defaultFilterMethod` option. If you want to override a particular column's filtering method, you can set the `filterMethod` option on a column. To completely override the filter that is shown, you can set the `filterRender` column option. Using this option you can specify the JSX that is shown. The option is passed an `onFilterChange` method which must be called with the the value that you wan't to pass to the `filterMethod` option whenever the filter has changed. See Custom Filtering demo for examples. ## Component Overrides Though we confidently stand by the markup and architecture behind it, `react-table` does offer the ability to change the core componentry it uses to render everything. You can extend or override these internal components by passing a react component to it's corresponding prop on either the global props or on a one-off basis like so: ```javascript // Change the global default import { ReactTableDefaults } from 'react-table' Object.assign(ReactTableDefaults, { TableComponent: component, TheadComponent: component, TbodyComponent: component, TrGroupComponent: component, TrComponent: component, ThComponent: component TdComponent: component, TfootComponent: component, ExpanderComponent: component, PivotValueComponent: component, PaginationComponent: component, PreviousComponent: undefined, NextComponent: undefined, LoadingComponent: component, NoDataComponent: component, ResizerComponent: component }) // Or change per instance ``` If you choose to change the core components React-Table uses to render, you must make sure your replacement components consume and utilize all of the supplied and inherited props that are needed for that component to function properly. We would suggest investigating the source for the component you wish to replace. ## Contributing To suggest a feature, create an issue if it does not already exist. If you would like to help develop a suggested feature follow these steps: - Fork this repo - `$ yarn` - `$ yarn run storybook` - Implement your changes to files in the `src/` directory - View changes as you code via our React Storybook `localhost:8000` - Make changes to stories in `/stories`, or create a new one if needed - Submit PR for review #### Scripts - `$ yarn run storybook` Runs the storybook server - `$ yarn run test` Runs the test suite - `$ yarn run prepublish` Builds the distributable bundle - `$ yarn run docs` Builds the website/docs from the storybook for github pages ## Used By