@serenity-is/corelib / Select2Options

Interface: Select2Options

Table of contents

Properties

• adaptContainerCssClass
• adaptDropdownCssClass
• ajax
• allowClear
• blurOnChange
• closeOnSelect
• containerCss
• containerCssClass
• createSearchChoice
• createSearchChoicePosition
• data
• dropdownAutoWidth
• dropdownCss
• dropdownCssClass
• dropdownParent
• element
• escapeMarkup
• formatAjaxError
• formatInputTooLong
• formatInputTooShort
• formatLoadMore
• formatMatches
• formatNoMatches
• formatResult
• formatResultCssClass
• formatSearching
• formatSelection
• formatSelectionCssClass
• formatSelectionTooBig
• id
• initSelection
• loadMorePadding
• matcher
• maximumInputLength
• maximumSelectionSize
• minimumInputLength
• minimumResultsForSearch
• multiple
• nextSearchTerm
• openOnEnter
• placeholder
• placeholderOption
• populateResults
• query
• searchInputPlaceholder
• selectOnBlur
• separator
• shouldFocusInput
• sortResults
• tags
• tokenSeparators
• tokenizer
• width

Properties

adaptContainerCssClass

• Optional adaptContainerCssClass: (p1: string) => string

Type declaration

▸ (p1): string

Parameters

Name	Type
p1	string

Returns

string

Defined in

src/ui/editors/select2.ts:91

---

adaptDropdownCssClass

• Optional adaptDropdownCssClass: (p1: string) => string

Type declaration

▸ (p1): string

Parameters

Name	Type
p1	string

Returns

string

Defined in

src/ui/editors/select2.ts:92

---

ajax

• Optional ajax: Select2AjaxOptions

Defined in

src/ui/editors/select2.ts:82

---

allowClear

• Optional allowClear: boolean

Defined in

src/ui/editors/select2.ts:57

---

blurOnChange

• Optional blurOnChange: boolean

Defined in

src/ui/editors/select2.ts:96

---

closeOnSelect

• Optional closeOnSelect: boolean

Defined in

src/ui/editors/select2.ts:59

---

containerCss

• Optional containerCss: any

Defined in

src/ui/editors/select2.ts:85

---

containerCssClass

• Optional containerCssClass: any

Defined in

src/ui/editors/select2.ts:86

---

createSearchChoice

• Optional createSearchChoice: (p1: string) => Select2Item

Type declaration

▸ (p1): Select2Item

Parameters

Name	Type
p1	string

Returns

Select2Item

Defined in

src/ui/editors/select2.ts:76

---

createSearchChoicePosition

• Optional createSearchChoicePosition: string | (list: Select2Item[], item: Select2Item) => void

Defined in

src/ui/editors/select2.ts:77

---

data

• Optional data: any

Defined in

src/ui/editors/select2.ts:83

---

dropdownAutoWidth

• Optional dropdownAutoWidth: boolean

Defined in

src/ui/editors/select2.ts:89

---

dropdownCss

• Optional dropdownCss: any

Defined in

src/ui/editors/select2.ts:87

---

dropdownCssClass

• Optional dropdownCssClass: any

Defined in

src/ui/editors/select2.ts:88

---

dropdownParent

• Optional dropdownParent: (input: HTMLElement) => HTMLElement

Type declaration

▸ (input): HTMLElement

Parameters

Name	Type
input	HTMLElement

Returns

HTMLElement

Defined in

src/ui/editors/select2.ts:90

---

element

• Optional element: Select2Element

Defined in

src/ui/editors/select2.ts:48

---

escapeMarkup

• Optional escapeMarkup: (p1: string) => string

Type declaration

▸ (p1): string

Parameters

Name	Type
p1	string

Returns

string

Defined in

src/ui/editors/select2.ts:93

---

formatAjaxError

• Optional formatAjaxError: (p1: any, p2: any) => Select2FormatResult

Type declaration

▸ (p1, p2): Select2FormatResult

Parameters

Name	Type
p1	any
p2	any

Returns

Select2FormatResult

Defined in

src/ui/editors/select2.ts:64

---

formatInputTooLong

• Optional formatInputTooLong: (input: string, max: number) => Select2FormatResult

Type declaration

▸ (input, max): Select2FormatResult

Parameters

Name	Type
input	string
max	number

Returns

Select2FormatResult

Defined in

src/ui/editors/select2.ts:73

---

formatInputTooShort

• Optional formatInputTooShort: (input: string, min: number) => Select2FormatResult

Type declaration

▸ (input, min): Select2FormatResult

Parameters

Name	Type
input	string
min	number

Returns

Select2FormatResult

Defined in

src/ui/editors/select2.ts:74

---

formatLoadMore

• Optional formatLoadMore: (pageNumber: number) => Select2FormatResult

Type declaration

▸ (pageNumber): Select2FormatResult

Parameters

Name	Type
pageNumber	number

Returns

Select2FormatResult

Defined in

src/ui/editors/select2.ts:71

---

formatMatches

• Optional formatMatches: (matches: number) => Select2FormatResult

Type declaration

▸ (matches): Select2FormatResult

Parameters

Name	Type
matches	number

Returns

Select2FormatResult

Defined in

src/ui/editors/select2.ts:65

---

formatNoMatches

• Optional formatNoMatches: (input: string) => Select2FormatResult

Type declaration

▸ (input): Select2FormatResult

Parameters

Name	Type
input	string

Returns

Select2FormatResult

Defined in

src/ui/editors/select2.ts:70

---

formatResult

• Optional formatResult: (p1: any, p2: HTMLElement, p3: any, p4: (p1: string) => string) => Select2FormatResult

Type declaration

▸ (p1, p2, p3, p4): Select2FormatResult

Parameters

Name	Type
p1	any
p2	HTMLElement
p3	any
p4	(p1: string) => string

Returns

Select2FormatResult

Defined in

src/ui/editors/select2.ts:67

---

formatResultCssClass

• Optional formatResultCssClass: (p1: any) => string

Type declaration

▸ (p1): string

Parameters

Name	Type
p1	any

Returns

string

Defined in

src/ui/editors/select2.ts:68

---

formatSearching

• Optional formatSearching: () => Select2FormatResult

Type declaration

▸ (): Select2FormatResult

Returns

Select2FormatResult

Defined in

src/ui/editors/select2.ts:72

---

formatSelection

• Optional formatSelection: (p1: any, p2: HTMLElement, p3: (p1: string) => string) => Select2FormatResult

Type declaration

▸ (p1, p2, p3): Select2FormatResult

Parameters

Name	Type
p1	any
p2	HTMLElement
p3	(p1: string) => string

Returns

Select2FormatResult

Defined in

src/ui/editors/select2.ts:66

---

formatSelectionCssClass

• Optional formatSelectionCssClass: (item: Select2Item, container: HTMLElement) => string

Type declaration

▸ (item, container): string

Parameters

Name	Type
item	Select2Item
container	HTMLElement

Returns

string

Defined in

src/ui/editors/select2.ts:69

---

formatSelectionTooBig

• Optional formatSelectionTooBig: (p1: number) => Select2FormatResult

Type declaration

▸ (p1): Select2FormatResult

Parameters

Name	Type
p1	number

Returns

Select2FormatResult

Defined in

src/ui/editors/select2.ts:75

---

id

• Optional id: (p1: any) => string

Type declaration

▸ (p1): string

Parameters

Name	Type
p1	any

Returns

string

Defined in

src/ui/editors/select2.ts:61

---

initSelection

• Optional initSelection: (p1: HTMLElement, p2: (p1: any) => void) => void

Type declaration

▸ (p1, p2): void

Parameters

Name	Type
p1	HTMLElement
p2	(p1: any) => void

Returns

void

Defined in

src/ui/editors/select2.ts:78

---

loadMorePadding

• Optional loadMorePadding: number

Defined in

src/ui/editors/select2.ts:97

---

matcher

• Optional matcher: (p1: string, p2: string, p3: HTMLElement) => boolean

Type declaration

▸ (p1, p2, p3): boolean

Parameters

Name	Type
p1	string
p2	string
p3	HTMLElement

Returns

boolean

Defined in

src/ui/editors/select2.ts:62

---

maximumInputLength

• Optional maximumInputLength: number

Defined in

src/ui/editors/select2.ts:51

---

maximumSelectionSize

• Optional maximumSelectionSize: any

Defined in

src/ui/editors/select2.ts:53

---

minimumInputLength

• Optional minimumInputLength: number

Defined in

src/ui/editors/select2.ts:50

---

minimumResultsForSearch

• Optional minimumResultsForSearch: number

Defined in

src/ui/editors/select2.ts:52

---

multiple

• Optional multiple: boolean

Defined in

src/ui/editors/select2.ts:58

---

nextSearchTerm

• Optional nextSearchTerm: (p1: any, p2: string) => string

Type declaration

▸ (p1, p2): string

Parameters

Name	Type
p1	any
p2	string

Returns

string

Defined in

src/ui/editors/select2.ts:98

---

openOnEnter

• Optional openOnEnter: boolean

Defined in

src/ui/editors/select2.ts:60

---

placeholder

• Optional placeholder: string

Defined in

src/ui/editors/select2.ts:54

---

placeholderOption

• Optional placeholderOption: any

Defined in

src/ui/editors/select2.ts:55

---

populateResults

• Optional populateResults: (container: HTMLElement, results: Select2Item[], query: Select2QueryOptions) => void

Type declaration

▸ (container, results, query): void

Parameters

Name	Type
container	HTMLElement
results	Select2Item[]
query	Select2QueryOptions

Returns

void

Defined in

src/ui/editors/select2.ts:99

---

query

• Optional query: (p1: Select2QueryOptions) => void

Type declaration

▸ (p1): void

Parameters

Name	Type
p1	Select2QueryOptions

Returns

void

Defined in

src/ui/editors/select2.ts:81

---

searchInputPlaceholder

• Optional searchInputPlaceholder: string

Defined in

src/ui/editors/select2.ts:94

---

selectOnBlur

• Optional selectOnBlur: boolean

Defined in

src/ui/editors/select2.ts:95

---

separator

• Optional separator: string

Defined in

src/ui/editors/select2.ts:56

---

shouldFocusInput

• Optional shouldFocusInput: (p1: any) => boolean

Type declaration

▸ (p1): boolean

Parameters

Name	Type
p1	any

Returns

boolean

Defined in

src/ui/editors/select2.ts:100

---

sortResults

• Optional sortResults: (p1: any, p2: HTMLElement, p3: any) => any

Type declaration

▸ (p1, p2, p3): any

Parameters

Name	Type
p1	any
p2	HTMLElement
p3	any

Returns

any

Defined in

src/ui/editors/select2.ts:63

---

tags

• Optional tags: (string | Select2Item)[] | () => (string | Select2Item)[]

Defined in

src/ui/editors/select2.ts:84

---

tokenSeparators

• Optional tokenSeparators: any

Defined in

src/ui/editors/select2.ts:80

---

tokenizer

• Optional tokenizer: (p1: string, p2: any, p3: (p1: any) => any, p4: any) => string

Type declaration

▸ (p1, p2, p3, p4): string

Parameters

Name	Type
p1	string
p2	any
p3	(p1: any) => any
p4	any

Returns

string

Defined in

src/ui/editors/select2.ts:79

---

width

• Optional width: any

Defined in

src/ui/editors/select2.ts:49