1
0
mirror of synced 2024-11-22 04:56:08 +03:00
select2/README.md

147 lines
5.5 KiB
Markdown
Raw Normal View History

2012-03-04 22:58:26 +04:00
Select2
=======
2012-03-04 22:58:26 +04:00
2013-06-05 19:18:00 +04:00
Select2 is a jQuery-based replacement for select boxes. It supports searching, remote data sets, and infinite scrolling of results.
2012-03-04 22:58:26 +04:00
2013-06-05 19:18:00 +04:00
To get started, checkout examples and documentation at http://ivaynberg.github.com/select2
2012-03-04 22:58:26 +04:00
Use cases
---------
2013-06-05 19:18:00 +04:00
* 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
---------------------
2013-05-14 19:52:42 +04:00
* IE 8+
* Chrome 8+
2013-05-14 19:52:42 +04:00
* Firefox 10+
* Safari 3+
* Opera 10.6+
2014-04-15 01:51:45 +04:00
Usage
-----
You can source Select2 directly from a CDN like [JSDliver][jsdelivr] or
[CDNJS][cdnjs], [download it from this GitHub repo][tags], or use one of
the integrations below.
2012-06-15 07:27:10 +04:00
Integrations
------------
2012-06-15 05:08:49 +04:00
* [Wicket-Select2][wicket-select2] (Java / [Apache Wicket][wicket])
* [select2-rails][select2-rails] (Ruby on Rails)
* [AngularUI][angularui-select] ([AngularJS][angularjs])
* [Django][django-select2]
* [Symfony][symfony-select2]
* [Symfony2][symfony2-select2]
* [Bootstrap 2][bootstrap2-select2] and [Bootstrap 3][bootstrap3-select2]
(CSS skins)
* [Meteor][meteor-select2] ([Bootstrap 3 skin][meteor-select2-bootstrap3])
* [Meteor][meteor-select2-alt]
* [Yii 2.x][yii2-select2]
* [Yii 1.x][yii-select2]
* [AtmosphereJS][atomospherejs-select2]
2014-05-18 08:31:42 +04:00
### Example Integrations
* [Knockout.js](https://github.com/ivaynberg/select2/wiki/Knockout.js-Integration)
* [Socket.IO](https://github.com/ivaynberg/select2/wiki/Socket.IO-Integration)
* [PHP](https://github.com/ivaynberg/select2/wiki/PHP-Example)
* [.Net MVC] (https://github.com/ivaynberg/select2/wiki/.Net-MVC-Example)
2012-06-15 05:08:49 +04:00
Internationalization (i18n)
---------------------------
2014-02-04 19:49:51 +04:00
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
2013-06-05 19:18:00 +04:00
it, and make a pull request back to Select2 here on GitHub.
Documentation
-------------
The documentation for Select2 is available
[through GitHub Pages][documentation] and is located within this repository
in the [docs folder][documentation-folder].
2014-08-13 04:50:38 +04:00
Community
---------
### Bug tracker
2012-03-04 22:58:26 +04:00
Have a bug? Please create an issue here on GitHub!
2012-03-04 22:59:28 +04:00
https://github.com/ivaynberg/select2/issues
2012-03-04 22:58:26 +04:00
2014-08-13 04:50:38 +04:00
### Mailing list
2012-03-04 22:58:26 +04:00
Have a question? Ask on our mailing list!
2012-03-04 22:59:28 +04:00
select2@googlegroups.com
2012-03-04 22:58:26 +04:00
2012-03-04 22:59:28 +04:00
https://groups.google.com/d/forum/select2
2012-03-04 22:58:26 +04:00
2014-08-13 04:50:38 +04:00
### IRC channel
Need help implementing Select2 in your project? Ask in our IRC channel!
**Network:** [Freenode][freenode] (`chat.freenode.net`)
2014-08-13 04:50:38 +04:00
**Channel:** `#select2`
**Web access:** https://webchat.freenode.net/?channels=select2
2012-03-04 22:58:26 +04:00
Copyright and license
2012-03-04 22:58:26 +04:00
---------------------
The MIT License (MIT)
Copyright (c) 2012-2014 Kevin Brown, Igor Vaynberg, and Select2 contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
[angularjs]: https://angularjs.org/
[angularui-select]: http://angular-ui.github.io/#ui-select
[atmospherejs-select2]: https://atmospherejs.com/package/jquery-select2
[bootstrap2-select2]: https://github.com/t0m/select2-bootstrap-css
[bootstrap3-select2]: https://github.com/t0m/select2-bootstrap-css/tree/bootstrap3
[cdnjs]: http://www.cdnjs.com/libraries/select2
[django-select2]: https://github.com/applegrew/django-select2
[documentation]: https://ivaynberg.github.io/select2/
[documentation-folder]: https://github.com/ivaynberg/select2/tree/master/docs
[freenode]: https://freenode.net/
[jsdelivr]: http://www.jsdelivr.com/#!select2
[meteor-select2]: https://github.com/nate-strauser/meteor-select2
[meteor-select2-alt]: https://jquery-select2.meteor.com
[meteor-select2-bootstrap3]: https://github.com/esperadomedia/meteor-select2-bootstrap3-css/
[select2-rails]: https://github.com/argerim/select2-rails
[symfony-select2]: https://github.com/19Gerhard85/sfSelect2WidgetsPlugin
[symfony2-select2]: https://github.com/avocode/FormExtensions
[tags]: https://github.com/ivaynberg/select2/tags
[wicket]: http://wicket.apache.org
[wicket-select2]: https://github.com/ivaynberg/wicket-select2
[yii-select2]: https://github.com/tonybolzan/yii-select2
[yii2-select2]: http://demos.krajee.com/widgets#select2