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.0 KiB
2.0 KiB
UI Modal Service
Modals have similar characteristics to that of Dialogs, but are often larger, and only allow for a single instance to be viewable at once. They also tend to be centered, and not draggable. They're commonly used 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"
GIF showing successful call of UIModalService 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 open modal |
show() |
Shows the provided content in a modal |
Implementations
| Implementation | Consumer |
|---|---|
| Modal Provider* | OHIFModal* |
* - Denotes maintained by OHIF
3rd Party implementers may be added to this table via pull requests.