Add Toast Notifications API for Plugin Developers

Features
1

Summary

Request the addition of a toast notification API to allow plugin developers to notify users of completed actions in a non-intrusive manner.

Motivation

Toast notifications provide timely and unobtrusive feedback. For example, my plugin summarizes notes using LLMs, and it would be useful to show a toast message like "Summary completed" upon task completion.

Proposed Solution

Add an API method for plugins to trigger toast notifications with customizable options for message content, duration, and position.

Benefits

  • User Experience: Provides immediate, non-disruptive feedback.
  • Plugin Functionality: Enhances interactivity and responsiveness.
  • Consistent UI/UX: Ensures uniform notification design across the app.

Example Use Case

joplin.plugins.on("noteSummarized", async (summary) => {
    joplin.notifications.showToast({
        type: 'success',
        message: 'Summary completed!',
        duration: 3000,
        position: 'top-right'
    });
});

Conclusion

Adding toast notifications will improve Joplin's usability and interactivity. This feature will be valuable for enhancing user experiences through plugins.

Thank you for considering this request.

5 Likes
2

Thanks for writing the detailed spec. It will be available from the next version with this API:

5 Likes