ohif-viewer/docs/latest/services/ui/ui-dialog-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

1.7 KiB

UI Dialog Service

Dialogs have similar characteristics to that of Modals, but often with a streamlined focus. They can be helpful when:

  • We need to grab the user's attention
  • We need user input
  • We need to show additional information

If you're curious about the DOs and DON'Ts of dialogs and modals, check out this article: "Best Practices for Modals / Overlays / Dialog Windows"

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
create() Creates a new Dialog that is displayed until dismissed
dismiss() Dismisses the specified dialog
dismissAll() Dismisses all dialogs

Implementations

Implementation Consumer
Dialog Provider* Baked into Dialog Provider

* - Denotes maintained by OHIF

3rd Party implementers may be added to this table via pull requests.