@eui/ecl 22.0.0-alpha.30 → 22.0.0-alpha.32

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 (30) hide show
  1. package/docs/changelog.html +76 -0
  2. package/docs/components/EclMultiselectComponent.html +88 -605
  3. package/docs/components/EclMultiselectDropdownComponent.html +204 -2316
  4. package/docs/components/EclMultiselectInputComponent.html +3 -545
  5. package/docs/components/EclMultiselectOptionComponent.html +48 -443
  6. package/docs/components/EclRatingFieldComponent.html +0 -45
  7. package/docs/components/EclSearchFormComponent.html +4 -447
  8. package/docs/directives/EclMultiselectOptionDirective.html +21 -286
  9. package/docs/interfaces/EclMultiselectOption.html +6 -6
  10. package/docs/js/search/search_index.js +2 -2
  11. package/docs/json/EclMultiselectComponent.md +6 -6
  12. package/docs/json/EclMultiselectDropdownComponent.md +1 -6
  13. package/docs/json/EclMultiselectInputComponent.md +1 -1
  14. package/docs/json/EclMultiselectOptionComponent.md +2 -1
  15. package/docs/json/EclMultiselectOptionDirective.md +1 -1
  16. package/docs/json/documentation.json +834 -1416
  17. package/docs/llms.txt +33 -95
  18. package/docs/properties.html +1 -1
  19. package/fesm2022/eui-ecl-components-ecl-multiselect.mjs +320 -430
  20. package/fesm2022/eui-ecl-components-ecl-multiselect.mjs.map +1 -1
  21. package/fesm2022/eui-ecl-components-ecl-rating-field.mjs +4 -6
  22. package/fesm2022/eui-ecl-components-ecl-rating-field.mjs.map +1 -1
  23. package/fesm2022/eui-ecl-components-ecl-search-form.mjs +22 -27
  24. package/fesm2022/eui-ecl-components-ecl-search-form.mjs.map +1 -1
  25. package/package.json +1 -1
  26. package/types/eui-ecl-components-ecl-multiselect.d.ts +163 -192
  27. package/types/eui-ecl-components-ecl-multiselect.d.ts.map +1 -1
  28. package/types/eui-ecl-components-ecl-rating-field.d.ts.map +1 -1
  29. package/types/eui-ecl-components-ecl-search-form.d.ts +14 -14
  30. package/types/eui-ecl-components-ecl-search-form.d.ts.map +1 -1
package/docs/llms.txt CHANGED
@@ -1,6 +1,6 @@
1
1
  # eui documentation
2
2
 
3
- > Generated by compodoc 2.0.0 at 2026-09-29T06:54:10.873Z, llm-md export.
3
+ > Generated by compodoc 2.0.0 at 2026-09-30T09:02:51.197Z, llm-md export.
4
4
 
5
5
  ## Modules
6
6
 
@@ -1705,16 +1705,16 @@ Selector: `select[eclMultiselect]`
1705
1705
  Description: Component representing a custom multiselect input using the ECL design system. Should be used on a native element to enhance it with ECL multiselect behavior. Replaces the original element with a custom dropdown rendered dynamically.
1706
1706
 
1707
1707
  Inputs:
1708
- - `counterLabel: string` — Label for the selections counter, read by screen readers. Accepts a translation key or plain text. Default: 'ecl.multiselect.SELECTED'.
1709
- - `disabled: BooleanInput` — Disables the multiselect component when set to true.
1710
- - `eclPlaceholder: string` — Placeholder text to show in the multiselect input field when no options are selected.
1711
- - `hasSearchBox: string` — Enables the search box within the dropdown.
1712
- - `hasSelectAll: string` — Displays the "Select all" option in the dropdown.
1713
- - `isInvalid: boolean | undefined` — Marks the multiselect as invalid.
1714
- - `isSubmitOnApply: string` — When true, the Apply button in the dropdown acts as a submit button (type="submit").
1715
1708
  - `ariaDescribedby: string | undefined = undefined` — Defines the aria-describedby attribute for accessibility.
1709
+ - `counterLabel: string = 'ecl.multiselect.SELECTED'` — Label for the selections counter, read by screen readers. Accepts a translation key or plain text. Default: 'ecl.multiselect.SELECTED'.
1710
+ - `disabled: boolean = false` — Disables the multiselect component when set to true.
1711
+ - `eclPlaceholder: string = 'Select item'` — Placeholder text to show in the multiselect input field when no options are selected.
1716
1712
  - `eclSize: string = 'm'` — Multiselect size: 's' \| 'm' \| 'l'. Default is 'm'.
1713
+ - `hasSearchBox: boolean = true` — Enables the search box within the dropdown.
1714
+ - `hasSelectAll: boolean = true` — Displays the "Select all" option in the dropdown.
1717
1715
  - `id: string | undefined = undefined` — Sets the id attribute of the multiselect component.
1716
+ - `isInvalid: boolean = false` — Marks the multiselect as invalid.
1717
+ - `isSubmitOnApply: boolean = false` — When true, the Apply button in the dropdown acts as a submit button (type="submit").
1718
1718
  - `toggleLabel: string | undefined = undefined` — Label used for the toggle button that expands or collapses the dropdown.
1719
1719
  - `class: string`
1720
1720
  - `e2eAttr: any`
@@ -1725,7 +1725,6 @@ Outputs:
1725
1725
 
1726
1726
  Properties:
1727
1727
  - `eclOptionItems: unknown = contentChildren(forwardRef(() => EclMultiselectOptionDirective))` — List of option directives projected into the component.
1728
- - `injector: unknown = inject(Injector)`
1729
1728
 
1730
1729
  Methods:
1731
1730
  - `getCssClasses(rootClass: string): string`
@@ -1738,66 +1737,29 @@ Selector: `div[eclMultiselectDropdown]`
1738
1737
  Description: Component that renders a dropdown-style multiselect UI element. Used internally by the EclMultiselectComponent .
1739
1738
 
1740
1739
  Inputs:
1741
- - `disabled: boolean | undefined` — Disables the component when true.
1742
- - `eclSize: string = 'm'` — Size of the multiselect dropdown (e.g., 'm', 'l').
1743
- - `isInvalid: boolean | undefined` — Marks the component as visually invalid.
1744
- - `mainInputPlaceholder: string = 'Select an item'` — Placeholder for the main multiselect input.
1745
- - `searchFieldPlaceholder: string = 'Enter filter keyword'` — Placeholder for the search field input.
1746
1740
  - `class: string`
1747
1741
  - `e2eAttr: any`
1748
1742
  - `tabindex: number`
1749
1743
 
1750
1744
  Outputs:
1751
- - `eclChange: EventEmitter = new EventEmitter<string[]>()` — Emits the list of selected values whenever the selection changes.
1745
+ - `eclChange: string[]` — Emits the list of selected values whenever the selection changes.
1752
1746
 
1753
1747
  Properties:
1754
- - `ariaDescribedby: string | undefined = undefined` — Optional ARIA description used for accessibility purposes.
1755
- - `clearAllBtn: unknown = viewChild('clearAllBtn', { read: ElementRef })`
1756
- - `closeBtn: unknown = viewChild('closeBtn', { read: ElementRef })`
1757
- - `counterLabel: string = 'ecl.multiselect.SELECTED'` — Label for the selections counter, read by screen readers.
1758
- - `eclMultiselectInput: unknown = viewChild<EclMultiselectInputComponent>('eclMultiselectInput')`
1759
- - `form: FormGroup` — Reactive form group managing internal form state.
1760
- - `hasSearchBox: unknown = true` — Enables the search box in the dropdown interface.
1761
- - `hasSelectAll: unknown = true` — Displays the "Select all" checkbox above the list of options.
1762
- - `id: string = ''` — Optional identifier used for the dropdown element.
1763
- - `isItemsSelected: unknown = computed(() => this._selectedItems().length > 0)` — Indicates if any options are currently selected.
1764
- - `isShowMultiselectDropdown: unknown = false` — Controls the visibility of the multiselect dropdown.
1765
- - `isShowNoResultsFound: unknown = false` — Indicates that the "no results found" message should be displayed.
1766
- - `isShowToolbar: unknown = computed(() => this.isSubmitOnApply() || this._selectedItems().length > 0)` — Controls the visibility of the multiselect toolbar. Always visible when isSubmitOnApply is true so the user can submit the form.
1748
+ - `ariaDescribedby: unknown = signal<string | undefined>(undefined)` — Optional ARIA description used for accessibility purposes.
1749
+ - `counterLabel: unknown = signal('ecl.multiselect.SELECTED')` — Label for the selections counter, read by screen readers.
1750
+ - `disabled: unknown = signal<boolean | undefined>(undefined)` — Disables the component when true. Set by the parent and by ControlValueAccessor.setDisabledState .
1751
+ - `eclSize: unknown = signal('m')` — Size of the multiselect dropdown (e.g., 'm', 'l').
1752
+ - `hasSearchBox: unknown = signal(true)` — Enables the search box in the dropdown interface.
1753
+ - `hasSelectAll: unknown = signal(true)` — Displays the "Select all" checkbox above the list of options.
1754
+ - `id: unknown = signal('')` — Optional identifier used for the dropdown element.
1755
+ - `isInvalid: unknown = signal<boolean | undefined>(undefined)` — State configured imperatively by the parent EclMultiselectComponent . This dropdown is created dynamically and is never bound in a template, so these are writable signals set through their .set() accessor rather than inputs.
1767
1756
  - `isSubmitOnApply: unknown = signal(false)` — When true, the Apply button acts as a submit button (type="submit") instead of a regular button.
1768
- - `multiOptionComponents: QueryList<EclMultiselectOptionComponent>`
1757
+ - `mainInputPlaceholder: unknown = signal('Select an item')` — Placeholder for the main multiselect input.
1769
1758
  - `multiOptionDirectives: unknown = signal<EclMultiselectOptionDirective[]>([])` — List of option directives currently rendered in the dropdown.
1770
- - `optionsCount: number = 0` — Total number of options available in the dropdown list.
1771
- - `searchInput: unknown = viewChild<ElementRef>('searchInput')`
1772
- - `selectAllCheckbox: unknown = viewChild<ElementRef>('selectAllCheckbox')`
1773
- - `selectedItems: unknown = computed(() => this._selectedItems().map((item) => item.label))` — Gets labels of currently selected options.
1774
- - `toggleLabel: string | undefined = undefined` — Label displayed for the toggle button to assist screen readers.
1775
-
1776
- Methods:
1777
- - `initSelectedOptions(): void`
1778
- - `onArrowDownClear(evt: Event): void`
1779
- - `onArrowDownClose(evt: Event): void`
1780
- - `onArrowDownSearch(evt: Event): void`
1781
- - `onArrowDownSelectAll(evt: Event): void`
1782
- - `onArrowUpClear(evt: Event): void`
1783
- - `onArrowUpClose(evt: Event): void`
1784
- - `onArrowUpSearch(evt: Event): void`
1785
- - `onArrowUpSelectAll(evt: Event): void`
1786
- - `onClickClearAll(evt: Event): void`
1787
- - `onClickClose(evt: Event): void`
1788
- - `onClickMainInput(evt: EclMultiselectMainInputClickEvent): void`
1789
- - `onEnterClear(evt: Event): void`
1790
- - `onEnterSearch(evt: Event): void`
1791
- - `onEnterSelectAll(evt: Event): void`
1792
- - `onEscapeKey(): void`
1793
- - `onKeydownMainInput(evt: Event): void`
1794
- - `onKeydownOption(evt: EclMultiselectOptionKeydownEvent): void` — Handles keyboard interaction on option items. Supports arrow keys, tab, escape, and enter.
1795
- - `onKeyUp(event: MouseEvent): void`
1796
- - `onOptionSelected(evt: EclMultiselectOptionClickEvent): void` — Triggered when a single option is clicked/selected. Updates selected items, emits changes.
1797
- - `onSearch(input: EventTarget): void` — Handles search input, filters options, and updates their visibility.
1798
- - `onSelectAll(): void` — Toggles all visible options based on the "Select All" checkbox.
1799
- - `onTabClear(evt: Event): void`
1800
- - `onTabClose(evt: Event): void`
1759
+ - `searchFieldPlaceholder: unknown = signal('Enter filter keyword')` — Placeholder for the search field input.
1760
+ - `toggleLabel: unknown = signal<string | undefined>(undefined)` — Label displayed for the toggle button to assist screen readers.
1761
+
1762
+ Methods:
1801
1763
  - `registerOnChange(fn: any): void` — Registers a callback function to be called when the value changes. Required by ControlValueAccessor.
1802
1764
  - `registerOnTouched(fn: any): void` — Registers a callback function to be called when the component is touched. Required by ControlValueAccessor.
1803
1765
  - `setDisabledState(isDisabled: boolean): void` — Enables or disables the component. Required by ControlValueAccessor.
@@ -1820,7 +1782,7 @@ Inputs:
1820
1782
  - `isDisabled: boolean = false` — Marks the component as disabled.
1821
1783
  - `isDropdownExpanded: boolean = false` — Indicates that the dropdown is currently expanded.
1822
1784
  - `isInvalid: boolean = false` — Marks the component as being in an invalid state.
1823
- - `selectedItems: string[] = []` — Array of currently selected item labels.
1785
+ - `selectedItemsLabels: string[] = []` — Array of currently selected item labels.
1824
1786
  - `toggleId: string = ''` — ID of the toggle button element (used for accessibility).
1825
1787
  - `toggleLabel: string | undefined = undefined` — Label for the toggle button (optional).
1826
1788
  - `class: string`
@@ -1831,19 +1793,8 @@ Outputs:
1831
1793
  - `mainInputClick: EclMultiselectMainInputClickEvent` — Event emitted when the input is clicked.
1832
1794
  - `mainInputKeydown: Event` — Event emitted when a key is pressed on the input.
1833
1795
 
1834
- Properties:
1835
- - `ariaDescribedbyFull: unknown = computed(() => { const describedby = this.ariaDescribedby(); const counter = this.counterId(); return [describedby, counter].filter(Boolean).join(' ') || undefi…` — Computed ARIA describedby combining the input value with the counter ID.
1836
- - `buttonText: unknown = computed(() => { const items = this.selectedItems(); return items.length === 0 ? this.inputPlaceholder() : items.join(','); })` — Returns the label text shown inside the button.
1837
- - `counterId: unknown = signal(crypto.randomUUID())` — Unique ID for the counter element.
1838
- - `inputMultiselect: unknown = viewChild<ElementRef>('inputMultiselect')` — Reference to the internal input element.
1839
- - `isActive: unknown = computed(() => this.isDropdownExpanded())` — Indicates that the dropdown is expanded (active).
1840
- - `isShowCounter: unknown = computed(() => this.selectedItems().length > 0)` — Displays a count badge when items are selected.
1841
- - `selectedItemsCount: unknown = computed(() => this.selectedItems().length)` — Returns the count of selected items.
1842
-
1843
1796
  Methods:
1844
- - `onClick(evt: Event): void` — Handles click on the input container. Emits custom event with original DOM event.
1845
1797
  - `onFocus(): void` — Focuses the multiselect input element.
1846
- - `onKeydown(evt: KeyboardEvent): void` — Handles keydown events on the input. Only emits event on ArrowDown, Enter, or Space keys.
1847
1798
  - `getCssClasses(rootClass: string): string`
1848
1799
 
1849
1800
  ### EclMultiselectOptgroupComponent
@@ -1871,28 +1822,22 @@ Description: Component representing a single selectable option in the multiselec
1871
1822
 
1872
1823
  Inputs:
1873
1824
  - `disabled: boolean = false` — Disables the option when true.
1874
- - `isChecked: boolean` — Indicates whether the option is selected.
1875
- - `label: string` — Display label for the option.
1876
- - `value: string`
1825
+ - `isChecked: boolean = false` — Indicates whether the option is selected.
1826
+ - `label: string = ''` — Display label for the option.
1827
+ - `value: string = ''` — Value assigned to the option.
1877
1828
  - `class: string`
1878
1829
  - `e2eAttr: any`
1879
1830
  - `tabindex: number`
1880
1831
 
1881
1832
  Outputs:
1833
+ - `isChecked: boolean = false` — Indicates whether the option is selected.
1882
1834
  - `optionClick: EclMultiselectOptionClickEvent` — Emits when the option is clicked.
1883
1835
  - `optionKeydown: EclMultiselectOptionKeydownEvent` — Emits when a key is pressed while focused on the option.
1884
1836
 
1885
- Properties:
1886
- - `changes: unknown = new Subject()`
1887
- - `eclCheckboxInput: unknown = viewChild<ElementRef>('checkboxInput')`
1888
- - `keyword: string = ''`
1889
-
1890
1837
  Methods:
1891
1838
  - `hide(): void` — Hides the option from view.
1892
- - `highlightSearchText(keyword: string): void` — Sets the keyword for search highlighting.
1839
+ - `highlightSearchText(keyword: string): void` — Sets the keyword used by the boldText pipe to highlight matching text.
1893
1840
  - `onFocus(): void` — Focuses the checkbox input.
1894
- - `onOptionClick(): void` — Toggles the selected state and emits the optionClick event.
1895
- - `onOptionKeydown(evt: KeyboardEvent): void` — Emits the optionKeydown event when a key is pressed.
1896
1841
  - `show(): void` — Makes the option visible.
1897
1842
  - `getCssClasses(rootClass: string): string`
1898
1843
 
@@ -2434,13 +2379,7 @@ Outputs:
2434
2379
  - `searchEvent: EclSearchFormEvent` — This event is emited, when user performs the search action. Includes the search text from the input field.
2435
2380
  - `searchInputText: string = undefined` — The current/default search text.
2436
2381
 
2437
- Properties:
2438
- - `role: string = 'search'`
2439
-
2440
2382
  Methods:
2441
- - `onEnterKeyDown(evt: Event): void` — Perform search when user clicks Enter when on the input field. Emits the search event with the search text.
2442
- - `onModelChange(newValue: string): void` — Assigns the new input text value to the 'searchInputText' property, each time the input is changed.
2443
- - `onSearchClick(evt: Event): void` — Perform search when user clicks the search button. Emits the search event with the search text.
2444
2383
  - `registerOnChange(fn: function): void`
2445
2384
  - `registerOnTouched(fn: function): void`
2446
2385
  - `writeValue(value: any): void`
@@ -5126,16 +5065,15 @@ Selector: `optgroup[eclMultiselectOptgroup], option[eclMultiselectOption]`
5126
5065
  Description: Directive used to decorate and elements within a multiselect. Adds support for value, label, disabled, selected states and styling.
5127
5066
 
5128
5067
  Inputs:
5129
- - `disabled: boolean` — Indicates that the option is disabled.
5130
- - `selected: boolean` — Indicates that the option is selected.
5068
+ - `disabled: boolean = false` — Indicates that the option is disabled.
5131
5069
  - `label: string = undefined` — Label displayed for the option.
5070
+ - `selected: boolean = false` — Indicates that the option is selected.
5132
5071
  - `value: string = undefined` — Value assigned to the option.
5133
5072
  - `class: string`
5134
5073
  - `e2eAttr: any`
5135
5074
  - `tabindex: number`
5136
5075
 
5137
5076
  Properties:
5138
- - `changes: unknown = new Subject()` — Emits whenever the option's state changes (used internally).
5139
5077
  - `eclOptionItems: unknown = contentChildren(forwardRef(() => EclMultiselectOptionDirective))` — Nested option directives (used for optgroups).
5140
5078
 
5141
5079
  Methods:
@@ -7437,9 +7375,9 @@ File: `packages/ecl/components/ecl-multiselect/models/ecl-multiselect-option.mod
7437
7375
  Properties:
7438
7376
  - `id?: string`
7439
7377
  - `isActive: boolean`
7440
- - `isChecked: boolean`
7441
- - `label?: string`
7442
- - `value?: string`
7378
+ - `isChecked: ModelSignal<boolean>`
7379
+ - `label?: InputSignal<string>`
7380
+ - `value?: InputSignal<string>`
7443
7381
 
7444
7382
  ### EclQuizCardFlipEvent
7445
7383
 
@@ -128,7 +128,7 @@
128
128
  </ol>
129
129
  <ul class="properties-list">
130
130
  <li>
131
- <b>Version</b> : 22.0.0-alpha.30</li>
131
+ <b>Version</b> : 22.0.0-alpha.32</li>
132
132
  </ul>
133
133
 
134
134