angular / angular/components

Proposal: Decouple autocomplete from the form control

Abierto
#12,144 4 comentarios 24 reacciones 0 asignados Ver en GitHub
area: material/autocomplete feature G P3
Lenguaje dominante
TypeScript
Estrellas
25k
Forks
6.8k
Merge medio
1 d 8 h
PR fusionados (30 d)
91

Descripción

### 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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza revisando la API del componente autocomplete y las issues vinculadas sobre displayWith y la sobrescritura de value. Compara el comportamiento actual con el ejemplo de StackBlitz proporcionado y determina cómo debería interactuar optionSelected con el control de formulario. Se considera completado cuando el caso de uso propuesto de autocomplete de varias palabras puede controlar el valor resultante de la opción seleccionada sin que autocomplete lo sobrescriba.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
angular, typescript
Área
frontend
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.