Skip to content

RtkUiProvider

Properties

PropertyTypeRequiredDefaultDescription
configUIConfig1✅-Config
iconPackIconPack1❌defaultIconPackIcon pack
meetingMeeting | null❌nullMeeting
modeMeetingMode1✅-Fill type
overridesOverrides1❌defaultOverridesUI Kit Overrides
showSetupScreenboolean✅-Whether to show setup screen or not
tRtkI18n1❌useLanguage()Language utility

Usage Examples

Basic Usage

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

With Properties

import { RtkUiProvider } from '@cloudflare/realtimekit-react-ui';
function MyComponent() {
return (
<RtkUiProvider
config={defaultUiConfig}
mode={meeting}
showSetupScreen={true}
/>
);
}