Skip to content

Latest commit

 

History

History
105 lines (71 loc) · 5.69 KB

README.md

File metadata and controls

105 lines (71 loc) · 5.69 KB
Raw

Stories in Ready Stories in Discussion Griddle

Take a brief look at what's coming in Griddle v1.0

Join us here ![Gitter](https://badges.gitter.im/Join Chat.svg)

Build Status

Griddle is a simple grid Component for use with React. It depends on underscore.js and React.

Please check out the documentation and examples.

To use Griddle:

npm install griddle-react

Or

download and reference griddle.js from the build directory (npm is preferred).

To run from source, type the following commands into a terminal:

  1. npm install -g grunt-cli if you don't have grunt.
  2. npm install
  3. grunt
  4. That's it!

Griddle is not yet version 1. There are likely some areas that will change and some issues that you may encounter. Please submit issues / pull requests for anything you run into.

###Contributing:###

Please feel free submit any bugs or suggestions as issues. If you are having problems getting up and running please post in the Gitter chat and we'll try to help out. Pull requests are welcome but if you have an idea please post as an issue first to make sure everyone is on the same-page (and to help avoid duplicate work). If you are looking to help out but don't know where to start, please take a look at approved issues that don't have anyone assigned.

###Changelog:###

0.3.0

  • Pulling the React 0.14 update into a larger version update to prevent npm from assuming it's safe to update.

0.2.16

  • Reverted to prevent an auto-upgrade to React 0.14.

0.2.15

  • Upgrade to React 0.14 - big thanks to Sajin Shrestha (@sajinshrestha) on nearly single-handedly taking on this effort!

0.2.13

  • Numerous bug fixes, additions.
  • Additional notes will be added soon. ...

0.2.1 - 0.2.3

  • Tweaks surrounding package.json dependencies.

0.2.0

  1. Styling - Griddle now renders as a single HTML table by default. Additionally, if you don't want to use Griddle's styles they can be turned off with a property useGriddleStyles={false}. See more on styling.
  2. External Results - External data should now be passed in via props rather than a callback. The Griddle callback is still available for those that wish to use it but it's now in a separate module. More on External Data
  3. Custom Components - In addition to swapping out the column or row with a custom component, it's now possible to switch out the entire grid with a custom component. For example, the data could initially be rendered as a chart. The data that makes up the chart could be displayed by clicking on settings and unchecking the Enable Custom Formatting option. Customization docs
  4. Infinite Scrolling - Infinite scrolling can be toggled instead of the default pagination. View infinite scrolling docs
  5. New Documentation Site - The documentation site is a bit more thorough and no longer a single page. Check it out here

Breaking Changes:

  1. Updated the following properties:
  • useCustomFormat changed to useCustomRowComponent
  • useCustomPager changed to useCustomPagerComponent
  • customFormat changed to customRowComponent
  • customPager changed to customPagerComponent
  • customFormatClassName changed to customRowComponentClassName
  • allowToggleCustom to enableToggleCustom
  • customNoData changed to customNoDataComponent
  • Significantly changed getExternalResults. See the note below.
  1. The getExternalResults property and loading data from an external source has been updated quite a bit.

0.1.19:

  1. Updated some of the documentation to note forthcoming changes to ExternalResults etc.
  2. Custom cell components now have a property rowData as well as the data. See here for more info
  3. Components reference just React now instead of React/Addons.

0.1.18:

  1. Fixed a bug where initialSort property wasn't getting used
  2. Added initialSortAscending prop (defaults to true)
  3. Removed references to bootstrap
  4. Fixed an issue with filtering and external results
  5. External Results fixes/enhancements
  6. Metadata enhancements