Skip to main content

<MessageTable />

Added in eventcatalog@2.26.0

The <MessageTable/> component renders a table of messages for a service or domain in EventCatalog.

The component renders a paginated table of messages, with the ability to filter by message type (event, command, query), and text search.

Use case​

  • Display all the messages that a service sends and receives.
  • Display all the messages that a domain sends and receives.
    • These are all messages that are sent and received in child services of the domain.

Support​

The <MessageTable/> component is supported in domains and services.

Usage​

  1. Include the <MessageTable/> component inside the markdown
    • e.g /domains/MyDomain/index.mdx

Basic Example

---
#domain frontmatter
---

<MessageTable limit={10} showChannels={true} />

Output example in EventCatalog​

Example output

See the demo for a full example.

Props​

NameTypeDefaultDescription
formatstring'all'Which messages to render. all will render messages that are sent and received. sends will render messages that are sent and receives will render messages that are received.
limitnumber10The number of messages to render in the table. Results are paginated.
showChannelsbooleantrueWhether to show the channel information in the table for each message.