Skip to content

Commit e2dae4a

Browse files
docs: NotificationProvider Guidelines (#1907)
* docs: NotificationProvider Guidelines * Nutzer zu User geändert * Changes after review
1 parent dfbeaf9 commit e2dae4a

File tree

3 files changed

+19
-10
lines changed

3 files changed

+19
-10
lines changed
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Grundlagen
2+
3+
## Best Practices
4+
5+
Achte bei der Verwendung des NotificationProviders darauf, dass…
6+
* die User nicht von zu vielen Notifications überflutet werden.
7+
* die eingesetzten Notifications die Richtlinien aus der [Notification Guideline](/03-components/status/notification) einhalten.
8+
* bei der Nutzung von `autoClose` darauf geachtet wird, dass User ausreichend Zeit haben, die Notification zu lesen. Idealerweise sollte die Anzeigedauer einstellbar sein.
9+
10+
## Verwendung
11+
12+
Verwende den NotificationProvider, um…
13+
* allen Teilen der Anwendung zu ermöglichen, Notifications zu triggern.
14+
* Benachrichtigungen konsistent und zentralisiert zu verwalten (Anzeigeort und Anzeigedauer).
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
component: NotificationProvider
33
description:
4-
Die NotificationProvider dient zur Anzeige und Steuerung von Notifications
4+
Der NotificationProvider dient zur Anzeige und Steuerung von Notifications.
55
---
66

77
<LiveCodeEditor editorDisabled />
Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,25 @@
11
# Initialisierung
22

3-
Damit Notifications angezeigt werden können, muss der `<NotificationProvider />`
4-
als obere Komponente existieren.
3+
Damit Notifications angezeigt werden können, muss der `<NotificationProvider />` als übergeordnete Component eingebunden werden.
54

65
<LiveCodeEditor example="provider" />
76

87
---
98

109
# Notifications anzeigen
1110

12-
Über den `useNotificationController()` Hook kann auf den Notification-Controller
13-
zugegriffen werden. Dieser stellt zum Anzeigen einer Notification die
14-
`add()`-Method bereit.
11+
Über den `useNotificationController()` Hook kann auf den Notification-Controller zugegriffen werden. Dieser stellt zum Anzeigen einer Notification die `add()`-Methode bereit.
1512

1613
<LiveCodeEditor />
1714

1815
# Auto close
1916

20-
Ist das Property `autoClose` gesetzt, verschwinden die Notifications nach 10
21-
Sekunden.
17+
Ist das Property `autoClose` gesetzt, verschwinden die Notifications nach 10 Sekunden.
2218

2319
<LiveCodeEditor example="auto-close" editorCollapsed />
2420

2521
# Manuelles Schließen
2622

27-
Die `add()`-Methode gibt eine Notification-ID zurück. Diese kann in der
28-
`remove()`-Methode verwendetet werden um eine Notifcation manuell zu schließen.
23+
Die `add()`-Methode gibt eine Notification-ID zurück. Diese kann in der `remove()`-Methode verwendet werden, um eine Notifcation manuell zu schließen.
2924

3025
<LiveCodeEditor example="closeById" editorCollapsed />

0 commit comments

Comments
 (0)