How to make a sidebar plugin, rather than a pop-up plugin

  • 26 July 2022
  • 5 replies
  • 41 views

Badge +1

Hey all, I’m working on developing a Miro plugin and would like to find out how I can make my plugin take up the sidebar, rather than opening up as a pop-up. I’ve attached a screenshot of the difference between the sidebar and pop-up plugins which I am referring to (Let me know if there is a correct way to name these!).

 

The documentation only has openPanel and openModal which do not work for me. Any help would be much appreciated! 

 

Cheers!

 

 

BoardUI Documentation
Sidebar Plugin
Pop-up Plugin

 


5 replies

Userlevel 7
Badge +11

@Joseph Low - It looks like Clusterizer is still using SDK 1.0. According to the following documentation, openLeftSidebar has been removed in 2.0:

https://developers.miro.com/docs/web-sdk-comparison-guide#modals

 

Userlevel 5
Badge +1

Hi, 

 

Robert is right, in the new version of SDK (v2), we only support 2 extension points for the moment:

  • The app panel that you can open using openPanel. It opens on the right on the side bar and you can control its height. 
  • A modal view openModal that you can fully configure

 

More information here.

 

I would be interested to understand why the app panel doesn’t fit your need and why the leftSideBar is a better fit for your need.

 

Userlevel 7
Badge +11

A benefit of Panel over LeftSidebar:

 

Badge +1

I see . So the only way for me to make my plugin on the left sidebar is to downgrade to SDK V1?

 

I do prefer the left sidebar as it does not obstruct what is on the user’s board. Our plugin requires a fair bit of back-and-forth interaction between selecting things on the Miro board and interacting with the plugin.

 

For openPanel, our users tend to accidentally close the plugin (causing the plugin state to reset), and the openModal is not suited for our needs as the user still needs to select items on the board while the plugin is open.

Userlevel 7
Badge +11

@Joseph Low

I do prefer the left sidebar as it does not obstruct what is on the user’s board.

From my tests, both the SDK 1.0 and 2.0 Sidebar and Panel do temporarily obstruct the board’s content:

 

Looking at the SDK documentation, you may be able minimize the obstruction by panning/resizing the board using the Viewport property?

https://developers.miro.com/docs/viewport_viewport

For openPanel, our users tend to accidentally close the plugin (causing the plugin state to reset), and the openModal is not suited for our needs as the user still needs to select items on the board while the plugin is open.

Do you have an example of how exactly users are doing this? Are they accidentally clicking on the “X”?

Reply