@jentic/arazzo-ui

@jentic/arazzo-ui is a UI component for visualizing Arazzo Specification workflows. It provides interactive diagram views, documentation views, and a split view combining both.

Load any Arazzo Document by appending a ?document= query parameter:

https://arazzo-ui.jentic.com?document=https://arazzo-ui.jentic.com/petstore-order-workflow.arazzo.yaml

Supported Arazzo versions:

• Arazzo 1.0.0
• Arazzo 1.0.1

Installation

You can install this package via npm CLI by running the following command:

npm install @jentic/arazzo-ui

Peer dependencies: React 18 or 19 (react and react-dom).

CLI

Open any Arazzo document in the browser without installing anything locally:

# from a URL
npx @jentic/arazzo-ui https://arazzo-ui.jentic.com/petstore-order-workflow.arazzo.yaml

# from a local file
npx @jentic/arazzo-ui ./workflow.arazzo.yaml

This opens https://arazzo-ui.jentic.com with the document pre-loaded. Local files are passed via the URL fragment (#document=), so the document content is never sent to the server. The resulting URL is also shareable if the workflow size is not too large.

Components

ArazzoUI

Headless viewer controlled entirely via props. Use this when you need full control over the surrounding layout and view switching.

import { useState } from 'react';
import { ArazzoUI } from '@jentic/arazzo-ui';
import '@jentic/arazzo-ui/styles.css';

function App() {
  const [view, setView] = useState('split');

  return (
    <ArazzoUI
      document="https://example.com/workflow.arazzo.yaml"
      view={view}
      onViewChange={setView}
    />
  );
}

ArazzoUIStandalone

Self-contained viewer with a built-in header including the Jentic logo, a URL input for loading documents, and a view mode toggle. Use this for a drop-in widget that works without any external UI.

import { ArazzoUIStandalone } from '@jentic/arazzo-ui/standalone';
import '@jentic/arazzo-ui/styles.css';

function App() {
  return (
    <ArazzoUIStandalone
      document="https://example.com/workflow.arazzo.yaml"
      initialView="docs"
    />
  );
}

UMD (script tag)

Both components are available as UMD builds that bundle all dependencies into a single file and expose an imperative API. Build artifacts are located in ./dist/:

ArazzoUI

<link rel="stylesheet" href="dist/arazzo-ui.css" />
<div id="root"></div>
<script src="dist/arazzo-ui.js"></script>
<script>
  const ui = ArazzoUI({
    dom_id: '#root',
    document: 'https://example.com/workflow.arazzo.yaml',
    view: 'split',
  });

  // ui.getRef()   — access the imperative ref API
  // ui.unmount()  — remove the component from the DOM
</script>

ArazzoUIStandalone

<link rel="stylesheet" href="dist/arazzo-ui.css" />
<div id="root"></div>
<script src="dist/arazzo-ui-standalone.js"></script>
<script>
  const ui = ArazzoUIStandalone({
    dom_id: '#root',
    document: 'https://example.com/workflow.arazzo.yaml',
  });

  // ui.getRef()   — access the imperative ref API
  // ui.unmount()  — remove the component from the DOM
</script>

Document sources

The document prop accepts multiple input types:

1. URL string — fetches and parses a remote Arazzo document (JSON or YAML)
2. String content — parses inline Arazzo JSON or YAML
3. ArazzoDocument object — uses the document directly

// From URL
<ArazzoUI document="https://example.com/workflow.arazzo.yaml" view="docs" />

// From inline YAML string
<ArazzoUI document={yamlString} view="docs" />

// From object
<ArazzoUI document={arazzoDocumentObject} view="docs" />

When the document is a URL, it is displayed below the title in the docs view.

View modes

The view prop (or initialView for standalone) controls the display:

In split view, clicking a step node in the diagram expands the workflow and scrolls to that step in the docs pane. Switching workflow tabs in the diagram scrolls to the corresponding workflow in docs.

Props

ArazzoUIProps

ArazzoUIStandaloneProps

Inherits all ArazzoUIProps except view, plus:

Ref API

Both components expose an imperative API via React ref:

const ref = useRef(null);

<ArazzoUI ref={ref} document={doc} view="diagram" />

// Later:
ref.current.fitView();
ref.current.setZoom(1.5);
ref.current.setActiveWorkflow('myWorkflow');
ref.current.selectStep('step1');
ref.current.clearSelection();
ref.current.getDocument();
ref.current.getActiveWorkflowId();
ref.current.getSelectedStepId();