self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2025-06-27 23:28:38 +02:00
Code Issues Releases Activity

Plugins: Allow retrieving form values from dialogs

Browse Source
This commit is contained in:
Laurent Cozic
2020-11-13 18:48:42 +00:00
parent 72472c13c5
commit a647272cf0
7 changed files with 77 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
packages/lib/services/plugins/api/JoplinViewsDialogs.ts
View File

@ -1,12 +1,13 @@
import Plugin from '../Plugin';
import createViewHandle from '../utils/createViewHandle';
import WebviewController, { ContainerType } from '../WebviewController';
import { ButtonSpec, ViewHandle, ButtonId } from './types';
import { ButtonSpec, ViewHandle, DialogResult } from './types';
/**
* 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.
* 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 an object indicating what button was clicked
* on. If your HTML content included one or more form, a `formData` object will also be included with the key/value for each form.
* 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](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/dialog)
*/
@ -61,7 +62,7 @@ export default class JoplinViewsDialogs {
/**
* Opens the dialog
*/
async open(handle: ViewHandle): Promise<ButtonId> {
async open(handle: ViewHandle): Promise<DialogResult> {
return this.controller(handle).open();
}

5
packages/lib/services/plugins/api/types.ts
View File

@ -261,6 +261,11 @@ export interface EditorCommand {
value?: any;
}
export interface DialogResult {
id: ButtonId;
formData?: any;
}
// =================================================================
// Settings types
// =================================================================