Miro Web SDK reference

The Miro Web SDK is based on the following core concepts:

  • Board: the Miro board
  • Items: objects that you can create, add to a board, and interact with.

Miro apps interact with Miro boards and board items to enhance standard functionality.
Check the Miro Web SDK tutorials, and explore our repository with Miro App Examples to explore sample apps that you can use to familiarize yourself with the Miro Web SDK.

Methods

  • For an overview of board methods to create, update, and remove items, as well as get board, item, and user information, see the section on board methods.
  • For an overview of board viewport methods to get, set, and zoom to the viewport, see the section on viewport methods.
  • For an overview of board UI methods to open and close modals and panels, as well as event handling, see the sections on UI methods and on supported events.
  • For an overview of methods to display informational and error notifications on the board UI, see the section on notifications.

Events

  • Use the on property to subscribe to supported events to listen to them and to react to them firing.
  • Use the off property to unsubscribe from supported events, when it's no longer necessary to listen to them.

Items

The following board items are supported:

The Miro Web SDK doesn't yet support all standard Miro board items. We'll gradually introduce full support in future releases.
Board items that the Miro Web SDK doesn't support are grouped under a generic category called Unsupported.

Example

The following example creates a sticky note on a board with the text "Hello, World!":

const {board} = window.miro;

// Create a sticky note on the board
const stickyNote = await board.createStickyNote({content: 'Hello, World!'});

What’s Next

To get familiar with the Web SDK methods, and with board item properties, get inspiration from the Web SDK tutorials.