angular / angular/components

Misleading *ngIf attribute in <mat-error> example?

Offen
#18,430 4 Kommentare 23 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
area: material/form-field docs needs: discussion P4
Vorherrschende Sprache
TypeScript
Sterne
25k
Forks
6.8k
Ø Merge
1 T. 8 Std.
Gemergte PRs (30 T.)
91

Beschreibung

#### Documentation Feedback

I was working on form validation and wanted to take advantage of `` elements. I based my code on the following example:
```



Enter your email

{{getErrorMessage()}}


```
As many, I thought at first that it was possible to use `` for its aesthetics only and that using a `FormControl` was optional. But apparently, `` shows up only if there is a `FormControl` used at some point, and if that `FormControl` is in an error state. The docs also state that:

> If a form field can have more than one error state, it is up to the consumer to toggle which messages should be displayed. This can be done with CSS, `ngIf` or `ngSwitch`.

Which means, if I got that right, that `*ngIf` is more of an **additional** condition deciding if `` is displayed and has no effect if the `FormControl` isn't already in an error state. According to my tests, this seems to be the case. If I am right, I think this line is incredibly misleading:
```
{{getErrorMessage()}}
```
Because that `*ngIf="email.invalid"` does not dictate if the `` element is displayed (something anyone sane thinks it does at first sight), nor does it have any interesting effect in this example since `email.invalid` seems to always be true if the `` element is displayed. During my tests, having `*ngIf="email.invalid"` or not did not make any difference.

Consequently, I suggest:

- that `*ngIf="email.invalid"` is removed from the aforementioned example,
- that ``'s dependency on using a `FormControl` is explicitly mentioned in the docs
- and that, maybe, another example showing how the `*ngIf` is used to handle several error messages **in the template** (instead of using `getErrorMessage()` in the component's TS file) is added.

**Affected documentation page:** https://material.angular.io/components/form-field/overview#error-messages

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginnen Sie im Abschnitt „Fehlermeldungen“ der Übersicht zu Formularfeldern und überprüfen Sie das mat-error-Beispiel sowie die umgebende Erklärung der Fehlerzustände von FormControl. Als erledigt gilt die Aufgabe, wenn das Beispiel und die Dokumentation die Rolle von *ngIf* korrekt erklären und jedes vorgeschlagene Template-Beispiel den Umgang mit mehreren Meldungen eindeutig demonstriert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
angular, typescript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
52/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.