Skip to content

RtkChatToggle

Last updated View as MarkdownAgent setup

A button which toggles visibility of chat. You need to pass the meeting object to it to see the unread messages count badge. When clicked it emits a rtkStateUpdate event with the data:

{ activeSidebar: boolean; sidebar: 'chat' }

Properties

Property Type Required Default Description
iconPack IconPack defaultIconPack Icon pack
meeting Meeting - Meeting object
size Size - Size
states States - States object
t RtkI18n useLanguage() Language
variant ControlBarVariant - Variant

Usage Examples

Basic Usage

import { RtkChatToggle } from '@cloudflare/realtimekit-react-ui';

function MyComponent() {
  return <RtkChatToggle />;
}

With Properties

import { RtkChatToggle } from '@cloudflare/realtimekit-react-ui';

function MyComponent() {
  return (
    <RtkChatToggle
      meeting={meeting}
      size="md"
      variant="button"
    />
  );
}

Was this helpful?