Tools

Methods

getTool

() => Promise<ToolType>

🚦 Rate limit: Level 1

Experimental

Getting current tool

Use this method to retrieve the currently selected tool on a Miro board.

await miro.board.experimental.tools.getTool()
// 'CURSOR'

setTool

(tool: ToolType) => Promise<void>

🚦 Rate limit: Level 1

Experimental

Setting tool

Use this method to set a tool on a Miro board.

await miro.board.experimental.tools.setTool('HIGHLIGHTER')
// Check your cursor in Miro board now

Supported tools:

• COMMENT
• CURSOR
• ERASER
• HAND
• HIGHLIGHTER
• PEN
• STICKER
• TEXT

All properties

() => Promise<ToolType>

(tool: ToolType) => Promise<void>