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

Plugins: Allow posting messages from plugin to webview (#5569)

Browse Source
This commit is contained in:
agerardin
2021-11-09 10:50:50 -05:00
committed by GitHub
parent 200ba858dd
commit 6b31609338
8 changed files with 126 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
packages/lib/services/plugins/api/JoplinViewsPanels.ts
View File

@ -44,14 +44,14 @@ export default class JoplinViewsPanels {
/**
* Sets the panel webview HTML
*/
public async setHtml(handle: ViewHandle, html: string) {
public async setHtml(handle: ViewHandle, html: string): Promise<string> {
return this.controller(handle).html = html;
}
/**
* Adds and loads a new JS or CSS files into the panel.
*/
public async addScript(handle: ViewHandle, scriptPath: string) {
public async addScript(handle: ViewHandle, scriptPath: string): Promise<void> {
return this.controller(handle).addScript(scriptPath);
}
@ -74,10 +74,30 @@ export default class JoplinViewsPanels {
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages) for more details.
*
*/
public async onMessage(handle: ViewHandle, callback: Function) {
public async onMessage(handle: ViewHandle, callback: Function): Promise<void> {
return this.controller(handle).onMessage(callback);
}
/**
* Sends a message to the webview.
*
* The webview must have registered a message handler prior, otherwise the message is ignored. Use;
*
* ```javascript
* webviewApi.onMessage((message) => { ... });
* ```
*
* - `message` can be any JavaScript object, string or number
*
* The view API may have only one onMessage handler defined.
* This method is fire and forget so no response is returned.
*
* It is particularly useful when the webview needs to react to events emitted by the plugin or the joplin api.
*/
public postMessage(handle: ViewHandle, message: any): void {
return this.controller(handle).postMessage(message);
}
/**
* Shows the panel
*/