AsyncAPI Render Engine

Overview

The AsyncAPI render engine is based on the AsyncAPI React component.

Installation

• using npm

  npm i @kyma-project/dc-async-api-render-engine

• using yarn

  yarn add @kyma-project/dc-async-api-render-engine

Configuration

| Name | Required | Type | Default value | Description | | -------- | -------- | --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | | config | No | ConfigInterface | See the default values here. | Defines the configuration of the AsyncAPI React component. | | theme | No | ThemeInterface | See the default values here. | Defines the theme of the AsyncAPI React component. |

NOTE: To learn how to pass options of a render engine, read this document.

Styles

To use default styles based on SAP Fundamentals, import them as follows:

import "@asyncapi/react-component/lib/styles/fiori.css";

To use the default font 72 provided by SAP Fundamentals, install the npm package from this Getting Started guide and import the font as follows:

import "fiori-fundamentals/dist/fonts.min.css";