RtkHeader

A component that houses all the header components.

Properties

Property	Type	Required	Default	Description
`config`	`UIConfig1`	❌	`createDefaultConfig()`	Config
`disableRender`	`boolean`	✅	-	Whether to render the default UI
`iconPack`	`IconPack1`	❌	`defaultIconPack`	Icon Pack
`meeting`	`Meeting`	✅	-	Meeting
`size`	`Size`	✅	-	Size
`states`	`States`	✅	-	States
`t`	`RtkI18n`	❌	`useLanguage()`	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"
    />
  );
}