Skip to content

RtkUiProvider

Last updated View as MarkdownAgent setup

Properties

Property Type Required Default Description
config UIConfig1 ✅ - Config
iconPack IconPack1 ❌ defaultIconPack Icon pack
meeting Meeting | null ❌ null Meeting
mode MeetingMode1 ✅ - Fill type
overrides Overrides1 ❌ defaultOverrides UI Kit Overrides
showSetupScreen boolean ✅ - Whether to show setup screen or not
t RtkI18n1 ❌ 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}
    />
  );
}

Was this helpful?