RtkMessageView
{/* 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-message-view/rtk-message-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. */}
Properties
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
actions |
MessageAction[] |
✅ | - | List of actions to show in menu |
authorName |
string |
✅ | - | Author display label |
avatarUrl |
string |
✅ | - | Avatar image url |
hideAuthorName |
boolean |
✅ | - | Hides author display label |
hideAvatar |
boolean |
✅ | - | Hides avatar |
hideMetadata |
boolean |
✅ | - | Hides metadata (time) |
iconPack |
IconPack1 |
❌ | defaultIconPack |
Icon pack |
isEdited |
boolean |
✅ | - | Has the message been edited |
isSelf |
boolean |
✅ | - | Is the message sent by the current user |
messageType |
Message['type'] |
✅ | - | Type of message |
pinned |
boolean |
✅ | - | Is message pinned |
time |
Date |
✅ | - | Time when message was sent |
variant |
'plain' | 'bubble' |
✅ | - | Appearance |
viewType |
'incoming' | 'outgoing' |
✅ | - | Render |
Usage Examples
Basic Usage
import { RtkMessageView } from '@cloudflare/realtimekit-react-ui';
function MyComponent() {
return <RtkMessageView />;
}
With Properties
import { RtkMessageView } from '@cloudflare/realtimekit-react-ui';
function MyComponent() {
return (
<RtkMessageView
actions={[]}
authorName="example"
avatarUrl="example"
/>
);
}
这篇文档对你有帮助吗?
谢谢你的反馈!