Edit

Share via

DialogUIOptions interface

  • Reference
Package:
@ms-fabric/workload-client

An interface representing configurable options available for an workload dialog

Properties

hasCloseButton

Whether the dialog has a close button on the upper right corner. If isBlocking is set to true, it is recommended to set this property to true.
height

Height of the dialog.

If type of the value is number, it will be treated as px value. If type of the value is string, it will be used directly.
isBlocking

A concept borrowed from fluent ui. See blocking dialog example here https://developer.microsoft.com/en-us/fluentui#/controls/web/dialog
isTransparent

Whether set transparent background to dialog iframe. Use it with caution. It's a workaround to show overlay outside small dialog, but it could break user experience with other dialog options.
width

Width of the dialog.

If type of the value is number, it will be treated as px value. If type of the value is string, it will be used directly.

Property Details

hasCloseButton

Whether the dialog has a close button on the upper right corner. If isBlocking is set to true, it is recommended to set this property to true.

hasCloseButton?: boolean

Property Value

boolean

height

Height of the dialog.

If type of the value is number, it will be treated as px value. If type of the value is string, it will be used directly.

height?: string | number

Property Value

string | number

isBlocking

A concept borrowed from fluent ui. See blocking dialog example here https://developer.microsoft.com/en-us/fluentui#/controls/web/dialog

isBlocking?: boolean

Property Value

boolean

isTransparent

Whether set transparent background to dialog iframe. Use it with caution. It's a workaround to show overlay outside small dialog, but it could break user experience with other dialog options.

isTransparent?: boolean

Property Value

boolean

width

Width of the dialog.

If type of the value is number, it will be treated as px value. If type of the value is string, it will be used directly.

width?: string | number

Property Value

string | number