@threadplane/react/chatInterfacev0.0.0

WelcomeSuggestionProps

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

Configures a literal suggestion button whose selection remains caller controlled.

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

Declaration

export interface WelcomeSuggestionProps  {
  readonly className?: string;
  readonly description?: string;
  readonly disabled?: boolean;
  readonly icon?: ReactNode;
  readonly label: string;
  readonly onSelect: (value: string) => void;
  readonly value: string;
}

Members

className

Additional classes on the suggestion button.

readonly className?: string;

description

Optional literal tooltip and accessible description.

readonly description?: string;

disabled

Prevents selection only when strictly true.

readonly disabled?: boolean;

icon

Decorative noninteractive phrasing content, hidden from assistive technology.

readonly icon?: ReactNode;

label

Literal visible button label.

readonly label: string;

onSelect

Receives the raw value on an enabled, unclaimed native button click.

readonly onSelect: (value: string) => void;

value

Exact value passed to onSelect without trimming or transformation.

readonly value: string;