title: UI Documents Example description: Example demonstrating Studio document rendering — MessageDocument, ErrorDocument, MarkdownDocument, PlainDocument from a single workflow

@loopstack/test-ui-documents-example-workflow

Demonstrates core Studio document rendering by emitting message, error, markdown, and plain-text documents from a single workflow.

By using this example you'll get...

• A compact workflow for UI/document smoke testing
• Real examples of MessageDocument, ErrorDocument, MarkdownDocument, and PlainDocument
• A quick baseline for validating custom Studio document rendering behavior

Installation

npm install @loopstack/test-ui-documents-example-workflow

Then register the module in your app:

import { StudioApp } from '@loopstack/common';
import { TestUiDocumentsExampleModule, TestUiDocumentsWorkflow } from '@loopstack/test-ui-documents-example-workflow';

@StudioApp({
  title: 'UI Documents Example',
  workflows: [TestUiDocumentsWorkflow],
})
@Module({
  imports: [TestUiDocumentsExampleModule],
})
export class MyAppModule {}

How It Works

1. renderAll saves one document of each core UI type.
2. The workflow transitions to end after writing all documents.
3. Studio displays each document using its corresponding renderer.

Public API

• TestUiDocumentsExampleModule
• TestUiDocumentsWorkflow

Dependencies

• @loopstack/common