@syncfusion/ej2-dropdowns 18.1.57 → 18.2.44-4569

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (183) hide show
  1. package/.eslintrc.json +244 -0
  2. package/CHANGELOG.md +1524 -1514
  3. package/README.md +118 -118
  4. package/dist/ej2-dropdowns.umd.min.js +1 -10
  5. package/dist/ej2-dropdowns.umd.min.js.map +1 -1
  6. package/dist/es6/ej2-dropdowns.es2015.js +198 -126
  7. package/dist/es6/ej2-dropdowns.es2015.js.map +1 -1
  8. package/dist/es6/ej2-dropdowns.es5.js +290 -217
  9. package/dist/es6/ej2-dropdowns.es5.js.map +1 -1
  10. package/dist/global/ej2-dropdowns.min.js +1 -10
  11. package/dist/global/ej2-dropdowns.min.js.map +1 -1
  12. package/dist/global/index.d.ts +0 -9
  13. package/dist/ts/auto-complete/auto-complete.ts +527 -0
  14. package/dist/ts/combo-box/combo-box.ts +957 -0
  15. package/dist/ts/common/highlight-search.ts +47 -0
  16. package/dist/ts/common/incremental-search.ts +81 -0
  17. package/dist/ts/drop-down-base/drop-down-base.ts +1572 -0
  18. package/dist/ts/drop-down-list/drop-down-list.ts +2993 -0
  19. package/dist/ts/drop-down-tree/drop-down-tree.ts +3066 -0
  20. package/dist/ts/list-box/list-box.ts +2317 -0
  21. package/dist/ts/multi-select/checkbox-selection.ts +528 -0
  22. package/dist/ts/multi-select/float-label.ts +155 -0
  23. package/dist/ts/multi-select/interface.ts +66 -0
  24. package/dist/ts/multi-select/multi-select.ts +4216 -0
  25. package/helpers/e2e/index.js +3 -3
  26. package/license +2 -2
  27. package/package.json +77 -77
  28. package/src/auto-complete/auto-complete-model.d.ts +179 -179
  29. package/src/auto-complete/auto-complete.d.ts +12 -12
  30. package/src/auto-complete/auto-complete.js +21 -21
  31. package/src/combo-box/combo-box-model.d.ts +212 -212
  32. package/src/combo-box/combo-box.d.ts +27 -27
  33. package/src/combo-box/combo-box.js +29 -29
  34. package/src/common/incremental-search.d.ts +1 -1
  35. package/src/common/incremental-search.js +4 -2
  36. package/src/drop-down-base/drop-down-base-model.d.ts +191 -191
  37. package/src/drop-down-base/drop-down-base.d.ts +17 -17
  38. package/src/drop-down-base/drop-down-base.js +20 -20
  39. package/src/drop-down-list/drop-down-list-model.d.ts +222 -222
  40. package/src/drop-down-list/drop-down-list.d.ts +3 -2
  41. package/src/drop-down-list/drop-down-list.js +43 -30
  42. package/src/drop-down-tree/drop-down-tree-model.d.ts +344 -344
  43. package/src/drop-down-tree/drop-down-tree.js +32 -26
  44. package/src/list-box/index.d.ts +1 -0
  45. package/src/list-box/index.js +1 -0
  46. package/src/list-box/list-box-model.d.ts +156 -156
  47. package/src/list-box/list-box.d.ts +2 -2
  48. package/src/list-box/list-box.js +57 -59
  49. package/src/multi-select/index.d.ts +1 -0
  50. package/src/multi-select/index.js +1 -0
  51. package/src/multi-select/multi-select-model.d.ts +452 -452
  52. package/src/multi-select/multi-select.d.ts +2 -0
  53. package/src/multi-select/multi-select.js +98 -43
  54. package/styles/_all.scss +3 -3
  55. package/styles/auto-complete/_bootstrap-dark-definition.scss +3 -3
  56. package/styles/auto-complete/_bootstrap4-definition.scss +11 -11
  57. package/styles/auto-complete/_fabric-dark-definition.scss +2 -2
  58. package/styles/auto-complete/_highcontrast-light-definition.scss +2 -2
  59. package/styles/auto-complete/_material-dark-definition.scss +2 -2
  60. package/styles/bootstrap-dark.css +67 -61
  61. package/styles/bootstrap.css +69 -63
  62. package/styles/bootstrap4.css +81 -61
  63. package/styles/combo-box/_bootstrap-dark-definition.scss +2 -2
  64. package/styles/combo-box/_bootstrap4-definition.scss +11 -11
  65. package/styles/combo-box/_fabric-dark-definition.scss +2 -2
  66. package/styles/combo-box/_highcontrast-light-definition.scss +3 -3
  67. package/styles/combo-box/_material-dark-definition.scss +2 -2
  68. package/styles/drop-down-base/_all.scss +2 -2
  69. package/styles/drop-down-base/_bootstrap-dark-definition.scss +64 -64
  70. package/styles/drop-down-base/_bootstrap-definition.scss +64 -64
  71. package/styles/drop-down-base/_bootstrap4-definition.scss +78 -78
  72. package/styles/drop-down-base/_definition.scss +23 -23
  73. package/styles/drop-down-base/_fabric-dark-definition.scss +68 -68
  74. package/styles/drop-down-base/_fabric-definition.scss +66 -66
  75. package/styles/drop-down-base/_highcontrast-definition.scss +82 -82
  76. package/styles/drop-down-base/_highcontrast-light-definition.scss +81 -81
  77. package/styles/drop-down-base/_layout.scss +108 -108
  78. package/styles/drop-down-base/_material-dark-definition.scss +67 -67
  79. package/styles/drop-down-base/_material-definition.scss +65 -65
  80. package/styles/drop-down-base/_theme.scss +242 -242
  81. package/styles/drop-down-list/_all.scss +2 -2
  82. package/styles/drop-down-list/_bootstrap-dark-definition.scss +157 -157
  83. package/styles/drop-down-list/_bootstrap-definition.scss +156 -156
  84. package/styles/drop-down-list/_bootstrap4-definition.scss +184 -184
  85. package/styles/drop-down-list/_fabric-dark-definition.scss +127 -127
  86. package/styles/drop-down-list/_fabric-definition.scss +122 -122
  87. package/styles/drop-down-list/_highcontrast-definition.scss +131 -131
  88. package/styles/drop-down-list/_highcontrast-light-definition.scss +133 -133
  89. package/styles/drop-down-list/_layout.scss +218 -218
  90. package/styles/drop-down-list/_material-dark-definition.scss +143 -143
  91. package/styles/drop-down-list/_material-definition.scss +166 -166
  92. package/styles/drop-down-list/_theme.scss +10 -10
  93. package/styles/drop-down-list/icons/_bootstrap-dark.scss +14 -14
  94. package/styles/drop-down-list/icons/_bootstrap.scss +14 -14
  95. package/styles/drop-down-list/icons/_bootstrap4.scss +14 -14
  96. package/styles/drop-down-list/icons/_fabric-dark.scss +14 -14
  97. package/styles/drop-down-list/icons/_fabric.scss +14 -14
  98. package/styles/drop-down-list/icons/_highcontrast-light.scss +14 -14
  99. package/styles/drop-down-list/icons/_highcontrast.scss +14 -14
  100. package/styles/drop-down-list/icons/_material-dark.scss +14 -14
  101. package/styles/drop-down-list/icons/_material.scss +14 -14
  102. package/styles/drop-down-list/material.css +9 -0
  103. package/styles/drop-down-tree/_all.scss +2 -2
  104. package/styles/drop-down-tree/_bootstrap-dark-definition.scss +62 -49
  105. package/styles/drop-down-tree/_bootstrap-definition.scss +62 -49
  106. package/styles/drop-down-tree/_bootstrap4-definition.scss +63 -50
  107. package/styles/drop-down-tree/_fabric-dark-definition.scss +63 -49
  108. package/styles/drop-down-tree/_fabric-definition.scss +63 -49
  109. package/styles/drop-down-tree/_highcontrast-definition.scss +63 -49
  110. package/styles/drop-down-tree/_highcontrast-light-definition.scss +63 -49
  111. package/styles/drop-down-tree/_layout.scss +437 -398
  112. package/styles/drop-down-tree/_material-dark-definition.scss +61 -54
  113. package/styles/drop-down-tree/_material-definition.scss +61 -54
  114. package/styles/drop-down-tree/_theme.scss +68 -63
  115. package/styles/drop-down-tree/bootstrap-dark.css +67 -61
  116. package/styles/drop-down-tree/bootstrap.css +69 -63
  117. package/styles/drop-down-tree/bootstrap4.css +81 -61
  118. package/styles/drop-down-tree/fabric-dark.css +71 -63
  119. package/styles/drop-down-tree/fabric.css +71 -63
  120. package/styles/drop-down-tree/highcontrast-light.css +71 -63
  121. package/styles/drop-down-tree/highcontrast.css +75 -63
  122. package/styles/drop-down-tree/icons/_bootstrap-dark.scss +11 -11
  123. package/styles/drop-down-tree/icons/_bootstrap.scss +11 -11
  124. package/styles/drop-down-tree/icons/_bootstrap4.scss +11 -11
  125. package/styles/drop-down-tree/icons/_fabric-dark.scss +11 -11
  126. package/styles/drop-down-tree/icons/_fabric.scss +11 -11
  127. package/styles/drop-down-tree/icons/_highcontrast-light.scss +11 -11
  128. package/styles/drop-down-tree/icons/_highcontrast.scss +11 -11
  129. package/styles/drop-down-tree/icons/_material-dark.scss +11 -11
  130. package/styles/drop-down-tree/icons/_material.scss +11 -11
  131. package/styles/drop-down-tree/material-dark.css +76 -85
  132. package/styles/drop-down-tree/material.css +93 -85
  133. package/styles/fabric-dark.css +71 -63
  134. package/styles/fabric.css +71 -63
  135. package/styles/highcontrast-light.css +71 -63
  136. package/styles/highcontrast.css +75 -63
  137. package/styles/list-box/_all.scss +2 -2
  138. package/styles/list-box/_bootstrap-dark-definition.scss +118 -118
  139. package/styles/list-box/_bootstrap-definition.scss +112 -112
  140. package/styles/list-box/_bootstrap4-definition.scss +118 -118
  141. package/styles/list-box/_fabric-dark-definition.scss +118 -118
  142. package/styles/list-box/_fabric-definition.scss +112 -112
  143. package/styles/list-box/_highcontrast-definition.scss +112 -112
  144. package/styles/list-box/_highcontrast-light-definition.scss +118 -118
  145. package/styles/list-box/_layout.scss +458 -458
  146. package/styles/list-box/_material-dark-definition.scss +118 -118
  147. package/styles/list-box/_material-definition.scss +112 -112
  148. package/styles/list-box/_theme.scss +273 -273
  149. package/styles/list-box/icons/_bootstrap-dark.scss +25 -25
  150. package/styles/list-box/icons/_bootstrap.scss +25 -25
  151. package/styles/list-box/icons/_bootstrap4.scss +25 -25
  152. package/styles/list-box/icons/_fabric-dark.scss +25 -25
  153. package/styles/list-box/icons/_fabric.scss +25 -25
  154. package/styles/list-box/icons/_highcontrast-light.scss +25 -25
  155. package/styles/list-box/icons/_highcontrast.scss +25 -25
  156. package/styles/list-box/icons/_material-dark.scss +25 -25
  157. package/styles/list-box/icons/_material.scss +25 -25
  158. package/styles/list-box/material-dark.css +4 -4
  159. package/styles/list-box/material.css +4 -4
  160. package/styles/material-dark.css +80 -89
  161. package/styles/material.css +115 -89
  162. package/styles/multi-select/_all.scss +2 -2
  163. package/styles/multi-select/_bootstrap-dark-definition.scss +171 -171
  164. package/styles/multi-select/_bootstrap-definition.scss +166 -166
  165. package/styles/multi-select/_bootstrap4-definition.scss +233 -233
  166. package/styles/multi-select/_fabric-dark-definition.scss +170 -170
  167. package/styles/multi-select/_fabric-definition.scss +167 -167
  168. package/styles/multi-select/_highcontrast-definition.scss +257 -257
  169. package/styles/multi-select/_highcontrast-light-definition.scss +258 -258
  170. package/styles/multi-select/_layout.scss +1153 -1153
  171. package/styles/multi-select/_material-dark-definition.scss +186 -186
  172. package/styles/multi-select/_material-definition.scss +191 -191
  173. package/styles/multi-select/_theme.scss +384 -384
  174. package/styles/multi-select/icons/_bootstrap-dark.scss +26 -26
  175. package/styles/multi-select/icons/_bootstrap.scss +26 -26
  176. package/styles/multi-select/icons/_bootstrap4.scss +37 -37
  177. package/styles/multi-select/icons/_fabric-dark.scss +26 -26
  178. package/styles/multi-select/icons/_fabric.scss +26 -26
  179. package/styles/multi-select/icons/_highcontrast-light.scss +26 -26
  180. package/styles/multi-select/icons/_highcontrast.scss +26 -26
  181. package/styles/multi-select/icons/_material-dark.scss +26 -26
  182. package/styles/multi-select/icons/_material.scss +324 -324
  183. package/styles/multi-select/material.css +9 -0
@@ -1,4 +1,4 @@
1
- import { DropDownBase, SelectEventArgs, dropDownBaseClasses, PopupEventArgs, FilteringEventArgs } from '../drop-down-base/drop-down-base';import { ResultData, FocusEventArgs, BeforeOpenEventArgs, FilterType, FieldSettings } from '../drop-down-base/drop-down-base';import { FieldSettingsModel } from '../drop-down-base/drop-down-base-model';import { Popup, createSpinner, showSpinner, hideSpinner } from '@syncfusion/ej2-popups';import { IInput, FloatLabelType } from '@syncfusion/ej2-inputs';import { attributes, setValue } from '@syncfusion/ej2-base';import { NotifyPropertyChanges, extend } from '@syncfusion/ej2-base';import { EventHandler, Property, Event, compile, L10n, EmitType, KeyboardEventArgs } from '@syncfusion/ej2-base';import { Animation, AnimationModel, Browser, prepend, isBlazor, Complex } from '@syncfusion/ej2-base';import { Search } from '../common/incremental-search';import { append, addClass, removeClass, closest, detach, remove, select } from '@syncfusion/ej2-base';import { getUniqueID, formatUnit, isNullOrUndefined, isUndefined, ModuleDeclaration } from '@syncfusion/ej2-base';import { DataManager, Query, Predicate } from '@syncfusion/ej2-data';import { SortOrder } from '@syncfusion/ej2-lists';import { CheckBoxSelection } from './checkbox-selection';import { createFloatLabel, removeFloating, floatLabelFocus, floatLabelBlur } from './float-label';import { IMulitSelect } from './interface';
1
+ import { DropDownBase, SelectEventArgs, dropDownBaseClasses, PopupEventArgs, FilteringEventArgs } from '../drop-down-base/drop-down-base';
2
2
  import {visualMode,MultiSelectChangeEventArgs,RemoveEventArgs,ISelectAllEventArgs,TaggingEventArgs,CustomValueEventArgs} from "./multi-select";
3
3
  import {DropDownBaseModel} from "../drop-down-base/drop-down-base-model";
4
4
 
@@ -8,501 +8,501 @@ import {DropDownBaseModel} from "../drop-down-base/drop-down-base-model";
8
8
  export interface MultiSelectModel extends DropDownBaseModel{
9
9
 
10
10
  /**
11
- * The `fields` property maps the columns of the data table and binds the data to the component.
12
- * * text - Maps the text column from data table for each list item.
13
- * * value - Maps the value column from data table for each list item.
14
- * * iconCss - Maps the icon class column from data table for each list item.
15
- * * groupBy - Group the list items with it's related items by mapping groupBy field.
16
- * ```html
17
- * <input type="text" tabindex="1" id="list"> </input>
18
- * ```
19
- * ```typescript
20
- * let customers: MultiSelect = new MultiSelect({
21
- * dataSource:new DataManager({ url:'http://js.syncfusion.com/demos/ejServices/Wcf/Northwind.svc/' }),
22
- * query: new Query().from('Customers').select(['ContactName', 'CustomerID']).take(5),
23
- * fields: { text: 'ContactName', value: 'CustomerID' },
24
- * placeholder: 'Select a customer'
25
- * });
26
- * customers.appendTo("#list");
27
- * ```
28
- * @default {text: null, value: null, iconCss: null, groupBy: null}
29
- */
30
- fields?: FieldSettingsModel;
31
-
32
- /**
33
- * Enable or disable persisting MultiSelect component's state between page reloads.
34
- * If enabled, following list of states will be persisted.
35
- * 1. value
36
- * @default false
37
- */
38
- enablePersistence?: boolean;
39
-
40
- /**
41
- * Accepts the template design and assigns it to the group headers present in the MultiSelect popup list.
42
- * @default null
43
- */
44
- groupTemplate?: string;
45
-
46
- /**
47
- * Accepts the template design and assigns it to popup list of MultiSelect component
48
- * when no data is available on the component.
49
- * @default 'No records found'
50
- */
51
- noRecordsTemplate?: string;
52
-
53
- /**
54
- * Accepts the template and assigns it to the popup list content of the MultiSelect component
55
- * when the data fetch request from the remote server fails.
56
- * @default 'Request failed'
57
- */
58
- actionFailureTemplate?: string;
59
-
60
- /**
61
- * Specifies the `sortOrder` to sort the data source. The available type of sort orders are
62
- * * `None` - The data source is not sorting.
63
- * * `Ascending` - The data source is sorting with ascending order.
64
- * * `Descending` - The data source is sorting with descending order.
65
- * @default None
66
- */
67
- sortOrder?: SortOrder;
68
-
69
- /**
70
- * Specifies a value that indicates whether the MultiSelect component is enabled or not.
71
- * @default true
72
- */
73
- enabled?: boolean;
74
-
75
- /**
76
- * Accepts the list items either through local or remote service and binds it to the MultiSelect component.
77
- * It can be an array of JSON Objects or an instance of
78
- * `DataManager`.
79
- * @default []
80
- */
81
- dataSource?: { [key: string]: Object }[] | DataManager | string[] | number[] | boolean[];
82
-
83
- /**
84
- * Accepts the external `Query`
85
- * which will execute along with the data processing in MultiSelect.
86
- * @default null
87
- */
88
- query?: Query;
89
-
90
- /**
91
- * Determines on which filter type, the MultiSelect component needs to be considered on search action.
92
- * The `FilterType` and its supported data types are
93
- *
94
- * <table>
95
- * <tr>
96
- * <td colSpan=1 rowSpan=1>
97
- * FilterType<br/></td><td colSpan=1 rowSpan=1>
98
- * Description<br/></td><td colSpan=1 rowSpan=1>
99
- * Supported Types<br/></td></tr>
100
- * <tr>
101
- * <td colSpan=1 rowSpan=1>
102
- * StartsWith<br/></td><td colSpan=1 rowSpan=1>
103
- * Checks whether a value begins with the specified value.<br/></td><td colSpan=1 rowSpan=1>
104
- * String<br/></td></tr>
105
- * <tr>
106
- * <td colSpan=1 rowSpan=1>
107
- * EndsWith<br/></td><td colSpan=1 rowSpan=1>
108
- * Checks whether a value ends with specified value.<br/><br/></td><td colSpan=1 rowSpan=1>
109
- * <br/>String<br/></td></tr>
110
- * <tr>
111
- * <td colSpan=1 rowSpan=1>
112
- * Contains<br/></td><td colSpan=1 rowSpan=1>
113
- * Checks whether a value contains with specified value.<br/><br/></td><td colSpan=1 rowSpan=1>
114
- * <br/>String<br/></td></tr>
115
- * </table>
116
- *
117
- * The default value set to `StartsWith`, all the suggestion items which contain typed characters to listed in the suggestion popup.
118
- * @default 'StartsWith'
119
- */
120
- filterType?: FilterType;
121
-
122
- /**
123
- * specifies the z-index value of the component popup element.
124
- * @default 1000
125
- */
126
- zIndex?: number;
127
-
128
- /**
129
- * ignoreAccent set to true, then ignores the diacritic characters or accents when filtering.
130
- */
131
- ignoreAccent?: boolean;
132
-
133
- /**
134
- * Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
135
- * @default 'en-US'
136
- */
137
- locale?: string;
138
-
139
- /**
140
- * Specifies a Boolean value that indicates the whether the grouped list items are
141
- * allowed to check by checking the group header in checkbox mode.
142
- * By default, there is no checkbox provided for group headers.
143
- * This property allows you to render checkbox for group headers and to select
144
- * all the grouped items at once
145
- * @default false
146
- */
147
- enableGroupCheckBox?: boolean;
148
-
149
- /**
150
- * Sets the CSS classes to root element of this component which helps to customize the
151
- * complete styles.
152
- * @default null
153
- */
154
- cssClass?: string;
155
-
156
- /**
157
- * Gets or sets the width of the component. By default, it sizes based on its parent.
158
- * container dimension.
159
- * @default '100%'
160
- * @aspType string
161
- * @blazorType string
162
- */
163
- width?: string | number;
164
-
165
- /**
166
- * Gets or sets the height of the popup list. By default it renders based on its list item.
167
- * > For more details about the popup configuration refer to
168
- * [`Popup Configuration`](../../multi-select/getting-started/#configure-the-popup-list) documentation.
169
- *
170
- * @default '300px'
171
- * @aspType string
172
- * @blazorType string
173
- */
174
- popupHeight?: string | number;
175
-
176
- /**
177
- * Gets or sets the width of the popup list and percentage values has calculated based on input width.
178
- * > For more details about the popup configuration refer to
179
- * [`Popup Configuration`](../../multi-select/getting-started/#configure-the-popup-list) documentation.
180
- *
181
- * @default '100%'
182
- * @aspType string
183
- * @blazorType string
184
- */
185
- popupWidth?: string | number;
186
-
187
- /**
188
- * Gets or sets the placeholder in the component to display the given information
189
- * in input when no item selected.
190
- * @default null
191
- */
192
- placeholder?: string;
193
-
194
- /**
195
- * Accepts the value to be displayed as a watermark text on the filter bar.
196
- * @default null
197
- */
198
- filterBarPlaceholder?: string;
199
-
200
- /**
201
- * Gets or sets the additional attribute to `HtmlAttributes` property in MultiSelect,
202
- * which helps to add attribute like title, name etc, input should be key value pair.
203
- *
204
- * {% codeBlock src='multiselect/htmlAttributes/index.md' %}{% endcodeBlock %}
205
- * @default {}
206
- */
207
- htmlAttributes?: { [key: string]: string; };
208
-
209
- /**
210
- * Accepts the template design and assigns it to the selected list item in the input element of the component.
211
- * For more details about the available template options refer to
212
- * [`Template`](../../multi-select/templates) documentation.
213
- *
214
- * We have built-in `template engine`
215
- * which provides options to compile template string into a executable function.
216
- * For EX: We have expression evolution as like ES6 expression string literals.
217
- * @default null
218
- */
219
- valueTemplate?: string;
11
+ * The `fields` property maps the columns of the data table and binds the data to the component.
12
+ * * text - Maps the text column from data table for each list item.
13
+ * * value - Maps the value column from data table for each list item.
14
+ * * iconCss - Maps the icon class column from data table for each list item.
15
+ * * groupBy - Group the list items with it's related items by mapping groupBy field.
16
+ * ```html
17
+ * <input type="text" tabindex="1" id="list"> </input>
18
+ * ```
19
+ * ```typescript
20
+ * let customers: MultiSelect = new MultiSelect({
21
+ * dataSource:new DataManager({ url:'http://js.syncfusion.com/demos/ejServices/Wcf/Northwind.svc/' }),
22
+ * query: new Query().from('Customers').select(['ContactName', 'CustomerID']).take(5),
23
+ * fields: { text: 'ContactName', value: 'CustomerID' },
24
+ * placeholder: 'Select a customer'
25
+ * });
26
+ * customers.appendTo("#list");
27
+ * ```
28
+ * @default {text: null, value: null, iconCss: null, groupBy: null}
29
+ */
30
+ fields?: FieldSettingsModel;
31
+
32
+ /**
33
+ * Enable or disable persisting MultiSelect component's state between page reloads.
34
+ * If enabled, following list of states will be persisted.
35
+ * 1. value
36
+ * @default false
37
+ */
38
+ enablePersistence?: boolean;
39
+
40
+ /**
41
+ * Accepts the template design and assigns it to the group headers present in the MultiSelect popup list.
42
+ * @default null
43
+ */
44
+ groupTemplate?: string;
45
+
46
+ /**
47
+ * Accepts the template design and assigns it to popup list of MultiSelect component
48
+ * when no data is available on the component.
49
+ * @default 'No records found'
50
+ */
51
+ noRecordsTemplate?: string;
52
+
53
+ /**
54
+ * Accepts the template and assigns it to the popup list content of the MultiSelect component
55
+ * when the data fetch request from the remote server fails.
56
+ * @default 'Request failed'
57
+ */
58
+ actionFailureTemplate?: string;
59
+
60
+ /**
61
+ * Specifies the `sortOrder` to sort the data source. The available type of sort orders are
62
+ * * `None` - The data source is not sorting.
63
+ * * `Ascending` - The data source is sorting with ascending order.
64
+ * * `Descending` - The data source is sorting with descending order.
65
+ * @default None
66
+ */
67
+ sortOrder?: SortOrder;
68
+
69
+ /**
70
+ * Specifies a value that indicates whether the MultiSelect component is enabled or not.
71
+ * @default true
72
+ */
73
+ enabled?: boolean;
74
+
75
+ /**
76
+ * Accepts the list items either through local or remote service and binds it to the MultiSelect component.
77
+ * It can be an array of JSON Objects or an instance of
78
+ * `DataManager`.
79
+ * @default []
80
+ */
81
+ dataSource?: { [key: string]: Object }[] | DataManager | string[] | number[] | boolean[];
82
+
83
+ /**
84
+ * Accepts the external `Query`
85
+ * which will execute along with the data processing in MultiSelect.
86
+ * @default null
87
+ */
88
+ query?: Query;
89
+
90
+ /**
91
+ * Determines on which filter type, the MultiSelect component needs to be considered on search action.
92
+ * The `FilterType` and its supported data types are
93
+ *
94
+ * <table>
95
+ * <tr>
96
+ * <td colSpan=1 rowSpan=1>
97
+ * FilterType<br/></td><td colSpan=1 rowSpan=1>
98
+ * Description<br/></td><td colSpan=1 rowSpan=1>
99
+ * Supported Types<br/></td></tr>
100
+ * <tr>
101
+ * <td colSpan=1 rowSpan=1>
102
+ * StartsWith<br/></td><td colSpan=1 rowSpan=1>
103
+ * Checks whether a value begins with the specified value.<br/></td><td colSpan=1 rowSpan=1>
104
+ * String<br/></td></tr>
105
+ * <tr>
106
+ * <td colSpan=1 rowSpan=1>
107
+ * EndsWith<br/></td><td colSpan=1 rowSpan=1>
108
+ * Checks whether a value ends with specified value.<br/><br/></td><td colSpan=1 rowSpan=1>
109
+ * <br/>String<br/></td></tr>
110
+ * <tr>
111
+ * <td colSpan=1 rowSpan=1>
112
+ * Contains<br/></td><td colSpan=1 rowSpan=1>
113
+ * Checks whether a value contains with specified value.<br/><br/></td><td colSpan=1 rowSpan=1>
114
+ * <br/>String<br/></td></tr>
115
+ * </table>
116
+ *
117
+ * The default value set to `StartsWith`, all the suggestion items which contain typed characters to listed in the suggestion popup.
118
+ * @default 'StartsWith'
119
+ */
120
+ filterType?: FilterType;
121
+
122
+ /**
123
+ * specifies the z-index value of the component popup element.
124
+ * @default 1000
125
+ */
126
+ zIndex?: number;
127
+
128
+ /**
129
+ * ignoreAccent set to true, then ignores the diacritic characters or accents when filtering.
130
+ */
131
+ ignoreAccent?: boolean;
132
+
133
+ /**
134
+ * Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
135
+ * @default 'en-US'
136
+ */
137
+ locale?: string;
138
+
139
+ /**
140
+ * Specifies a Boolean value that indicates the whether the grouped list items are
141
+ * allowed to check by checking the group header in checkbox mode.
142
+ * By default, there is no checkbox provided for group headers.
143
+ * This property allows you to render checkbox for group headers and to select
144
+ * all the grouped items at once
145
+ * @default false
146
+ */
147
+ enableGroupCheckBox?: boolean;
148
+
149
+ /**
150
+ * Sets the CSS classes to root element of this component which helps to customize the
151
+ * complete styles.
152
+ * @default null
153
+ */
154
+ cssClass?: string;
155
+
156
+ /**
157
+ * Gets or sets the width of the component. By default, it sizes based on its parent.
158
+ * container dimension.
159
+ * @default '100%'
160
+ * @aspType string
161
+ * @blazorType string
162
+ */
163
+ width?: string | number;
164
+
165
+ /**
166
+ * Gets or sets the height of the popup list. By default it renders based on its list item.
167
+ * > For more details about the popup configuration refer to
168
+ * [`Popup Configuration`](../../multi-select/getting-started/#configure-the-popup-list) documentation.
169
+ *
170
+ * @default '300px'
171
+ * @aspType string
172
+ * @blazorType string
173
+ */
174
+ popupHeight?: string | number;
175
+
176
+ /**
177
+ * Gets or sets the width of the popup list and percentage values has calculated based on input width.
178
+ * > For more details about the popup configuration refer to
179
+ * [`Popup Configuration`](../../multi-select/getting-started/#configure-the-popup-list) documentation.
180
+ *
181
+ * @default '100%'
182
+ * @aspType string
183
+ * @blazorType string
184
+ */
185
+ popupWidth?: string | number;
186
+
187
+ /**
188
+ * Gets or sets the placeholder in the component to display the given information
189
+ * in input when no item selected.
190
+ * @default null
191
+ */
192
+ placeholder?: string;
193
+
194
+ /**
195
+ * Accepts the value to be displayed as a watermark text on the filter bar.
196
+ * @default null
197
+ */
198
+ filterBarPlaceholder?: string;
199
+
200
+ /**
201
+ * Gets or sets the additional attribute to `HtmlAttributes` property in MultiSelect,
202
+ * which helps to add attribute like title, name etc, input should be key value pair.
203
+ *
204
+ * {% codeBlock src='multiselect/htmlAttributes/index.md' %}{% endcodeBlock %}
205
+ * @default {}
206
+ */
207
+ htmlAttributes?: { [key: string]: string; };
208
+
209
+ /**
210
+ * Accepts the template design and assigns it to the selected list item in the input element of the component.
211
+ * For more details about the available template options refer to
212
+ * [`Template`](../../multi-select/templates) documentation.
213
+ *
214
+ * We have built-in `template engine`
215
+ * which provides options to compile template string into a executable function.
216
+ * For EX: We have expression evolution as like ES6 expression string literals.
217
+ * @default null
218
+ */
219
+ valueTemplate?: string;
220
220
 
221
221
  /**
222
- * Accepts the template design and assigns it to the header container of the popup list.
223
- * > For more details about the available template options refer to [`Template`](../../multi-select/templates) documentation.
224
- *
225
- * @default null
226
- */
227
- headerTemplate?: string;
228
-
229
- /**
230
- * Accepts the template design and assigns it to the footer container of the popup list.
231
- * > For more details about the available template options refer to [`Template`](../../multi-select/templates) documentation.
232
- *
233
- * @default null
234
- */
235
- footerTemplate?: string;
236
-
237
- /**
238
- * Accepts the template design and assigns it to each list item present in the popup.
239
- * > For more details about the available template options refer to [`Template`](../../multi-select/templates) documentation.
240
- *
241
- * We have built-in `template engine`
242
- * which provides options to compile template string into a executable function.
243
- * For EX: We have expression evolution as like ES6 expression string literals.
244
- * @default null
245
- */
246
- itemTemplate?: string;
247
-
248
- /**
249
- * To enable the filtering option in this component.
250
- * Filter action performs when type in search box and collect the matched item through `filtering` event.
251
- * If searching character does not match, `noRecordsTemplate` property value will be shown.
252
- *
253
- * {% codeBlock src="multiselect/allow-filtering-api/index.ts" %}{% endcodeBlock %}
254
- *
255
- * {% codeBlock src="multiselect/allow-filtering-api/index.html" %}{% endcodeBlock %}
256
- *
257
- * @default null
258
- * @isBlazorNullableType true
259
- * @blazorDefaultValue
260
- */
261
- allowFiltering?: boolean;
262
-
263
- /**
264
- * By default, the multiselect component fires the change event while focus out the component.
265
- * If you want to fires the change event on every value selection and remove, then disable the changeOnBlur property.
266
- *
267
- * @default true
268
- */
269
- changeOnBlur?: boolean;
270
-
271
- /**
272
- * Allows user to add a
273
- * [`custom value`](../../multi-select/custom-value), the value which is not present in the suggestion list.
274
- * @default false
275
- */
276
- allowCustomValue?: boolean;
277
-
278
- /**
279
- * Enables close icon with the each selected item.
280
- * @default true
281
- */
282
- showClearButton?: boolean;
283
-
284
- /**
285
- * Sets limitation to the value selection.
286
- * based on the limitation, list selection will be prevented.
287
- * @default 1000
288
- * @blazorType int
289
- */
290
- maximumSelectionLength?: number;
291
-
292
- /**
293
- * Gets or sets the `readonly` to input or not. Once enabled, just you can copy or highlight
294
- * the text however tab key action will perform.
295
- *
296
- * @default false
297
- */
298
- readonly?: boolean;
299
-
300
- /**
301
- * Selects the list item which maps the data `text` field in the component.
302
- * @default null
303
- */
304
- text?: string;
305
-
306
- /**
307
- * Selects the list item which maps the data `value` field in the component.
308
- * {% codeBlock src='multiselect/value/index.md' %}{% endcodeBlock %}
309
- * @default null
310
- * @isGenericType true
311
- */
312
- value?: number[] | string[] | boolean[];
313
-
314
- /**
315
- * Hides the selected item from the list item.
316
- * @default true
317
- */
318
- hideSelectedItem?: boolean;
319
-
320
- /**
321
- * Based on the property, when item get select popup visibility state will changed.
322
- * @default true
323
- */
324
- closePopupOnSelect?: boolean;
325
-
326
- /**
327
- * configures visibility mode for component interaction.
328
- *
329
- * - `Box` - selected items will be visualized in chip.
330
- *
331
- * - `Delimiter` - selected items will be visualized in text content.
332
- *
333
- * - `Default` - on `focus in` component will act in `box` mode.
334
- * on `blur` component will act in `delimiter` mode.
335
- *
336
- * - `CheckBox` - The 'checkbox' will be visualized in list item.
337
- *
338
- * {% codeBlock src="multiselect/visual-mode-api/index.ts" %}{% endcodeBlock %}
339
- *
340
- * {% codeBlock src="multiselect/visual-mode-api/index.html" %}{% endcodeBlock %}
341
- *
342
- * @default Default
343
- */
344
- mode?: visualMode;
222
+ * Accepts the template design and assigns it to the header container of the popup list.
223
+ * > For more details about the available template options refer to [`Template`](../../multi-select/templates) documentation.
224
+ *
225
+ * @default null
226
+ */
227
+ headerTemplate?: string;
228
+
229
+ /**
230
+ * Accepts the template design and assigns it to the footer container of the popup list.
231
+ * > For more details about the available template options refer to [`Template`](../../multi-select/templates) documentation.
232
+ *
233
+ * @default null
234
+ */
235
+ footerTemplate?: string;
236
+
237
+ /**
238
+ * Accepts the template design and assigns it to each list item present in the popup.
239
+ * > For more details about the available template options refer to [`Template`](../../multi-select/templates) documentation.
240
+ *
241
+ * We have built-in `template engine`
242
+ * which provides options to compile template string into a executable function.
243
+ * For EX: We have expression evolution as like ES6 expression string literals.
244
+ * @default null
245
+ */
246
+ itemTemplate?: string;
247
+
248
+ /**
249
+ * To enable the filtering option in this component.
250
+ * Filter action performs when type in search box and collect the matched item through `filtering` event.
251
+ * If searching character does not match, `noRecordsTemplate` property value will be shown.
252
+ *
253
+ * {% codeBlock src="multiselect/allow-filtering-api/index.ts" %}{% endcodeBlock %}
254
+ *
255
+ * {% codeBlock src="multiselect/allow-filtering-api/index.html" %}{% endcodeBlock %}
256
+ *
257
+ * @default null
258
+ * @isBlazorNullableType true
259
+ * @blazorDefaultValue
260
+ */
261
+ allowFiltering?: boolean;
262
+
263
+ /**
264
+ * By default, the multiselect component fires the change event while focus out the component.
265
+ * If you want to fires the change event on every value selection and remove, then disable the changeOnBlur property.
266
+ *
267
+ * @default true
268
+ */
269
+ changeOnBlur?: boolean;
270
+
271
+ /**
272
+ * Allows user to add a
273
+ * [`custom value`](../../multi-select/custom-value), the value which is not present in the suggestion list.
274
+ * @default false
275
+ */
276
+ allowCustomValue?: boolean;
277
+
278
+ /**
279
+ * Enables close icon with the each selected item.
280
+ * @default true
281
+ */
282
+ showClearButton?: boolean;
283
+
284
+ /**
285
+ * Sets limitation to the value selection.
286
+ * based on the limitation, list selection will be prevented.
287
+ * @default 1000
288
+ * @blazorType int
289
+ */
290
+ maximumSelectionLength?: number;
291
+
292
+ /**
293
+ * Gets or sets the `readonly` to input or not. Once enabled, just you can copy or highlight
294
+ * the text however tab key action will perform.
295
+ *
296
+ * @default false
297
+ */
298
+ readonly?: boolean;
299
+
300
+ /**
301
+ * Selects the list item which maps the data `text` field in the component.
302
+ * @default null
303
+ */
304
+ text?: string;
305
+
306
+ /**
307
+ * Selects the list item which maps the data `value` field in the component.
308
+ * {% codeBlock src='multiselect/value/index.md' %}{% endcodeBlock %}
309
+ * @default null
310
+ * @isGenericType true
311
+ */
312
+ value?: number[] | string[] | boolean[];
313
+
314
+ /**
315
+ * Hides the selected item from the list item.
316
+ * @default true
317
+ */
318
+ hideSelectedItem?: boolean;
319
+
320
+ /**
321
+ * Based on the property, when item get select popup visibility state will changed.
322
+ * @default true
323
+ */
324
+ closePopupOnSelect?: boolean;
325
+
326
+ /**
327
+ * configures visibility mode for component interaction.
328
+ *
329
+ * - `Box` - selected items will be visualized in chip.
330
+ *
331
+ * - `Delimiter` - selected items will be visualized in text content.
332
+ *
333
+ * - `Default` - on `focus in` component will act in `box` mode.
334
+ * on `blur` component will act in `delimiter` mode.
335
+ *
336
+ * - `CheckBox` - The 'checkbox' will be visualized in list item.
337
+ *
338
+ * {% codeBlock src="multiselect/visual-mode-api/index.ts" %}{% endcodeBlock %}
339
+ *
340
+ * {% codeBlock src="multiselect/visual-mode-api/index.html" %}{% endcodeBlock %}
341
+ *
342
+ * @default Default
343
+ */
344
+ mode?: visualMode;
345
345
 
346
346
  /**
347
- * Sets the delimiter character for 'default' and 'delimiter' visibility modes.
348
- * @default ','
349
- */
350
- delimiterChar?: string;
347
+ * Sets the delimiter character for 'default' and 'delimiter' visibility modes.
348
+ * @default ','
349
+ */
350
+ delimiterChar?: string;
351
351
 
352
352
  /**
353
- * Sets [`case sensitive`](../../multi-select/filtering/#case-sensitive-filtering)
354
- * option for filter operation.
355
- * @default true
356
- */
357
- ignoreCase?: boolean;
353
+ * Sets [`case sensitive`](../../multi-select/filtering/#case-sensitive-filtering)
354
+ * option for filter operation.
355
+ * @default true
356
+ */
357
+ ignoreCase?: boolean;
358
358
 
359
359
  /**
360
- * Allows you to either show or hide the DropDown button on the component
361
- *
362
- * @default false
363
- */
364
- showDropDownIcon?: boolean;
360
+ * Allows you to either show or hide the DropDown button on the component
361
+ *
362
+ * @default false
363
+ */
364
+ showDropDownIcon?: boolean;
365
365
 
366
366
  /**
367
- * Specifies whether to display the floating label above the input element.
368
- * Possible values are:
369
- * * Never: The label will never float in the input when the placeholder is available.
370
- * * Always: The floating label will always float above the input.
371
- * * Auto: The floating label will float above the input after focusing or entering a value in the input.
372
- *
373
- * @default Syncfusion.EJ2.Inputs.FloatLabelType.Never
374
- * @aspType Syncfusion.EJ2.Inputs.FloatLabelType
375
- * @isEnumeration true
376
- * @blazorType Syncfusion.Blazor.Inputs.FloatLabelType
377
- */
378
- floatLabelType?: FloatLabelType;
367
+ * Specifies whether to display the floating label above the input element.
368
+ * Possible values are:
369
+ * * Never: The label will never float in the input when the placeholder is available.
370
+ * * Always: The floating label will always float above the input.
371
+ * * Auto: The floating label will float above the input after focusing or entering a value in the input.
372
+ *
373
+ * @default Syncfusion.EJ2.Inputs.FloatLabelType.Never
374
+ * @aspType Syncfusion.EJ2.Inputs.FloatLabelType
375
+ * @isEnumeration true
376
+ * @blazorType Syncfusion.Blazor.Inputs.FloatLabelType
377
+ */
378
+ floatLabelType?: FloatLabelType;
379
379
 
380
380
  /**
381
- * Allows you to either show or hide the selectAll option on the component.
382
- *
383
- * @default false
384
- */
385
- showSelectAll?: boolean;
381
+ * Allows you to either show or hide the selectAll option on the component.
382
+ *
383
+ * @default false
384
+ */
385
+ showSelectAll?: boolean;
386
386
 
387
387
  /**
388
- * Specifies the selectAllText to be displayed on the component.
389
- *
390
- * @default 'select All'
391
- */
392
- selectAllText?: string;
388
+ * Specifies the selectAllText to be displayed on the component.
389
+ *
390
+ * @default 'select All'
391
+ */
392
+ selectAllText?: string;
393
393
 
394
394
  /**
395
- * Specifies the UnSelectAllText to be displayed on the component.
396
- *
397
- * @default 'select All'
398
- */
399
- unSelectAllText?: string;
395
+ * Specifies the UnSelectAllText to be displayed on the component.
396
+ *
397
+ * @default 'select All'
398
+ */
399
+ unSelectAllText?: string;
400
400
 
401
401
  /**
402
- * Reorder the selected items in popup visibility state.
403
- *
404
- * @default true
405
- */
406
- enableSelectionOrder?: boolean;
402
+ * Reorder the selected items in popup visibility state.
403
+ *
404
+ * @default true
405
+ */
406
+ enableSelectionOrder?: boolean;
407
407
 
408
408
  /**
409
- * Whether to automatically open the popup when the control is clicked.
410
- * @default true
411
- */
412
- openOnClick?: boolean;
409
+ * Whether to automatically open the popup when the control is clicked.
410
+ * @default true
411
+ */
412
+ openOnClick?: boolean;
413
413
 
414
414
  /**
415
- * Fires each time when selection changes happened in list items after model and input value get affected.
416
- * @event
417
- * @blazorProperty 'ValueChange'
418
- */
419
- change?: EmitType<MultiSelectChangeEventArgs>;
415
+ * Fires each time when selection changes happened in list items after model and input value get affected.
416
+ * @event
417
+ * @blazorProperty 'ValueChange'
418
+ */
419
+ change?: EmitType<MultiSelectChangeEventArgs>;
420
420
 
421
421
  /**
422
- * Fires before the selected item removed from the widget.
423
- * @event
424
- * @blazorProperty 'OnValueRemove'
425
- */
426
- removing?: EmitType<RemoveEventArgs>;
427
-
422
+ * Fires before the selected item removed from the widget.
423
+ * @event
424
+ * @blazorProperty 'OnValueRemove'
425
+ */
426
+ removing?: EmitType<RemoveEventArgs>;
427
+
428
428
  /**
429
- * Fires after the selected item removed from the widget.
430
- * @event
431
- * @blazorProperty 'ValueRemoved'
432
- */
433
- removed?: EmitType<RemoveEventArgs>;
429
+ * Fires after the selected item removed from the widget.
430
+ * @event
431
+ * @blazorProperty 'ValueRemoved'
432
+ */
433
+ removed?: EmitType<RemoveEventArgs>;
434
434
 
435
435
  /**
436
- * Fires after select all process completion.
437
- * @event
438
- * @blazorProperty 'SelectedAll'
439
- */
440
- selectedAll?: EmitType<ISelectAllEventArgs>;
436
+ * Fires after select all process completion.
437
+ * @event
438
+ * @blazorProperty 'SelectedAll'
439
+ */
440
+ selectedAll?: EmitType<ISelectAllEventArgs>;
441
441
 
442
442
  /**
443
- * Fires when popup opens before animation.
444
- * @event
445
- * @blazorProperty 'OnOpen'
446
- * @blazorType BeforeOpenEventArgs
447
- */
448
- beforeOpen?: EmitType<Object>;
443
+ * Fires when popup opens before animation.
444
+ * @event
445
+ * @blazorProperty 'OnOpen'
446
+ * @blazorType BeforeOpenEventArgs
447
+ */
448
+ beforeOpen?: EmitType<Object>;
449
449
 
450
450
  /**
451
- * Fires when popup opens after animation completion.
452
- * @event
453
- * @blazorProperty 'Opened'
454
- */
455
- open?: EmitType<PopupEventArgs>;
451
+ * Fires when popup opens after animation completion.
452
+ * @event
453
+ * @blazorProperty 'Opened'
454
+ */
455
+ open?: EmitType<PopupEventArgs>;
456
456
 
457
457
  /**
458
- * Fires when popup close after animation completion.
459
- * @event
460
- * @blazorProperty 'OnClose'
461
- */
462
- close?: EmitType<PopupEventArgs>;
458
+ * Fires when popup close after animation completion.
459
+ * @event
460
+ * @blazorProperty 'OnClose'
461
+ */
462
+ close?: EmitType<PopupEventArgs>;
463
463
 
464
464
  /**
465
- * Event triggers when the input get focus-out.
466
- * @event
467
- */
468
- blur?: EmitType<Object>;
465
+ * Event triggers when the input get focus-out.
466
+ * @event
467
+ */
468
+ blur?: EmitType<Object>;
469
469
 
470
470
  /**
471
- * Event triggers when the input get focused.
472
- * @event
473
- */
474
- focus?: EmitType<Object>;
471
+ * Event triggers when the input get focused.
472
+ * @event
473
+ */
474
+ focus?: EmitType<Object>;
475
475
 
476
476
  /**
477
- * Event triggers when the chip selection.
478
- * @event
479
- * @blazorProperty 'ChipSelected'
480
- */
481
- chipSelection?: EmitType<Object>;
477
+ * Event triggers when the chip selection.
478
+ * @event
479
+ * @blazorProperty 'ChipSelected'
480
+ */
481
+ chipSelection?: EmitType<Object>;
482
482
 
483
483
  /**
484
- * Triggers event,when user types a text in search box.
485
- * > For more details about filtering, refer to [`Filtering`](../../multi-select/filtering) documentation.
486
- *
487
- * @event
488
- * @blazorProperty 'Filtering'
489
- */
490
- filtering?: EmitType<FilteringEventArgs>;
484
+ * Triggers event,when user types a text in search box.
485
+ * > For more details about filtering, refer to [`Filtering`](../../multi-select/filtering) documentation.
486
+ *
487
+ * @event
488
+ * @blazorProperty 'Filtering'
489
+ */
490
+ filtering?: EmitType<FilteringEventArgs>;
491
491
 
492
492
  /**
493
- * Fires before set the selected item as chip in the component.
494
- * > For more details about chip customization refer [`Chip Customization`](../../multi-select/chip-customization)
495
- *
496
- * @event
497
- * @blazorProperty 'OnChipTag'
498
- */
499
- tagging?: EmitType<TaggingEventArgs>;
493
+ * Fires before set the selected item as chip in the component.
494
+ * > For more details about chip customization refer [`Chip Customization`](../../multi-select/chip-customization)
495
+ *
496
+ * @event
497
+ * @blazorProperty 'OnChipTag'
498
+ */
499
+ tagging?: EmitType<TaggingEventArgs>;
500
500
 
501
501
  /**
502
- * Triggers when the [`customValue`](../../multi-select/custom-value) is selected.
503
- * @event
504
- * @blazorProperty 'CustomValueSpecifier'
505
- */
506
- customValueSelection?: EmitType<CustomValueEventArgs>;
502
+ * Triggers when the [`customValue`](../../multi-select/custom-value) is selected.
503
+ * @event
504
+ * @blazorProperty 'CustomValueSpecifier'
505
+ */
506
+ customValueSelection?: EmitType<CustomValueEventArgs>;
507
507
 
508
508
  }