addons/web/static/lib/select2/README.md

   1 Select2
   2 =================
   3
   4 Select2 is a jQuery based replacement for select boxes. It supports searching, remote data sets, and infinite scrolling of results. Look and feel of Select2 is based on the excellent [Chosen](http://harvesthq.github.com/chosen/) library.
   5
   6 To get started -- checkout http://ivaynberg.github.com/select2!
   7
   8 What Does Select2 Support That Chosen Does Not?
   9 -------------------------------------------------
  10
  11 * Working with large datasets: Chosen requires the entire dataset to be loaded as `option` tags in the DOM, which limits
  12 it to working with small-ish datasets. Select2 uses a function to find results on-the-fly, which allows it to partially
  13 load results.
  14 * Paging of results: Since Select2 works with large datasets and only loads a small amount of matching results at a time
  15 it has to support paging. Select2 will call the search function when the user scrolls to the bottom of currently loaded
  16 result set allowing for the 'infinite scrolling' of results.
  17 * Custom markup for results: Chosen only supports rendering text results because that is the only markup supported by
  18 `option` tags. Select2 provides an extension point which can be used to produce any kind of markup to represent results.
  19 * Ability to add results on the fly: Select2 provides the ability to add results from the search term entered by the user, which allows it to be used for
  20 tagging.
  21
  22 Browser Compatibility
  23 --------------------
  24 * IE 8+ (7 mostly works except for [issue with z-index](https://github.com/ivaynberg/select2/issues/37))
  25 * Chrome 8+
  26 * Firefox 3.5+
  27 * Safari 3+
  28 * Opera 10.6+
  29
  30 Integrations
  31 ------------
  32
  33 * [Wicket-Select2](https://github.com/ivaynberg/wicket-select2) (Java / Apache Wicket)
  34 * [select2-rails](https://github.com/argerim/select2-rails) (Ruby on Rails)
  35 * [AngularUI](http://angular-ui.github.com/#directives-select2) ([AngularJS](angularjs.org))
  36 * [Django](https://github.com/applegrew/django-select2)
  37
  38 Bug tracker
  39 -----------
  40
  41 Have a bug? Please create an issue here on GitHub!
  42
  43 https://github.com/ivaynberg/select2/issues
  44
  45
  46 Mailing list
  47 ------------
  48
  49 Have a question? Ask on our mailing list!
  50
  51 select2@googlegroups.com
  52
  53 https://groups.google.com/d/forum/select2
  54
  55
  56 Copyright and License
  57 ---------------------
  58
  59 Copyright 2012 Igor Vaynberg
  60
  61 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in
  62 compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:
  63
  64 http://www.apache.org/licenses/LICENSE-2.0
  65
  66 Unless required by applicable law or agreed to in writing, software distributed under the License is
  67 distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  68 See the License for the specific language governing permissions and limitations under the License.