AUI Select2
Summary
Select2 is a third party replacement for select boxes. It supports searching, remote data sets, and infinite scrolling of results.
AUI wraps Select2 v3.5.4 and styles it according to the Atlassian Design Guidelines (ADG).
Status
| API status: | general |
|---|---|
| Web resource key: |
com.atlassian.auiplugin:aui-select2
|
| AMD Module key: | N/A |
| Experimental API: | 5.3 |
| General API: | 5.8 |
Examples
Multi select
Single select
Options
These docs only show the method to call the ADG-styled Select2. The options passed into the function are the same as the original Select2.
However, we have some custom options that can be set in the options object:
| Option | Type | Default | Description |
|---|---|---|---|
searchLabel |
String | undefined |
Custom text for the search field label which will be announced by screen readers on opening single select dropdown and on focusing multi-select search input. If not provided, the original label text is announced, as in the examples above. |