RetailCRM-Mirror/select2
1
0
Fork 0
mirror of synced 2024-11-28 15:46:03 +03:00
Code Issues Projects Releases Wiki Activity
82c51a319c
select2/README.md

128 lines
4.9 KiB
Markdown
Raw Normal View History

initial checkin
2012-03-04 22:58:26 +04:00
Select2
Update README.md Use consistent sentence casing.
2013-06-05 08:34:54 +04:00
=======
Added Travis CI badge and fixed package.json
2015-01-10 00:09:30 +03:00
[![Build Status][travis-ci-image]][travis-ci-status]
Clean up docs (#5528) * Remove SauceLabs credentials SauceLabs is no longer used during builds, so we no longer need to include these encrypted credentials. * Clean up badges * Remove SauceLabs from the README * Misc README fixes * Disable Travis email notifications Looks like we accidentally re-enabled these when removing IRC.
2019-06-05 03:46:45 +03:00
[![cdnjs](https://img.shields.io/cdnjs/v/select2.svg)][cdnjs]
[![jsdelivr](https://data.jsdelivr.com/v1/package/npm/select2/badge)][jsdelivr]
Added Travis CI badge and fixed package.json
2015-01-10 00:09:30 +03:00
Tweak the README Now we point users to the `LICENSE.md` file for the license, instead of including it in the README. This also removes the example integrations, which are no longer officially maintained by Select2. The translation section has also been updated.
2014-11-01 23:05:47 +03:00
Select2 is a jQuery-based replacement for select boxes. It supports searching,
remote data sets, and pagination of results.
initial checkin
2012-03-04 22:58:26 +04:00
Tweak the README Now we point users to the `LICENSE.md` file for the license, instead of including it in the README. This also removes the example integrations, which are no longer officially maintained by Select2. The translation section has also been updated.
2014-11-01 23:05:47 +03:00
To get started, checkout examples and documentation at
update links in readme
2017-09-11 00:48:47 +03:00
https://select2.org/
initial checkin
2012-03-04 22:58:26 +04:00
Update README.md Use consistent sentence casing.
2013-06-05 08:34:54 +04:00
Use cases
---------
fixes #1386
2013-06-05 19:18:00 +04:00
* Enhancing native selects with search.
* Enhancing native selects with a better multi-select interface.
Updated README and CONTRIBUTING This also updates the LICENSE year. [ci skip]
2015-01-10 03:26:59 +03:00
* Loading data from JavaScript: easily load items via AJAX and have them
searchable.
* Nesting optgroups: native selects only support one level of nesting. Select2
does not have this restriction.
fixes #1386
2013-06-05 19:18:00 +04:00
* Tagging: ability to add new items on the fly.
Updated README and CONTRIBUTING This also updates the LICENSE year. [ci skip]
2015-01-10 03:26:59 +03:00
* 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.
fixes #1386
2013-06-05 19:18:00 +04:00
* Templating: support for custom rendering of results and selections.
tweak readme to show differences from chosen
2012-06-07 20:33:22 +04:00
Update README.md Use consistent sentence casing.
2013-06-05 08:34:54 +04:00
Browser compatibility
---------------------
Update README.md
2013-05-14 19:52:42 +04:00
* IE 8+
adding browser compatibility. issue #79
2012-06-09 05:18:40 +04:00
* Chrome 8+
Update README.md
2013-05-14 19:52:42 +04:00
* Firefox 10+
adding browser compatibility. issue #79
2012-06-09 05:18:40 +04:00
* Safari 3+
* Opera 10.6+
Call out documentation a bit more explicitly This should help fix the problem with users not being able to find the branch when trying to update the documentation.
2014-08-01 18:36:09 +04:00
Mention CDN hosting
2014-04-15 01:51:45 +04:00
Usage
-----
Merge branch 'master' into select2-ng This adds the package management files back into the repository and also updates the README to reflect the future Select2 4.0.
2014-11-01 22:43:01 +03:00
You can source Select2 directly from a CDN like [JSDliver][jsdelivr] or
Update contributing guide and README for 4.0
2015-01-09 19:10:53 +03:00
[CDNJS][cdnjs], [download it from this GitHub repo][releases], or use one of
Merge branch 'master' into select2-ng This adds the package management files back into the repository and also updates the README to reflect the future Select2 4.0.
2014-11-01 22:43:01 +03:00
the integrations below.
adding browser compatibility. issue #79
2012-06-09 05:18:40 +04:00
Update master
2012-06-15 07:27:10 +04:00
Integrations
------------
Fix minor typo in README.md
2017-05-24 14:20:55 +03:00
Third 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.
Update the list of integrations The integrations are now organized by the name of the integration, and themes are now separated out from the plugins. The references for this section have been pulled out at the bottom because there are so many. This closes https://github.com/select2/select2/issues/4150. This closes https://github.com/select2/select2/pull/4067. This closes https://github.com/select2/select2/issues/3957.
2016-02-18 01:10:39 +03:00
Plugins
* [Django]
Add django-autocomplete-light to integrations
2016-09-22 01:08:19 +03:00
- [django-autocomplete-light]
Update the list of integrations The integrations are now organized by the name of the integration, and themes are now separated out from the plugins. The references for this section have been pulled out at the bottom because there are so many. This closes https://github.com/select2/select2/issues/4150. This closes https://github.com/select2/select2/pull/4067. This closes https://github.com/select2/select2/issues/3957.
2016-02-18 01:10:39 +03:00
- [django-easy-select2]
- [django-select2]
Add drupal plugin (#5349)
2018-09-05 04:09:39 +03:00
* [Drupal] - [drupal-select2]
Update the list of integrations The integrations are now organized by the name of the integration, and themes are now separated out from the plugins. The references for this section have been pulled out at the bottom because there are so many. This closes https://github.com/select2/select2/issues/4150. This closes https://github.com/select2/select2/pull/4067. This closes https://github.com/select2/select2/issues/3957.
2016-02-18 01:10:39 +03:00
* [Meteor] - [meteor-select2]
* [Ruby on Rails][ruby-on-rails] - [select2-rails]
* [Wicket] - [wicketstuff-select2]
* [Yii 2][yii2] - [yii2-widget-select2]
Add integration in Angularjs (#4331)
2018-09-05 20:29:52 +03:00
* [Angularjs][angularjs] - [mdr-angular-select2]
Update the list of integrations The integrations are now organized by the name of the integration, and themes are now separated out from the plugins. The references for this section have been pulled out at the bottom because there are so many. This closes https://github.com/select2/select2/issues/4150. This closes https://github.com/select2/select2/pull/4067. This closes https://github.com/select2/select2/issues/3957.
2016-02-18 01:10:39 +03:00
Themes
- [Bootstrap 3][bootstrap3] - [select2-bootstrap-theme]
docs: add link to @ttskch/select2-bootstrap4-theme to README.md (#5487)
2019-04-28 07:06:02 +03:00
- [Bootstrap 4][bootstrap4] - [select2-bootstrap4-theme]
Update the list of integrations The integrations are now organized by the name of the integration, and themes are now separated out from the plugins. The references for this section have been pulled out at the bottom because there are so many. This closes https://github.com/select2/select2/issues/4150. This closes https://github.com/select2/select2/pull/4067. This closes https://github.com/select2/select2/issues/3957.
2016-02-18 01:10:39 +03:00
- [Flat UI][flat-ui] - [select2-flat-theme]
- [Metro UI][metro-ui] - [select2-metro]
Missing an integration? Modify this `README` and make a pull request back here to Select2 on GitHub.
reference about gem use in rails.
2012-06-15 05:08:49 +04:00
Mentioning i18n in README Should probably be documented on http://ivaynberg.github.com/select2/, too, but I'm not very much of a Jekyll dude.
2013-03-13 20:59:59 +04:00
Internationalization (i18n)
---------------------------
Add note about position of locale file
2014-02-04 19:49:51 +04:00
Select2 supports multiple languages by simply including the right language JS
Tweak the README Now we point users to the `LICENSE.md` file for the license, instead of including it in the README. This also removes the example integrations, which are no longer officially maintained by Select2. The translation section has also been updated.
2014-11-01 23:05:47 +03:00
file (`dist/js/i18n/it.js`, `dist/js/i18n/nl.js`, etc.) after
`dist/js/select2.js`.
Mentioning i18n in README Should probably be documented on http://ivaynberg.github.com/select2/, too, but I'm not very much of a Jekyll dude.
2013-03-13 20:59:59 +04:00
Tweak the README Now we point users to the `LICENSE.md` file for the license, instead of including it in the README. This also removes the example integrations, which are no longer officially maintained by Select2. The translation section has also been updated.
2014-11-01 23:05:47 +03:00
Missing a language? Just copy `src/js/select2/i18n/en.js`, translate it, and
make a pull request back to Select2 here on GitHub.
Mentioning i18n in README Should probably be documented on http://ivaynberg.github.com/select2/, too, but I'm not very much of a Jekyll dude.
2013-03-13 20:59:59 +04:00
Call out documentation a bit more explicitly This should help fix the problem with users not being able to find the branch when trying to update the documentation.
2014-08-01 18:36:09 +04:00
Documentation
-------------
Merge branch 'master' into select2-ng This adds the package management files back into the repository and also updates the README to reflect the future Select2 4.0.
2014-11-01 22:43:01 +03:00
The documentation for Select2 is available
Clean up docs (#5528) * Remove SauceLabs credentials SauceLabs is no longer used during builds, so we no longer need to include these encrypted credentials. * Clean up badges * Remove SauceLabs from the README * Misc README fixes * Disable Travis email notifications Looks like we accidentally re-enabled these when removing IRC.
2019-06-05 03:46:45 +03:00
[through GitHub Pages][documentation] and is located within the [separate `select2/docs` repository][documentation-repository].
Call out documentation a bit more explicitly This should help fix the problem with users not being able to find the branch when trying to update the documentation.
2014-08-01 18:36:09 +04:00
Add IRC information to README
2014-08-13 04:50:38 +04:00
Community
---------
Updated README and CONTRIBUTING This also updates the LICENSE year. [ci skip]
2015-01-10 03:26:59 +03:00
You can find out about the different ways to get in touch with the Select2
community at the [Select2 community page][community].
initial checkin
2012-03-04 22:58:26 +04:00
Update README.md Use consistent sentence casing.
2013-06-05 08:34:54 +04:00
Copyright and license
initial checkin
2012-03-04 22:58:26 +04:00
---------------------
Tweak the README Now we point users to the `LICENSE.md` file for the license, instead of including it in the README. This also removes the example integrations, which are no longer officially maintained by Select2. The translation section has also been updated.
2014-11-01 23:05:47 +03:00
The license is available within the repository in the [LICENSE][license] file.
Merge branch 'master' into select2-ng This adds the package management files back into the repository and also updates the README to reflect the future Select2 4.0.
2014-11-01 22:43:01 +03:00
[cdnjs]: http://www.cdnjs.com/libraries/select2
update links in readme
2017-09-11 00:48:47 +03:00
[community]: https://select2.org/getting-help
[documentation]: https://select2.org
Clean up docs (#5528) * Remove SauceLabs credentials SauceLabs is no longer used during builds, so we no longer need to include these encrypted credentials. * Clean up badges * Remove SauceLabs from the README * Misc README fixes * Disable Travis email notifications Looks like we accidentally re-enabled these when removing IRC.
2019-06-05 03:46:45 +03:00
[documentation-repository]: https://github.com/select2/docs
Merge branch 'master' into select2-ng This adds the package management files back into the repository and also updates the README to reflect the future Select2 4.0.
2014-11-01 22:43:01 +03:00
[freenode]: https://freenode.net/
Clean up docs (#5528) * Remove SauceLabs credentials SauceLabs is no longer used during builds, so we no longer need to include these encrypted credentials. * Clean up badges * Remove SauceLabs from the README * Misc README fixes * Disable Travis email notifications Looks like we accidentally re-enabled these when removing IRC.
2019-06-05 03:46:45 +03:00
[jsdelivr]: https://www.jsdelivr.com/package/npm/select2
Tweak the README Now we point users to the `LICENSE.md` file for the license, instead of including it in the README. This also removes the example integrations, which are no longer officially maintained by Select2. The translation section has also been updated.
2014-11-01 23:05:47 +03:00
[license]: LICENSE.md
Update contributing guide and README for 4.0
2015-01-09 19:10:53 +03:00
[releases]: https://github.com/select2/select2/releases
Add Sauce Labs matrix to the README This also updates the Travis CI image to be a vector.
2016-02-18 01:11:17 +03:00
[travis-ci-image]: https://img.shields.io/travis/select2/select2/master.svg
Added Travis CI badge and fixed package.json
2015-01-10 00:09:30 +03:00
[travis-ci-status]: https://travis-ci.org/select2/select2
Update the list of integrations The integrations are now organized by the name of the integration, and themes are now separated out from the plugins. The references for this section have been pulled out at the bottom because there are so many. This closes https://github.com/select2/select2/issues/4150. This closes https://github.com/select2/select2/pull/4067. This closes https://github.com/select2/select2/issues/3957.
2016-02-18 01:10:39 +03:00
Clean up docs (#5528) * Remove SauceLabs credentials SauceLabs is no longer used during builds, so we no longer need to include these encrypted credentials. * Clean up badges * Remove SauceLabs from the README * Misc README fixes * Disable Travis email notifications Looks like we accidentally re-enabled these when removing IRC.
2019-06-05 03:46:45 +03:00
[angularjs]: https://angularjs.org/
Update the list of integrations The integrations are now organized by the name of the integration, and themes are now separated out from the plugins. The references for this section have been pulled out at the bottom because there are so many. This closes https://github.com/select2/select2/issues/4150. This closes https://github.com/select2/select2/pull/4067. This closes https://github.com/select2/select2/issues/3957.
2016-02-18 01:10:39 +03:00
[bootstrap3]: https://getbootstrap.com/
docs: add link to @ttskch/select2-bootstrap4-theme to README.md (#5487)
2019-04-28 07:06:02 +03:00
[bootstrap4]: https://getbootstrap.com/
Update the list of integrations The integrations are now organized by the name of the integration, and themes are now separated out from the plugins. The references for this section have been pulled out at the bottom because there are so many. This closes https://github.com/select2/select2/issues/4150. This closes https://github.com/select2/select2/pull/4067. This closes https://github.com/select2/select2/issues/3957.
2016-02-18 01:10:39 +03:00
[django]: https://www.djangoproject.com/
Add django-autocomplete-light to integrations
2016-09-22 01:08:19 +03:00
[django-autocomplete-light]: https://github.com/yourlabs/django-autocomplete-light
Update the list of integrations The integrations are now organized by the name of the integration, and themes are now separated out from the plugins. The references for this section have been pulled out at the bottom because there are so many. This closes https://github.com/select2/select2/issues/4150. This closes https://github.com/select2/select2/pull/4067. This closes https://github.com/select2/select2/issues/3957.
2016-02-18 01:10:39 +03:00
[django-easy-select2]: https://github.com/asyncee/django-easy-select2
[django-select2]: https://github.com/applegrew/django-select2
Add drupal plugin (#5349)
2018-09-05 04:09:39 +03:00
[drupal]: https://www.drupal.org/
[drupal-select2]: https://www.drupal.org/project/select2
Update the list of integrations The integrations are now organized by the name of the integration, and themes are now separated out from the plugins. The references for this section have been pulled out at the bottom because there are so many. This closes https://github.com/select2/select2/issues/4150. This closes https://github.com/select2/select2/pull/4067. This closes https://github.com/select2/select2/issues/3957.
2016-02-18 01:10:39 +03:00
[flat-ui]: http://designmodo.github.io/Flat-UI/
Clean up docs (#5528) * Remove SauceLabs credentials SauceLabs is no longer used during builds, so we no longer need to include these encrypted credentials. * Clean up badges * Remove SauceLabs from the README * Misc README fixes * Disable Travis email notifications Looks like we accidentally re-enabled these when removing IRC.
2019-06-05 03:46:45 +03:00
[mdr-angular-select2]: https://github.com/modulr/mdr-angular-select2
Update the list of integrations The integrations are now organized by the name of the integration, and themes are now separated out from the plugins. The references for this section have been pulled out at the bottom because there are so many. This closes https://github.com/select2/select2/issues/4150. This closes https://github.com/select2/select2/pull/4067. This closes https://github.com/select2/select2/issues/3957.
2016-02-18 01:10:39 +03:00
[meteor]: https://www.meteor.com/
[meteor-select2]: https://github.com/nate-strauser/meteor-select2
[metro-ui]: http://metroui.org.ua/
[select2-metro]: http://metroui.org.ua/select2.html
[ruby-on-rails]: http://rubyonrails.org/
[select2-bootstrap-theme]: https://github.com/select2/select2-bootstrap-theme
docs: add link to @ttskch/select2-bootstrap4-theme to README.md (#5487)
2019-04-28 07:06:02 +03:00
[select2-bootstrap4-theme]: https://github.com/ttskch/select2-bootstrap4-theme
Update the list of integrations The integrations are now organized by the name of the integration, and themes are now separated out from the plugins. The references for this section have been pulled out at the bottom because there are so many. This closes https://github.com/select2/select2/issues/4150. This closes https://github.com/select2/select2/pull/4067. This closes https://github.com/select2/select2/issues/3957.
2016-02-18 01:10:39 +03:00
[select2-flat-theme]: https://github.com/techhysahil/select2-Flat_Theme
[select2-rails]: https://github.com/argerim/select2-rails
[vue.js]: http://vuejs.org/
[select2-vue]: http://vuejs.org/examples/select2.html
[wicket]: https://wicket.apache.org/
[wicketstuff-select2]: https://github.com/wicketstuff/core/tree/master/select2-parent
[yii2]: http://www.yiiframework.com/
[yii2-widget-select2]: https://github.com/kartik-v/yii2-widget-select2
Reference in New Issue Copy Permalink