angular / angular/components

Proposal: Decouple autocomplete from the form control

Ouverte
#12,144 4 commentaires 24 réactions 0 personnes assignées Voir sur GitHub
area: material/autocomplete feature G P3
Langage dominant
TypeScript
Étoiles
25k
Forks
6.8k
Merge moyen
1 j 8 h
PR mergées (30 j)
91

Description

### Motivation

Suppose you have a text input that should contain a space separated list of options. As the user is typing the next option the autocomplete should suggest a completion and on picking one it replaces the current word being typed. Real world examples would be the "To" field for email or a search input with multiple keywords and you want to autocomplete only one part of the bigger query string.

With the current API this is hard to implement because the autocomplete effectively hijacks the input field from you and writes directly to it giving you no control on how that selected mat-option should affect the value.

### Proposal

Decouple the autocomplete from the form input so that it doesn't write the form control value directly and leave it up to the containing component to decide what to write on "optionSelected". The above example could then be implemented with something like

```html


{{option}}

```

```ts
@Component({
selector: 'autocomplete-filter-example',
templateUrl: 'autocomplete-filter-example.html',
styleUrls: ['autocomplete-filter-example.css'],
})
export class AutocompleteFilterExample {
options: string[] = ['One', 'Two', 'Three'];
myControl = new FormControl('');
filteredOptions = this.myControl.valueChanges
.pipe(
map(value => this.currentWord(value)),
map(current => this._filter(current)));

currentWord(value: string): string {
const words = value.split(' ');
if (words.length === 0) {
return value;
} else {
return words[words.length - 1];
}
}

private _filter(value: string): string[] {
const filterValue = value.toLowerCase();
return this.options.filter(
option => option.toLowerCase().includes(filterValue)
);
}

addOption(option: string): void {
const value = this.myControl.value as string;
const words = value.split(' ');
if (words.length === 0){
this.myControl.setValue(option);
} else {
words[words.length - 1] = option;
this.myControl.setValue(words.join(' '));
}
}
}
```

To see what the current behavior is with the above code: https://stackblitz.com/edit/angular-gaktkz

I believe these are all related issues:

Trying to achieve the above using "displayWith":
https://github.com/angular/material2/issues/11796
https://github.com/angular/material2/issues/8436

Not exactly same use case as above but would be solved be decoupling autocomplete and the form control:
https://github.com/angular/material2/issues/4863

Autocomplete overwriting the value that's being set via formControl.setValue(...)
https://github.com/angular/material2/issues/10968
https://github.com/angular/material2/issues/8214

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par examiner l’API du composant autocomplete et les issues associées concernant displayWith et l’écrasement de value. Comparez le comportement actuel avec l’exemple StackBlitz fourni et déterminez comment optionSelected devrait interagir avec le contrôle de formulaire. C’est terminé lorsque le cas d’utilisation proposé d’autocomplete à plusieurs mots peut contrôler la valeur résultante de l’option sélectionnée sans qu’autocomplete ne l’écrase.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
angular, typescript
Domaine
frontend
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.