Danny Brown
a2c4161477
* docs: process docs to include UX Stories requirement * docs: include note regarding different environments * Services init * Remove unused canny logos * docs: add ModalService diagram * docs: GIF of notification * docs: add ui-services page * docs: simplify ui services call out in the general services docs * docs: tips and tricks for UI services * docs: moar pages * docs: dialog gif * docs: services in summary/sidebar * docs: gif examples at top of dialog and notification pages * docs: add UIModal gif * docs: details for Dialog Service * docs: include usage information for ui modal service * docs: detailed information about our UI Notification Service * docs: services diagram * docs: remove unused links * docs: services example and image
2.2 KiB
2.2 KiB
UI Notification Service
Notifications can be annoying and disruptive. They can also deliver timely helpful information, or expedite the user's workflow. Here is some high level guidance on when and how to use them:
- Notifications should be non-interfering (timely, relevant, important)
- We should only show small/brief notifications
- Notifications should be contextual to current behavior/actions
- Notifications can serve warnings (acting as a confirmation)
If you're curious about the DOs and DON'Ts of notifications, check out this article: "How To Design Notifications For Better UX"
GIF showing successful call of UINotificationService from an extension.
Interface
For a more detailed look on the options and return values each of these methods
is expected to support, check out it's interface in @ohif/core
| API Member | Description |
|---|---|
hide() |
Hides the specified notification |
show() |
Creates and displays a new notification |
Implementations
| Implementation | Consumer |
|---|---|
| Snackbar Provider* | SnackbarContainer* |
* - Denotes maintained by OHIF
3rd Party implementers may be added to this table via pull requests.