@jimka/typescript-ui / component/input / AutoCompleteFieldOptions

Interface: AutoCompleteFieldOptions

Defined in: src/typescript/lib/component/input/AutoCompleteField.ts:27

Construction-time options for AutoCompleteField.

Extends

• ComponentOptions

Properties

attributes?

optional attributes: Record<string, string>;

Defined in: src/typescript/lib/core/Component.ts:102

Inherited from

ComponentOptions.attributes

---

backgroundColor?

optional backgroundColor: string;

Defined in: src/typescript/lib/core/Component.ts:81

Inherited from

ComponentOptions.backgroundColor

---

backgroundImage?

optional backgroundImage: string;

Defined in: src/typescript/lib/core/Component.ts:82

Inherited from

ComponentOptions.backgroundImage

---

border?

optional border: 
  | string
  | BorderOptions;

Defined in: src/typescript/lib/core/Component.ts:85

Inherited from

ComponentOptions.border

---

borderRadius?

optional borderRadius: string;

Defined in: src/typescript/lib/core/Component.ts:86

Inherited from

ComponentOptions.borderRadius

---

colorScheme?

optional colorScheme: string;

Defined in: src/typescript/lib/core/Component.ts:84

Inherited from

ComponentOptions.colorScheme

---

components?

optional components: (
  | Component<ComponentOptions>
  | ConstrainedComponent)[];

Defined in: src/typescript/lib/core/Component.ts:103

Inherited from

ComponentOptions.components

---

cursor?

optional cursor: string;

Defined in: src/typescript/lib/core/Component.ts:89

Inherited from

ComponentOptions.cursor

---

debounceMs?

optional debounceMs: number;

Defined in: src/typescript/lib/component/input/AutoCompleteField.ts:37

Debounce delay in milliseconds before querying on each keystroke. Default: 200.

---

display?

optional display: string;

Defined in: src/typescript/lib/core/Component.ts:97

Inherited from

ComponentOptions.display

---

displayed?

optional displayed: boolean;

Defined in: src/typescript/lib/core/Component.ts:77

Inherited from

ComponentOptions.displayed

---

displayField?

optional displayField: string;

Defined in: src/typescript/lib/component/input/AutoCompleteField.ts:33

The store field name whose value is shown as the suggestion text. Required when store is set.

---

foregroundColor?

optional foregroundColor: string;

Defined in: src/typescript/lib/core/Component.ts:83

Inherited from

ComponentOptions.foregroundColor

---

id?

optional id: string;

Defined in: src/typescript/lib/core/Component.ts:101

Inherited from

ComponentOptions.id

---

insets?

optional insets: Insets;

Defined in: src/typescript/lib/core/Component.ts:79

Inherited from

ComponentOptions.insets

---

layoutManager?

optional layoutManager: LayoutManager;

Defined in: src/typescript/lib/core/Component.ts:100

Inherited from

ComponentOptions.layoutManager

---

matchMode?

optional matchMode: AutoCompleteMatchMode;

Defined in: src/typescript/lib/component/input/AutoCompleteField.ts:43

How the typed query is matched against suggestions. Default: 'contains'.

---

maxSize?

optional maxSize: Size;

Defined in: src/typescript/lib/core/Component.ts:92

Inherited from

ComponentOptions.maxSize

---

maxSuggestions?

optional maxSuggestions: number;

Defined in: src/typescript/lib/component/input/AutoCompleteField.ts:39

Maximum number of suggestions to show at once. Default: 10.

---

minChars?

optional minChars: number;

Defined in: src/typescript/lib/component/input/AutoCompleteField.ts:35

Minimum number of characters typed before suggestions are queried. Default: 1.

---

minSize?

optional minSize: Size;

Defined in: src/typescript/lib/core/Component.ts:91

Inherited from

ComponentOptions.minSize

---

opacity?

optional opacity: number;

Defined in: src/typescript/lib/core/Component.ts:95

Inherited from

ComponentOptions.opacity

---

outline?

optional outline: string;

Defined in: src/typescript/lib/core/Component.ts:88

Inherited from

ComponentOptions.outline

---

overflow?

optional overflow: string;

Defined in: src/typescript/lib/core/Component.ts:98

Inherited from

ComponentOptions.overflow

---

padding?

optional padding: Insets;

Defined in: src/typescript/lib/core/Component.ts:80

Inherited from

ComponentOptions.padding

---

placeholder?

optional placeholder: string;

Defined in: src/typescript/lib/component/input/AutoCompleteField.ts:41

Placeholder text shown in the input when empty.

---

pointerEvents?

optional pointerEvents: string;

Defined in: src/typescript/lib/core/Component.ts:99

Inherited from

ComponentOptions.pointerEvents

---

position?

optional position: Position;

Defined in: src/typescript/lib/core/Component.ts:96

Inherited from

ComponentOptions.position

---

preferredSize?

optional preferredSize: Size;

Defined in: src/typescript/lib/core/Component.ts:90

Inherited from

ComponentOptions.preferredSize

---

shadow?

optional shadow: string;

Defined in: src/typescript/lib/core/Component.ts:87

Inherited from

ComponentOptions.shadow

---

store?

optional store: AbstractStore;

Defined in: src/typescript/lib/component/input/AutoCompleteField.ts:31

Data store used when suggestions come from a remote/in-memory store.

---

suggestions?

optional suggestions: string[];

Defined in: src/typescript/lib/component/input/AutoCompleteField.ts:29

Static list of suggestion strings.

---

tag?

optional tag: string;

Defined in: src/typescript/lib/core/Component.ts:75

Inherited from

ComponentOptions.tag

---

transform?

optional transform: string;

Defined in: src/typescript/lib/core/Component.ts:93

Inherited from

ComponentOptions.transform

---

visible?

optional visible: boolean;

Defined in: src/typescript/lib/core/Component.ts:76

Inherited from

ComponentOptions.visible

---

willChange?

optional willChange: null | string;

Defined in: src/typescript/lib/core/Component.ts:94

Inherited from

ComponentOptions.willChange

---

zIndex?

optional zIndex: number;

Defined in: src/typescript/lib/core/Component.ts:78

Inherited from

ComponentOptions.zIndex