diff --git a/CHANGELOG.md b/CHANGELOG.md index e69de29..cd37e14 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -0,0 +1,44 @@ +## 6.0.0 + +##### New Features +- New Renderers: + - `Aggregated` - Custom renderer for aggregated cells + - `Pivot` - Custom renderer for Pivoted Cells (utilizes `Expander` and `PivotValue`) + - `PivotValue` - Custom renderer for Pivot cell values (deprecates the undocumented `pivotRender` option) + - `Expander` - Custom renderer for Pivot cell Expander +- Added custom sorting methods per table via `defaultSortMethod` and per column via `column.sortMethod` +- Pivot columns are now visibly separate and sorted/filtered independently. +- Added `column.resizable` to override global table `resizable` option for specific columns. +- Added `column.sortable` to override global table `sortable` option for specific columns. +- Added `column.filterable` to override global table `filterable` option for specific columns. +- Added `defaultExpanded` table option. +- All callbacks can now be utilized without needing to hoist and manage the piece of state they export. That is what their prop counterparts are for, so now the corresponding prop is used instead of the callback to detect a "fully controlled" state. +- Prevent transitions while column resizing for a smoother resize effect. +- Disable text selection while resizing columns. + + +##### Breaking API Changes +- New Renderers: + - `Cell` - deprecates and replaces `render` + - `Header` - deprecates and replaces `header` + - `Footer` - deprecates and replaces `footer` + - `Filter`- deprecates and replaces `filterRender` +- Callbacks now provide the destination state as the primary parameter(s). This makes hoisting and controlling the state in redux or component state much easier. eg. + - `onSorting` no longer requires you to build your own toggle logic + - `onResize` no longer requires you to build your own resize logic +- Renamed `onChange` callback -> `onFetchData` which will always fire when a new data model needs to be fetched (or if not using `manual`, when new data is materialized internally). +- Renamed `filtering` -> `filtered` +- Renamed `sorting` -> `sorted` +- Renamed `expandedRows` -> `expanded` +- Renamed `resizing` -> `resized` +- Renamed `defaultResizing` -> `defaultResized` +- Renamed `defaultFiltering` -> `defaultFiltered` +- Renamed `defaultSorting` -> `defaultSorted` +- Renamed `onSortingChange` -> `onSortedChange` +- Renamed `onFilteringChange` -> `onFilteredChange` +- Renamed `onResize` -> `onResizedChange` +- Renamed `onExpandRow` -> `onExpandedChange` +- Renamed `showFilters` -> `filterable` +- Renamed `hideFilter` -> `filterable` (Column option. Note the true/false value is now flipped.) +- `cellInfo.row` and `rowInfo.row` now reference the materialize data for the table. To reference the original row, use `cellInfo.original` and `rowInfo.original` +- Removed `pivotRender` column option. You can now control how the value is displayed by overriding the `PivotValueComponent` or the individual column's `PivotValue` renderer. See [Pivoting Options Story](https://react-table.js.org/?selectedKind=2.%20Demos&selectedStory=Pivoting%20Options&full=0&down=1&left=1&panelRight=0&downPanel=kadirahq%2Fstorybook-addon-actions%2Factions-panel) for a reference on how to customize pivot column rendering. diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 93fad07..2ee6435 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,7 +1,7 @@ ## Problem Description include a detailed explanation of the problem here... -## Code Snippet(s) or Codepen (http://codepen.io/tannerlinsley/pen/QpeZBa?editors=0010) // TODO +## Code Snippet(s) or Codepen (http://codepen.io/tannerlinsley/pen/QpeZBa?editors=0010) ## Steps to Reproduce 1. list the steps diff --git a/LICENSE b/LICENSE index e5222bd..9fe1442 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2017 Tanner Linsley +Copyright (c) 2016 Tanner Linsley Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 222f8df..fad1b28 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,25 @@
- React Table Logo + React Table Logo

# React Table -`react-story` is a **lightweight, fast and extendable datagrid** built for React +`react-table` is a **lightweight, fast and extendable datagrid** built for React - - + + - - + + - - + + @@ -28,15 +28,28 @@ +## Versions +This document refers to version 6.x.x of react-table. + +Previous versions: + +[5.x.x Readme](https://github.com/tannerlinsley/react-table/blob/ad7d31cd3978eb45da7c6194dbab93c1e9a8594d/README.md) + ## Features -- Lightweight at 1kb +- Lightweight at 7kb (and just 2kb more for styles) +- Fully customizable JSX templating +- Supports both Client-side & Server-side pagination and multi-sorting +- Column Pivoting & Aggregation +- Minimal design & easily themeable +- Fully controllable via optional props and callbacks +- "Why I wrote React Table and the problems it has solved for Nozzle.io by Tanner Linsley ## Demos and examples - +- Codepen +- Storybook ## Table of Contents - +- [Used By](#used-by) ## Installation 1. Install React Table as a dependency ```bash -$ yarn add react-story +$ yarn add react-table ``` -2. Import the `react-story` module +2. Import the `react-table` module ```javascript // ES6 -import ReactStory from 'react-story' +import ReactTable from 'react-table' // ES5 -var ReactStory = require('react-story').default +var ReactTable = require('react-table').default +``` +3. Import styles by including `react-table.css` +```javascript +// JS (Webpack) +import 'react-table/react-table.css' +// Old-school + ``` ##### CDN ```html + + + - + ``` ## Example ```javascript -import ReactStory from 'react-story' +import ReactTable from 'react-table' -render () { - return ( - +render() { + const data = [{ + name: 'Tanner Linsley', + age: 26, + friend: { + name: 'Jason Maurer', + age: 23, + } + },{ + ... + }] - // or - - ) + const columns = [{ + Header: 'Name', + accessor: 'name' // String-based value accessors! + }, { + Header: 'Age', + accessor: 'age', + Cell: props => {props.value} // Custom cell components! + }, { + id: 'friendName', // Required because our accessor is not a string + Header: 'Friend Name', + accessor: d => d.friend.name // Custom value accessors! + }, { + Header: props => Friend Age, // Custom header components! + accessor: 'friend.age' + }] + + } ``` +## Data +Simply pass the `data` prop anything that resembles an array or object. Client-side sorting and pagination are built in, and your table will update gracefully as you change any props. [Server-side data](#server-side-data) is also supported! + + +## Props +These are all of the available props (and their default values) for the main `` component. +```javascript +{ + // General + data: [], + loading: false, + showPagination: true, + showPageSizeOptions: true, + pageSizeOptions: [5, 10, 20, 25, 50, 100], + defaultPageSize: 20, + showPageJump: true, + collapseOnSortingChange: true, + collapseOnPageChange: true, + collapseOnDataChange: true, + freezeWhenExpanded: false, + sortable: true, + resizable: true, + filterable: false, + defaultSorted: [], + defaultFiltered: [], + defaultResized: [], + defaultExpanded: {}, + defaultFilterMethod: (filter, row, column) => { + const id = filter.pivotId || filter.id + return row[id] !== undefined ? String(row[id]).startsWith(filter.value) : true + }, + defaultSortMethod: (a, b) => { + // force null and undefined to the bottom + a = (a === null || a === undefined) ? -Infinity : a + b = (b === null || b === undefined) ? -Infinity : b + // force any string values to lowercase + a = a === 'string' ? a.toLowerCase() : a + b = b === 'string' ? b.toLowerCase() : b + // Return either 1 or -1 to indicate a sort priority + if (a > b) { + return 1 + } + if (a < b) { + return -1 + } + // returning 0, undefined or any falsey value will use subsequent sorts or the index as a tiebreaker + return 0 + }, + + // Controlled State Overrides (see Fully Controlled Component section) + page: undefined, + pageSize: undefined, + sorted: [], + filtered: [], + resized: [], + expanded: {}, + + // Controlled State Callbacks + onPageChange: undefined, + onPageSizeChange: undefined, + onSortedChange: undefined, + onFilteredChange: undefined, + onResizedChange: undefined, + onExpandedChange: undefined, + + // Pivoting + pivotBy: undefined, + + // Key Constants + pivotValKey: '_pivotVal', + pivotIDKey: '_pivotID', + subRowsKey: '_subRows', + aggregatedKey: '_aggregated', + nestingLevelKey: '_nestingLevel', + originalKey: '_original', + indexKey: '_index', + groupedByPivotKey: '_groupedByPivot', + + // Server-side callbacks + onFetchData: () => null, + + // Classes + className: '', + style: {}, + + // Component decorators + getProps: () => ({}), + getTableProps: () => ({}), + getTheadGroupProps: () => ({}), + getTheadGroupTrProps: () => ({}), + getTheadGroupThProps: () => ({}), + getTheadProps: () => ({}), + getTheadTrProps: () => ({}), + getTheadThProps: () => ({}), + getTheadFilterProps: () => ({}), + getTheadFilterTrProps: () => ({}), + getTheadFilterThProps: () => ({}), + getTbodyProps: () => ({}), + getTrGroupProps: () => ({}), + getTrProps: () => ({}), + getThProps: () => ({}), + getTdProps: () => ({}), + getTfootProps: () => ({}), + getTfootTrProps: () => ({}), + getTfootThProps: () => ({}), + getPaginationProps: () => ({}), + getLoadingProps: () => ({}), + getNoDataProps: () => ({}), + getResizerProps: () => ({}), + + // Global Column Defaults + column: { + // Renderers + Cell: undefined, + Header: undefined, + Footer: undefined, + Aggregated: undefined, + Pivot: undefined, + PivotValue: undefined, + Expander: undefined, + Filter: undefined, + // Standard options + sortable: undefined, // use table default + resizable: undefined, // use table default + filterable: undefined, // use table default + show: true, + minWidth: 100, + // Cells only + className: '', + style: {}, + getProps: () => ({}), + // Headers only + headerClassName: '', + headerStyle: {}, + getHeaderProps: () => ({}) + // Footers only + footerClassName: '', + footerStyle: {}, + getFooterProps: () => ({}), + filterMethod: undefined, + sortMethod: undefined + }, + + // Global Expander Column Defaults + expanderDefaults: { + sortable: false, + resizable: false, + filterable: false, + width: 35 + }, + + // Global Pivot Column Defaults + pivotDefaults: {}, + + // Text + previousText: 'Previous', + nextText: 'Next', + loadingText: 'Loading...', + noDataText: 'No rows found', + pageText: 'Page', + ofText: 'of', + rowsText: 'rows', +} +``` + +You can easily override the core defaults like so: + +```javascript +import { ReactTableDefaults } from 'react-table' + +Object.assign(ReactTableDefaults, { + defaultPageSize: 10, + minRows: 3, + // etc... +}) +``` + +Or just define them as props + +```javascript + +``` + +## Columns +`` requires a `columns` prop, which is an array of objects containing the following properties + +```javascript +[{ + // Renderers - For more information, see "Renderers" section below + Cell: JSX | String | Function // Used to render a standard cell, defaults to the accessed value + Header: JSX | String | Function // Used to render the header of a column or column group + Footer: JSX | String | Function // Used to render the footer of a column + Filter: JSX | cellInfo => ( // Used to render the filter UI of a filter-enabled column + + // The value passed to onFiltersChange will be the value passed to filter.value of the filterMethod + ) + Aggregated: JSX | String | Function // Used to render aggregated cells. Defaults to a comma separated list of values. + Pivot: JSX | String | Function | cellInfo => ( // Used to render a pivoted cell + + // By default, will utilize the the PivotValue and Expander components at run time + + ), + PivotValue: JSX | String | Function // Used to render the value inside of a Pivot cell + Expander: JSX | String | Function // Used to render the expander in both Pivot and Expander cells + + // General + accessor: 'propertyName', // or Accessor eg. (row) => row.propertyName (see "Accessors" section for more details) + id: 'myProperty', // Conditional - A unique ID is required if the accessor is not a string or if you would like to override the column name used in server-side calls + sortable: boolean, // Overrides the table option + resizable: boolean, // Overrides the table option + filterable: boolean, // Overrides the table option + show: true, // can be used to hide a column + width: undefined, // A hardcoded width for the column. This overrides both min and max width options + minWidth: 100, // A minimum width for this column. If there is extra room, column will flex to fill available space (up to the max-width, if set) + maxWidth: undefined, // A maximum width for this column. + + // Special + pivot: false, + // Turns this column into a special column for specifying pivot position in your column definitions. + // The `pivotDefaults` options will be applied on top of this column's options. + // It will also let you specify rendering of the header (and header group if this special column is placed in the `columns` option of another column) + expander: false, + // Turns this column into a special column for specifying expander position and options in your column definitions. + // The `expanderDefaults` options will be applied on top of this column's options. + // It will also let you specify rendering of the header (and header group if this special column is placed in the `columns` option of another column) and + // the rendering of the expander itself via the `Expander` property + + // Cell Options + className: '', // Set the classname of the `td` element of the column + style: {}, // Set the style of the `td` element of the column + // Header & HeaderGroup Options + headerClassName: '', // Set the classname of the `th` element of the column + headerStyle: {}, // Set the style of the `th` element of the column + getHeaderProps: (state, rowInfo, column, instance) => ({}), // a function that returns props to decorate the `th` element of the column + + // Header Groups only + columns: [...], // See Header Groups section below + + // Footer + footerClassName: '', // Set the classname of the `td` element of the column's footer + footerStyle: {}, // Set the style of the `td` element of the column's footer + getFooterProps: (state, rowInfo, column, instance) => ({}), // A function that returns props to decorate the `td` element of the column's footer + + // Filtering + filterMethod: (filter, row, column) => {return true}, // A function returning a boolean that specifies the filtering logic for the column + // filter == an object specifying which filter is being applied. Format: {id: [the filter column's id], value: [the value the user typed in the filter field], pivotId: [if filtering on a pivot column, the pivotId will be set to the pivot column's id and the `id` field will be set to the top level pivoting column]} + // row == the row of data supplied to the table + // column == the column that the filter is on +}] +``` + +## Renderers +React Table supports very flexible renderers for just about everything: +- `Cell` - Renders a standard cell +- `Header` - Renders a column header or column group header +- `Footer` - Renders a column footer +- `Filter` - Renders a column's filter UI +- `Aggregated` - Renders an aggregated cell +- `Pivot` - Renders a pivoted cell (by default, will utilize `Expander` and `PivotValue` renderers) +- `PivotValue` - Renders the value inside a `Pivot` renderer +- `Expander` - Renders the Expander used in both the default `Pivot` renderer and any expander-designated column + +Any of these renderers can be one of the following: +- A React Class +- JSX or any rendered react component +- Stateless functional component +- Function that returns any primitive + +All of these formats receive the following props: +```javascript +{ + // Row-level props + row: Object, // the materialized row of data + original: , // the original row of data + index: '', // the index of the row in the original arra + viewIndex: '', // the index of the row relative to the current view + level: '', // the nesting level of this row + nestingPath: '', // the nesting path of this row + aggregated: '', // true if this row's values were aggregated + groupedByPivot: '', // true if this row was produced by a pivot + subRows: '', // any sub rows defined by the `subRowKey` prop + + // Cells-level props + isExpanded: '', // true if this row is expanded + value: '', // the materialized value of this cell + resized: '', // the resize information for this cell's column + show: '', // true if the column is visible + width: '', // the resolved width of this cell + maxWidth: '', // the resolved maxWidth of this cell + tdProps: '', // the resolved tdProps from `getTdProps` for this cell + columnProps: '', // the resolved column props from 'getProps' for this cell's column + classes: '', // the resolved array of classes for this cell + styles: '' // the resolved styles for this cell +} +``` + +## Accessors +Accessors are functions that return the value to populate the row's value for the column. +This lets the render function not have to worry about accessing the correct data, the value is automatically populated in it's props. + +If a `string` or `array` is passed the default accessor is used. +The default accessor will parse the input into an array and recursively flatten it. +Any values that contain a dot (`.`) will be split. +Any values that contain bracket (`[]`) will be split. +This array is then used as the path to the value to return. + +("$" is the placeholder value that would be returned by the default accessor) + +| value | path | data | +|--------------|-----------------|------------------------| +| "a" | ["a"] | {"a": $} | +| "a.b" | ["a", "b"] | {"a": {"b": $}} | +| "a[0]" | ["a", "0"] | {"a": [$]} | +| ["a.b", "c"] | ["a", "b", "c"] | {"a": {"b": {"c": $}}} | + +*NOTE* +If your data has a field/key with a dot (`.`) you will need to supply a custom accessor. + + +## Column Header Groups +To group columns with another header column, just nest your columns in a header column. Header columns utilize the same header properties as regular columns. +```javascript +const columns = [{ + Header: 'Favorites', + headerClassName: 'my-favorites-column-header-group' + columns: [{ + Header: 'Color', + accessor: 'favorites.color' + }, { + Header: 'Food', + accessor: 'favorites.food' + } { + Header: 'Actor', + accessor: 'favorites.actor' + }] +}] +``` + +## Custom Cell, Header and Footer Rendering +You can use any react component or JSX to display content in column headers, cells and footers. Any component you use will be passed the following props (if available): +- `row` - Original row from your data +- `row` - The post-accessed values from the original row +- `index` - The index of the row +- `viewIndex` - the index of the row relative to the current page +- `level` - The nesting depth (zero-indexed) +- `nestingPath` - The nesting path of the row +- `aggregated` - A boolean stating if the row is an aggregation row +- `subRows` - An array of any expandable sub-rows contained in this row + +```javascript +// This column uses a stateless component to produce a different colored bar depending on the value +// You can also use stateful components or any other function that returns JSX +const columns = [{ + Header: () => Progress, + accessor: 'progress', + Cell: row => ( +
+
66 ? '#85cc00' + : row.value > 33 ? '#ffbf00' + : '#ff2e00', + borderRadius: '2px', + transition: 'all .2s ease-out' + }} + /> +
+ ) +}] +``` + +## 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)), + Aggregated: row => { + // You can even render the cell differently if it's an aggregated cell + return row.value (avg) + } +}, { + 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 `onFetchData` prop. This function is called at `compomentDidMount` and any time sorting, pagination or filterting is changed in the table +1. In the `onFetchData` callback, request your data using the provided information in the params of the function (current 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, + sorted: state.sorted, + filtered: state.filtered + }) + .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 + onSortedChange={(newSorted, 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 + onExpandedChange={(newExpanded, index, event) => {...}} // Called when an expander is clicked. Use this to manage `expandedRows` + onFilteredChange={(column, value) => {...}} // Called when a user enters a value into a filter input field or the value passed to the onFiltersChange handler by the filterRender option. + onResizedChange={(newResized, event) => {...}} // 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! + +## Sorting +Sorting comes built in with React-Table. Click column header to sort by its column. Click it again to reverse the sort. + +## 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! + +## Custom Sorting Algorithm +To override the default sorting algorithm for the whole table use the `defaultSortMethod` prop. + +To override the sorting algorithm for a single column, use the `sortMethod` column property. + +Supply a function that implements the native javascript [`Array.sort`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) interface. This is React Table's default sorting algorithm: +- `a` the first value to compare +- `b` the second value to compare +- `dir` the +```javascript +defaultSortMethod = (a, b) => { + // force null and undefined to the bottom + a = (a === null || a === undefined) ? -Infinity : a + b = (b === null || b === undefined) ? -Infinity : b + // force any string values to lowercase + a = a === 'string' ? a.toLowerCase() : a + b = b === 'string' ? b.toLowerCase() : b + // Return either 1 or -1 to indicate a sort priority + if (a > b) { + return 1 + } + if (a < b) { + return -1 + } + // returning 0 or undefined will use any subsequent column sorting methods or the row index as a tiebreaker + return 0 +} +``` + +## Filtering +Filtering can be enabled by setting the `filterable` option on the table. + +If you don't want particular column to be filtered you can set the `filterable={false}` 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 `Filter` column option. Using this option you can specify the JSX that is shown. The option is passed an `onChange` 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, + AggregatedComponent: component, + PivotValueComponent: component, + PivotComponent: component, + FilterComponent: 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. diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 0000000..9a30abb --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +react-table.js.org diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index a520336..0000000 --- a/docs/README.md +++ /dev/null @@ -1,1623 +0,0 @@ -This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app). - -Below you will find some information on how to perform common tasks.
-You can find the most recent version of this guide [here](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md). - -## Table of Contents - -- [Updating to New Releases](#updating-to-new-releases) -- [Sending Feedback](#sending-feedback) -- [Folder Structure](#folder-structure) -- [Available Scripts](#available-scripts) - - [npm start](#npm-start) - - [npm test](#npm-test) - - [npm run build](#npm-run-build) - - [npm run eject](#npm-run-eject) -- [Supported Language Features and Polyfills](#supported-language-features-and-polyfills) -- [Syntax Highlighting in the Editor](#syntax-highlighting-in-the-editor) -- [Displaying Lint Output in the Editor](#displaying-lint-output-in-the-editor) -- [Debugging in the Editor](#debugging-in-the-editor) -- [Changing the Page ``](#changing-the-page-title) -- [Installing a Dependency](#installing-a-dependency) -- [Importing a Component](#importing-a-component) -- [Adding a Stylesheet](#adding-a-stylesheet) -- [Post-Processing CSS](#post-processing-css) -- [Adding a CSS Preprocessor (Sass, Less etc.)](#adding-a-css-preprocessor-sass-less-etc) -- [Adding Images and Fonts](#adding-images-and-fonts) -- [Using the `public` Folder](#using-the-public-folder) - - [Changing the HTML](#changing-the-html) - - [Adding Assets Outside of the Module System](#adding-assets-outside-of-the-module-system) - - [When to Use the `public` Folder](#when-to-use-the-public-folder) -- [Using Global Variables](#using-global-variables) -- [Adding Bootstrap](#adding-bootstrap) - - [Using a Custom Theme](#using-a-custom-theme) -- [Adding Flow](#adding-flow) -- [Adding Custom Environment Variables](#adding-custom-environment-variables) - - [Referencing Environment Variables in the HTML](#referencing-environment-variables-in-the-html) - - [Adding Temporary Environment Variables In Your Shell](#adding-temporary-environment-variables-in-your-shell) - - [Adding Development Environment Variables In `.env`](#adding-development-environment-variables-in-env) -- [Can I Use Decorators?](#can-i-use-decorators) -- [Integrating with an API Backend](#integrating-with-an-api-backend) - - [Node](#node) - - [Ruby on Rails](#ruby-on-rails) -- [Proxying API Requests in Development](#proxying-api-requests-in-development) -- [Using HTTPS in Development](#using-https-in-development) -- [Generating Dynamic `<meta>` Tags on the Server](#generating-dynamic-meta-tags-on-the-server) -- [Pre-Rendering into Static HTML Files](#pre-rendering-into-static-html-files) -- [Injecting Data from the Server into the Page](#injecting-data-from-the-server-into-the-page) -- [Running Tests](#running-tests) - - [Filename Conventions](#filename-conventions) - - [Command Line Interface](#command-line-interface) - - [Version Control Integration](#version-control-integration) - - [Writing Tests](#writing-tests) - - [Testing Components](#testing-components) - - [Using Third Party Assertion Libraries](#using-third-party-assertion-libraries) - - [Initializing Test Environment](#initializing-test-environment) - - [Focusing and Excluding Tests](#focusing-and-excluding-tests) - - [Coverage Reporting](#coverage-reporting) - - [Continuous Integration](#continuous-integration) - - [Disabling jsdom](#disabling-jsdom) - - [Snapshot Testing](#snapshot-testing) - - [Editor Integration](#editor-integration) -- [Developing Components in Isolation](#developing-components-in-isolation) -- [Making a Progressive Web App](#making-a-progressive-web-app) -- [Deployment](#deployment) - - [Static Server](#static-server) - - [Other Solutions](#other-solutions) - - [Serving Apps with Client-Side Routing](#serving-apps-with-client-side-routing) - - [Building for Relative Paths](#building-for-relative-paths) - - [Azure](#azure) - - [Firebase](#firebase) - - [GitHub Pages](#github-pages) - - [Heroku](#heroku) - - [Modulus](#modulus) - - [Netlify](#netlify) - - [Now](#now) - - [S3 and CloudFront](#s3-and-cloudfront) - - [Surge](#surge) -- [Advanced Configuration](#advanced-configuration) -- [Troubleshooting](#troubleshooting) - - [`npm start` doesn’t detect changes](#npm-start-doesnt-detect-changes) - - [`npm test` hangs on macOS Sierra](#npm-test-hangs-on-macos-sierra) - - [`npm run build` silently fails](#npm-run-build-silently-fails) - - [`npm run build` fails on Heroku](#npm-run-build-fails-on-heroku) -- [Something Missing?](#something-missing) - -## Updating to New Releases - -Create React App is divided into two packages: - -* `create-react-app` is a global command-line utility that you use to create new projects. -* `react-scripts` is a development dependency in the generated projects (including this one). - -You almost never need to update `create-react-app` itself: it delegates all the setup to `react-scripts`. - -When you run `create-react-app`, it always creates the project with the latest version of `react-scripts` so you’ll get all the new features and improvements in newly created apps automatically. - -To update an existing project to a new version of `react-scripts`, [open the changelog](https://github.com/facebookincubator/create-react-app/blob/master/CHANGELOG.md), find the version you’re currently on (check `package.json` in this folder if you’re not sure), and apply the migration instructions for the newer versions. - -In most cases bumping the `react-scripts` version in `package.json` and running `npm install` in this folder should be enough, but it’s good to consult the [changelog](https://github.com/facebookincubator/create-react-app/blob/master/CHANGELOG.md) for potential breaking changes. - -We commit to keeping the breaking changes minimal so you can upgrade `react-scripts` painlessly. - -## Sending Feedback - -We are always open to [your feedback](https://github.com/facebookincubator/create-react-app/issues). - -## Folder Structure - -After creation, your project should look like this: - -``` -my-app/ - README.md - node_modules/ - package.json - public/ - index.html - favicon.ico - src/ - App.css - App.js - App.test.js - index.css - index.js - logo.svg -``` - -For the project to build, **these files must exist with exact filenames**: - -* `public/index.html` is the page template; -* `src/index.js` is the JavaScript entry point. - -You can delete or rename the other files. - -You may create subdirectories inside `src`. For faster rebuilds, only files inside `src` are processed by Webpack.<br> -You need to **put any JS and CSS files inside `src`**, or Webpack won’t see them. - -Only files inside `public` can be used from `public/index.html`.<br> -Read instructions below for using assets from JavaScript and HTML. - -You can, however, create more top-level directories.<br> -They will not be included in the production build so you can use them for things like documentation. - -## Available Scripts - -In the project directory, you can run: - -### `npm start` - -Runs the app in the development mode.<br> -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. - -The page will reload if you make edits.<br> -You will also see any lint errors in the console. - -### `npm test` - -Launches the test runner in the interactive watch mode.<br> -See the section about [running tests](#running-tests) for more information. - -### `npm run build` - -Builds the app for production to the `build` folder.<br> -It correctly bundles React in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.<br> -Your app is ready to be deployed! - -See the section about [deployment](#deployment) for more information. - -### `npm run eject` - -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** - -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. - -Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. - -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. - -## Supported Language Features and Polyfills - -This project supports a superset of the latest JavaScript standard.<br> -In addition to [ES6](https://github.com/lukehoban/es6features) syntax features, it also supports: - -* [Exponentiation Operator](https://github.com/rwaldron/exponentiation-operator) (ES2016). -* [Async/await](https://github.com/tc39/ecmascript-asyncawait) (ES2017). -* [Object Rest/Spread Properties](https://github.com/sebmarkbage/ecmascript-rest-spread) (stage 3 proposal). -* [Class Fields and Static Properties](https://github.com/tc39/proposal-class-public-fields) (stage 2 proposal). -* [JSX](https://facebook.github.io/react/docs/introducing-jsx.html) and [Flow](https://flowtype.org/) syntax. - -Learn more about [different proposal stages](https://babeljs.io/docs/plugins/#presets-stage-x-experimental-presets-). - -While we recommend to use experimental proposals with some caution, Facebook heavily uses these features in the product code, so we intend to provide [codemods](https://medium.com/@cpojer/effective-javascript-codemods-5a6686bb46fb) if any of these proposals change in the future. - -Note that **the project only includes a few ES6 [polyfills](https://en.wikipedia.org/wiki/Polyfill)**: - -* [`Object.assign()`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) via [`object-assign`](https://github.com/sindresorhus/object-assign). -* [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) via [`promise`](https://github.com/then/promise). -* [`fetch()`](https://developer.mozilla.org/en/docs/Web/API/Fetch_API) via [`whatwg-fetch`](https://github.com/github/fetch). - -If you use any other ES6+ features that need **runtime support** (such as `Array.from()` or `Symbol`), make sure you are including the appropriate polyfills manually, or that the browsers you are targeting already support them. - -## Syntax Highlighting in the Editor - -To configure the syntax highlighting in your favorite text editor, head to the [relevant Babel documentation page](https://babeljs.io/docs/editors) and follow the instructions. Some of the most popular editors are covered. - -## Displaying Lint Output in the Editor - ->Note: this feature is available with `react-scripts@0.2.0` and higher. - -Some editors, including Sublime Text, Atom, and Visual Studio Code, provide plugins for ESLint. - -They are not required for linting. You should see the linter output right in your terminal as well as the browser console. However, if you prefer the lint results to appear right in your editor, there are some extra steps you can do. - -You would need to install an ESLint plugin for your editor first. - ->**A note for Atom `linter-eslint` users** - ->If you are using the Atom `linter-eslint` plugin, make sure that **Use global ESLint installation** option is checked: - -><img src="http://i.imgur.com/yVNNHJM.png" width="300"> - - ->**For Visual Studio Code users** - ->VS Code ESLint plugin automatically detects Create React App's configuration file. So you do not need to create `eslintrc.json` at the root directory, except when you want to add your own rules. In that case, you should include CRA's config by adding this line: - ->```js -{ - // ... - "extends": "react-app" -} -``` - -Then add this block to the `package.json` file of your project: - -```js -{ - // ... - "eslintConfig": { - "extends": "react-app" - } -} -``` - -Finally, you will need to install some packages *globally*: - -```sh -npm install -g eslint-config-react-app@0.3.0 eslint@3.8.1 babel-eslint@7.0.0 eslint-plugin-react@6.4.1 eslint-plugin-import@2.0.1 eslint-plugin-jsx-a11y@4.0.0 eslint-plugin-flowtype@2.21.0 -``` - -We recognize that this is suboptimal, but it is currently required due to the way we hide the ESLint dependency. The ESLint team is already [working on a solution to this](https://github.com/eslint/eslint/issues/3458) so this may become unnecessary in a couple of months. - -## Debugging in the Editor - -**This feature is currently only supported by [Visual Studio Code](https://code.visualstudio.com) editor.** - -Visual Studio Code supports live-editing and debugging out of the box with Create React App. This enables you as a developer to write and debug your React code without leaving the editor, and most importantly it enables you to have a continuous development workflow, where context switching is minimal, as you don’t have to switch between tools. - -You would need to have the latest version of [VS Code](https://code.visualstudio.com) and VS Code [Chrome Debugger Extension](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) installed. - -Then add the block below to your `launch.json` file and put it inside the `.vscode` folder in your app’s root directory. - -```json -{ - "version": "0.2.0", - "configurations": [{ - "name": "Chrome", - "type": "chrome", - "request": "launch", - "url": "http://localhost:3000", - "webRoot": "${workspaceRoot}/src", - "userDataDir": "${workspaceRoot}/.vscode/chrome", - "sourceMapPathOverrides": { - "webpack:///src/*": "${webRoot}/*" - } - }] -} -``` - -Start your app by running `npm start`, and start debugging in VS Code by pressing `F5` or by clicking the green debug icon. You can now write code, set breakpoints, make changes to the code, and debug your newly modified code—all from your editor. - -## Changing the Page `<title>` - -You can find the source HTML file in the `public` folder of the generated project. You may edit the `<title>` tag in it to change the title from “React App” to anything else. - -Note that normally you wouldn’t edit files in the `public` folder very often. For example, [adding a stylesheet](#adding-a-stylesheet) is done without touching the HTML. - -If you need to dynamically update the page title based on the content, you can use the browser [`document.title`](https://developer.mozilla.org/en-US/docs/Web/API/Document/title) API. For more complex scenarios when you want to change the title from React components, you can use [React Helmet](https://github.com/nfl/react-helmet), a third party library. - -If you use a custom server for your app in production and want to modify the title before it gets sent to the browser, you can follow advice in [this section](#generating-dynamic-meta-tags-on-the-server). Alternatively, you can pre-build each page as a static HTML file which then loads the JavaScript bundle, which is covered [here](#pre-rendering-into-static-html-files). - -## Installing a Dependency - -The generated project includes React and ReactDOM as dependencies. It also includes a set of scripts used by Create React App as a development dependency. You may install other dependencies (for example, React Router) with `npm`: - -``` -npm install --save <library-name> -``` - -## Importing a Component - -This project setup supports ES6 modules thanks to Babel.<br> -While you can still use `require()` and `module.exports`, we encourage you to use [`import` and `export`](http://exploringjs.com/es6/ch_modules.html) instead. - -For example: - -### `Button.js` - -```js -import React, { Component } from 'react'; - -class Button extends Component { - render() { - // ... - } -} - -export default Button; // Don’t forget to use export default! -``` - -### `DangerButton.js` - - -```js -import React, { Component } from 'react'; -import Button from './Button'; // Import a component from another file - -class DangerButton extends Component { - render() { - return <Button color="red" />; - } -} - -export default DangerButton; -``` - -Be aware of the [difference between default and named exports](http://stackoverflow.com/questions/36795819/react-native-es-6-when-should-i-use-curly-braces-for-import/36796281#36796281). It is a common source of mistakes. - -We suggest that you stick to using default imports and exports when a module only exports a single thing (for example, a component). That’s what you get when you use `export default Button` and `import Button from './Button'`. - -Named exports are useful for utility modules that export several functions. A module may have at most one default export and as many named exports as you like. - -Learn more about ES6 modules: - -* [When to use the curly braces?](http://stackoverflow.com/questions/36795819/react-native-es-6-when-should-i-use-curly-braces-for-import/36796281#36796281) -* [Exploring ES6: Modules](http://exploringjs.com/es6/ch_modules.html) -* [Understanding ES6: Modules](https://leanpub.com/understandinges6/read#leanpub-auto-encapsulating-code-with-modules) - -## Adding a Stylesheet - -This project setup uses [Webpack](https://webpack.github.io/) for handling all assets. Webpack offers a custom way of “extending” the concept of `import` beyond JavaScript. To express that a JavaScript file depends on a CSS file, you need to **import the CSS from the JavaScript file**: - -### `Button.css` - -```css -.Button { - padding: 20px; -} -``` - -### `Button.js` - -```js -import React, { Component } from 'react'; -import './Button.css'; // Tell Webpack that Button.js uses these styles - -class Button extends Component { - render() { - // You can use them as regular CSS styles - return <div className="Button" />; - } -} -``` - -**This is not required for React** but many people find this feature convenient. You can read about the benefits of this approach [here](https://medium.com/seek-ui-engineering/block-element-modifying-your-javascript-components-d7f99fcab52b). However you should be aware that this makes your code less portable to other build tools and environments than Webpack. - -In development, expressing dependencies this way allows your styles to be reloaded on the fly as you edit them. In production, all CSS files will be concatenated into a single minified `.css` file in the build output. - -If you are concerned about using Webpack-specific semantics, you can put all your CSS right into `src/index.css`. It would still be imported from `src/index.js`, but you could always remove that import if you later migrate to a different build tool. - -## Post-Processing CSS - -This project setup minifies your CSS and adds vendor prefixes to it automatically through [Autoprefixer](https://github.com/postcss/autoprefixer) so you don’t need to worry about it. - -For example, this: - -```css -.App { - display: flex; - flex-direction: row; - align-items: center; -} -``` - -becomes this: - -```css -.App { - display: -webkit-box; - display: -ms-flexbox; - display: flex; - -webkit-box-orient: horizontal; - -webkit-box-direction: normal; - -ms-flex-direction: row; - flex-direction: row; - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center; -} -``` - -If you need to disable autoprefixing for some reason, [follow this section](https://github.com/postcss/autoprefixer#disabling). - -## Adding a CSS Preprocessor (Sass, Less etc.) - -Generally, we recommend that you don’t reuse the same CSS classes across different components. For example, instead of using a `.Button` CSS class in `<AcceptButton>` and `<RejectButton>` components, we recommend creating a `<Button>` component with its own `.Button` styles, that both `<AcceptButton>` and `<RejectButton>` can render (but [not inherit](https://facebook.github.io/react/docs/composition-vs-inheritance.html)). - -Following this rule often makes CSS preprocessors less useful, as features like mixins and nesting are replaced by component composition. You can, however, integrate a CSS preprocessor if you find it valuable. In this walkthrough, we will be using Sass, but you can also use Less, or another alternative. - -First, let’s install the command-line interface for Sass: - -``` -npm install node-sass --save-dev -``` - -Then in `package.json`, add the following lines to `scripts`: - -```diff - "scripts": { -+ "build-css": "node-sass src/ -o src/", -+ "watch-css": "npm run build-css && node-sass src/ -o src/ --watch --recursive", - "start": "react-scripts start", - "build": "react-scripts build", - "test": "react-scripts test --env=jsdom", -``` - ->Note: To use a different preprocessor, replace `build-css` and `watch-css` commands according to your preprocessor’s documentation. - -Now you can rename `src/App.css` to `src/App.scss` and run `npm run watch-css`. The watcher will find every Sass file in `src` subdirectories, and create a corresponding CSS file next to it, in our case overwriting `src/App.css`. Since `src/App.js` still imports `src/App.css`, the styles become a part of your application. You can now edit `src/App.scss`, and `src/App.css` will be regenerated. - -To share variables between Sass files, you can use Sass imports. For example, `src/App.scss` and other component style files could include `@import "./shared.scss";` with variable definitions. - -At this point you might want to remove all CSS files from the source control, and add `src/**/*.css` to your `.gitignore` file. It is generally a good practice to keep the build products outside of the source control. - -As a final step, you may find it convenient to run `watch-css` automatically with `npm start`, and run `build-css` as a part of `npm run build`. You can use the `&&` operator to execute two scripts sequentially. However, there is no cross-platform way to run two scripts in parallel, so we will install a package for this: - -``` -npm install --save-dev npm-run-all -``` - -Then we can change `start` and `build` scripts to include the CSS preprocessor commands: - -```diff - "scripts": { - "build-css": "node-sass src/ -o src/", - "watch-css": "npm run build-css && node-sass src/ -o src/ --watch --recursive", -- "start": "react-scripts start", -- "build": "react-scripts build", -+ "start-js": "react-scripts start", -+ "start": "npm-run-all -p watch-css start-js", -+ "build": "npm run build-css && react-scripts build", - "test": "react-scripts test --env=jsdom", - "eject": "react-scripts eject" - } -``` - -Now running `npm start` and `npm run build` also builds Sass files. Note that `node-sass` seems to have an [issue recognizing newly created files on some systems](https://github.com/sass/node-sass/issues/1891) so you might need to restart the watcher when you create a file until it’s resolved. - -## Adding Images and Fonts - -With Webpack, using static assets like images and fonts works similarly to CSS. - -You can **`import` an image right in a JavaScript module**. This tells Webpack to include that image in the bundle. Unlike CSS imports, importing an image or a font gives you a string value. This value is the final image path you can reference in your code. - -Here is an example: - -```js -import React from 'react'; -import logo from './logo.png'; // Tell Webpack this JS file uses this image - -console.log(logo); // /logo.84287d09.png - -function Header() { - // Import result is the URL of your image - return <img src={logo} alt="Logo" />; -} - -export default Header; -``` - -This ensures that when the project is built, Webpack will correctly move the images into the build folder, and provide us with correct paths. - -This works in CSS too: - -```css -.Logo { - background-image: url(./logo.png); -} -``` - -Webpack finds all relative module references in CSS (they start with `./`) and replaces them with the final paths from the compiled bundle. If you make a typo or accidentally delete an important file, you will see a compilation error, just like when you import a non-existent JavaScript module. The final filenames in the compiled bundle are generated by Webpack from content hashes. If the file content changes in the future, Webpack will give it a different name in production so you don’t need to worry about long-term caching of assets. - -Please be advised that this is also a custom feature of Webpack. - -**It is not required for React** but many people enjoy it (and React Native uses a similar mechanism for images).<br> -An alternative way of handling static assets is described in the next section. - -## Using the `public` Folder - ->Note: this feature is available with `react-scripts@0.5.0` and higher. - -### Changing the HTML - -The `public` folder contains the HTML file so you can tweak it, for example, to [set the page title](#changing-the-page-title). -The `<script>` tag with the compiled code will be added to it automatically during the build process. - -### Adding Assets Outside of the Module System - -You can also add other assets to the `public` folder. - -Note that we normally encourage you to `import` assets in JavaScript files instead. -For example, see the sections on [adding a stylesheet](#adding-a-stylesheet) and [adding images and fonts](#adding-images-and-fonts). -This mechanism provides a number of benefits: - -* Scripts and stylesheets get minified and bundled together to avoid extra network requests. -* Missing files cause compilation errors instead of 404 errors for your users. -* Result filenames include content hashes so you don’t need to worry about browsers caching their old versions. - -However there is an **escape hatch** that you can use to add an asset outside of the module system. - -If you put a file into the `public` folder, it will **not** be processed by Webpack. Instead it will be copied into the build folder untouched. To reference assets in the `public` folder, you need to use a special variable called `PUBLIC_URL`. - -Inside `index.html`, you can use it like this: - -```html -<link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico"> -``` - -Only files inside the `public` folder will be accessible by `%PUBLIC_URL%` prefix. If you need to use a file from `src` or `node_modules`, you’ll have to copy it there to explicitly specify your intention to make this file a part of the build. - -When you run `npm run build`, Create React App will substitute `%PUBLIC_URL%` with a correct absolute path so your project works even if you use client-side routing or host it at a non-root URL. - -In JavaScript code, you can use `process.env.PUBLIC_URL` for similar purposes: - -```js -render() { - // Note: this is an escape hatch and should be used sparingly! - // Normally we recommend using `import` for getting asset URLs - // as described in “Adding Images and Fonts” above this section. - return <img src={process.env.PUBLIC_URL + '/img/logo.png'} />; -} -``` - -Keep in mind the downsides of this approach: - -* None of the files in `public` folder get post-processed or minified. -* Missing files will not be called at compilation time, and will cause 404 errors for your users. -* Result filenames won’t include content hashes so you’ll need to add query arguments or rename them every time they change. - -### When to Use the `public` Folder - -Normally we recommend importing [stylesheets](#adding-a-stylesheet), [images, and fonts](#adding-images-and-fonts) from JavaScript. -The `public` folder is useful as a workaround for a number of less common cases: - -* You need a file with a specific name in the build output, such as [`manifest.webmanifest`](https://developer.mozilla.org/en-US/docs/Web/Manifest). -* You have thousands of images and need to dynamically reference their paths. -* You want to include a small script like [`pace.js`](http://github.hubspot.com/pace/docs/welcome/) outside of the bundled code. -* Some library may be incompatible with Webpack and you have no other option but to include it as a `<script>` tag. - -Note that if you add a `<script>` that declares global variables, you also need to read the next section on using them. - -## Using Global Variables - -When you include a script in the HTML file that defines global variables and try to use one of these variables in the code, the linter will complain because it cannot see the definition of the variable. - -You can avoid this by reading the global variable explicitly from the `window` object, for example: - -```js -const $ = window.$; -``` - -This makes it obvious you are using a global variable intentionally rather than because of a typo. - -Alternatively, you can force the linter to ignore any line by adding `// eslint-disable-line` after it. - -## Adding Bootstrap - -You don’t have to use [React Bootstrap](https://react-bootstrap.github.io) together with React but it is a popular library for integrating Bootstrap with React apps. If you need it, you can integrate it with Create React App by following these steps: - -Install React Bootstrap and Bootstrap from npm. React Bootstrap does not include Bootstrap CSS so this needs to be installed as well: - -``` -npm install react-bootstrap --save -npm install bootstrap@3 --save -``` - -Import Bootstrap CSS and optionally Bootstrap theme CSS in the beginning of your ```src/index.js``` file: - -```js -import 'bootstrap/dist/css/bootstrap.css'; -import 'bootstrap/dist/css/bootstrap-theme.css'; -// Put any other imports below so that CSS from your -// components takes precedence over default styles. -``` - -Import required React Bootstrap components within ```src/App.js``` file or your custom component files: - -```js -import { Navbar, Jumbotron, Button } from 'react-bootstrap'; -``` - -Now you are ready to use the imported React Bootstrap components within your component hierarchy defined in the render method. Here is an example [`App.js`](https://gist.githubusercontent.com/gaearon/85d8c067f6af1e56277c82d19fd4da7b/raw/6158dd991b67284e9fc8d70b9d973efe87659d72/App.js) redone using React Bootstrap. - -### Using a Custom Theme - -Sometimes you might need to tweak the visual styles of Bootstrap (or equivalent package).<br> -We suggest the following approach: - -* Create a new package that depends on the package you wish to customize, e.g. Bootstrap. -* Add the necessary build steps to tweak the theme, and publish your package on npm. -* Install your own theme npm package as a dependency of your app. - -Here is an example of adding a [customized Bootstrap](https://medium.com/@tacomanator/customizing-create-react-app-aa9ffb88165) that follows these steps. - -## Adding Flow - -Flow is a static type checker that helps you write code with fewer bugs. Check out this [introduction to using static types in JavaScript](https://medium.com/@preethikasireddy/why-use-static-types-in-javascript-part-1-8382da1e0adb) if you are new to this concept. - -Recent versions of [Flow](http://flowtype.org/) work with Create React App projects out of the box. - -To add Flow to a Create React App project, follow these steps: - -1. Run `npm install --save-dev flow-bin` (or `yarn add --dev flow-bin`). -2. Add `"flow": "flow"` to the `scripts` section of your `package.json`. -3. Run `npm run flow -- init` (or `yarn flow -- init`) to create a [`.flowconfig` file](https://flowtype.org/docs/advanced-configuration.html) in the root directory. -4. Add `// @flow` to any files you want to type check (for example, to `src/App.js`). - -Now you can run `npm run flow` (or `yarn flow`) to check the files for type errors. -You can optionally use an IDE like [Nuclide](https://nuclide.io/docs/languages/flow/) for a better integrated experience. -In the future we plan to integrate it into Create React App even more closely. - -To learn more about Flow, check out [its documentation](https://flowtype.org/). - -## Adding Custom Environment Variables - ->Note: this feature is available with `react-scripts@0.2.3` and higher. - -Your project can consume variables declared in your environment as if they were declared locally in your JS files. By -default you will have `NODE_ENV` defined for you, and any other environment variables starting with -`REACT_APP_`. - -**The environment variables are embedded during the build time**. Since Create React App produces a static HTML/CSS/JS bundle, it can’t possibly read them at runtime. To read them at runtime, you would need to load HTML into memory on the server and replace placeholders in runtime, just like [described here](#injecting-data-from-the-server-into-the-page). Alternatively you can rebuild the app on the server anytime you change them. - ->Note: You must create custom environment variables beginning with `REACT_APP_`. Any other variables except `NODE_ENV` will be ignored to avoid accidentally [exposing a private key on the machine that could have the same name](https://github.com/facebookincubator/create-react-app/issues/865#issuecomment-252199527). Changing any environment variables will require you to restart the development server if it is running. - -These environment variables will be defined for you on `process.env`. For example, having an environment -variable named `REACT_APP_SECRET_CODE` will be exposed in your JS as `process.env.REACT_APP_SECRET_CODE`. - -There is also a special built-in environment variable called `NODE_ENV`. You can read it from `process.env.NODE_ENV`. When you run `npm start`, it is always equal to `'development'`, when you run `npm test` it is always equal to `'test'`, and when you run `npm run build` to make a production bundle, it is always equal to `'production'`. **You cannot override `NODE_ENV` manually.** This prevents developers from accidentally deploying a slow development build to production. - -These environment variables can be useful for displaying information conditionally based on where the project is -deployed or consuming sensitive data that lives outside of version control. - -First, you need to have environment variables defined. For example, let’s say you wanted to consume a secret defined -in the environment inside a `<form>`: - -```jsx -render() { - return ( - <div> - <small>You are running this application in <b>{process.env.NODE_ENV}</b> mode.</small> - <form> - <input type="hidden" defaultValue={process.env.REACT_APP_SECRET_CODE} /> - </form> - </div> - ); -} -``` - -During the build, `process.env.REACT_APP_SECRET_CODE` will be replaced with the current value of the `REACT_APP_SECRET_CODE` environment variable. Remember that the `NODE_ENV` variable will be set for you automatically. - -When you load the app in the browser and inspect the `<input>`, you will see its value set to `abcdef`, and the bold text will show the environment provided when using `npm start`: - -```html -<div> - <small>You are running this application in <b>development</b> mode.</small> - <form> - <input type="hidden" value="abcdef" /> - </form> -</div> -``` - -The above form is looking for a variable called `REACT_APP_SECRET_CODE` from the environment. In order to consume this -value, we need to have it defined in the environment. This can be done using two ways: either in your shell or in -a `.env` file. Both of these ways are described in the next few sections. - -Having access to the `NODE_ENV` is also useful for performing actions conditionally: - -```js -if (process.env.NODE_ENV !== 'production') { - analytics.disable(); -} -``` - -When you compile the app with `npm run build`, the minification step will strip out this condition, and the resulting bundle will be smaller. - -### Referencing Environment Variables in the HTML - ->Note: this feature is available with `react-scripts@0.9.0` and higher. - -You can also access the environment variables starting with `REACT_APP_` in the `public/index.html`. For example: - -```html -<title>%REACT_APP_WEBSITE_NAME% -``` - -Note that the caveats from the above section apply: - -* Apart from a few built-in variables (`NODE_ENV` and `PUBLIC_URL`), variable names must start with `REACT_APP_` to work. -* The environment variables are injected at build time. If you need to inject them at runtime, [follow this approach instead](#generating-dynamic-meta-tags-on-the-server). - -### Adding Temporary Environment Variables In Your Shell - -Defining environment variables can vary between OSes. It’s also important to know that this manner is temporary for the -life of the shell session. - -#### Windows (cmd.exe) - -```cmd -set REACT_APP_SECRET_CODE=abcdef&&npm start -``` - -(Note: the lack of whitespace is intentional.) - -#### Linux, macOS (Bash) - -```bash -REACT_APP_SECRET_CODE=abcdef npm start -``` - -### Adding Development Environment Variables In `.env` - ->Note: this feature is available with `react-scripts@0.5.0` and higher. - -To define permanent environment variables, create a file called `.env` in the root of your project: - -``` -REACT_APP_SECRET_CODE=abcdef -``` - -These variables will act as the defaults if the machine does not explicitly set them.
-Please refer to the [dotenv documentation](https://github.com/motdotla/dotenv) for more details. - ->Note: If you are defining environment variables for development, your CI and/or hosting platform will most likely need -these defined as well. Consult their documentation how to do this. For example, see the documentation for [Travis CI](https://docs.travis-ci.com/user/environment-variables/) or [Heroku](https://devcenter.heroku.com/articles/config-vars). - -## Can I Use Decorators? - -Many popular libraries use [decorators](https://medium.com/google-developers/exploring-es7-decorators-76ecb65fb841) in their documentation.
-Create React App doesn’t support decorator syntax at the moment because: - -* It is an experimental proposal and is subject to change. -* The current specification version is not officially supported by Babel. -* If the specification changes, we won’t be able to write a codemod because we don’t use them internally at Facebook. - -However in many cases you can rewrite decorator-based code without decorators just as fine.
-Please refer to these two threads for reference: - -* [#214](https://github.com/facebookincubator/create-react-app/issues/214) -* [#411](https://github.com/facebookincubator/create-react-app/issues/411) - -Create React App will add decorator support when the specification advances to a stable stage. - -## Integrating with an API Backend - -These tutorials will help you to integrate your app with an API backend running on another port, -using `fetch()` to access it. - -### Node -Check out [this tutorial](https://www.fullstackreact.com/articles/using-create-react-app-with-a-server/). -You can find the companion GitHub repository [here](https://github.com/fullstackreact/food-lookup-demo). - -### Ruby on Rails - -Check out [this tutorial](https://www.fullstackreact.com/articles/how-to-get-create-react-app-to-work-with-your-rails-api/). -You can find the companion GitHub repository [here](https://github.com/fullstackreact/food-lookup-demo-rails). - -## Proxying API Requests in Development - ->Note: this feature is available with `react-scripts@0.2.3` and higher. - -People often serve the front-end React app from the same host and port as their backend implementation.
-For example, a production setup might look like this after the app is deployed: - -``` -/ - static server returns index.html with React app -/todos - static server returns index.html with React app -/api/todos - server handles any /api/* requests using the backend implementation -``` - -Such setup is **not** required. However, if you **do** have a setup like this, it is convenient to write requests like `fetch('/api/todos')` without worrying about redirecting them to another host or port during development. - -To tell the development server to proxy any unknown requests to your API server in development, add a `proxy` field to your `package.json`, for example: - -```js - "proxy": "http://localhost:4000", -``` - -This way, when you `fetch('/api/todos')` in development, the development server will recognize that it’s not a static asset, and will proxy your request to `http://localhost:4000/api/todos` as a fallback. The development server will only attempt to send requests without a `text/html` accept header to the proxy. - -Conveniently, this avoids [CORS issues](http://stackoverflow.com/questions/21854516/understanding-ajax-cors-and-security-considerations) and error messages like this in development: - -``` -Fetch API cannot load http://localhost:4000/api/todos. No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'http://localhost:3000' is therefore not allowed access. If an opaque response serves your needs, set the request's mode to 'no-cors' to fetch the resource with CORS disabled. -``` - -Keep in mind that `proxy` only has effect in development (with `npm start`), and it is up to you to ensure that URLs like `/api/todos` point to the right thing in production. You don’t have to use the `/api` prefix. Any unrecognized request without a `text/html` accept header will be redirected to the specified `proxy`. - -The `proxy` option supports HTTP, HTTPS and WebSocket connections.
-If the `proxy` option is **not** flexible enough for you, alternatively you can: - -* Enable CORS on your server ([here’s how to do it for Express](http://enable-cors.org/server_expressjs.html)). -* Use [environment variables](#adding-custom-environment-variables) to inject the right server host and port into your app. - -## Using HTTPS in Development - ->Note: this feature is available with `react-scripts@0.4.0` and higher. - -You may require the dev server to serve pages over HTTPS. One particular case where this could be useful is when using [the "proxy" feature](#proxying-api-requests-in-development) to proxy requests to an API server when that API server is itself serving HTTPS. - -To do this, set the `HTTPS` environment variable to `true`, then start the dev server as usual with `npm start`: - -#### Windows (cmd.exe) - -```cmd -set HTTPS=true&&npm start -``` - -(Note: the lack of whitespace is intentional.) - -#### Linux, macOS (Bash) - -```bash -HTTPS=true npm start -``` - -Note that the server will use a self-signed certificate, so your web browser will almost definitely display a warning upon accessing the page. - -## Generating Dynamic `` Tags on the Server - -Since Create React App doesn’t support server rendering, you might be wondering how to make `` tags dynamic and reflect the current URL. To solve this, we recommend to add placeholders into the HTML, like this: - -```html - - - - - -``` - -Then, on the server, regardless of the backend you use, you can read `index.html` into memory and replace `__OG_TITLE__`, `__OG_DESCRIPTION__`, and any other placeholders with values depending on the current URL. Just make sure to sanitize and escape the interpolated values so that they are safe to embed into HTML! - -If you use a Node server, you can even share the route matching logic between the client and the server. However duplicating it also works fine in simple cases. - -## Pre-Rendering into Static HTML Files - -If you’re hosting your `build` with a static hosting provider you can use [react-snapshot](https://www.npmjs.com/package/react-snapshot) to generate HTML pages for each route, or relative link, in your application. These pages will then seamlessly become active, or “hydrated”, when the JavaScript bundle has loaded. - -There are also opportunities to use this outside of static hosting, to take the pressure off the server when generating and caching routes. - -The primary benefit of pre-rendering is that you get the core content of each page _with_ the HTML payload—regardless of whether or not your JavaScript bundle successfully downloads. It also increases the likelihood that each route of your application will be picked up by search engines. - -You can read more about [zero-configuration pre-rendering (also called snapshotting) here](https://medium.com/superhighfives/an-almost-static-stack-6df0a2791319). - -## Injecting Data from the Server into the Page - -Similarly to the previous section, you can leave some placeholders in the HTML that inject global variables, for example: - -```js - - - - -``` - -Then, on the server, you can replace `__SERVER_DATA__` with a JSON of real data right before sending the response. The client code can then read `window.SERVER_DATA` to use it. **Make sure to [sanitize the JSON before sending it to the client](https://medium.com/node-security/the-most-common-xss-vulnerability-in-react-js-applications-2bdffbcc1fa0) as it makes your app vulnerable to XSS attacks.** - -## Running Tests - ->Note: this feature is available with `react-scripts@0.3.0` and higher.
->[Read the migration guide to learn how to enable it in older projects!](https://github.com/facebookincubator/create-react-app/blob/master/CHANGELOG.md#migrating-from-023-to-030) - -Create React App uses [Jest](https://facebook.github.io/jest/) as its test runner. To prepare for this integration, we did a [major revamp](https://facebook.github.io/jest/blog/2016/09/01/jest-15.html) of Jest so if you heard bad things about it years ago, give it another try. - -Jest is a Node-based runner. This means that the tests always run in a Node environment and not in a real browser. This lets us enable fast iteration speed and prevent flakiness. - -While Jest provides browser globals such as `window` thanks to [jsdom](https://github.com/tmpvar/jsdom), they are only approximations of the real browser behavior. Jest is intended to be used for unit tests of your logic and your components rather than the DOM quirks. - -We recommend that you use a separate tool for browser end-to-end tests if you need them. They are beyond the scope of Create React App. - -### Filename Conventions - -Jest will look for test files with any of the following popular naming conventions: - -* Files with `.js` suffix in `__tests__` folders. -* Files with `.test.js` suffix. -* Files with `.spec.js` suffix. - -The `.test.js` / `.spec.js` files (or the `__tests__` folders) can be located at any depth under the `src` top level folder. - -We recommend to put the test files (or `__tests__` folders) next to the code they are testing so that relative imports appear shorter. For example, if `App.test.js` and `App.js` are in the same folder, the test just needs to `import App from './App'` instead of a long relative path. Colocation also helps find tests more quickly in larger projects. - -### Command Line Interface - -When you run `npm test`, Jest will launch in the watch mode. Every time you save a file, it will re-run the tests, just like `npm start` recompiles the code. - -The watcher includes an interactive command-line interface with the ability to run all tests, or focus on a search pattern. It is designed this way so that you can keep it open and enjoy fast re-runs. You can learn the commands from the “Watch Usage” note that the watcher prints after every run: - -![Jest watch mode](http://facebook.github.io/jest/img/blog/15-watch.gif) - -### Version Control Integration - -By default, when you run `npm test`, Jest will only run the tests related to files changed since the last commit. This is an optimization designed to make your tests runs fast regardless of how many tests you have. However it assumes that you don’t often commit the code that doesn’t pass the tests. - -Jest will always explicitly mention that it only ran tests related to the files changed since the last commit. You can also press `a` in the watch mode to force Jest to run all tests. - -Jest will always run all tests on a [continuous integration](#continuous-integration) server or if the project is not inside a Git or Mercurial repository. - -### Writing Tests - -To create tests, add `it()` (or `test()`) blocks with the name of the test and its code. You may optionally wrap them in `describe()` blocks for logical grouping but this is neither required nor recommended. - -Jest provides a built-in `expect()` global function for making assertions. A basic test could look like this: - -```js -import sum from './sum'; - -it('sums numbers', () => { - expect(sum(1, 2)).toEqual(3); - expect(sum(2, 2)).toEqual(4); -}); -``` - -All `expect()` matchers supported by Jest are [extensively documented here](http://facebook.github.io/jest/docs/expect.html).
-You can also use [`jest.fn()` and `expect(fn).toBeCalled()`](http://facebook.github.io/jest/docs/expect.html#tohavebeencalled) to create “spies” or mock functions. - -### Testing Components - -There is a broad spectrum of component testing techniques. They range from a “smoke test” verifying that a component renders without throwing, to shallow rendering and testing some of the output, to full rendering and testing component lifecycle and state changes. - -Different projects choose different testing tradeoffs based on how often components change, and how much logic they contain. If you haven’t decided on a testing strategy yet, we recommend that you start with creating simple smoke tests for your components: - -```js -import React from 'react'; -import ReactDOM from 'react-dom'; -import App from './App'; - -it('renders without crashing', () => { - const div = document.createElement('div'); - ReactDOM.render(, div); -}); -``` - -This test mounts a component and makes sure that it didn’t throw during rendering. Tests like this provide a lot value with very little effort so they are great as a starting point, and this is the test you will find in `src/App.test.js`. - -When you encounter bugs caused by changing components, you will gain a deeper insight into which parts of them are worth testing in your application. This might be a good time to introduce more specific tests asserting specific expected output or behavior. - -If you’d like to test components in isolation from the child components they render, we recommend using [`shallow()` rendering API](http://airbnb.io/enzyme/docs/api/shallow.html) from [Enzyme](http://airbnb.io/enzyme/). You can write a smoke test with it too: - -```sh -npm install --save-dev enzyme react-addons-test-utils -``` - -```js -import React from 'react'; -import { shallow } from 'enzyme'; -import App from './App'; - -it('renders without crashing', () => { - shallow(); -}); -``` - -Unlike the previous smoke test using `ReactDOM.render()`, this test only renders `` and doesn’t go deeper. For example, even if `` itself renders a `