Skip to content
This repository has been archived by the owner on Nov 27, 2018. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vaiRk committed Feb 13, 2016
1 parent 505224f commit d238a73
Showing 1 changed file with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
[![npm version](https://badge.fury.io/js/responsive-fixed-data-table.svg)](http://badge.fury.io/js/responsive-fixed-data-table)
# responsive-fixed-data-table
[![npm version](https://badge.fury.io/js/responsive-fixed-data-table.svg)](http://badge.fury.io/js/responsive-fixed-data-table)
Responsive wrapper for [Facebook's Fixed-Data-Table](https://github.com/facebook/fixed-data-table) grids

## Installation
This module is available as an npm package.

npm install [--save] responsive-fixed-data-table
npm install [--save] responsive-fixed-data-table

## Usage
This module includes minified and non minified UMD builds as well as an ES6 build. You choose!

```js
var React = require('react');
var Column = require('fixed-data-table').Column;
var ResponsiveFixedDataTable = require('responsive-fixed-data-table');

var ResponsiveTable = React.createClass({
render: function() {
return (
<ResponsiveFixedDataTable {...tableProps}>
<Column {...columnsProps} />
</ResponsiveFixedDataTable>
);
}
});

module.exports = ResponsiveTable;
import React from 'react';
import ResponsiveFixedDataTable from 'responsive-fixed-data-table';
import { Column } from 'fixed-data-table';

export default class ResponsiveTable extends React.Component {
render() {
return (
<ResponsiveFixedDataTable {...tableProps}>
<Column {...columnsProps} />
</ResponsiveFixedDataTable>
);
}
}
```

All passed props will be passed to the underlying FixedDataTable component. Please check [FixedDataTable docs](http://facebook.github.io/fixed-data-table/api-table.html) for a list of available options.
Expand All @@ -32,3 +32,6 @@ Width and height will be overriden to take all the available space of its parent
### Additional configuration
**containerStyle** *{Object}*: Additional styles to be set on the container div.
**refreshRate** *{Number}*: Time in milliseconds to debounce the resize handler.

### React 0.13 compatibility
If you want to use this module with old versions of React and FixedDataTable please check the **v1.5.0-deprecated** branch.

0 comments on commit d238a73

Please sign in to comment.