Pivoting & Aggregation

.storybook/config.js

@@ -13,6 +13,8 @@ import Readme from '../README.md'
 import Simple from '../stories/Simple.js'
 import ServerSide from '../stories/ServerSide.js'
 import SubComponents from '../stories/SubComponents.js'
+import Pivoting from '../stories/Pivoting.js'
+import PivotingSubComponents from '../stories/PivotingSubComponents.js'
 //
 configure(() => {
   storiesOf('1. Docs')
@@ -31,4 +33,6 @@ configure(() => {
     .add('Client-side Data', Simple)
     .add('Server-side Data', ServerSide)
     .add('Sub Components', SubComponents)
+    .add('Pivoting & Aggregation', Pivoting)
+    .add('Pivoting & Aggregation w/ Sub Components', PivotingSubComponents)
 }, module)

README.md

@@ -12,10 +12,12 @@
 
 ## Features
 
-- Lightweight at 4kb (and just 2kb more for styles)
-- Fully customizable JSX and callbacks for everything
-- Supports both Client-side & Server-side pagination and sorting
+- 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
 - <a href="https://medium.com/@tannerlinsley/why-i-wrote-react-table-and-the-problems-it-has-solved-for-nozzle-others-445c4e93d4a8#.axza4ixba" target="\_blank">"Why I wrote React Table and the problems it has solved for Nozzle.io</a> by Tanner Linsley
 
 ## <a href="http://react-table.zabapps.com/?selectedKind=2.%20Demos&selectedStory=Client-side%20Data&full=0&down=1&left=1&panelRight=0&downPanel=kadirahq%2Fstorybook-addon-actions%2Factions-panel" target="\_blank">Demo</a>
@@ -28,7 +30,8 @@
 - [Columns](#columns)
 - [Styles](#styles)
 - [Header Groups](#header-groups)
-- [Sub Tables & Components](#sub-tables-components)
+- [Pivoting & Aggregation](#pivoting-aggregation)
+- [Sub Tables & Sub Components](#sub-tables-sub-components)
 - [Server-side Data](#server-side-data)
 - [Fully Controlled Component](#fully-controlled-component)
 - [Multi-sort](#multi-sort)
@@ -128,9 +131,9 @@ These are all of the available props (and their default values) for the main `<R
   page: undefined,
   pageSize: undefined,
   sorting: undefined,
-  visibleSubComponents: undefined,
+  expandedRows: undefined,
   // Controlled Callbacks
-  onExpand: undefined,
+  onExpandRow: undefined,
   onPageChange: undefined,
   onPageSizeChange: undefined,
 }
@@ -155,7 +158,7 @@ Or just define them on the component per-instance
   defaultPageSize={10}
   minRows={3}
   // etc...
-  />
+/>
 ```
 
 ## Columns
@@ -213,7 +216,37 @@ const columns = [{
 }]
 ```
 
-## Sub Tables & Components
+## Pivoting & 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
+<ReactTable
+  ...
+  pivotBy={['lastName', 'age']}
+/>
+```
+
+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 <span>{row.aggregated ? `${row.value} (avg)` : row.value}</span>
+  }
+}, {
+  header: 'Visits',
+  accessor: 'visits',
+  aggregate: (values, rows) => _.sum(values)
+}]
+```
+
+Pivoted columns can be sorted just like regular columns, but not independently of each other.  For instance, if you click to sort the pivot column in ascending order, it will sort by each pivot recursively in ascending order together.
+
+## Sub Tables & Sub Components
 By adding a `SubComponent` props, you can easily add an expansion level to all root-level rows:
 ```javascript
 <ReactTable
@@ -287,13 +320,20 @@ Here are the props and their corresponding callbacks that control the state of t
       id: 'firstName',
       asc: true
   }]} // the sorting model for the table
-  visibleSubComponents={[1,4,5]} // The row indexes on the current page that should appear expanded
+  expandedRows={{
+    1: true,
+    4: true,
+    5: {
+      2: true,
+      3: true
+    }
+  }} // The nested row indexes on the current page that should appear expanded
 
   // Callbacks
   onPageChange={(pageIndex) => {...}} // 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.
-  onExpand={(index, event) => {...}} // Called when an expander is clicked. Use this to manage `visibleSubComponents`
+  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`
 />
 ```
 

src/index.styl

@@ -56,6 +56,8 @@ $expandSize = 7px
       border-right:1px solid alpha(black, .02)
       &:last-child
         border-right:0
+    .rt-pivot
+      cursor: pointer
   .rt-tr-group
     display: flex
     flex-direction: column
@@ -79,29 +81,35 @@ $expandSize = 7px
       border:0 !important
       opacity: 0 !important
 
-  .rt-expander-wrap
-    display:flex
-    align-items: center
-    justify-content: center
-    cursor: pointer
-
   .rt-expander
-    width: 0
-    height: 0
-    border-left: ($expandSize * .72) solid transparent
-    border-right: ($expandSize * .72) solid transparent
-    border-top: $expandSize solid alpha(black, .8)
-    transition: all .3s $easeOutBack
-    transform: rotate(-90deg)
-    &.-open
-      transform: rotate(0deg)
+    display: inline-block
+    position:relative
+    margin: 0
+    color: transparent
+    margin: 0 10px
+    &:after
+      content: ''
+      position: absolute
+      width: 0
+      height: 0
+      top:50%
+      left:50%
+      transform: translate(-50%, -50%) rotate(-90deg)
+      border-left: ($expandSize * .72) solid transparent
+      border-right: ($expandSize * .72) solid transparent
+      border-top: $expandSize solid alpha(black, .8)
+      transition: all .3s $easeOutBack
+      cursor: pointer
+    &.-open:after
+        transform: translate(-50%, -50%) rotate(0deg)
 
   &.-striped
-    .rt-tr-group:nth-child(even)
+    .rt-tr.-odd
       background: alpha(black, .03)
   &.-highlight
-    .rt-tr-group:hover
-      background: alpha(black, .05)
+    .rt-tbody
+      .rt-tr:hover
+        background: alpha(black, .05)
 
   .-pagination
     z-index: 1

src/pagination.js

@@ -17,7 +17,7 @@ export default React.createClass({
     this.setState({page: nextProps.page})
   },
   getSafePage (page) {
-    return Math.min(Math.max(page, 0), this.props.pagesLength - 1)
+    return Math.min(Math.max(page, 0), this.props.pages - 1)
   },
   changePage (page) {
     page = this.getSafePage(page)
@@ -32,7 +32,7 @@ export default React.createClass({
   render () {
     const {
       // Computed
-      pagesLength,
+      pages,
       // Props
       page,
       showPageSizeOptions,
@@ -85,7 +85,7 @@ export default React.createClass({
               </form>
             ) : (
               <span className='-currentPage'>{page + 1}</span>
-            )} {this.props.ofText} <span className='-totalPages'>{pagesLength}</span>
+            )} {this.props.ofText} <span className='-totalPages'>{pages}</span>
           </span>
           {showPageSizeOptions && (
             <span className='select-wrap -pageSizeOptions'>

src/utils.js

@@ -3,41 +3,45 @@ import classnames from 'classnames'
 //
 export default {
   get,
+  set,
   takeRight,
   last,
-  orderBy,
+  sortBy,
   range,
-  clone,
   remove,
+  clone,
   getFirstDefined,
   sum,
   makeTemplateComponent,
-  prefixAll
+  prefixAll,
+  groupBy,
+  isArray
 }
 
-function remove (a, b) {
-  return a.filter(function (o, i) {
-    var r = b(o)
-    if (r) {
-      a.splice(i, 1)
-      return true
-    }
-    return false
-  })
-}
-
-function get (a, b) {
-  if (isArray(b)) {
-    b = b.join('.')
+function get (obj, path, def) {
+  if (!path) {
+    return obj
   }
-  return b
-    .replace('[', '.').replace(']', '')
-    .split('.')
-    .reduce(
-      function (obj, property) {
-        return obj[property]
-      }, a
-    )
+  const pathObj = makePathArray(path)
+  let val
+  try {
+    val = pathObj.reduce((current, pathPart) => current[pathPart], obj)
+  } catch (e) {}
+  return typeof val !== 'undefined' ? val : def
+}
+
+function set (obj = {}, path, value) {
+  const keys = makePathArray(path)
+  let keyPart
+  let cursor = obj
+  while ((keyPart = keys.shift()) && keys.length) {
+    if (!cursor[keyPart]) {
+      cursor[keyPart] = {}
+    }
+    cursor = cursor[keyPart]
+  }
+  cursor[keyPart] = value
+  return obj
 }
 
 function takeRight (arr, n) {
@@ -57,7 +61,7 @@ function range (n) {
   return arr
 }
 
-function orderBy (arr, funcs, dirs) {
+function sortBy (arr, funcs, dirs) {
   return arr.sort((a, b) => {
     for (let i = 0; i < funcs.length; i++) {
       const comp = funcs[i]
@@ -75,21 +79,28 @@ function orderBy (arr, funcs, dirs) {
   })
 }
 
-function clone (a) {
-  return JSON.parse(JSON.stringify(a, function (key, value) {
-    if (typeof value === 'function') {
-      return value.toString()
+function remove (a, b) {
+  return a.filter(function (o, i) {
+    var r = b(o)
+    if (r) {
+      a.splice(i, 1)
+      return true
     }
-    return value
-  }))
+    return false
+  })
 }
 
-// ########################################################################
-// Helpers
-// ########################################################################
-
-function isArray (a) {
-  return Array.isArray(a)
+function clone (a) {
+  try {
+    return JSON.parse(JSON.stringify(a, (key, value) => {
+      if (typeof value === 'function') {
+        return value.toString()
+      }
+      return value
+    }))
+  } catch (e) {
+    return a
+  }
 }
 
 function getFirstDefined (...args) {
@@ -120,3 +131,39 @@ function makeTemplateComponent (compClass) {
 function prefixAll (obj) {
   return obj
 }
+
+function groupBy (xs, key) {
+  return xs.reduce((rv, x, i) => {
+    const resKey = typeof key === 'function' ? key(x, i) : x[key]
+    rv[resKey] = rv[resKey] || []
+    rv[resKey].push(x)
+    return rv
+  }, {})
+}
+
+function isArray (a) {
+  return Array.isArray(a)
+}
+
+// ########################################################################
+// Non-exported Helpers
+// ########################################################################
+
+function makePathArray (obj) {
+  return flattenDeep(obj)
+      .join('.')
+      .replace('[', '.')
+      .replace(']', '')
+      .split('.')
+}
+
+function flattenDeep (arr, newArr = []) {
+  if (!isArray(arr)) {
+    newArr.push(arr)
+  } else {
+    for (var i = 0; i < arr.length; i++) {
+      flattenDeep(arr[i], newArr)
+    }
+  }
+  return newArr
+}

stories/Pivoting.js

@@ -0,0 +1,120 @@
+import React from 'react'
+import _ from 'lodash'
+import namor from 'namor'
+
+import CodeHighlight from './components/codeHighlight'
+import ReactTable from '../lib/index'
+
+export default () => {
+  const data = _.map(_.range(10000), d => {
+    return {
+      firstName: namor.generate({ words: 1, numLen: 0 }),
+      lastName: namor.generate({ words: 1, numLen: 0 }),
+      age: Math.floor(Math.random() * 30),
+      visits: Math.floor(Math.random() * 100)
+    }
+  })
+
+  const columns = [{
+    header: 'Name',
+    columns: [{
+      header: 'First Name',
+      accessor: 'firstName'
+    }, {
+      header: 'Last Name',
+      id: 'lastName',
+      accessor: d => d.lastName
+    }]
+  }, {
+    header: 'Info',
+    columns: [{
+      header: 'Age',
+      accessor: 'age',
+      aggregate: vals => _.round(_.mean(vals)),
+      render: row => {
+        return <span>{row.aggregated ? `${row.value} (avg)` : row.value}</span>
+      }
+    }, {
+      header: 'Visits',
+      accessor: 'visits',
+      aggregate: vals => _.sum(vals)
+    }]
+  }]
+
+  return (
+    <div>
+      <div className='table-wrap'>
+        <ReactTable
+          data={data}
+          columns={columns}
+          defaultPageSize={10}
+          pivotBy={['firstName', 'lastName']}
+          // expandedRows={{
+          //   2: true,
+          //   3: {
+          //     2: true
+          //   }
+          // }}
+        />
+      </div>
+      <div style={{textAlign: 'center'}}>
+        <br />
+        <em>Tip: Hold shift when sorting to multi-sort!</em>
+      </div>
+      <CodeHighlight>{() => getCode()}</CodeHighlight>
+    </div>
+  )
+}
+
+function getCode () {
+  return `
+const columns = [{
+  header: 'Name',
+  columns: [{
+    header: 'First Name',
+    accessor: 'firstName'
+  }, {
+    header: 'Last Name',
+    id: 'lastName',
+    accessor: d => d.lastName
+  }]
+}, {
+  header: 'Info',
+  columns: [{
+    header: 'Age',
+    accessor: 'age'
+  }]
+}]
+
+export default (
+  <ReactTable
+    data={data}
+    columns={columns}
+    defaultPageSize={10}
+    SubComponent={(row) => {
+      return (
+        <div style={{padding: '20px'}}>
+          <em>You can put any component you want here, even another React Table!</em>
+          <br />
+          <br />
+          <ReactTable
+            data={data}
+            columns={columns}
+            defaultPageSize={3}
+            showPagination={false}
+            SubComponent={(row) => {
+              return (
+                <div style={{padding: '20px'}}>
+                  <em>It even has access to the row data: </em>
+                  <CodeHighlight>{() => JSON.stringify(row, null, 2)}</CodeHighlight>
+                </div>
+              )
+            }}
+          />
+        </div>
+      )
+    }}
+  />
+)
+  `
+}

stories/PivotingSubComponents.js

@@ -0,0 +1,138 @@
+import React from 'react'
+import _ from 'lodash'
+import namor from 'namor'
+
+import CodeHighlight from './components/codeHighlight'
+import ReactTable from '../lib/index'
+
+export default () => {
+  const data = _.map(_.range(10000), d => {
+    return {
+      firstName: namor.generate({ words: 1, numLen: 0 }),
+      lastName: namor.generate({ words: 1, numLen: 0 }),
+      age: Math.floor(Math.random() * 30),
+      visits: Math.floor(Math.random() * 100)
+    }
+  })
+
+  const columns = [{
+    header: 'Name',
+    columns: [{
+      header: 'First Name',
+      accessor: 'firstName'
+    }, {
+      header: 'Last Name',
+      id: 'lastName',
+      accessor: d => d.lastName
+    }]
+  }, {
+    header: 'Info',
+    columns: [{
+      header: 'Age',
+      accessor: 'age',
+      aggregate: vals => _.round(_.mean(vals)),
+      render: row => {
+        return <span>{row.aggregated ? `${row.value} (avg)` : row.value}</span>
+      }
+    }, {
+      header: 'Visits',
+      accessor: 'visits',
+      aggregate: vals => _.sum(vals)
+    }]
+  }]
+
+  return (
+    <div>
+      <div className='table-wrap'>
+        <ReactTable
+          data={data}
+          columns={columns}
+          defaultPageSize={10}
+          pivotBy={['firstName', 'lastName']}
+          SubComponent={(row) => {
+            return (
+              <div style={{padding: '20px'}}>
+                <em>You can put any component you want here, even another React Table!</em>
+                <br />
+                <br />
+                <ReactTable
+                  data={data}
+                  columns={columns}
+                  defaultPageSize={3}
+                  showPagination={false}
+                  SubComponent={(row) => {
+                    return (
+                      <div style={{padding: '20px'}}>
+                        <em>It even has access to the row data: </em>
+                        <CodeHighlight>{() => JSON.stringify(row, null, 2)}</CodeHighlight>
+                      </div>
+                    )
+                  }}
+                />
+              </div>
+            )
+          }}
+        />
+      </div>
+      <div style={{textAlign: 'center'}}>
+        <br />
+        <em>Tip: Hold shift when sorting to multi-sort!</em>
+      </div>
+      <CodeHighlight>{() => getCode()}</CodeHighlight>
+    </div>
+  )
+}
+
+function getCode () {
+  return `
+const columns = [{
+  header: 'Name',
+  columns: [{
+    header: 'First Name',
+    accessor: 'firstName'
+  }, {
+    header: 'Last Name',
+    id: 'lastName',
+    accessor: d => d.lastName
+  }]
+}, {
+  header: 'Info',
+  columns: [{
+    header: 'Age',
+    accessor: 'age'
+  }]
+}]
+
+export default (
+  <ReactTable
+    data={data}
+    columns={columns}
+    defaultPageSize={10}
+    pivotBy={['firstName', 'lastName']}
+    SubComponent={(row) => {
+      return (
+        <div style={{padding: '20px'}}>
+          <em>You can put any component you want here, even another React Table!</em>
+          <br />
+          <br />
+          <ReactTable
+            data={data}
+            columns={columns}
+            defaultPageSize={3}
+            showPagination={false}
+            SubComponent={(row) => {
+              return (
+                <div style={{padding: '20px'}}>
+                  <em>It even has access to the row data: </em>
+                  <CodeHighlight>{() => JSON.stringify(row, null, 2)}</CodeHighlight>
+                </div>
+              )
+            }}
+          />
+        </div>
+      )
+    }}
+  />
+)
+  `
+}

stories/ServerSide.js

@@ -48,6 +48,7 @@ const ServerSide = React.createClass({
     }
   },
   fetchData (state, instance) {
+    console.log(state, instance)
     // Whenever the table model changes, or the user sorts or changes pages, this method gets called and passed the current table model.
     // You can set the `loading` prop of the table to true to use the built-in one or show you're own loading bar if you want.
     this.setState({loading: true})