Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Quick search plugin for backbone collections using the Quicksilver string ranking algorithm.
JavaScript
Branch: master

README.md

Backbone Search

Quick search plugin for backbone collections using the Quicksilver string ranking algorithm.

Getting Started

Download the production version or the development version.

In your web page:

<script src="jquery.js"></script>
<script src="backbone.min.js"></script>
<script src="backbone.search.min.js"></script>
<script>
  var searchableObjs = new Backbone.Collection( arrOfObjs );

  var results = searchableObjs.search( "term" )

  // 'results' is a new collection, where the models that score higher than
  // 0 for "term" are sorted by their score for matching "term"
</script>

Documentation

(Coming soon)

Examples

(Coming soon)

Release History

(Nothing yet)

License

Copyright (c) 2012 Boaz Sender
Licensed under the MIT license.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Important notes

Please don't edit files in the dist subdirectory as they are generated via grunt. You'll find source code in the src subdirectory!

While grunt can run the included unit tests via PhantomJS, this shouldn't be considered a substitute for the real thing. Please be sure to test the test/*.html unit test file(s) in actual browsers.

Installing grunt

This assumes you have node.js and npm installed already.

  1. Test that grunt is installed globally by running grunt --version at the command-line.
  2. If grunt isn't installed globally, run npm install -g grunt to install the latest version. You may need to run sudo npm install -g grunt.
  3. From the root directory of this project, run npm install to install the project's dependencies.

Installing PhantomJS

In order for the qunit task to work properly, PhantomJS must be installed and in the system PATH (if you can run "phantomjs" at the command line, this task should work).

Unfortunately, PhantomJS cannot be installed automatically via npm or grunt, so you need to install it yourself. There are a number of ways to install PhantomJS.

Note that the phantomjs executable needs to be in the system PATH for grunt to see it.

Something went wrong with that request. Please try again.