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.
   5
   6 To get started, checkout examples and documentation at http://ivaynberg.github.com/select2
   7
   8 Use cases
   9 ---------
  10
  11 * Enhancing native selects with search.
  12 * Enhancing native selects with a better multi-select interface.
  13 * Loading data from JavaScript: easily load items via ajax and have them searchable.
  14 * Nesting optgroups: native selects only support one level of nested. Select2 does not have this restriction.
  15 * Tagging: ability to add new items on the fly.
  16 * Working with large, remote datasets: ability to partially load a dataset based on the search term.
  17 * Paging of large datasets: easy support for loading more pages when the results are scrolled to the end.
  18 * Templating: support for custom rendering of results and selections.
  19
  20 Browser compatibility
  21 ---------------------
  22 * IE 8+
  23 * Chrome 8+
  24 * Firefox 10+
  25 * Safari 3+
  26 * Opera 10.6+
  27
  28 Usage
  29 -----
  30 You can source Select2 directly from a [CDN like JSDliver](http://www.jsdelivr.com/#!select2), [download it from this GitHub repo](https://github.com/ivaynberg/select2/tags), or use one of the integrations below.
  31
  32 Integrations
  33 ------------
  34
  35 * [Wicket-Select2](https://github.com/ivaynberg/wicket-select2) (Java / [Apache Wicket](http://wicket.apache.org))
  36 * [select2-rails](https://github.com/argerim/select2-rails) (Ruby on Rails)
  37 * [AngularUI](http://angular-ui.github.com/#directives-select2) ([AngularJS](angularjs.org))
  38 * [Django](https://github.com/applegrew/django-select2)
  39 * [Symfony](https://github.com/19Gerhard85/sfSelect2WidgetsPlugin)
  40 * [Symfony2](https://github.com/avocode/FormExtensions)
  41 * [Bootstrap 2](https://github.com/t0m/select2-bootstrap-css) and [Bootstrap 3](https://github.com/t0m/select2-bootstrap-css/tree/bootstrap3) (CSS skins)
  42 * [Meteor](https://github.com/nate-strauser/meteor-select2) (modern reactive JavaScript framework; + [Bootstrap 3 skin](https://github.com/esperadomedia/meteor-select2-bootstrap3-css/))
  43 * [Meteor](https://jquery-select2.meteor.com)
  44 * [Yii 2.x](http://demos.krajee.com/widgets#select2)
  45 * [Yii 1.x](https://github.com/tonybolzan/yii-select2)
  46 * [AtmosphereJS](https://atmospherejs.com/package/jquery-select2)
  47
  48 ### Example Integrations
  49
  50 * [Knockout.js](https://github.com/ivaynberg/select2/wiki/Knockout.js-Integration)
  51 * [Socket.IO](https://github.com/ivaynberg/select2/wiki/Socket.IO-Integration)
  52 * [PHP](https://github.com/ivaynberg/select2/wiki/PHP-Example)
  53 * [.Net MVC] (https://github.com/ivaynberg/select2/wiki/.Net-MVC-Example)
  54
  55 Internationalization (i18n)
  56 ---------------------------
  57
  58 Select2 supports multiple languages by simply including the right language JS
  59 file (`select2_locale_it.js`, `select2_locale_nl.js`, etc.) after `select2.js`.
  60
  61 Missing a language? Just copy `select2_locale_en.js.template`, translate
  62 it, and make a pull request back to Select2 here on GitHub.
  63
  64 Bug tracker
  65 -----------
  66
  67 Have a bug? Please create an issue here on GitHub!
  68
  69 https://github.com/ivaynberg/select2/issues
  70
  71 Mailing list
  72 ------------
  73
  74 Have a question? Ask on our mailing list!
  75
  76 select2@googlegroups.com
  77
  78 https://groups.google.com/d/forum/select2
  79
  80
  81 Copyright and license
  82 ---------------------
  83
  84 Copyright 2012 Igor Vaynberg
  85
  86 This software is licensed under the Apache License, Version 2.0 (the "Apache License") or the GNU
  87 General Public License version 2 (the "GPL License"). You may choose either license to govern your
  88 use of this software only upon the condition that you accept all of the terms of either the Apache
  89 License or the GPL License.
  90
  91 You may obtain a copy of the Apache License and the GPL License in the LICENSE file, or at:
  92
  93 http://www.apache.org/licenses/LICENSE-2.0
  94 http://www.gnu.org/licenses/gpl-2.0.html
  95
  96 Unless required by applicable law or agreed to in writing, software distributed under the Apache License
  97 or the GPL License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  98 either express or implied. See the Apache License and the GPL License for the specific language governing
  99 permissions and limitations under the Apache License and the GPL License.