RtkParticipantSetup

Properties

Property	Type	Required	Default	Description
config	UIConfig	❌	createDefaultConfig()	Config object
iconPack	IconPack	❌	defaultIconPack	Icon pack
isPreview	boolean	✅	-	Whether tile is used for preview
nameTagPosition	| 'bottom-left' | 'bottom-right' | 'bottom-center' | 'top-left' | 'top-right' | 'top-center'	✅	-	Position of name tag
participant	Peer	✅	-	Participant object
size	Size	✅	-	Size
states	States	✅	-	States object
t	RtkI18n	❌	useLanguage()	Language
variant	'solid' | 'gradient'	✅	-	Variant

Usage Examples

Basic Usage

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

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

With Properties

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

function MyComponent() {
  return (
    <RtkParticipantSetup
      isPreview={true}
      nameTagPosition={| 'bottom-left'
    | 'bottom-right'
    | 'bottom-center'
    | 'top-left'
    | 'top-right'
    | 'top-center'}
      participant={participant}
    />
  );
}