Skip to main content
Version: Version 3.0 ๐Ÿšง

UI Viewport Dialog Service


This is a new UI service, that creates a modal inside the viewport.

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"][ux-article]


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][interface]

API MemberDescription
create()Creates a new Dialog that is displayed until dismissed
dismiss()Dismisses the specified dialog
dismissAll()Dismisses all dialogs


[ViewportDialogProvider]Baked into Dialog Provider

* - Denotes maintained by OHIF


const DEFAULT_STATE = {  viewportIndex: null,  message: undefined,  type: 'info', // "error" | "warning" | "info" | "success"  actions: undefined, // array of { type, text, value }  onSubmit: () => {    console.log('btn value?');  },  onOutsideClick: () => {    console.warn('default: onOutsideClick')  },  onDismiss: () => {    console.log('dismiss? -1');  },};