Skip to content

docs: NotificationProvider Guidelines #1907

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 22, 2025
Merged

docs: NotificationProvider Guidelines #1907

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1fff0ed
docs: NotificationProvider Guidelines
Jan-Eimertenbrink Aug 22, 2025
fee1388
Nutzer zu User geändert
Jan-Eimertenbrink Aug 22, 2025
5858204
Changes after review
Jan-Eimertenbrink Aug 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions apps/docs/src/content/03-components/status/notification-provider/guidelines.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Grundlagen

## Best Practices

Achte bei der Verwendung des NotificationProviders darauf, dass…
* die User nicht von zu vielen Notifications überflutet werden.
* die eingesetzten Notifications die Richtlinien aus der [Notification Guideline](/03-components/status/notification) einhalten.
* bei der Nutzung von `autoClose` darauf geachtet wird, dass User ausreichend Zeit haben, die Notification zu lesen. Idealerweise sollte die Anzeigedauer einstellbar sein.

## Verwendung

Verwende den NotificationProvider, um…
* allen Teilen der Anwendung zu ermöglichen, Notifications zu triggern.
* Benachrichtigungen konsistent und zentralisiert zu verwalten (Anzeigeort und Anzeigedauer).
2 changes: 1 addition & 1 deletion apps/docs/src/content/03-components/status/notification-provider/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
component: NotificationProvider
description:
Die NotificationProvider dient zur Anzeige und Steuerung von Notifications
Der NotificationProvider dient zur Anzeige und Steuerung von Notifications.
---

<LiveCodeEditor editorDisabled />
13 changes: 4 additions & 9 deletions apps/docs/src/content/03-components/status/notification-provider/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,25 @@
# Initialisierung

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

<LiveCodeEditor example="provider" />

---

# Notifications anzeigen

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

<LiveCodeEditor />

# Auto close

Ist das Property `autoClose` gesetzt, verschwinden die Notifications nach 10
Sekunden.
Ist das Property `autoClose` gesetzt, verschwinden die Notifications nach 10 Sekunden.

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

# Manuelles Schließen

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

<LiveCodeEditor example="closeById" editorCollapsed />