跳转到主要内容

RtkChatComposerView

{/* AUTO-GENERATED FILE. DO NOT EDIT MANUALLY. Any manual changes will be overwritten the next time the docs are generated.

Source: https://github.com/cloudflare/realtimekit-ui/blob/main/packages/core/src/components/rtk-chat-composer-view/rtk-chat-composer-view.tsx Generator: https://github.com/cloudflare/realtimekit-ui/blob/main/scripts/generate-stencil-docs.js

To update this page, edit the component source in the realtimekit-ui repository and submit a pull request against the staging branch; the changes will automatically sync here upon the next release. */}

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
isSending boolean ✅ - Whether a message is being sent
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"
    />
  );
}
这篇文档对你有帮助吗？
想留言或继续讨论？请到 Cyberforums 赛博论坛参与。 参与讨论 / 回复