Miro Web SDK reference
The Miro Web SDK is based on the following core concepts:
Combine these concepts to create Miro apps.
Check the Miro Web SDK tutorials, and explore our repository with Miro App Examples.
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.
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!'});
Updated about 13 hours ago
Did this page help you?