Wer sich noch an die Angular-1-Zeit erinnert, vermisst seit geraumer Zeit die damals sogenannten Formatter und Parser. Dieses Konzept erlaubte es, in Formularen einen anders formatierten Wert anzuzeigen, als in den zugrunde liegenden Daten gespeichert ist. Ein sehr alter Feature Request (link) zeigt diverse Workarounds und Hacks, wie das Thema in Angular2+ angegangen werden kann. Dank der Signal Forms (ab v.22) geht es heute aber viel viel einfacher.

Unser Beispiel soll die Eingabe einer Kundennummer in einem bestimmten Format erlauben (1-2345-6). Als Wert im Modell sollen die Bindestriche jedoch entfernt werden (123456). Grundlage ist eine eigene Komponente, die dank SignalForms bekanntlich sehr übersichtlich ausfällt:

@Component({
  selector: 'app-customer-number-input',
  templateUrl: './customer-number-input.html',
  styleUrl: './customer-number-input.scss',
})
export class CustomerNumberInput implements FormValueControl<string> {
  value = model('');
}

Dies kann wie gewohnt über die FormField-Direktive in Formularen eingebunden werden. Zusätzlich zu der Implementierung oben ergänzen wir nun ein spezielles Signal:

  private readonly customerNumberPattern = /^\d-\d{4}-\d$/; 
 
  internalValue = transformedValue(
    this.value,
    {
      parse: (v: string) => {
        if (v && !this.customerNumberPattern.test(v)) {
          return {error: {kind: 'format', message: `${v} ist keine gültige Kundennummer`}};
        }

        const valueInput = v.replaceAll('-', '');
        return {value: valueInput};
      },
      format: v => v?`${v.slice(0, 1)}-${v.slice(1, 5)}-${v.slice(5)}:`:''
    }
  );

„transformedValue“ nimmt ein Objekt mit zwei Callback-Methoden entgegen

  • parse, nimmt den eingegebenen Wert entgegen und liefert
    • ein Objekt mit einem „value“ Attribut, das in das Modell des Formularfeldes gesetzt wird
    • Objekt mit einem „error“ Attribut, das als Fehler an das Formularfeld angehängt wird
  • format, nimmt den Modellwert (123456) entgegen und formatiert die entsprechende Ausgabe (1-2345-6)

Dieses Signal können wir in unserem Komponenten-Template nun an einem Eingabefeld verwenden, um die Usereingaben entsprechend zu prüfen und zu formatieren:

<input [value]="internalValue()"
       (input)="internalValue.set($event.target.value)"
/>

Die Verwendung:

<app-customer-number-input [formField]="demoForm.customerNumber" [autoFormat]="true"></app-customer-number-input>
<div>{{demoForm.customerNumber().errors().map(e => e.message).join(", ")}}</div>

Damit wird ein Formularwert wie „123456“ dem User als „1-2345-6“ präsentiert. Und Eingaben erlauben strikt auch nur dieses Format. Im Formstate wird bei korrekter Eingabe jedoch der Wert „123456“ hinterlegt. Zusätzliche Validatoren (z.B. required) können wie gewohnt bei der Formular-Definition ergänzt werden.

Eine wirklich einfache und saubere Implementierung. Danke, SignalForms.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert