Skip to main content

Details Panel

Added in eventcatalog@2.53.0

The details panel is the panel that is rendered on the domains, services, messages, flows and entities pages. (right side of the page).

Using the detailsPanel property in your documentation page frontmatter, you can show or hide items in the details panel.

By default, all items in the details panel are shown.

Example

You can show or hide items in the application sidebar by using the sidebar property in your eventcatalog.config.js file.

Example​

You can hide properties in the details panel by using the detailsPanel property in your documentation page frontmatter.

Setting visible to false will hide the item from the details panel.

Each page has it's own detailsPanel property and configuration (see below for examples).

Example /domains/MyDomain/index.mdx
---
  id: 'my-domain'
  title: 'My Domain'
  detailsPanel:
    services:
      visible: false
    entities:
      visible: true
    messages:
      visible: false
    ubiquitousLanguage:
      visible: false
---

You can configure the details panel for the following resources: