@eui/components 19.1.2-snapshot-1741681025211 → 19.1.2-snapshot-1741955106555

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 (105) hide show
  1. package/docs/components/EuiAutocompleteComponent.html +377 -0
  2. package/docs/components/EuiAutocompleteOptionComponent.html +50 -0
  3. package/docs/components/EuiAutocompleteOptionGroupComponent.html +38 -0
  4. package/docs/components/EuiBlockDocumentComponent.html +64 -0
  5. package/docs/components/EuiDropdownComponent.html +25 -1
  6. package/docs/components/EuiProgressBarComponent.html +115 -109
  7. package/docs/components/EuiTableV2Component.html +228 -63
  8. package/docs/components/EuiTableV2FilterComponent.html +39 -0
  9. package/docs/components/EuiTableV2SelectableHeaderComponent.html +33 -0
  10. package/docs/components/EuiTableV2SelectableRowComponent.html +45 -0
  11. package/docs/components/EuiTableV2SortableColComponent.html +47 -0
  12. package/docs/dependencies.html +2 -2
  13. package/docs/directives/EuiDropdownContentDirective.html +69 -0
  14. package/docs/directives/EuiTableV2ExpandableRowDirective.html +7 -0
  15. package/docs/directives/EuiTableV2StickyColDirective.html +7 -0
  16. package/docs/injectables/EuiTableV2SelectableRowService.html +106 -0
  17. package/docs/injectables/EuiTableV2SortService.html +47 -0
  18. package/docs/js/menu-wc.js +33 -16
  19. package/docs/js/menu-wc_es5.js +1 -1
  20. package/docs/js/search/search_index.js +2 -2
  21. package/docs/modules/EuiAutocompleteModule.html +11 -0
  22. package/docs/modules/EuiBlockDocumentModule.html +22 -4
  23. package/docs/modules/EuiProgressBarModule.html +2 -14
  24. package/docs/modules/EuiTableV2Module.html +11 -0
  25. package/docs/pipes/EuiTableV2HighlightPipe.html +26 -0
  26. package/eui-autocomplete/eui-autocomplete-option/eui-autocomplete-option.component.d.ts +29 -0
  27. package/eui-autocomplete/eui-autocomplete-option/eui-autocomplete-option.component.d.ts.map +1 -1
  28. package/eui-autocomplete/eui-autocomplete-option-group/eui-autocomplete-option-group.component.d.ts +17 -0
  29. package/eui-autocomplete/eui-autocomplete-option-group/eui-autocomplete-option-group.component.d.ts.map +1 -1
  30. package/eui-autocomplete/eui-autocomplete.component.d.ts +311 -1
  31. package/eui-autocomplete/eui-autocomplete.component.d.ts.map +1 -1
  32. package/eui-autocomplete/eui-autocomplete.module.d.ts +12 -0
  33. package/eui-autocomplete/eui-autocomplete.module.d.ts.map +1 -1
  34. package/eui-autocomplete/validators/force-selection-from-data.validator.d.ts +1 -1
  35. package/eui-block-document/eui-block-document.component.d.ts +41 -1
  36. package/eui-block-document/eui-block-document.component.d.ts.map +1 -1
  37. package/eui-block-document/eui-block-document.module.d.ts +12 -2
  38. package/eui-block-document/eui-block-document.module.d.ts.map +1 -1
  39. package/eui-date-range-selector/eui-date-range-selector.component.d.ts +10 -1
  40. package/eui-date-range-selector/eui-date-range-selector.component.d.ts.map +1 -1
  41. package/eui-datepicker/eui-datepicker.component.d.ts +10 -1
  42. package/eui-datepicker/eui-datepicker.component.d.ts.map +1 -1
  43. package/eui-dropdown/directives/eui-dropdown-content.directive.d.ts +1 -0
  44. package/eui-dropdown/directives/eui-dropdown-content.directive.d.ts.map +1 -1
  45. package/eui-dropdown/eui-dropdown.component.d.ts +2 -1
  46. package/eui-dropdown/eui-dropdown.component.d.ts.map +1 -1
  47. package/eui-progress-bar/eui-progress-bar.component.d.ts +16 -9
  48. package/eui-progress-bar/eui-progress-bar.component.d.ts.map +1 -1
  49. package/eui-progress-bar/eui-progress-bar.module.d.ts +5 -17
  50. package/eui-progress-bar/eui-progress-bar.module.d.ts.map +1 -1
  51. package/eui-table-v2/directives/eui-table-v2-expandable-row.directive.d.ts +4 -0
  52. package/eui-table-v2/directives/eui-table-v2-expandable-row.directive.d.ts.map +1 -1
  53. package/eui-table-v2/directives/eui-table-v2-sticky-col.directive.d.ts +4 -0
  54. package/eui-table-v2/directives/eui-table-v2-sticky-col.directive.d.ts.map +1 -1
  55. package/eui-table-v2/eui-table-v2.component.d.ts +273 -1
  56. package/eui-table-v2/eui-table-v2.component.d.ts.map +1 -1
  57. package/eui-table-v2/eui-table-v2.module.d.ts +12 -0
  58. package/eui-table-v2/eui-table-v2.module.d.ts.map +1 -1
  59. package/eui-table-v2/filter/eui-table-v2-filter.component.d.ts +21 -0
  60. package/eui-table-v2/filter/eui-table-v2-filter.component.d.ts.map +1 -1
  61. package/eui-table-v2/pipes/eui-table-v2-highlight.pipe.d.ts +19 -0
  62. package/eui-table-v2/pipes/eui-table-v2-highlight.pipe.d.ts.map +1 -1
  63. package/eui-table-v2/selectable-header/eui-table-v2-selectable-header.component.d.ts +19 -0
  64. package/eui-table-v2/selectable-header/eui-table-v2-selectable-header.component.d.ts.map +1 -1
  65. package/eui-table-v2/selectable-row/eui-table-v2-selectable-row.component.d.ts +28 -0
  66. package/eui-table-v2/selectable-row/eui-table-v2-selectable-row.component.d.ts.map +1 -1
  67. package/eui-table-v2/services/eui-table-v2-selectable-row.service.d.ts +71 -0
  68. package/eui-table-v2/services/eui-table-v2-selectable-row.service.d.ts.map +1 -1
  69. package/eui-table-v2/services/eui-table-v2-sort.service.d.ts +22 -0
  70. package/eui-table-v2/services/eui-table-v2-sort.service.d.ts.map +1 -1
  71. package/eui-table-v2/sortable-col/eui-table-v2-sortable-col.component.d.ts +32 -0
  72. package/eui-table-v2/sortable-col/eui-table-v2-sortable-col.component.d.ts.map +1 -1
  73. package/fesm2022/eui-components-eui-autocomplete.mjs +354 -4
  74. package/fesm2022/eui-components-eui-autocomplete.mjs.map +1 -1
  75. package/fesm2022/eui-components-eui-block-document.mjs +56 -7
  76. package/fesm2022/eui-components-eui-block-document.mjs.map +1 -1
  77. package/fesm2022/eui-components-eui-card.mjs +1 -1
  78. package/fesm2022/eui-components-eui-card.mjs.map +1 -1
  79. package/fesm2022/eui-components-eui-date-range-selector.mjs +7 -3
  80. package/fesm2022/eui-components-eui-date-range-selector.mjs.map +1 -1
  81. package/fesm2022/eui-components-eui-datepicker.mjs +7 -3
  82. package/fesm2022/eui-components-eui-datepicker.mjs.map +1 -1
  83. package/fesm2022/eui-components-eui-dropdown.mjs +12 -5
  84. package/fesm2022/eui-components-eui-dropdown.mjs.map +1 -1
  85. package/fesm2022/eui-components-eui-input-group.mjs +2 -2
  86. package/fesm2022/eui-components-eui-input-group.mjs.map +1 -1
  87. package/fesm2022/eui-components-eui-language-selector.mjs +1 -1
  88. package/fesm2022/eui-components-eui-language-selector.mjs.map +1 -1
  89. package/fesm2022/eui-components-eui-navbar.mjs +1 -1
  90. package/fesm2022/eui-components-eui-navbar.mjs.map +1 -1
  91. package/fesm2022/eui-components-eui-popover.mjs +2 -2
  92. package/fesm2022/eui-components-eui-popover.mjs.map +1 -1
  93. package/fesm2022/eui-components-eui-progress-bar.mjs +37 -31
  94. package/fesm2022/eui-components-eui-progress-bar.mjs.map +1 -1
  95. package/fesm2022/eui-components-eui-table-v2.mjs +482 -5
  96. package/fesm2022/eui-components-eui-table-v2.mjs.map +1 -1
  97. package/fesm2022/eui-components-eui-table.mjs +1 -1
  98. package/fesm2022/eui-components-eui-table.mjs.map +1 -1
  99. package/fesm2022/eui-components-eui-tree.mjs +2 -2
  100. package/fesm2022/eui-components-eui-tree.mjs.map +1 -1
  101. package/fesm2022/eui-components-eui-user-profile.mjs +1 -1
  102. package/fesm2022/eui-components-eui-user-profile.mjs.map +1 -1
  103. package/fesm2022/eui-components-layout.mjs +1 -1
  104. package/fesm2022/eui-components-layout.mjs.map +1 -1
  105. package/package.json +7 -7
@@ -112,6 +112,17 @@
112
112
 
113
113
 
114
114
 
115
+ <p class="comment">
116
+ <h3>Description</h3>
117
+ </p>
118
+ <p class="comment">
119
+ <p>Module that provides the EuiAutocomplete component and its dependencies</p>
120
+ <b>Example :</b><div><pre class="line-numbers"><code class="language-html">```typescript
121
+ \&#64;NgModule({
122
+ imports: [EuiAutocompleteModule]
123
+ })
124
+ export class YourModule { }</code></pre></div><b>Example :</b><div><pre class="line-numbers"><code class="language-none"></code></pre></div>
125
+ </p>
115
126
 
116
127
 
117
128
  <div class="container-fluid module">
@@ -87,7 +87,9 @@
87
87
 
88
88
  <ol class="breadcrumb">
89
89
  <li class="breadcrumb-item">Modules</li>
90
- <li class="breadcrumb-item" >EuiBlockDocumentModule</li>
90
+ <li class="breadcrumb-item"
91
+ class="breadcrumb-item deprecated-name"
92
+ >EuiBlockDocumentModule</li>
91
93
  </ol>
92
94
 
93
95
 
@@ -111,17 +113,33 @@
111
113
  </p>
112
114
 
113
115
 
116
+ <p class="comment">
117
+ <h3 class="deprecated">Deprecated</h3>
118
+ </p>
119
+ <p class="comment">
120
+ [object Object],[object Object],[object Object]
121
+ </p>
114
122
 
123
+ <p class="comment">
124
+ <h3>Description</h3>
125
+ </p>
126
+ <p class="comment">
127
+ <p>EuiBlockDocumentModule is an Angular module that declares and exports the EuiBlockDocumentComponent.</p>
128
+ <b>Example :</b><div><pre class="line-numbers"><code class="language-html"> imports: [EuiBlockDocumentModule]
129
+ })
130
+ export class AppModule {}</code></pre></div>
131
+ </p>
115
132
 
116
133
 
117
134
  <div class="container-fluid module">
118
135
  <div class="row">
119
136
  <div class="col-sm-3">
120
- <h3>Declarations<a href="https://angular.io/api/core/NgModule#declarations" target="_blank" rel="noopener noreferrer"
121
- title="Official documentation about module declarations"><span class="icon ion-ios-information-circle-outline"></span></a></h3>
137
+ <h3>Imports<a href="https://angular.io/api/core/NgModule#imports" target="_blank" rel="noopener noreferrer"
138
+ title="Official documentation about module imports"><span
139
+ class="icon ion-ios-information-circle-outline"></a></h3>
122
140
  <ul class="list-group">
123
141
  <li class="list-group-item">
124
- <a href="../components/EuiBlockDocumentComponent.html">EuiBlockDocumentComponent</a>
142
+ <a href="../modules/EuiBlockDocumentComponent.html">EuiBlockDocumentComponent</a>
125
143
  </li>
126
144
  </ul>
127
145
  </div>
@@ -126,14 +126,8 @@
126
126
  <p class="comment">
127
127
  <p>Module providing the EuiProgressBar component and its dependencies.</p>
128
128
  <p>This module is maintained for backward compatibility.</p>
129
- <b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Instead of importing the module:
130
- // import { EuiProgressBarModule } from &#39;&#64;eui/components/eui-progress-bar&#39;;</code></pre></div><p>// Import the standalone component:
131
- import { EuiProgressBarComponent } from &#39;@eui/components/eui-progress-bar&#39;;</p>
132
- <b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Instead of adding to NgModule imports:
133
- // &#64;NgModule({
134
- // imports: [EuiProgressBarModule]
135
- // })</code></pre></div><p>// Add the standalone component:
136
- imports: [EuiProgressBarComponent]
129
+ <b>Example :</b><div><pre class="line-numbers"><code class="language-html">Instead of importing the module:
130
+ import { EuiProgressBarModule } from &#39;&#64;eui/components/eui-progress-bar&#39;;</code></pre></div><p> imports: [EuiProgressBarModule]
137
131
  })</p>
138
132
 
139
133
  </p>
@@ -146,12 +140,6 @@ import { EuiProgressBarComponent } from &#39;@eui/components/eui-progress-bar&#3
146
140
  title="Official documentation about module imports"><span
147
141
  class="icon ion-ios-information-circle-outline"></a></h3>
148
142
  <ul class="list-group">
149
- <li class="list-group-item">
150
- <a href="../modules/EuiIconModule.html">EuiIconModule</a>
151
- </li>
152
- <li class="list-group-item">
153
- <a href="../modules/EuiIconStateModule.html">EuiIconStateModule</a>
154
- </li>
155
143
  <li class="list-group-item">
156
144
  <a href="../modules/EuiProgressBarComponent.html">EuiProgressBarComponent</a>
157
145
  </li>
@@ -112,6 +112,17 @@
112
112
 
113
113
 
114
114
 
115
+ <p class="comment">
116
+ <h3>Description</h3>
117
+ </p>
118
+ <p class="comment">
119
+ <p>Module that provides the EuiTableV2 component and its dependencies</p>
120
+ <b>Example :</b><div><pre class="line-numbers"><code class="language-html"></code></pre></div><p>@NgModule({
121
+ imports: [EuiTableV2Module]
122
+ })
123
+ export class YourModule { }</p>
124
+ <b>Example :</b><div><pre class="line-numbers"><code class="language-none"></code></pre></div>
125
+ </p>
115
126
 
116
127
 
117
128
  <div class="container-fluid module">
@@ -118,6 +118,17 @@
118
118
  </p>
119
119
 
120
120
 
121
+ <p class="comment">
122
+ <h3>Description</h3>
123
+ </p>
124
+ <p class="comment">
125
+ <p>Pipe used to highlight the matching string in the data of the table when used with filter feature.</p>
126
+ <b>Example :</b><div><pre class="line-numbers"><code class="language-html"></code></pre></div><td><span [innerHTML]="row.year | euiTableV2Highlight: strFilter"></span></td>
127
+ ```
128
+ strFilter = '19'
129
+ ```
130
+
131
+ </p>
121
132
 
122
133
 
123
134
  <section data-compodoc="block-metadata">
@@ -159,6 +170,8 @@
159
170
 
160
171
  <tr>
161
172
  <td class="col-md-4">
173
+ <div class="io-description"><p>Wrap a matching string with a span element with a class name in the data of the table</p>
174
+ </div>
162
175
 
163
176
  <div class="io-description">
164
177
  <b>Parameters :</b>
@@ -170,6 +183,7 @@
170
183
  <td>Type</td>
171
184
  <td>Optional</td>
172
185
  <td>Default value</td>
186
+ <td>Description</td>
173
187
  </tr>
174
188
  </thead>
175
189
  <tbody>
@@ -186,6 +200,10 @@
186
200
  <td>
187
201
  </td>
188
202
 
203
+ <td>
204
+ <p>Data displayed in a cell.</p>
205
+
206
+ </td>
189
207
  </tr>
190
208
  <tr>
191
209
  <td>strFilter</td>
@@ -200,6 +218,10 @@
200
218
  <td>
201
219
  </td>
202
220
 
221
+ <td>
222
+ <p>Search string to highlight.</p>
223
+
224
+ </td>
203
225
  </tr>
204
226
  <tr>
205
227
  <td>className</td>
@@ -215,6 +237,10 @@
215
237
  <code>&#x27;eui-table-v2--highlighted&#x27;</code>
216
238
  </td>
217
239
 
240
+ <td>
241
+ <p>CSS class to add to the span element. Default: &#39;eui-table-v2--highlighted&#39;</p>
242
+
243
+ </td>
218
244
  </tr>
219
245
  </tbody>
220
246
  </table>
@@ -1,12 +1,41 @@
1
1
  import { BaseStatesDirective } from '@eui/components/shared';
2
2
  import * as i0 from "@angular/core";
3
3
  import * as i1 from "@eui/components/shared";
4
+ /**
5
+ * @description
6
+ * Component used internally by `eui-autocomplete` to display the options in the panel.
7
+ */
4
8
  export declare class EuiAutocompleteOptionComponent {
5
9
  private baseStatesDirective;
10
+ /**
11
+ * ARIA role for the host element to ensure proper accessibility.
12
+ * @default 'option'
13
+ */
6
14
  role: string;
15
+ /**
16
+ * @description
17
+ * Computes and returns the CSS classes for the component based on its current state.
18
+ *
19
+ * @returns {string} Space-separated string of CSS class names
20
+ */
7
21
  get cssClasses(): string;
22
+ /**
23
+ * Wheter the option is active in the panel.
24
+ *
25
+ * @default false
26
+ */
8
27
  isActive: boolean;
28
+ /**
29
+ * Wheter the option is disabled in the panel.
30
+ *
31
+ * @default false
32
+ */
9
33
  isDisabled: boolean;
34
+ /**
35
+ * Wheter the option is displayed inside a group.
36
+ *
37
+ * @default false
38
+ */
10
39
  isGroupItem: boolean;
11
40
  constructor(baseStatesDirective: BaseStatesDirective);
12
41
  static ɵfac: i0.ɵɵFactoryDeclaration<EuiAutocompleteOptionComponent, never>;
@@ -1 +1 @@
1
- {"version":3,"file":"eui-autocomplete-option.component.d.ts","sourceRoot":"","sources":["../../../eui-autocomplete/eui-autocomplete-option/eui-autocomplete-option.component.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;;;AAE7D,qBAea,8BAA8B;IAkB3B,OAAO,CAAC,mBAAmB;IAjBb,IAAI,SAAY;IAC1C,IACI,UAAU,IAAI,MAAM,CASvB;IAEuC,QAAQ,UAAS;IACjB,UAAU,UAAS;IACnB,WAAW,UAAS;gBAExC,mBAAmB,EAAE,mBAAmB;yCAlBnD,8BAA8B;2CAA9B,8BAA8B;uCAqBw02C,OAAQ;yCAAR,OAAQ;0CAAR,OAAQ;CAD132C"}
1
+ {"version":3,"file":"eui-autocomplete-option.component.d.ts","sourceRoot":"","sources":["../../../eui-autocomplete/eui-autocomplete-option/eui-autocomplete-option.component.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;;;AAE7D;;;GAGG;AACH,qBAea,8BAA8B;IA4C3B,OAAO,CAAC,mBAAmB;IA3CvC;;;OAGG;IACuB,IAAI,SAAY;IAE1C;;;;;OAKG;IACH,IACI,UAAU,IAAI,MAAM,CASvB;IAED;;;;OAIG;IACqC,QAAQ,UAAS;IACzD;;;;OAIG;IACqC,UAAU,UAAS;IAC3D;;;;OAIG;IACqC,WAAW,UAAS;gBAExC,mBAAmB,EAAE,mBAAmB;yCA5CnD,8BAA8B;2CAA9B,8BAA8B;uCA+C+n1C,OAAQ;yCAAR,OAAQ;0CAAR,OAAQ;CADjr1C"}
@@ -1,7 +1,24 @@
1
1
  import * as i0 from "@angular/core";
2
+ /**
3
+ * @description
4
+ * Component used internally by `eui-autocomplete` with the option `groupBy`. It allows to display the options in groups.
5
+ */
2
6
  export declare class EuiAutocompleteOptionGroupComponent {
7
+ /**
8
+ * ARIA role for the host element to ensure proper accessibility.
9
+ * @default 'optgroup'
10
+ */
3
11
  role: string;
12
+ /**
13
+ * @description
14
+ * Computes and returns the CSS classes for the component based on its current state.
15
+ *
16
+ * @returns {string} Space-separated string of CSS class names
17
+ */
4
18
  get cssClasses(): string;
19
+ /**
20
+ * Sets the label of the group.
21
+ */
5
22
  label: string;
6
23
  static ɵfac: i0.ɵɵFactoryDeclaration<EuiAutocompleteOptionGroupComponent, never>;
7
24
  static ɵcmp: i0.ɵɵComponentDeclaration<EuiAutocompleteOptionGroupComponent, "eui-autocomplete-option-group", never, { "label": { "alias": "label"; "required": false; }; }, {}, never, ["*"], false, never>;
@@ -1 +1 @@
1
- {"version":3,"file":"eui-autocomplete-option-group.component.d.ts","sourceRoot":"","sources":["../../../eui-autocomplete/eui-autocomplete-option-group/eui-autocomplete-option-group.component.ts"],"names":[],"mappings":";AAEA,qBAOa,mCAAmC;IAClB,IAAI,SAAc;IAC5C,IACI,UAAU,IAAI,MAAM,CAEvB;IAEQ,KAAK,EAAE,MAAM,CAAC;yCAPd,mCAAmC;2CAAnC,mCAAmC;CAS/C"}
1
+ {"version":3,"file":"eui-autocomplete-option-group.component.d.ts","sourceRoot":"","sources":["../../../eui-autocomplete/eui-autocomplete-option-group/eui-autocomplete-option-group.component.ts"],"names":[],"mappings":";AAEA;;;GAGG;AACH,qBAOa,mCAAmC;IAC5C;;;OAGG;IACuB,IAAI,SAAc;IAE5C;;;;;OAKG;IACH,IACI,UAAU,IAAI,MAAM,CAEvB;IAED;;OAEG;IACM,KAAK,EAAE,MAAM,CAAC;yCArBd,mCAAmC;2CAAnC,mCAAmC;CAuB/C"}
@@ -8,10 +8,31 @@ import { EuiAppShellService } from '@eui/core';
8
8
  import { EuiChipDragDrop } from '@eui/components/eui-chip-list';
9
9
  import { EuiChip } from '@eui/components/eui-chip';
10
10
  import { EuiTemplateDirective } from '@eui/components/directives';
11
- import { EuiAutoCompleteItem } from './models/eui-autocomplete-item.model';
12
11
  import { BaseStatesDirective } from '@eui/components/shared';
12
+ import { EuiAutoCompleteItem } from './models/eui-autocomplete-item.model';
13
13
  import * as i0 from "@angular/core";
14
14
  import * as i1 from "@eui/components/shared";
15
+ /**
16
+ * @description
17
+ * `eui-autocomplete` is a text input showing some suggestions when the user types letters. It can be enhanced with chips to allow user to select multiple values.
18
+ *
19
+ * @example
20
+ * ```
21
+ * <eui-autocomplete [autocompleteData]="autocompleteData"></eui-autocomplete>
22
+ * ```
23
+ *
24
+ * ```
25
+ * public autocompleteData: EuiAutoCompleteItem[] = [
26
+ * { id: 1, label: 'Ananas' },
27
+ * { id: 2, label: 'Apple' },
28
+ * { id: 3, label: 'Banana' },
29
+ * { id: 4, label: 'Blackberry' },
30
+ * { id: 5, label: 'Coconut' },
31
+ * ];
32
+ * ```
33
+ *
34
+ * See {@link https://eui.ecdevops.eu/eui-showcase-ux-components-19.x/style-guide/components/eui-autocomplete}.
35
+ */
15
36
  export declare class EuiAutocompleteComponent implements OnInit, OnDestroy, ControlValueAccessor, OnChanges, AfterViewInit, DoCheck {
16
37
  private overlay;
17
38
  private cd;
@@ -23,37 +44,179 @@ export declare class EuiAutocompleteComponent implements OnInit, OnDestroy, Cont
23
44
  private baseStatesDirective;
24
45
  private control;
25
46
  private platformId;
47
+ /**
48
+ * @description
49
+ * Computes and returns the CSS classes for the component based on its current state.
50
+ *
51
+ * @returns {string} Space-separated string of CSS class names
52
+ */
26
53
  get cssClasses(): string;
54
+ /**
55
+ * Sets the id on the text input.
56
+ */
27
57
  inputId: string;
58
+ /**
59
+ * Datas to be used in the autocomplete.
60
+ */
28
61
  autocompleteData: EuiAutoCompleteItem[];
62
+ /**
63
+ * Sets the maximum number of options that will be visible in the autocomplete panel.
64
+ *
65
+ * @default 5
66
+ */
29
67
  visibleOptions: number;
68
+ /**
69
+ * Sets the way the options should be retrieved.
70
+ *
71
+ * @default 'contains'
72
+ */
30
73
  matching: 'startWith' | 'contains';
74
+ /**
75
+ * Sets the placeholder of the text input.
76
+ */
31
77
  placeholder: string;
78
+ /**
79
+ * Sets the options that will be selected selected by default.
80
+ */
32
81
  autocompleteDataSelected: EuiAutoCompleteItem[];
82
+ /**
83
+ * Sets the sort criteria of the chips.
84
+ *
85
+ * @type {('ASC' | 'DESC')}
86
+ * @default 'ASC'
87
+ */
33
88
  chipsSortOrder: 'ASC' | 'DESC';
89
+ /**
90
+ * In combination with `isChipsSorted`. Sets the sort criteria of the options in the panel.
91
+ *
92
+ * @type {('ASC' | 'DESC')}
93
+ * @default 'ASC'
94
+ */
34
95
  itemsSortOrder: 'ASC' | 'DESC';
96
+ /**
97
+ * In Combination with `isItemsSorted`. Sets the position of the chips relative to the text input.
98
+ *
99
+ * @type {('top' | 'bottom' | 'inside')}
100
+ * @default 'top''
101
+ */
35
102
  chipsPosition: 'top' | 'bottom' | 'inside';
103
+ /**
104
+ * Sets a grouping among the options.
105
+ */
36
106
  groupBy: string;
107
+ /**
108
+ * In combination with `maxVisibleChipsCount`, sets the label of the 'more label' button, if not provided an arrow right icon will be displayed only.
109
+ */
37
110
  toggleLinkMoreLabel: string;
111
+ /**
112
+ * In combination with `maxVisibleChipsCount`, sets the label of the 'less label' button, if not provided an arrow left icon will be displayed only.
113
+ */
38
114
  toggleLinkLessLabel: string;
115
+ /**
116
+ * Sets a CSS class to be added on the options panel container.
117
+ */
39
118
  classList: string;
119
+ /**
120
+ * Sets the width of the options panel.
121
+ *
122
+ * @type {(string | number)}
123
+ */
40
124
  panelWidth: string | number;
125
+ /**
126
+ * In combination with `isChipsDragAndDrop`, sets the name to the chips source.
127
+ */
41
128
  dragAndDropSourceName: string;
129
+ /**
130
+ * In combination with `isChipsDragAndDrop`, sets the name to the chips source with which a drag and drop will be done.
131
+ */
42
132
  dragAndDropConnectedTo: string[];
133
+ /**
134
+ * In combination with `hasChips`. Wheter the user can add a value, which is not part of the options, to craete a chip.
135
+ *
136
+ * @default true
137
+ */
43
138
  isFreeValueAllowed: boolean;
139
+ /**
140
+ * Wheter autocomplete is in readonly mode.
141
+ *
142
+ * @default false
143
+ */
44
144
  isReadonly: boolean;
145
+ /**
146
+ * Wheter loading spinner is displayed in text input.
147
+ *
148
+ * @default false
149
+ */
45
150
  isLoading: boolean;
151
+ /**
152
+ * Wheter autocomplete will display the selected values with chips.
153
+ *
154
+ * @default false
155
+ */
46
156
  hasChips: boolean;
157
+ /**
158
+ * Wheter autocomplete will get the data in an asynchronous way.
159
+ *
160
+ * @default false
161
+ */
47
162
  isAsync: boolean;
163
+ /**
164
+ * Wheter this chips are sorted on their label.
165
+ *
166
+ * @default false
167
+ */
48
168
  isChipsSorted: boolean;
169
+ /**
170
+ * Wheter this items in the panel are sorted on their label.
171
+ *
172
+ * @default false
173
+ */
49
174
  isItemsSorted: boolean;
175
+ /**
176
+ * Wheter the chip can be removed from the selection.
177
+ * When a chip is removed, its value goes back in the panel.
178
+ *
179
+ * @default true
180
+ */
50
181
  isChipsRemovable: boolean;
182
+ /**
183
+ * Wheter the chips can have multiple times the same value.
184
+ * With this option, the value is not removed from the panel when choosen.
185
+ *
186
+ * @default false
187
+ */
51
188
  isDuplicateValueAllowed: boolean;
189
+ /**
190
+ * In combination with `hasChips`. Wheter the chip is added when the text input is blurred.
191
+ *
192
+ * @default false
193
+ */
52
194
  isAddOnBlur: boolean;
195
+ /**
196
+ * In combination with `hasChips` and `isFreeValueAllowed=false`. Wheter the text input is empty after blurring when no value has been selected in the panel.
197
+ *
198
+ * @default false
199
+ */
53
200
  isForceSelection: boolean;
201
+ /**
202
+ * Wheter a limitated amount, defined by this option, is used to diplay the chips.
203
+ */
54
204
  maxVisibleChipsCount: any;
205
+ /**
206
+ * Wheter the chips label length are limitated by the value of this option.
207
+ */
55
208
  chipsLabelTruncateCount: any;
209
+ /**
210
+ * In combination with `maxVisibleChipsCount`. Wheter all chips are shown by default.
211
+ *
212
+ * @default false
213
+ */
56
214
  isMaxVisibleChipsOpened: boolean;
215
+ /**
216
+ * Wheter the chips can be drag and dropped.
217
+ *
218
+ * @default false
219
+ */
57
220
  isChipsDragAndDrop: boolean;
58
221
  autocompleteOptions: BehaviorSubject<EuiAutoCompleteItem<any>[]>;
59
222
  selectedOptionIndex: number;
@@ -82,17 +245,53 @@ export declare class EuiAutocompleteComponent implements OnInit, OnDestroy, Cont
82
245
  inputContainerRef: ElementRef;
83
246
  virtualScrolling: CdkVirtualScrollViewport;
84
247
  input: ElementRef;
248
+ /**
249
+ * Event emitted when the panel is closed.
250
+ */
85
251
  panelClose: EventEmitter<any>;
252
+ /**
253
+ * Event emitted when the panel is opened.
254
+ */
86
255
  panelOpen: EventEmitter<any>;
256
+ /**
257
+ * Event emitted when the text input gets the focus.
258
+ */
87
259
  inputFocus: EventEmitter<any>;
260
+ /**
261
+ * Event emitted when the text input is blurred.
262
+ */
88
263
  inputBlur: EventEmitter<any>;
264
+ /**
265
+ * Event emitted when the text input is cleared.
266
+ */
89
267
  clear: EventEmitter<any>;
268
+ /**
269
+ * Event emitted when an option is selected or when the selection is modified.
270
+ */
90
271
  selectionChange: EventEmitter<EuiAutoCompleteItem<any>[]>;
272
+ /**
273
+ * Event emitted when an option is selected.
274
+ */
91
275
  itemAdd: EventEmitter<EuiAutoCompleteItem<any>>;
276
+ /**
277
+ * Event emitted when an option is removed.
278
+ */
92
279
  itemRemove: EventEmitter<EuiAutoCompleteItem<any>>;
280
+ /**
281
+ * Event emitted when the value of the text input changes.
282
+ */
93
283
  inputChange: EventEmitter<string>;
284
+ /**
285
+ * Event emitted when a chip drag starts.
286
+ */
94
287
  chipDragStart: EventEmitter<EuiChipDragDrop>;
288
+ /**
289
+ * Event emitted when a chip drag is released.
290
+ */
95
291
  chipDragRelease: EventEmitter<EuiChipDragDrop>;
292
+ /**
293
+ * Event emitted when a chip is dropped.
294
+ */
96
295
  chipDrop: EventEmitter<EuiChipDragDrop>;
97
296
  protected hasAriaRequiredAttribute: boolean;
98
297
  private destroy$;
@@ -116,12 +315,43 @@ export declare class EuiAutocompleteComponent implements OnInit, OnDestroy, Cont
116
315
  ngDoCheck(): void;
117
316
  ngAfterViewInit(): void;
118
317
  ngOnDestroy(): void;
318
+ /**
319
+ * Calculates the height that the virtual scroll need to have.
320
+ *
321
+ * @type {number}
322
+ */
119
323
  get cdkVirtualScrollViewport(): number;
324
+ /**
325
+ * Returns the opening state of the panel.
326
+ *
327
+ * @type {boolean}
328
+ */
120
329
  get isOpen(): boolean;
330
+ /**
331
+ * Checks if autocomplete options are available.
332
+ *
333
+ * @returns {boolean} `true` if options are present, otherwise `false`.
334
+ */
121
335
  get hasOptionsResult(): boolean;
336
+ /**
337
+ * Method that creates and opens the panel containing autocomplete options.
338
+ */
122
339
  openPanel(): void;
340
+ /**
341
+ * Closes the autocomplete panel.
342
+ */
123
343
  closePanel(): void;
344
+ /**
345
+ * Method called when an option is selected.
346
+ *
347
+ * @param e Selected option
348
+ */
124
349
  onOptionSelected(e: EuiAutoCompleteItem): void;
350
+ /**
351
+ * Method called when an option is added through the text input.
352
+ *
353
+ * @param value Value to add
354
+ */
125
355
  add(value: string): void;
126
356
  optionsTrackByFn(index: number, item: EuiAutoCompleteItem): string | number;
127
357
  writeValue(value: EuiAutoCompleteItem | EuiAutoCompleteItem[]): void;
@@ -129,8 +359,19 @@ export declare class EuiAutocompleteComponent implements OnInit, OnDestroy, Cont
129
359
  registerOnChange(fn: () => void): void;
130
360
  registerOnTouched(fn: () => void): void;
131
361
  onClear(): void;
362
+ /**
363
+ * Text input focus handler.
364
+ */
132
365
  onFocus(): void;
366
+ /**
367
+ * Text input blur handler.
368
+ */
133
369
  onBlur(): void;
370
+ /**
371
+ * Called when a chip is removed.
372
+ *
373
+ * @param e Object containing the chip to remove.
374
+ */
134
375
  onChipRemove(e: {
135
376
  chips: EuiChip[];
136
377
  removed: EuiChip | {
@@ -138,17 +379,86 @@ export declare class EuiAutocompleteComponent implements OnInit, OnDestroy, Cont
138
379
  event: Event;
139
380
  };
140
381
  }): void;
382
+ /**
383
+ * Called when a chip is dropped for reordering or from a source to another.
384
+ *
385
+ * @param e Object containing the chip dropped.
386
+ */
141
387
  onChipDropped(e: EuiChipDragDrop): void;
388
+ /**
389
+ * Called when a chip is dragged for reordering or from a source to another.
390
+ *
391
+ * @param e Object containing the chip dragged.
392
+ */
142
393
  onChipDragStarted(e: EuiChipDragDrop): void;
394
+ /**
395
+ * Called when a chip is released for reordering or from a source to another.
396
+ *
397
+ * @param e Object containing the chip released.
398
+ */
143
399
  onChipDragReleased(e: EuiChipDragDrop): void;
400
+ /**
401
+ * Calculates the item size for virtual scrolling.
402
+ *
403
+ * @returns a number representing the item size.
404
+ */
144
405
  private getItemSize;
406
+ /**
407
+ * Re-order options panel based on the input valuea and sort order.
408
+ *
409
+ * @param value Value to filter the options.
410
+ * @param isItemsSorted If the items are sorted.
411
+ */
145
412
  private setOptions;
413
+ /**
414
+ * Return the position strategy for the panel.
415
+ *
416
+ * @returns A CDK position strategy.
417
+ */
146
418
  private getPositionStrategy;
419
+ /**
420
+ * Return the scroll strategy for the panel.
421
+ *
422
+ * @returns A CDK scroll strategy.
423
+ */
147
424
  private getScrollStrategy;
425
+ /**
426
+ * Refine the options based on the input value.
427
+ *
428
+ * @param inputValue Value to filter the options.
429
+ * @returns An array of options.
430
+ */
148
431
  private filterOptions;
432
+ /**
433
+ * Converts EuiAutoCompleteItem array to EuiChip array.
434
+ *
435
+ * @param items Array of EuiAutoCompleteItem.
436
+ * @returns An array of EuiChip
437
+ */
149
438
  private mapToChip;
439
+ /**
440
+ * Sort an array of objects based on their label.
441
+ *
442
+ * @param tab Array to order
443
+ * @param sortOrder Sort order criteria
444
+ * @returns A sorted array
445
+ */
150
446
  private orderArray;
447
+ /**
448
+ * Transforms array of EuiAutoCompleteItem into a grouped object.
449
+ *
450
+ * @param options Array of EuiAutoCompleteItem
451
+ * @param groupBy Label of the group
452
+ * @returns An object containing the grouped options and the distinct option groups.
453
+ */
151
454
  private groupingHandler;
455
+ /**
456
+ * Indicates if the origin element is visible in the scrollable parent.
457
+ *
458
+ * @param origin Origin of the autocomplete
459
+ * @param scrollableParent Scrollable container
460
+ * @returns A boolean, true if visible else false.
461
+ */
152
462
  private isVisible;
153
463
  private onChange;
154
464
  private onTouch;