RtkSettingsToggle

A button which toggles visibility of settings module. When clicked it emits a rtkStateUpdate event with the data:

TypeScript

{ activeSettings: boolean; }

Properties

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

Usage Examples

Basic Usage

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

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

With Properties

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

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

Explain Code