跳转到主要内容

RtkHeader

{/* AUTO-GENERATED FILE. DO NOT EDIT MANUALLY. Any manual changes will be overwritten the next time the docs are generated.

Source: https://github.com/cloudflare/realtimekit-ui/blob/main/packages/core/src/components/rtk-header/rtk-header.tsx Generator: https://github.com/cloudflare/realtimekit-ui/blob/main/scripts/generate-stencil-docs.js

To update this page, edit the component source in the realtimekit-ui repository and submit a pull request against the staging branch; the changes will automatically sync here upon the next release. */}

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"
    />
  );
}