Docs/Presentations/Chat

Chat

Presentations v1.0 zero-schema

Displays a live text chat backed by a Zero chat-room URL, showing message history and streaming new messages.

Required fields

PresentationType Url

Properties

PresentationType string required

Renders a live text chat backed by an authenticated Zero chat room, showing message history and streaming new messages.

Allowed Chat

Url string required

Chat-room URL, such as /api/chat-rooms/{id}.

Placeholder string optional

Hint text shown in the message composer.

Default "Message"

Height number optional

Height of the message feed and composer in pixels.

ReadOnly boolean optional

When true, hides the composer and shows messages only.

Default false

EmptyText string optional

Text shown when the room has no messages yet.

Default "No messages yet"

{ "$id": "/schema/Presentations/Chat/1.0/index.json", "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "title": "Chat", "description": "Displays a live text chat backed by a Zero chat-room URL, showing message history and streaming new messages.", "required": [ "PresentationType", "Url" ], "properties": { "PresentationType": { "type": "string", "enum": [ "Chat" ], "description": "Renders a live text chat backed by an authenticated Zero chat room, showing message history and streaming new messages." }, "Url": { "type": "string", "description": "Chat-room URL, such as /api/chat-rooms/{id}." }, "Placeholder": { "type": "string", "default": "Message", "description": "Hint text shown in the message composer." }, "Height": { "type": "number", "minimum": 120, "description": "Height of the message feed and composer in pixels." }, "ReadOnly": { "type": "boolean", "default": false, "description": "When true, hides the composer and shows messages only." }, "EmptyText": { "type": "string", "default": "No messages yet", "description": "Text shown when the room has no messages yet." } }, "additionalProperties": true, "x-icon": "<svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"1.7\" stroke-linecap=\"round\" stroke-linejoin=\"round\"><path d=\"M4 5h16v11H9l-5 4z\"/><path d=\"M8 9h8M8 12h5\"/></svg>", "x-family": "Presentations", "x-name": "Chat", "x-version": "1.0", "x-source-package": "zero-schema" }