Skip to content
Cloudflare Docs

RtkHeader

A component that houses all the header components.

Properties

PropertyTypeRequiredDefaultDescription
configUIConfig1createDefaultConfig()Config
disableRenderboolean-Whether to render the default UI
iconPackIconPack1defaultIconPackIcon Pack
meetingMeeting-Meeting
sizeSize-Size
statesStates-States
tRtkI18nuseLanguage()Language
variant'solid' | 'boxed'-Variant

Usage Examples

Basic Usage

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

With Properties

import { RtkHeader } from '@cloudflare/realtimekit-react-ui';
function MyComponent() {
return (
<RtkHeader
disableRender={true}
meeting={meeting}
size="md"
/>
);
}