alfresco-ng2-components/docs/content-services/components/search-chip-autocomplete-input.component.md
dominikiwanekhyland d1462253d0
ADW Saved Search (#10306)
Co-authored-by: MichalKinas <michal.kinas@hyland.com>
2024-10-17 14:57:56 +02:00

4.6 KiB

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
Search Chip Autocomplete Input component v6.1.0 Active 2023-06-13

Search Chip Autocomplete Input component

Represents an input with autocomplete options.

Search Chip Autocomplete Input

Basic usage

<adf-search-chip-autocomplete-input
    [autocompleteOptions]="autocompleteOptions"
    [onReset$]="onResetObservable$"
    [allowOnlyPredefinedValues]="allowOnlyPredefinedValues"
    (inputChanged)="onInputChange($event)"
    (optionsChanged)="onOptionsChange($event)">
</adf-search-chip-autocomplete-input>

Properties

Name Type Default value Description
autocompleteOptions AutocompleteOption[] [] Options for autocomplete
preselectedOptions AutocompleteOption[] [] Options which are selected from start
onReset$ Observable<void> Observable that will listen to any reset event causing component to clear the chips and input
allowOnlyPredefinedValues boolean true A flag that indicates whether it is possible to add a value not from the predefined ones
placeholder string 'SEARCH.FILTER.ACTIONS.ADD_OPTION' Placeholder which should be displayed in input.
compareOption (option1: AutocompleteOption, option2: AutocompleteOption) => boolean Function which is used to selected options with all options so it allows to detect which options are already selected.
formatChipValue (option: string) => string Function which is used to format custom typed options.
filter (options: AutocompleteOption[], value: string) => AutocompleteOption[] Function which is used to filter out possible options from hint. By default it checks if option includes typed value and is case insensitive.

Events

Name Type Description
inputChanged EventEmitter<string> Emitted when the input changes
optionsChanged EventEmitter<AutocompleteOption[]> Emitted when the selected options are changed

See also