<FigJam />

View as Markdown

---

Added in eventcatalog@2.34.6

The <FigJam /> component renders a FigJam diagram in your documentation.

Support

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

Usage

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

Basic Example

---
#event frontmatter
---

<FigJam url="{embed_url_from_figjam}" />

Output example in EventCatalog

Props

Name	Type	Default	Required	Description
url	string		Yes	The embed URL of the FigJam diagram. To get the URL, click "Shared", "Get embed code", then copy the URL from the iframe.