AboutSupportDeveloper GuideVersion 34.118.78.63

Popup window options.

Hierarchy

  • PopupOptions

Properties

additionalOptions?: Partial<MutableWindowOptions>

Updatable window options applied to new and existing windows when shown as popups.

blurBehavior?: PopupBlurBehavior

Determines what happens if the popup window is blurred.

  • 'modal' restricts resizing and positioning in the caller.
  • 'hide' hides the popup window on blur.
  • 'close' closes the popup window on blur.

Default Value

'close'

focus?: boolean

Determines if the popup window should or should not be focused when it is shown.

Default Value

true

height?: number

Height of the popup window in pixels (takes priority over intialOptions size properties).

Default Value

300

hideOnClose?: boolean

Hide the popup window instead of closing when close is called on it.

Note: if this is true and blurBehavior and/or resultDispatchBehavior are set to close, the window will be hidden.

Default Value

false

initialOptions?: Optional<WindowCreationOptions, "name">

Window creation options when using showPopupWindow to create a new window.

name?: string

If a window with this name exists, it will be shown as a popup. Otherwise, a new window with this name will be created. If this name is undefined, initialOptions.name will be used. If this name and intialOptions.name are both undefined, a name will be generated.

onPopupReady?: ((popupWindow) => any)

Type declaration

    • (popupWindow): any
    • Executed when the popup window is shown. Provides the popup window to the provided function, and allows for easy access the popup window for additional behavior customization.

      Parameters

      Returns any

onPopupResult?: ((payload) => any)

Type declaration

    • (payload): any
    • Executed when this window's popup calls dispatchPopupResult.

      Note: If this is defined, showPopupWindow will not return a PopupResult.

      Parameters

      Returns any

resultDispatchBehavior?: PopupResultBehavior

Determines what happens when the popup window calls dispatchPopupResult.

  • 'none' will do nothing.
  • 'hide' hides the popup window on dispatchPopupResult.
  • 'close' closes the popup window on dispatchPopupResult.

Default Value

'close'

url?: string

Navigates to this url if showing an existing window as a popup, otherwise the newly created window will load this url.

width?: number

Width of the popup window in pixels (takes priority over intialOptions size properties).

Default Value

300

x?: number

Left position in pixels where the popup window will be shown (relative to the window calling showPopupWindow).

Default Value

0

y?: number

Top position in pixels where the popup window will be shown (relative to the window calling showPopupWindow).

Default Value

0