Creating an Event for Menus on Canvas Items

aarongilly · July 20, 2024, 4:49pm

I’m trying to add a menu item to the context menu that shows when a user right-clicks on a Canvas edge and one when the user right-clicks on a Canvas node (that’s not a file node). The Obsidian.d.ts file shows the list of available events my plugin can subscribe to. None of these options are dispatched when the user right-clicks on an edge or a non-file node.

Is it possible to add menu items to the canvas menu?

Example use case:
I’m working on the Semantic Canvas plugin and would like to make the following possible:

Right click on an edge & have a menu option to delete the corresponding property from notes that link to the edge.
Right click on a node & have a menu option to pull properties from that node to the canvas

The Advanced Canvas plugin is editing the pop-up menu to include options there, which is similar, but doesn’t use Obsidian’s events API, instead using its own custom event handling logic that’s way more involved (and impressive, admittedly).

aarongilly · July 20, 2024, 6:12pm

Also I want it to work for mobile. Which I don’t believe the advanced canvas method supports based on some quick testing.

the_tree · July 21, 2024, 1:19am

I guess you can use this event, just like “editor-menu” event of workspace：

Argumnet e is the menu instance and this is the edge you right click.

github.com

guopenghui/obsidian-language-learner/blob/0b6839b7cb9df6ca332e6495dd68065a3dc0e267/src/plugin.ts#L494-L504


      
          this.registerEvent(
              this.app.workspace.on(
                  "editor-menu",
                  (menu: Menu, editor: Editor, view: MarkdownView) => {
                      let selection = editor.getSelection();
                      if (selection || selection.trim().length === selection.length) {
                          addMemu(menu, selection);
                      }
                  }
              )
          );

aarongilly · July 21, 2024, 4:10am

I may be looking in the wrong place, but I’m not seeing mention of “Canvas” anywhere in the link you sent. The snippet of code referencing canvas:edge-menu doesn’t work for me, unfortunately. There just isn’t a “canvas:edge-menu” option - or any “canvas” options for that matter.

the_tree · July 21, 2024, 5:20am

The full code is like this:

aarongilly · July 23, 2024, 3:40am

HOLY CATS! That’s perfect! I have no idea how you knew to use “canvas:edge-menu”, as that’s not in the d.ts file that I’m seeing, but it works! Thank you The_Tree!

the_tree · July 23, 2024, 7:32am

Adding a menu item in editor is to use workspace.on("editor-menu"), so I guess adding a menu item of canvas edge is similar. Then I tried to search edge-menu in app.js (obsidian’s source code in devtools)

system · August 20, 2024, 7:33am

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