The Joplin plugin API should consider adding a function similar to `vscode.window.withProgress`

rxliuli · 2024-05-31T10:04:14.713Z

Currently, while developing a Joplin plugin, I have some time-consuming operations, and I would like an API to display a progress bar indicating ongoing processing. The API could be similar to the one in the VS Code plugin API. Reference: vscode.window.withProgress.

Of course, I can always open an HTML view to implement this progress bar, but it would be much better if there were a native API that I could directly call.

laurent · 2024-05-31T16:52:44.985Z

I can't seem to find any screenshot of this API. Do you know how and where in the UI it's displayed in VSCode?

rxliuli · 2024-06-01T08:02:13.532Z

vscode.commands.registerCommand('joplin.test', async () => {
  await vscode.window.withProgress(
    {
      title: 'Test',
      location: vscode.ProgressLocation.Notification,
    },
    async (process) => {
      for (let i = 1; i <= 10; i++) {
        process.report({ increment: 1, message: `Processing ${i}` })
        await new Promise((resolve) => setTimeout(resolve, 1000))
      }
    },
  )
})

@laurent

laurent · 2024-06-01T11:46:39.182Z

Thanks, I think it would be useful to have this API. I've added an issue about it here:

github.com/laurent22/joplin

Implement a plugin API to display a progress bar

opened 11:46AM - 01 Jun 24 UTC

laurent22

enhancement plugins medium

Like in VSCode Ref: https://discourse.joplinapp.org/t/the-joplin-plugin-api-s…hould-consider-adding-a-function-similar-to-vscode-window-withprogress/38362/3?u=laurent ```ts vscode.commands.registerCommand('joplin.test', async () => { await vscode.window.withProgress( { title: 'Test', location: vscode.ProgressLocation.Notification, }, async (process) => { for (let i = 1; i <= 10; i++) { process.report({ increment: 1, message: `Processing ${i}` }) await new Promise((resolve) => setTimeout(resolve, 1000)) } }, ) }) ``` ![Kapture 2024-06-01 at 16.00.20|video](upload://cMK72NYI0QcEIf6pXyzqE9uN9dd.mp4)