These docs are for v1.0. Click to read the latest docs for v2.0.

How to use extension points

Extension point — is a place in product where web-plugins can render user interface.

Miro provides two types of extension points:

  • Custom view to render custom HTML in a container;
  • Button extension points to add a button.

Custom view:

  • LeftSidebar;
  • Library;
  • BottomPanel;
  • ModalWindow.

Button extension points:

  • toolbar;
  • bottomBar;
  • exportMenu;
  • widgetContextMenu.

Custom view. LeftSidebar.


Use it for collaborative plugins, data search, automatization. Don’t use it for adding widgets to canvas.
LeftSidebar fixed width = 340px.

Custom view. Library.


The library contains materials that you can drag & drop to the canvas.

Don’t use the library for other use-cases.

Custom view. BottomPanel.


You can add up to 5 simple controls to the BottomPanel that don't take too much space and are needed right in action.
Don’t use it for alerts.

You can change BottomPanel width up to 320px and height up to 200px.

Custom view. ModalWindow.


Use it for dialogs, that require user decision.

Or fill out modal window with content, for example: jira tasks picker.

ModalWindow has max width and height = 80%.

Button extension points. toolbar and bottomBar.


toolbar contains content sources for canvas, for example: icon library, wireframing library, templates, etc.

bottomBar contains either collaboration plugins, like chat, or another way to represent content, like presentation mode.

Don’t use them for other use-cases.

Button extension point. exportMenu.


Use it for export options.
Don’t use it for other use-cases.

Button extension point. widgetContextMenu.


All buttons will be added to the right side of the toolbar. You can only choose the number of the buttons, but can not change their location.

Use it to add options that affect selected element(s).
Don’t use it for options, that affect unselected elements.