@serenity-is/corelib / Select2Options

Interface: Select2Options

Defined in: src/ui/editors/select2.tsx:93

Options for the Select2 widget.

Properties

adaptContainerCssClass()?

optional adaptContainerCssClass: (p1) => string

Defined in: src/ui/editors/select2.tsx:181

Callback that adapts the container CSS class.

Parameters

p1

string

Returns

string

---

adaptDropdownCssClass()?

optional adaptDropdownCssClass: (p1) => string

Defined in: src/ui/editors/select2.tsx:183

Callback that adapts the dropdown CSS class.

Parameters

p1

string

Returns

string

---

ajax?

optional ajax: Select2AjaxOptions

Defined in: src/ui/editors/select2.tsx:163

Ajax options.

---

allowClear?

optional allowClear: boolean

Defined in: src/ui/editors/select2.tsx:113

Whether the selection can be cleared.

---

blurOnChange?

optional blurOnChange: boolean

Defined in: src/ui/editors/select2.tsx:191

Whether to blur on change.

---

closeOnSelect?

optional closeOnSelect: boolean

Defined in: src/ui/editors/select2.tsx:117

Whether to close the dropdown on select.

---

containerCss?

optional containerCss: any

Defined in: src/ui/editors/select2.tsx:169

Container CSS.

---

containerCssClass?

optional containerCssClass: any

Defined in: src/ui/editors/select2.tsx:171

Container CSS class.

---

createSearchChoice()?

optional createSearchChoice: (p1) => Select2Item

Defined in: src/ui/editors/select2.tsx:151

Callback that creates a search choice.

Parameters

p1

string

Returns

Select2Item

---

createSearchChoicePosition?

optional createSearchChoicePosition: string | (list, item) => void

Defined in: src/ui/editors/select2.tsx:153

Position of the create-search-choice item.

---

data?

optional data: any

Defined in: src/ui/editors/select2.tsx:165

Static data.

---

dropdownAutoWidth?

optional dropdownAutoWidth: boolean

Defined in: src/ui/editors/select2.tsx:177

Whether the dropdown auto-widths.

---

dropdownCss?

optional dropdownCss: any

Defined in: src/ui/editors/select2.tsx:173

Dropdown CSS.

---

dropdownCssClass?

optional dropdownCssClass: any

Defined in: src/ui/editors/select2.tsx:175

Dropdown CSS class.

---

dropdownParent()?

optional dropdownParent: (input) => HTMLElement

Defined in: src/ui/editors/select2.tsx:179

Callback that returns the dropdown parent.

Parameters

input

HTMLElement

Returns

HTMLElement

---

element?

optional element: Select2Element

Defined in: src/ui/editors/select2.tsx:95

The element to attach Select2 to.

---

escapeMarkup()?

optional escapeMarkup: (p1) => string

Defined in: src/ui/editors/select2.tsx:185

Callback that escapes markup.

Parameters

p1

string

Returns

string

---

formatAjaxError()?

optional formatAjaxError: (p1, p2) => Select2FormatResult

Defined in: src/ui/editors/select2.tsx:127

Formatter for ajax errors.

Parameters

p1

any

p2

any

Returns

Select2FormatResult

---

formatInputTooLong()?

optional formatInputTooLong: (input, max) => Select2FormatResult

Defined in: src/ui/editors/select2.tsx:145

Formatter for input-too-long text.

Parameters

input

string

max

number

Returns

Select2FormatResult

---

formatInputTooShort()?

optional formatInputTooShort: (input, min) => Select2FormatResult

Defined in: src/ui/editors/select2.tsx:147

Formatter for input-too-short text.

Parameters

input

string

min

number

Returns

Select2FormatResult

---

formatLoadMore()?

optional formatLoadMore: (pageNumber) => Select2FormatResult

Defined in: src/ui/editors/select2.tsx:141

Formatter for load-more text.

Parameters

pageNumber

number

Returns

Select2FormatResult

---

formatMatches()?

optional formatMatches: (matches) => Select2FormatResult

Defined in: src/ui/editors/select2.tsx:129

Formatter for the matches count.

Parameters

matches

number

Returns

Select2FormatResult

---

formatNoMatches()?

optional formatNoMatches: (input) => Select2FormatResult

Defined in: src/ui/editors/select2.tsx:139

Formatter for no-matches text.

Parameters

input

string

Returns

Select2FormatResult

---

formatResult()?

optional formatResult: (p1, p2, p3, p4) => Select2FormatResult

Defined in: src/ui/editors/select2.tsx:133

Formatter for result items.

Parameters

p1

any

p2

HTMLElement

p3

any

p4

(p1) => string

Returns

Select2FormatResult

---

formatResultCssClass()?

optional formatResultCssClass: (p1) => string

Defined in: src/ui/editors/select2.tsx:135

Formatter for result CSS classes.

Parameters

p1

any

Returns

string

---

formatSearching()?

optional formatSearching: () => Select2FormatResult

Defined in: src/ui/editors/select2.tsx:143

Formatter for searching text.

Returns

Select2FormatResult

---

formatSelection()?

optional formatSelection: (p1, p2, p3) => Select2FormatResult

Defined in: src/ui/editors/select2.tsx:131

Formatter for selected items.

Parameters

p1

any

p2

HTMLElement

p3

(p1) => string

Returns

Select2FormatResult

---

formatSelectionCssClass()?

optional formatSelectionCssClass: (item, container) => string

Defined in: src/ui/editors/select2.tsx:137

Formatter for selection CSS classes.

Parameters

item

Select2Item

container

HTMLElement

Returns

string

---

formatSelectionTooBig()?

optional formatSelectionTooBig: (p1) => Select2FormatResult

Defined in: src/ui/editors/select2.tsx:149

Formatter for selection-too-big text.

Parameters

p1

number

Returns

Select2FormatResult

---

id()?

optional id: (p1) => string

Defined in: src/ui/editors/select2.tsx:121

Callback that returns the id of an item.

Parameters

p1

any

Returns

string

---

initSelection()?

optional initSelection: (p1, p2) => void

Defined in: src/ui/editors/select2.tsx:155

Callback that initializes the selection.

Parameters

p1

HTMLElement

p2

(p1) => void

Returns

void

---

loadMorePadding?

optional loadMorePadding: number

Defined in: src/ui/editors/select2.tsx:193

Padding for load-more.

---

matcher()?

optional matcher: (p1, p2, p3) => boolean

Defined in: src/ui/editors/select2.tsx:123

Custom matcher function.

Parameters

p1

string

p2

string

p3

HTMLElement

Returns

boolean

---

maximumInputLength?

optional maximumInputLength: number

Defined in: src/ui/editors/select2.tsx:101

Maximum input length.

---

maximumSelectionSize?

optional maximumSelectionSize: any

Defined in: src/ui/editors/select2.tsx:105

Maximum number of selectable items.

---

minimumInputLength?

optional minimumInputLength: number

Defined in: src/ui/editors/select2.tsx:99

Minimum input length before searching.

---

minimumResultsForSearch?

optional minimumResultsForSearch: number

Defined in: src/ui/editors/select2.tsx:103

Minimum results required to show the search box.

---

multiple?

optional multiple: boolean

Defined in: src/ui/editors/select2.tsx:115

Whether multiple items can be selected.

---

nextSearchTerm()?

optional nextSearchTerm: (p1, p2) => string

Defined in: src/ui/editors/select2.tsx:195

Callback that returns the next search term.

Parameters

p1

any

p2

string

Returns

string

---

openOnEnter?

optional openOnEnter: boolean

Defined in: src/ui/editors/select2.tsx:119

Whether to open the dropdown on enter.

---

placeholder?

optional placeholder: string

Defined in: src/ui/editors/select2.tsx:107

Placeholder text.

---

placeholderOption?

optional placeholderOption: any

Defined in: src/ui/editors/select2.tsx:109

Placeholder option.

---

populateResults()?

optional populateResults: (container, results, query) => void

Defined in: src/ui/editors/select2.tsx:197

Callback that populates results.

Parameters

container

HTMLElement

results

Select2Item[]

query

Select2QueryOptions

Returns

void

---

query()?

optional query: (p1) => void

Defined in: src/ui/editors/select2.tsx:161

Query callback.

Parameters

p1

Select2QueryOptions

Returns

void

---

searchInputPlaceholder?

optional searchInputPlaceholder: string

Defined in: src/ui/editors/select2.tsx:187

Placeholder for the search input.

---

selectOnBlur?

optional selectOnBlur: boolean

Defined in: src/ui/editors/select2.tsx:189

Whether to select on blur.

---

separator?

optional separator: string

Defined in: src/ui/editors/select2.tsx:111

Separator for multiple values.

---

shouldFocusInput()?

optional shouldFocusInput: (p1) => boolean

Defined in: src/ui/editors/select2.tsx:199

Callback that determines whether to focus the input.

Parameters

p1

any

Returns

boolean

---

sortResults()?

optional sortResults: (p1, p2, p3) => any

Defined in: src/ui/editors/select2.tsx:125

Callback that sorts results.

Parameters

p1

any

p2

HTMLElement

p3

any

Returns

any

---

tags?

optional tags: (string | Select2Item)[] | () => (string | Select2Item)[]

Defined in: src/ui/editors/select2.tsx:167

Tags for tag mode.

---

tokenizer()?

optional tokenizer: (p1, p2, p3, p4) => string

Defined in: src/ui/editors/select2.tsx:157

Tokenizer function.

Parameters

p1

string

p2

any

p3

(p1) => any

p4

any

Returns

string

---

tokenSeparators?

optional tokenSeparators: any

Defined in: src/ui/editors/select2.tsx:159

Token separators.

---

width?

optional width: any

Defined in: src/ui/editors/select2.tsx:97

Width of the widget.