Banner

Page-level notice banner with an action link. The app-register sibling of the documentation Callout: sans, stateful, actionable.

Prop	Type	Notes
`state`	`string`	Workflow state (queued/running/needs-input/needs-review/failed) or outcome tone (info/success/warning). snake_case accepted.
`action`	`React.ReactNode`	Action link or button, rendered at the end.
`live`	`boolean`	role="status" announcement (default true).
`className`	`string`
`children`	`React.ReactNode`

Other props pass through to the root element (React.HTMLAttributes<HTMLDivElement>).

Preview

Declarations

TypeScript

export interface BannerProps extends React.HTMLAttributes<HTMLDivElement> {
  /** Workflow state (queued/running/needs-input/needs-review/failed) or
   *  outcome tone (info/success/warning). snake_case accepted. */
  state?: string;
  /** Action link or button, rendered at the end. */
  action?: React.ReactNode;
  /** role="status" announcement (default true). */
  live?: boolean;
  className?: string;
  children?: React.ReactNode;
}

/**
 * Page-level notice banner with an action link. The app-register sibling of
 * the documentation Callout: sans, stateful, actionable.
 */
export function Banner(props: BannerProps): React.JSX.Element;