@threadplane/react/chatInterfacev0.0.0

StatusPanelProps

Unpublished development API. This package is under development and is not available as a published release.

A lead sentence, detail and actions for something the person must read or act on.

View sourceView Markdown
import type { StatusPanelProps } from '@threadplane/react/chat';

Declaration

export interface StatusPanelProps  {
  readonly actions?: ReactNode;
  readonly children?: ReactNode;
  readonly className?: string;
  readonly lead?: ReactNode;
  readonly role?: 'alert' | 'status';
  readonly tone?: StatusPanelTone;
}

Members

actions

Buttons or links shown after the detail. Name the action and its object.

readonly actions?: ReactNode;

children

Detail, in ordinary text.

readonly children?: ReactNode;

className

readonly className?: string;

lead

Short statement ending in a period, such as "Saved."

readonly lead?: ReactNode;

role

Use alert for failures only; receipts and approvals are announced politely by their owner.

readonly role?: 'alert' | 'status';

tone

Defaults to neutral. The lead sentence carries the meaning; colour only reinforces it.

readonly tone?: StatusPanelTone;