🔍 Overview

This update add an optional attribute to the toolbar.addButton() API so that we can conditionally hide the shortcut showing up in the title.

Although for most cases, showing the shortcut in the title is fine. For complex uses of toolbar.addButton where it triggers a menu, it isn't ideal. For example, in Discourse AI, the toolbar API is used to show a menu for the AI composer helper. The shortcut in the API is used to trigger the proofreading item, but not necessarily for all other items. As such, we want the shortcut hidden in the title.

🛠️ Usage

        withPluginApi((api) => {
          api.onToolbarCreate((toolbar) => {
            toolbar.addButton({
              id: "smile",
              group: "extras",
              name: "smile",
              icon: "far-face-smile",
              title: "cheese",
              shortcut: "ALT+S",
+              hideShortcutInTitle: true,
            });
          });
        });

← Before

Title shows:

Cheese (Ctrl + Alt + S)

→ After

Title shows:

Cheese