Skip to content

RtkSwitch

Last updated View as MarkdownAgent setup

A switch component which follows RTK Design System.

Properties

Property Type Required Default Description
checked boolean ✅ - Whether the switch is enabled/checked
disabled boolean ✅ - Whether switch is readonly
iconPack IconPack ❌ defaultIconPack Icon pack
readonly boolean ✅ - Whether switch is readonly
t RtkI18n ❌ useLanguage() Language

Usage Examples

Basic Usage

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

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

With Properties

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

function MyComponent() {
  return (
    <RtkSwitch
      checked={true}
      disabled={true}
      readonly={true}
    />
  );
}

Was this helpful?