Skip to main content
⭐️ If you love EventCatalog, give it a star on GitHub. Thanks!

<Accordion />

The accordion component renders collapsable section in EventCatalog.

Support

The <Accordion/> component is supported in domains, services, and all messages.

Usage

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

Basic Example

---
#event frontmatter
---

<Accordion title="Learn how to raise this event">
This will be rendered as a child inside a collapsible section.
</Accordion>

Example with code as child

---
#event frontmatter
---

<Accordion title="Learn how to raise this event">
You can run the following command to raise this event.

```sh
bin/kafka-topics.sh --create --topic OrderAmended --bootstrap-server localhost:9092 --partitions 1 --replication-factor 1
``
</Accordion>

Output example in EventCatalog

Example output

Props

NameTypeDefaultDescription
title (required)string(empty)Title to render in your accordion block
childrenstring(empty)Content that goes inside your accordion