Skip to main content

<Attachments />

Added in eventcatalog@2.57.2

The Attachments component allows you to link related documents, diagrams, and resources to any EventCatalog resource. This is perfect for connecting Architecture Decision Records (ADRs), design documents, external diagrams, or any other relevant documentation.

Attachments can be a url (string) or an object with additional properties.

Support​

The <Attachments /> component is supported in all EventCatalog resources, and custom documentation pages.

Usage​

Here we have a domain with two attachments, one is a simple url and the other is an object with additional properties.

domains/E-Commerce/index.mdx
---
id: E-Commerce
name: E-Commerce Domain
attachments:
  - https://example.com/adr/001-microservices-architecture
  - url: https://example.com/adr/001
    title: ADR-001 - Use Kafka for asynchronous messaging
    description: Learn more about why we chose Kafka for asynchronous messaging in this architecture decision record.
    type: 'architecture-decisions'
    icon: FileTextIcon
---

## Domain Overview

This domain handles all e-commerce operations.

<Attachments />

Output example in EventCatalog​

Example output

Props​

NameTypeDefaultDescription
title (optional)string(empty)Title to render in your attachments block
description (optional)string(empty)Any additional description to render in your attachments block