Class DialogService

constructor

• new DialogService(eventTarget: EventTargetOrCommChannel): DialogService

  Create a service for the specific worker

  Parameters

  • eventTarget: EventTargetOrCommChannel

  Returns DialogService

ReadonlyeventTarget

closeCustomDialogById

• closeCustomDialogById(id: string): Promise<void>

  Close a Custom Webcomponent Dialog

  Parameters

  • id: string

    The id of the dialog to close

  Returns Promise<void>

openConfirmCancelDialog

• openConfirmCancelDialog(
      title: string,
      text: string,
      icon: string,
      confirmText?: string,
      confirmIcon?: string,
      cancelText?: string,
  ): Promise<CloseDialog<never>>

  Open a Confirmation Dialog with a single dismiss button.

  Parameters

  • title: string

    Dialog title

  • text: string

    Dialog message

  • icon: string

    Dialog icon. It can be 'info', 'warning', 'error', or other icon strings.

  • OptionalconfirmText: string

    Optional. Text for confirm button. Default to 'Confirm'.

  • OptionalconfirmIcon: string

    Optional. Icon for confirm button. Default to no icon.

  • OptionalcancelText: string

    Optional. Text for cancel button. Default to 'Go Back'.

  Returns Promise<CloseDialog<never>>

openConfirmDialog

• openConfirmDialog(
      title: string,
      text: string,
      icon: string,
      confirmText?: string,
      confirmIcon?: string,
  ): Promise<CloseDialog<never>>

  Open a Confirmation Dialog with a single dismiss button.

  Parameters

  • title: string

    Dialog title

  • text: string

    Dialog message

  • icon: string

    Dialog icon. It can be 'info', 'warning', 'error', or other icon strings.

  • OptionalconfirmText: string

    Optional. Text for confirm button. Default to 'OK'.

  • OptionalconfirmIcon: string

    Optional. icon for confirm button. Default to no icon.

  Returns Promise<CloseDialog<never>>

openCustomDialog

• openCustomDialog<ParamType = any, ReturnType = ParamType>(
      componentTag: string,
      initialData: ParamType,
      options?: GenericDialogOptions,
  ): Promise<CloseDialog<ReturnType>>

  Open a Custom Webcomponent Dialog

  Type Parameters

  • ParamType = any
  • ReturnType = ParamType

  Parameters

  • componentTag: string

    The tagname of the webcomponent to render in the dialog

  • initialData: ParamType

    The initial data to be passed to the dialog component upon opening

  • Optionaloptions: GenericDialogOptions

  Returns Promise<CloseDialog<ReturnType>>

openCustomDialogNoWait

• openCustomDialogNoWait<ParamType = any>(
      componentTag: string,
      initialData: ParamType,
      options?: GenericDialogOptions,
  ): Promise<string>

  Open a Custom Webcomponent Dialog without waiting for user to close

  Type Parameters

  • ParamType = any

  Parameters

  • componentTag: string

    The tagname of the webcomponent to render in the dialog

  • initialData: ParamType

    The initial data to be passed to the dialog component upon opening

  • Optionaloptions: GenericDialogOptions

  Returns Promise<string>

  The id of the dialog