UNPKG

2.15 kBTypeScriptView Raw
1import { ElementUIComponent, ElementUIComponentSize } from './component'
2
3export interface QueryChangeHandler {
4 /**
5 * @param queryString Current value of the text input
6 */
7 (queryString: string): void
8}
9
10/** Dropdown Select Component */
11export declare class ElSelect extends ElementUIComponent {
12 /** The form input value */
13 value: any
14
15 /** Whether multiple-select is activated */
16 multiple: boolean
17
18 /** Whether Select is disabled */
19 disabled: boolean
20
21 /** Unique identity key name for value, required when value is an object */
22 valueKey: string
23
24 /** Size of Input */
25 size: ElementUIComponentSize
26
27 /** Whether single select can be cleared */
28 clearable: boolean
29
30 /** Maximum number of options user can select when multiple is true. No limit when set to 0 */
31 multipleLimit: number
32
33 /** @Deprecated in next major version */
34 autoComplete: string
35
36 /** Same as autocomplete in native input */
37 autocomplete: string
38
39 /** The name attribute of select input */
40 name: string
41
42 /** Placeholder */
43 placeholder: string
44
45 /** Whether Select is filterable */
46 filterable: boolean
47
48 /** Whether creating new items is allowed. To use this, filterable must be true */
49 allowCreate: boolean
50
51 /** Custom filter method */
52 filterMethod: QueryChangeHandler
53
54 /** Whether options are loaded from server */
55 remote: boolean
56
57 /** Custom remote search method */
58 remoteMethod: QueryChangeHandler
59
60 /** Whether Select is loading data from server */
61 loading: boolean
62
63 /** Displayed text while loading data from server */
64 loadingText: string
65
66 /** Displayed text when no data matches the filtering query */
67 noMatchText: string
68
69 /** Displayed text when there is no options */
70 noDataText: string
71
72 /** Custom class name for Select's dropdown */
73 popperClass: string
74
75 /** Select first matching option on enter key. Use with filterable or remote */
76 defaultFirstOption: boolean
77
78 /** Whether to append the popper menu to body */
79 popperAppendToBody: boolean
80
81 /**
82 * Focus the Input component
83 */
84 focus (): void
85
86 /**
87 * Blur the Input component, and hide the dropdown
88 */
89 blur (): void
90}