<Miro />

View as Markdown

---

Added in eventcatalog@2.33.4

The <Miro /> component renders a Miro board in your documentation.

Each Miro board embedded can also be loaded in a full screen mode, letting your teams edit the board live (view demo).

Support

The <Miro /> component is supported in domains, services, all messages and custom documentation.

Usage

1. Include the <Miro /> component inside the markdown
   • e.g /events/MyEvent/index.mdx

Basic Example

---
#event frontmatter
---

<Miro boardId="uXjVIHCImos=/" edit={false} />

Example with edit enabled and scroll to default widget in Miro

---
#event frontmatter
---

<Miro boardId="uXjVIHCImos=/" moveToWidget="3074457347671667709" edit={false} />

Output example in EventCatalog

• Example: View demo in a domain page
• Example: View demo in custom documentation page
• Example: View demo of screen Miro board in EventCatalog

Props

Name	Type	Default	Required	Description
boardId	string		Yes	The ID of the Miro board to embed. (miro docs)
edit	boolean	false	No	Whether to enable edit mode for the Miro board.
moveToViewport	string		No	The ID of the widget to scroll to. (miro docs)
moveToWidget	string		No	The ID of the widget to scroll to. (miro docs)
height	string	500	No	The height of the Miro board.
title	string		No	The title of the Miro board.
autoplay	boolean	true	No	Whether to skip the preloader of the miro board. (miro docs)