README.md
1Select2
2=======
3![Build Status][github-actions-image]
4[](https://opencollective.com/select2) [][cdnjs]
5[][jsdelivr]
6
7Select2 is a jQuery-based replacement for select boxes. It supports searching,
8remote data sets, and pagination of results.
9
10To get started, checkout examples and documentation at
11https://select2.org/
12
13Use cases
14---------
15* Enhancing native selects with search.
16* Enhancing native selects with a better multi-select interface.
17* Loading data from JavaScript: easily load items via AJAX and have them
18 searchable.
19* Nesting optgroups: native selects only support one level of nesting. Select2
20 does not have this restriction.
21* Tagging: ability to add new items on the fly.
22* Working with large, remote datasets: ability to partially load a dataset based
23 on the search term.
24* Paging of large datasets: easy support for loading more pages when the results
25 are scrolled to the end.
26* Templating: support for custom rendering of results and selections.
27
28Browser compatibility
29---------------------
30* IE 8+
31* Chrome 8+
32* Firefox 10+
33* Safari 3+
34* Opera 10.6+
35
36Usage
37-----
38You can source Select2 directly from a CDN like [jsDelivr][jsdelivr] or
39[cdnjs][cdnjs], [download it from this GitHub repo][releases], or use one of
40the integrations below.
41
42Integrations
43------------
44Third party developers have created plugins for platforms which allow Select2 to be integrated more natively and quickly. For many platforms, additional plugins are not required because Select2 acts as a standard `<select>` box.
45
46Plugins
47
48* [Django]
49 - [django-autocomplete-light]
50 - [django-easy-select2]
51 - [django-select2]
52* [Drupal] - [drupal-select2]
53* [Meteor] - [meteor-select2]
54* [Ruby on Rails][ruby-on-rails] - [select2-rails]
55* [Wicket] - [wicketstuff-select2]
56* [Yii 2][yii2] - [yii2-widget-select2]
57* [Angularjs][angularjs] - [mdr-angular-select2]
58
59Themes
60
61- [Bootstrap 3][bootstrap3] - [select2-bootstrap-theme]
62- [Bootstrap 4][bootstrap4] - [select2-bootstrap4-theme]
63- [Flat UI][flat-ui] - [select2-flat-theme]
64- [Metro UI][metro-ui] - [select2-metro]
65
66Missing an integration? Modify this `README` and make a pull request back here to Select2 on GitHub.
67
68Internationalization (i18n)
69---------------------------
70Select2 supports multiple languages by simply including the right language JS
71file (`dist/js/i18n/it.js`, `dist/js/i18n/nl.js`, etc.) after
72`dist/js/select2.js`.
73
74Missing a language? Just copy `src/js/select2/i18n/en.js`, translate it, and
75make a pull request back to Select2 here on GitHub.
76
77Documentation
78-------------
79The documentation for Select2 is available
80[online at the documentation website][documentation] and is located within the
81[`docs` directory of this repository][documentation-directory].
82
83Community
84---------
85You can find out about the different ways to get in touch with the Select2
86community at the [Select2 community page][community].
87
88Copyright and license
89---------------------
90The license is available within the repository in the [LICENSE][license] file.
91
92[cdnjs]: http://www.cdnjs.com/libraries/select2
93[community]: https://select2.org/getting-help
94[documentation]: https://select2.org
95[documentation-directory]: https://github.com/select2/select2/tree/develop/docs
96[freenode]: https://freenode.net/
97[github-actions-image]: https://github.com/select2/select2/workflows/CI/badge.svg
98[jsdelivr]: https://www.jsdelivr.com/package/npm/select2
99[license]: LICENSE.md
100[releases]: https://github.com/select2/select2/releases
101
102[angularjs]: https://angularjs.org/
103[bootstrap3]: https://getbootstrap.com/
104[bootstrap4]: https://getbootstrap.com/
105[django]: https://www.djangoproject.com/
106[django-autocomplete-light]: https://github.com/yourlabs/django-autocomplete-light
107[django-easy-select2]: https://github.com/asyncee/django-easy-select2
108[django-select2]: https://github.com/applegrew/django-select2
109[drupal]: https://www.drupal.org/
110[drupal-select2]: https://www.drupal.org/project/select2
111[flat-ui]: http://designmodo.github.io/Flat-UI/
112[mdr-angular-select2]: https://github.com/modulr/mdr-angular-select2
113[meteor]: https://www.meteor.com/
114[meteor-select2]: https://github.com/nate-strauser/meteor-select2
115[metro-ui]: http://metroui.org.ua/
116[select2-metro]: http://metroui.org.ua/select2.html
117[ruby-on-rails]: http://rubyonrails.org/
118[select2-bootstrap-theme]: https://github.com/select2/select2-bootstrap-theme
119[select2-bootstrap4-theme]: https://github.com/ttskch/select2-bootstrap4-theme
120[select2-flat-theme]: https://github.com/techhysahil/select2-Flat_Theme
121[select2-rails]: https://github.com/argerim/select2-rails
122[vue.js]: http://vuejs.org/
123[select2-vue]: http://vuejs.org/examples/select2.html
124[wicket]: https://wicket.apache.org/
125[wicketstuff-select2]: https://github.com/wicketstuff/core/tree/master/select2-parent
126[yii2]: http://www.yiiframework.com/
127[yii2-widget-select2]: https://github.com/kartik-v/yii2-widget-select2
128
129## Contributors
130
131### Code Contributors
132
133This project exists thanks to all the people who contribute. [[Contribute](.github/CONTRIBUTING.md)].
134<a href="https://github.com/select2/select2/graphs/contributors"><img src="https://opencollective.com/select2/contributors.svg?width=890&button=false" /></a>
135
136### Financial Contributors
137
138Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/select2/contribute)]
139
140#### Individuals
141
142<a href="https://opencollective.com/select2"><img src="https://opencollective.com/select2/individuals.svg?width=890"></a>
143
144#### Organizations
145
146Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/select2/contribute)]
147
148<a href="https://opencollective.com/select2/organization/0/website"><img src="https://opencollective.com/select2/organization/0/avatar.svg"></a>
149<a href="https://opencollective.com/select2/organization/1/website"><img src="https://opencollective.com/select2/organization/1/avatar.svg"></a>
150<a href="https://opencollective.com/select2/organization/2/website"><img src="https://opencollective.com/select2/organization/2/avatar.svg"></a>
151<a href="https://opencollective.com/select2/organization/3/website"><img src="https://opencollective.com/select2/organization/3/avatar.svg"></a>
152<a href="https://opencollective.com/select2/organization/4/website"><img src="https://opencollective.com/select2/organization/4/avatar.svg"></a>
153<a href="https://opencollective.com/select2/organization/5/website"><img src="https://opencollective.com/select2/organization/5/avatar.svg"></a>
154<a href="https://opencollective.com/select2/organization/6/website"><img src="https://opencollective.com/select2/organization/6/avatar.svg"></a>
155<a href="https://opencollective.com/select2/organization/7/website"><img src="https://opencollective.com/select2/organization/7/avatar.svg"></a>
156<a href="https://opencollective.com/select2/organization/8/website"><img src="https://opencollective.com/select2/organization/8/avatar.svg"></a>
157<a href="https://opencollective.com/select2/organization/9/website"><img src="https://opencollective.com/select2/organization/9/avatar.svg"></a>
158
){kind=link}
){kind=link}
