Where is addToolbarPopupMenuOption?

pfaffman · March 20, 2024, 4:49pm

I was using addToolbarPopupMenuOptionsCallback and got a notice it had been renamed to addToolbarPopupMenuOption , but when I did I call addToolbarPopupMenuOption I get a error that it does not exist.


  addToolbarPopupMenuOptionsCallback(opts) {
    deprecated(
      "`addToolbarPopupMenuOptionsCallback` has been renamed to `addToolbarPopupMenuOption`",
      {
        id: "discourse.add-toolbar-popup-menu-options-callback",
        since: "3.2",
        dropFrom: "3.3",
      }
    );

In GitHub - literatecomputing/discourse-qrcode-theme-component: Add QRcode to composer

david · March 20, 2024, 5:03pm

Looks like we have a typo in the deprecation message. Fix here: DEV: Fix toolbar API deprecation message by davidtaylorhq · Pull Request #26266 · discourse/discourse · GitHub

This is the one you want:

github.com

discourse/discourse/blob/e3cfb1967d531a09b475bba45b33605eabd5a0d8/app/assets/javascripts/discourse/app/lib/plugin-api.gjs#L747-L779


      
          /**
           * Add a new button in the composer's toolbar options popup menu.
           *
           * @callback action
           * @param {Object} toolbarEvent - A toolbar event object.
           * @param {function} toolbarEvent.applySurround - Surrounds the selected text with the given text.
           * @param {function} toolbarEvent.addText - Append the given text to the selected text in the composer.
           *
           * @callback condition
           * @param {Object} composer - The composer service object.
           * @returns {boolean} - Whether the button should be displayed.
           *
           * @param {Object} opts - An Object.
           * @param {string} opts.icon - The name of the FontAwesome icon to display for the button.
           * @param {string} opts.label - The I18n translation key for the button's label.
           * @param {action} opts.action - The action to perform when the button is clicked.
           * @param {condition} opts.condition - A condition that must be met for the button to be displayed.
           *
           * @example
           * api.addComposerToolbarPopupMenuOption({

This file has been truncated. show original

Don · March 20, 2024, 5:06pm

I used addComposerToolbarPopupMenuOption when I changed it in Composer Footnote Button.

pfaffman · March 20, 2024, 5:47pm

Aha! So, it’s not just me. That’s great news, as I’ve spent most of the day trying to figure out things that are, in fact, my fault (but might still stand to have some better documentation). I’ll work on asking cogent questions about those things next.

This is resolved. Thanks so much!

pfaffman · April 19, 2024, 5:48pm

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
Depreciation notice in Spoiler Alert support spoiler-alert	2	208	October 18, 2023
Composer Footnote Button theme-component footnote	2	845	July 26, 2023
Configure button not working for auto-responder bug automation	4	240	July 29, 2023
Composer Help Button plugin	22	8171	November 9, 2023
Show a modal dialog after clicking toolbar button via a plugin dev	5	751	July 3, 2023

Where is addToolbarPopupMenuOption?

Related Topics