drupal-civicrm/sites/all/modules/civicrm/bower_components/select2/README.md
2018-01-14 13:10:16 +00:00

4.7 KiB

Select2

Select2 is a jQuery-based replacement for select boxes. It supports searching, remote data sets, and infinite scrolling of results.

To get started, checkout examples and documentation at http://select2.github.io/select2/

Use cases

  • Enhancing native selects with search.
  • Enhancing native selects with a better multi-select interface.
  • Loading data from JavaScript: easily load items via ajax and have them searchable.
  • Nesting optgroups: native selects only support one level of nested. Select2 does not have this restriction.
  • Tagging: ability to add new items on the fly.
  • Working with large, remote datasets: ability to partially load a dataset based on the search term.
  • Paging of large datasets: easy support for loading more pages when the results are scrolled to the end.
  • Templating: support for custom rendering of results and selections.

Browser compatibility

  • IE 8+
  • Chrome 8+
  • Firefox 10+
  • Safari 3+
  • Opera 10.6+

Usage

You can source Select2 directly from a CDN like jsDelivr or CDNJS, download it from this GitHub repo, or use one of the integrations below.

Integrations

Example Integrations

Internationalization (i18n)

Select2 supports multiple languages by simply including the right language JS file (select2_locale_it.js, select2_locale_nl.js, etc.) after select2.js.

Missing a language? Just copy select2_locale_en.js.template, translate it, and make a pull request back to Select2 here on GitHub.

Documentation

The documentation for Select2 is available through GitHub Pages and is located within this repository in the gh-pages branch.

Community

Bug tracker

Have a bug? Please create an issue here on GitHub!

https://github.com/ivaynberg/select2/issues

Mailing list

Have a question? Ask on our mailing list!

select2@googlegroups.com

https://groups.google.com/d/forum/select2

IRC channel

Need help implementing Select2 in your project? Ask in our IRC channel!

Network: Freenode (chat.freenode.net)

Channel: #select2

Web access: https://webchat.freenode.net/?channels=select2

Copyright 2015 Igor Vaynberg

This software is licensed under the Apache License, Version 2.0 (the "Apache License") or the GNU General Public License version 2 (the "GPL License"). You may choose either license to govern your use of this software only upon the condition that you accept all of the terms of either the Apache License or the GPL License.

You may obtain a copy of the Apache License and the GPL License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0 http://www.gnu.org/licenses/gpl-2.0.html

Unless required by applicable law or agreed to in writing, software distributed under the Apache License or the GPL License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License and the GPL License for the specific language governing permissions and limitations under the Apache License and the GPL License.