RtkSettingsToggle (2)

Last updated Oct 19, 2026 A button which toggles visibility of settings module. When clicked it emits a rtkStateUpdate event with the data:

{ activeSettings: boolean; }

Properties

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

Was this helpful?

YesNo

On this page

Docs

{"@context":"https://schema.org","@type":"WebPage","@id":"https://developers.cloudflare.com/realtime/realtimekit/humans/ui-kit/api-reference/react/rtksettingstoggle/#page","headline":"RtkSettingsToggle","description":"API reference for RtkSettingsToggle component (React Library)","url":"https://developers.cloudflare.com/realtime/realtimekit/humans/ui-kit/api-reference/react/rtksettingstoggle/","inLanguage":"en","image":"https://developers.cloudflare.com/realtime/realtimekit/humans/ui-kit/api-reference/react/rtksettingstoggle/og.png?v=601c3aff145dc1e3","dateModified":"2026-10-19","publisher":{"@type":"Organization","name":"Cloudflare","description":"One platform for your apps, agents, and workforce. Build, secure, and scale without managing infrastructure","url":"https://www.cloudflare.com/","sameAs":["https://github.com/cloudflare","https://www.linkedin.com/company/cloudflare","https://x.com/cloudflare"],"logo":{"@type":"ImageObject","url":"https://developers.cloudflare.com/logo.svg"},"address":{"@type":"PostalAddress","streetAddress":"101 Townsend St","addressLocality":"San Francisco","addressRegion":"CA","postalCode":"94107","addressCountry":"US"},"contactPoint":[{"@type":"ContactPoint","contactType":"Customer Support","url":"https://support.cloudflare.com/","availableLanguage":["English"]},{"@type":"ContactPoint","contactType":"Sales","url":"https://www.cloudflare.com/contact/","availableLanguage":["English"]}]},"isPartOf":{"@type":"WebSite","@id":"https://developers.cloudflare.com/#website","name":"Cloudflare Docs","url":"https://developers.cloudflare.com/"}}

description: API reference for RtkSettingsVideo component (React Library) title: RtkSettingsVideo image: https://developers.cloudflare.com/realtime/realtimekit/humans/ui-kit/api-reference/react/rtksettingsvideo/og.png?v=9df3ccedda570a34

Skip to content

Documentation Index
Fetch the complete documentation index at: https://developers.cloudflare.com/realtime/llms.txt
Use this file to discover all available pages before exploring further.