Skip to content

RtkChatComposerView

Last updated View as MarkdownAgent setup

A component which renders a chat composer

Properties

Property Type Required Default Description
canSendFiles boolean ✅ - Whether user can send file messages
canSendTextMessage boolean ✅ - Whether user can send text messages
iconPack IconPack1 ❌ defaultIconPack Icon pack
inputTextPlaceholder string ✅ - Placeholder for text input
isEditing boolean ✅ - Sets composer to edit mode
maxLength number ✅ - Max length for text input
message string ✅ - Message to be pre-populated
quotedMessage string ✅ - Quote message to be displayed
rateLimits { period: number; maxInvocations: number; } ✅ - Rate limits
storageKey string ✅ - Key for storing message in localStorage
t RtkI18n1 ❌ useLanguage() Language

Usage Examples

Basic Usage

import { RtkChatComposerView } from '@cloudflare/realtimekit-react-ui';

function MyComponent() {
  return <RtkChatComposerView />;
}

With Properties

import { RtkChatComposerView } from '@cloudflare/realtimekit-react-ui';

function MyComponent() {
  return (
    <RtkChatComposerView
      canSendFiles={true}
      canSendTextMessage={true}
      inputTextPlaceholder="example"
    />
  );
}

Was this helpful?