pourover
v1.2.0
Published
A library for simple, fast filtering and sorting of large collections in the browser
Downloads
964
Maintainers
Readme
PourOver is a library for simple, fast filtering and sorting of large collections -- think 100,000s of items -- in the browser. It allows you to build data-exploration apps and archives that run at 60fps, that don't have to to wait for a database call to render query results.
PourOver is built around the ideal of simple queries that can be arbitrarily composed with each other, without having to recalculate their results. You can union, intersect, and difference queries. PourOver will remember how your queries were constructed and can smartly update them when items are added or modified. You also get useful features like collections that buffer their information periodically, views that page and cache, fast sorting, and much, much more.
Visit the PourOver homepage on Github pages for more info.
Usage
Install through preferred package manager:
- npm:
npm install pourover
- bower:
bower install pourover
- component:
component install hhsnopek/pourover
Dependencies
Underscore.js is the only dependency. Optionally, you may use Lo-dash instead of underscore.
Then require pourover
and underscore
/lodash
into your project script and you're all set!
Browser Support
PourOver should work in any browser that underscore works in. It has been tested in:
- IE7+
- Firefox 4+
- Safari 5+
- Opera 9+
- Chrome 1+
Notice
This repo contains upstream changes that weren't verified by NYTimes developers. I attempted contact the original developers of PourOver for changes to be looked at or add myself or others as maintainers, but was unable to receive a response. There is an issue present in NYTimes/pourover that contains an open issue regarding this.