Note: Es gibt veraltete Versionen dieser Komponente. Wechseln Sie zu einer Version, die älter als 10.0.x ist, um die entsprechende Dokumentation anzuzeigen.
Zum Anzeigen einer einfachen Zahleneingabe-Komponente ist lediglich die Eigenschaft label erforderlich. Andere Eigenschaften können verwendet werden, um ihr Verhalten zu ergänzen: placeholder, secondaryLabel, onChange oder die zahlenbezogenen Eigenschaften.
<NumberInput label="Number input component" placeholder="Write what you want here" secondaryLabel="Free text input" />
Mit der Zahleneingabe-Komponente können die Maximal- und Minimalwerte festgelegt werden. Dies hat jedoch nichts mit einer Validierungsfunktion zu tun, sondern mit dem Verhalten der Komponente. Wenn Sie eine dieser beiden Eigenschaften einstellen, ist es nicht möglich, mit den Komponentenpfeilen einen Wert einzustellen, der unter der min-Eigenschaft liegt oder einen Wert, der über der max-Eigenschaft liegt.
Wenn eine spezielle Validierung erforderlich ist, muss diese vom Entwickler vorgenommen werden. Einzelheiten dazu finden Sie im Beispiel für die Validierung der Zahleneingabe bei Änderungen.
<NumberInput label="Number input component with min and max" placeholder="Enter a value" secondaryLabel="Test the limits with using the arrows" min={20} max={40} />
Die Zahleneingabe-Komponente stellt keine spezielle Validierungslogik zur Verfügung, bietet aber die Möglichkeit, die Validierung durch den Entwickler einzubeziehen und die Eigenschaft stateMessages zur Anzeige der erforderlichen Fehlermeldung zu verwenden.
Dies ist ein Beispiel für die Handhabung der Validierung, wenn ein onChange-Ereignis ausgelöst wird.
exportfunctionNumberInputValidation(){ const[validationMessages, setValidationMessages]=useState({}); const max =100; const min =0; const onChange =useCallback((e, newValue)=>{ setValidationMessages({}); if(newValue &&(newValue > max || newValue < min)){ setValidationMessages({ error:['Value must be between 0 and 100'], }); } },[]); return( <NumberInput label="Enter value" secondaryLabel="Min = 0. Max = 100" stateMessages={validationMessages} min={min} max={max} onChange={onChange} /> ); }
Mit der Eigenschaft decimalPlaces können Sie angeben, wie viele Dezimalstellen angezeigt werden sollen. Standardmäßig wird keine Einschränkung angewendet und jeder vom Benutzer eingegebene Wert wird angezeigt. Er wird jedoch geändert, wenn die Eingabe den Fokus verliert. Außerdem wird der Wert bei der Eingabe auf die nächste Dezimalstelle gerundet.
Beispiel: Wenn decimalPlaces auf 2 festgelegt ist und der Benutzer 5.666 eingibt, wird der Wert in 5.67 umgewandelt, wenn die Eingabe den Fokus verliert.
<NumberInput label="Number input component limited decimals" placeholder="Enter a value" secondaryLabel="Try to add an additional digit" initialValue={5.66} decimalPlaces={2} /> />
Wenn die Eigenschaft decimalPlaces festgelegt ist, kann ein Benutzer weiterhin zusätzliche Dezimalstellen eingeben. Die Rundung erfolgt erst, wenn das Element den Fokus verliert. Um Benutzer zu warnen, dass sich der Wert ändern wird, können Sie Validierungslogik zur Anzeige einer Warnung hinzufügen.
Note: Es gibt veraltete Versionen dieser Komponente. Wechseln Sie zu einer Version, die älter als 10.0.x ist, um die entsprechende Dokumentation anzuzeigen.
Die Zahleneingabe ermöglicht es dem Benutzer, numerische Werte innerhalb eines vorgegebenen Bereichs einzugeben oder auszuwählen. Sie enthält Steuerelemente zum schrittweisen Erhöhen oder Verringern des Wertes. Benutzer können numerische Werte auch direkt in das Eingabefeld eingeben.
Wenn für den Benutzer nicht der genaue Wert wichtig ist, sondern nur der ungefähre Bereich. Ziehen Sie in Betracht, stattdessen die Schieberegler-Komponente zu verwenden.
Beschriftung: Beschreibt den Zweck eines Eingabefeldes.
Hilfstext (optional): Bietet zusätzlichen Kontext, Hinweise oder hilfreiche Informationen, zur Unterstützung des Benutzers. Wird oft verwendet, um bestimmte Anforderungen für das korrekte Ausfüllen eines Feldes zu erklären.
Numerischer Wert: Ändert sich, wenn der Benutzer einen Wert in das Feld eingibt oder die beiden Pfeile am Ende der Eingabe verwendet, um Werte zu addieren und zu subtrahieren.
Zahleneingabefeld: der Container, bestehend aus einer Füllung und einem Strich, in den der Benutzer Daten eingibt.
Positionieren Sie eine deutlich sichtbare Beschriftung außerhalb des Zahleneingabefeldes. Ein Eingabefeld ohne Beschriftung ist mehrdeutig und nicht barrierefrei.
Positionieren Sie eine dauerhafte Beschriftung außerhalb des Feldes.
Gehen Sie nicht davon aus, dass das Feld ohne Beschriftung selbsterklärend ist.
Verwenden Sie Hilfetext, der erklärt, was wie eingeben werden muss. Hier sind einige Beispiele dafür, was Sie in den Hilfetext aufnehmen könnten:
Kontext zur Unterstützung des Benutzers, z. B. wie die Informationen verwendet werden sollen
Hinweise dazu, welche Art von Informationen in das Eingabefeld gehören
Formatierungsbeispiele oder -anforderungen
Verwenden Sie Hilfetext nur für relevante Informationen. Vermeiden Sie die Verwendung von Hilfetext, der einfach nur die gleichen Informationen wiedergibt, die in der Beschriftung erscheinen.
Verwenden Sie für Hilfetext die übliche Groß- und Kleinschreibung. Schreiben Sie den Hilfetext in 1 bis 2 kurzen, vollständigen Sätzen, die mit einem Punkt enden. Wenn Sie Formatierungsbeispiele zeigen, brauchen Sie nicht mit einem Punkt zu enden.
Verwenden Sie Hilfetext, um dem Benutzer zusätzliche Hilfe oder Kontext zu bieten.
Verwenden Sie den Hilfetext nicht, um einfach dieselben Informationen wiederzugeben, die auch in der Beschriftung erscheinen.
Fügen Sie keinen Platzhaltertext in das Eingabefeld für die Zahl ein. Platzhaltertext belastet das Kurzzeitgedächtnis der Benutzer, da es nach der Eingabe eines Wertes verschwindet. Auch für Benutzer mit vermindertem Sehvermögen und kognitiven Beeinträchtigungen stellt er eine zusätzliche Belastung dar.
Positionieren Sie Hinweise und Anweisungen, einschließlich Formatierungsbeispiele und -anforderungen, stattdessen außerhalb des Feldes.
Positionieren Sie Hinweise und Anweisungen, einschließlich Formatierungsbeispiele und -anforderungen, außerhalb des Feldes.
Fügen Sie keine Platzhalter in das Zahleneingabefeld ein.
Verwenden von Fehlertext zur Anleitung der Benutzer
Der Text der Fehlermeldung erklärt dem Benutzer, wie er den Fehler beheben kann. Im Falle des Zahleneingabefelds hängen die Fehler oft mit etwas zusammen, das für die Inline-Validierung korrigiert werden muss. Wenn der Benutzer beispielsweise ein Pflichtfeld nicht ausfüllt, in dem er nach seiner geschätzten jährlichen Fahrleistung gefragt wird, können Sie ihn mithilfe von Fehlertext zu einer Lösung führen: „Geben Sie Ihre geschätzte Jahresfahrleistung ein.“
Verwenden Sie für Fehlertext die übliche Groß- und Kleinschreibung. Schreiben Sie 1 bis 2 kurze, vollständige Sätze, die mit einem Punkt enden.
Verwenden Sie Fehlermeldungstexte, um den Benutzer zu führen und ihm eine Lösung zu zeigen.
Schreiben Sie keine zweideutigen Fehlermeldungen und lassen Sie die Benutzer nicht im Unklaren darüber, wie ein Problem zu lösen ist.
Markieren Sie erforderliche Felder mit einem Sternchen (*). Das Sternchen steht vor der Feldbeschriftung. Benutzer können so leicht herausfinden, welche Felder erforderlich sind, indem sie nur das Zeichen ganz links in der Beschriftung scannen.
Zusätzlich zur Markierung erforderlicher Felder mit einem Sternchen wird empfohlen, klare Anweisungen am oberen Rand des Formulars einzufügen, z. B. „Alle mit einem Sternchen gekennzeichneten Felder sind Pflichtfelder“, um sicherzustellen, dass die Benutzer die Bedeutung des Sternchens verstehen.
Verwenden Sie ein Sternchen, um anzuzeigen, dass ein Feld ein Pflichtfeld ist.
Verwenden Sie kein Sternchen, um etwas zu kennzeichnen, das optional ist.
Schreiben Sie das erste Wort und Substantive groß.
Für Feldbeschriftungen wird die übliche Groß- und Kleinschreibung verwendet.
Weitere Informationen zum Implementieren der Groß- und Kleinschreibung finden Sie im UI-Textstyleguide.
Verwenden Sie die übliche Groß- und Kleinschreibung.
Schreiben Sie nicht alles groß. Dies beeinträchtigt die Lesbarkeit.
Das Zahleneingabefeld erscheint ohne Wert (Standard), ohne Platzhaltertext und ohne vorausgefüllte Eingabe.
Bild
Zustand
Beschreibung
Kein Wert (Standard)
Zeigt dem Benutzer an, dass kein Wert eingegeben wurde und kein Platzhalter vorhanden ist.
Platzhalter
Zeigt dem Benutzer an, dass kein Wert eingegeben wurde. Der Platzhalter ist ausgegraut.
Vorausgefüllte Eingabe
Zeigt dem Benutzer an, dass die Eingabe mit Daten vorausgefüllt ist.
Zahleneingabefelder haben auch interaktive Zustände für Aktiviert, Fokus, Deaktiviert, Fehler, Schreibgeschützt und Nur Anzeigen.
Zustand
Beschreibung
Aktiviert
Zeigt dem Benutzer an, dass das Element für die Interaktion aktiviert ist.
Fokussiert
Zeigt dem Benutzer an, auf welchem UI-Element im System der Fokus liegt.
Deaktiviert
Zeigt dem Benutzer an, dass der Eingabewert aufgrund lokaler Faktoren nicht geändert werden kann. Zum Beispiel muss ein Kontrollkästchen über dem Eingabefeld aktiviert sein, um auf dieses Eingabefeld zuzugreifen. Der Benutzer kann durch Interaktion mit der Seite eine Aktion zur Aktivierung durchführen.
Fehler
Zeigt an, dass der Benutzer einen Fehler bei der Validierung gemacht hat. Der Fehlertext gibt dem Benutzer eine korrigierende Rückmeldung.
Schreibgeschützt
Zeigt dem Benutzer an, dass der Eingabewert aufgrund externer Faktoren nicht geändert werden kann. Zum Beispiel fehlender Schreibzugriff. Der Benutzer kann Maßnahmen zur Aktivierung ergreifen, indem er sich z. B. an einen Administrator wendet.
Nur Anzeige
Der Zustand „Nur Anzeige“ wird in zwei Fällen verwendet:
Ein UI-Element wird im Anzeigemodus verwendet.
Ein UI-Element wird im Bearbeitungsmodus angezeigt, ist aber nie bearbeitbar.
Dieser Zustand wurde zuvor als „Schreibgeschützt“ bezeichnet.
Benutzer können eine Zahleneingabe aktivieren, indem sie auf den Bereich innerhalb des Rahmens klicken. Wenn der Fokus aktiviert ist, werden zwei Pfeile am Ende der Eingabe angezeigt. Mit diesen Steuerelementen können Benutzer den Wert inkrementell erhöhen oder verringern.
Auf das Eingabeelement kann über die Tastatur zugegriffen werden. Benutzer können mit der TAB-Taste in die Komponente hinein und aus ihr heraus navigieren.
Der barrierefreie Name der Zahleneingabe-Komponente wird über ein aria-label-Attribut abgeleitet. Wenn Sie den Textwert des Beschriftungselements ändern, ändert sich auch der Wert des barrierefreien Namens. Das Standardattribut aria-required='true' wechselt zu „false“, wenn das erforderliche Kontrollkästchen in Storybook aktiviert ist.
Das Kontrastverhältnis von Textelementen zu ihrem Hintergrund liegt über 4,5:1 gemäß den Anforderungen der WCAG 2.1 AA. Nicht-textuelle Inhalte, die eine Bedeutung vermitteln müssen (z. B. Symbole und Sichtbarkeit des Tastaturfokus), weisen ein Kontrastverhältnis von mindestens 3:1 zu den angrenzenden Farben auf. Alle Inhalte sind bis einschließlich 400 % sichtbar und funktionsfähig, ohne dass ein Scrollen in zwei Dimensionen erforderlich ist.
Diese Komponente wurde validiert, um die Zugänglichkeitsrichtlinien WCAG 2.1 AA zu erfüllen. Vom Autor des Inhalts vorgenommene Änderungen können sich jedoch auf die Konformität mit der Barrierefreiheit auswirken.
Wenn Sie diese Komponente in Ihrer Anwendung verwenden, stellen Sie sicher, dass Beschriftungen und Anweisungen aussagekräftig und prägnant sind. Geben Sie bei Bedarf ergänzende Anweisungen.
Note: Es gibt veraltete Versionen dieser Komponente. Wechseln Sie zu einer Version, die älter als 10.0.x ist, um die entsprechende Dokumentation anzuzeigen.
Vergewissern Sie sich, dass Sie die API-Oberfläche der Design System-Komponenten und die damit verbundenen Auswirkungen und Kompromisse verstehen. Erfahren Sie mehr in unserer Einführung zur Komponenten-API.
The number of decimal places to display in the value. If not set, no restriction is applied. When a user enters a value with more decimal places it will round the value. For example, if decimalPlaces is 2 and the user enters 5.666666 it will convert the value to 5.67.
If set to true, displays the component value in plain text. Consider using readonly instead, if possible, because plain text is worse for accessibility than readonly inputs.
Value of input. Takes precedence over initialValue. If this prop is passed, component works in controlled mode and its value will change only if this prop changes.
Übergeben von HTML-Eigenschaften an die Komponente
Sie können Attribute der HTML-Eingabe verwenden, mit Ausnahme derjenigen, die von Jutro überschrieben werden. Diese Attribute werden dem HTML-Element input zugewiesen.
Bitte beachten Sie, dass die meisten eingabespezifischen Attribute (step, min und max) als Teil der Komponenten-API enthalten sind und möglicherweise mit einer Jutro-spezifischen Logik verbunden sind.
Die Jutro-Eingaben haben imperative Handler als Mechanismus implementiert, um Zugang zu einigen gängigen nativen Funktionen zu bieten, die für Sie nützlich sein könnten. Die folgenden Funktionen sind verfügbar:
Fokus setzen ermöglicht es, den Fokus des Benutzers auf eine bestimmte Komponente zu setzen.
Weichzeichnen ermöglicht es, den Fokus von der Komponente zu entfernen.
Zur Komponente scrollen ermöglicht es, den Benutzer zu einem bestimmten Bereich der Seite zu führen.
Diese Funktionen werden über die ref-Eigenschaft bereitgestellt, die sie wie folgt verfügbar macht:
Obwohl einige Jutro-Komponenten ergänzende Funktionen oder eine Hilfsfunktion zur Erleichterung des Validierungsprozesses bereitstellen, liegt es in Ihrer Verantwortung als Entwickler, die Validierung von Benutzereingaben (mit oder ohne Verwendung der ergänzenden Hilfsfunktionen) durchzuführen und zu entscheiden, welche Fehlermeldungen angezeigt werden sollen.
Jutro-Komponenten verhalten sich in Abhängigkeit von der Implementierung des Entwicklers.
Wann werden Fehlermeldungen angezeigt?
Fehlermeldungen werden nur angezeigt, wenn Sie sie über die Eigenschaft stateMessages an die Komponente übergeben. Diese Eigenschaft empfängt ein Objekt mit dem folgenden Inhalt:
Die Komponente zeigt alle bereitgestellten Fehlermeldungen in der gleichen Reihenfolge wie im Array an.
Wann erfolgt die Validierung?
Dies ist Ihre Entscheidung als Entwickler. Da die Komponenten nicht festlegen, wann die Validierung durchgeführt wird oder wann der Fehler angezeigt werden muss, müssen Sie die Logik für die Behandlung entsprechend den Projektanforderungen implementieren, z. B. während der Benutzer den Inhalt bearbeitet, wenn die Komponente den Fokus verliert und bei der Formularübermittlung.
Es wurde eine neue @jutro/components/NumberInput-Komponente eingeführt, welche InputNumberField ersetzt.
Die frühere zahlenbezogene Komponente InputNumberField wurde verworfen und in das @jutro/legacy-Paket verschoben. Um die entsprechende Dokumentation anzuzeigen, wechseln Sie zu einer älteren Version.