Download:
child 5:8042a3d4fcc6
parent 3:c2023ec9fa6a
4:223997f08b4c
Anton Shestakov <engored@ya.ru>, Wed, 05 Dec 2012 02:45:25 +0900
Docs.

1 файлов изменено, 39 вставок(+), 0 удалений(-) [+]
README.rst file | annotate | diff | comparison | revisions
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst Wed Dec 05 02:45:25 2012 +0900
@@ -0,0 +1,39 @@
+Overview
+========
+
+Backbone.Shard is a variation on a Subset taken from different perspective.
+Shard was built as a simple "persistent filter" for collections; it can
+help grouping and displaying items of certain kind based on your filter
+function. I know it works for me, but your mileage may vary.
+
+Usage
+=====
+
+It's easy if you're familiar with Backbone.Collection since Shard shares
+with it most of the methods marked **Underscore methods** in the
+`documentation <http://backbonejs.org/#Collection-Underscore-Methods>`_::
+
+ var shelf = Backbone.Shard({
+ collection: books,
+ filter: function(book) { return task.get('read'); }
+ });
+
+ read.each(...);
+ read.pluck(...);
+
+You can add/remove models or reset *the original collection* and Shard will
+honestly try to keep up with it, but currently Shard itself has no methods
+such as add/remove/reset.
+
+Events work and respect your filter function::
+
+ shelf.on('add', doSomething);
+ collection.add({read true}); // this will call doSomething
+ collection.add({read: false}); // this won't
+
+Tests
+=====
+
+Download the `source
+<https://bitbucket.org/engored/backbone-shard/get/tip.tar.bz2>`_ and open
+test/index.html in your browser.