TrizTech/ohif-viewer
17
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
f5ecc753f7
ohif-viewer/docs/latest/services/ui/ui-notification-service.md
Alireza 5643f8f6d2
feat: Added documentation for OHIF-v3 (#2450) 
* Added docs with new screenshots

* Added doc to architecture

* Added documentations to various extension modules

* Added more documentation to modes

* Added docs to managers

* Added docs for services

* Fixed deployment docs

* Added white labelling documentation

* Added i18n docs and measurement export
2021-06-15 11:15:29 -04:00

2.3 KiB
Raw Blame History

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"

## 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.