Files
ohif-viewer/docs/latest/services/ui/ui-dialog-service.md
T
Danny Brown a2c4161477 docs: services (#1255)
* 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
2019-12-05 15:47:46 -05:00

1.9 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"

UI Dialog Service Example
GIF showing successful call of UIDialogService 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
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.