Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom options, passed to event handlers #26

Open
wants to merge 19 commits into
base: master
Choose a base branch
from

Conversation

hashchange
Copy link

With custom options, it is possible to send additional information to event handlers.

It works by passing an arbitrary, custom option (or a whole bunch of them) to any method. The option doesn't affect the operation of Backbone.Picky, but it is passed on to the event handlers as the last argument.

myCol = new SingleCollection([myModel]);
myCol.on("select:one", function (model, options){ 
  if (options) console.log("Selected while foo=" + options.foo);
});

myCol.select(myModel, {foo: "bar"});    // prints "Selected while foo=bar"

Options get passed around to all event handlers which are running. In the example above, the event handler is set up for the collection. But it will also pick up an option passed to the select method of the model, for instance.

myModel.select({foo: "baz"});    // prints "Selected while foo=baz"

The feature is based on my previous commits. Tests and documentation are included.

hashchange and others added 19 commits December 30, 2013 16:00
deselectAll is more consistent with the rest of the API; selectNone is kept around for compatibility.
If a selectable model belongs to more than one selectable collection then only the initial collection will have it's select() method called.

Also, if a model is initially added to a non-selectable collection, and then later added to a selectable collection the 2nd collection will not have it's select() method called, and a error will be thrown as the initial collection will not have a select() method.
Backbone 1.0.0, Underscore 1.5.0. Using the listenTo and stopListening methods requires at least Backbone 0.9.9.
The extended model or collection is passed to the mixin as an argument now.
Events still need to be improved, those tests are failing.
Plus trivial changes in the tests to get rid of some warnings when committing.
…e in spec)

Previously, selectAll fired a select:all event even if all models had already
been selected beforehand. Similarly, deselectAll fired a select:none event
even if no model had been selected in the first place.

No-ops like this don't trigger an event any more.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants