Options
All
  • Public
  • Public/Protected
  • All
Menu

joplin.views.dialogs

Allows creating and managing dialogs. A dialog is modal window that contains a webview and a row of buttons. You can update the update the webview using the setHtml method. Dialogs are hidden by default and you need to call open() to open them. Once the user clicks on a button, the open call will return and provide the button ID that was clicked on. There is currently no "close" method since the dialog should be thought as a modal one and thus can only be closed by clicking on one of the buttons.

View the demo plugin

Index

Methods

create

  • Creates a new dialog

open

setButtons

setHtml

  • setHtml(handle: ViewHandle, html: string): Promise<string>
  • Sets the dialog HTML content

    Parameters

showMessageBox

  • showMessageBox(message: string): Promise<number>
  • Displays a message box with OK/Cancel buttons. Returns the button index that was clicked - "0" for OK and "1" for "Cancel"

    Parameters

    • message: string