<ResourceLink />
Added in
eventcatalog@2.32.3
The <ResourceLink/>
component renders a link to a resource in EventCatalog.
Support
The <ResourceLink/>
component is supported on all EventCatalog pages.
Usage
- Include the
<ResourceLink/>
component inside the markdown- e.g
/domains/MyDomain/index.mdx
- e.g
Basic Example
---
#domain frontmatter
---
<!-- No version specified, so the latest version is used -->
<ResourceLink id="InventoryService" type="service" />
<!-- Specifying a version, will link to that version of the resource -->
<ResourceLink id="InventoryService" type="service" version="1.0.0" />
<!-- Specifying a child element will render that element as the link text -->
<ResourceLink id="InventoryService" type="service">This is a custom link</ResourceLink>
Props
Name | Type | Default | Required | Description |
---|---|---|---|---|
id | string | none | Yes | Id of the resource group to render. |
type | string | none | Yes | The type of resource to render (service, event, query, command, channel, flow, domain, user, team) |
version | string | none | Optional. The version of the resource to render, by default the latest version is used. | Version of the resource to link to. |