Skip to content

RtkParticipantTile

A component which plays a participants video and allows for placement of components like rtk-name-tag, rtk-audio-visualizer or any other component.

Properties

PropertyTypeRequiredDefaultDescription
configUIConfig❌createDefaultConfig()Config object
iconPackIconPack❌defaultIconPackIcon pack
isPreviewboolean✅-Whether tile is used for preview
meetingMeeting✅-Meeting object
nameTagPosition| 'bottom-left' | 'bottom-right' | 'bottom-center' | 'top-left' | 'top-right' | 'top-center'✅-Position of name tag
participantPeer✅-Participant object
sizeSize✅-Size
statesStates✅-States object
tRtkI18n❌useLanguage()Language
variant'solid' | 'gradient'✅-Variant

Usage Examples

Basic Usage

import { RtkParticipantTile } from '@cloudflare/realtimekit-react-ui';
function MyComponent() {
return <RtkParticipantTile />;
}

With Properties

import { RtkParticipantTile } from '@cloudflare/realtimekit-react-ui';
function MyComponent() {
return (
<RtkParticipantTile
isPreview={true}
meeting={meeting}
nameTagPosition={| 'bottom-left'
| 'bottom-right'
| 'bottom-center'
| 'top-left'
| 'top-right'
| 'top-center'}
/>
);
}