---
description: API reference for RtkSettingsToggle component (React Native Library)
title: RtkSettingsToggle
image: https://developers.cloudflare.com/og-docs.png
---

[Skip to content](#main-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.

# RtkSettingsToggle

Last updated Aug 31, 2026|Copy as Markdown| [View as Markdown](https://439c4358.previews.developers.cloudflare.com/realtime/realtimekit/ui-kit/api-reference/react-native/rtksettingstoggle/index.md)| [Agent setup](https://439c4358.previews.developers.cloudflare.com/agent-setup/)

Toggle button to open the settings dialog. Hides if no audio or video permissions are available.

## Properties

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `size` | `'lg' \| 'md' \| 'sm' \| 'xl'` | ❌ | - | Icon size |
| `states` | `States` | ❌ | - | UI state object |
| `variant` | `'button' \| 'horizontal'` | ❌ | - | Layout variant |
| `iconPack` | `IconPack` | ❌ | `defaultIconPack` | Custom icon pack |
| `t` | `RtkI18n` | ❌ | - | i18n translation function |

## Usage Examples

### Basic Usage

```tsx
import { RtkSettingsToggle } from "@cloudflare/realtimekit-react-native-ui";

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

### With Properties

```tsx
import { RtkSettingsToggle } from "@cloudflare/realtimekit-react-native-ui";

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

Was this helpful?

YesNo

## On this page

[![](https://439c4358.previews.developers.cloudflare.com/_astro/logo.te5VL_aD.svg)Docs](https://439c4358.previews.developers.cloudflare.com/)

```json
{"@context":"https://schema.org","@type":"TechArticle","@id":"https://developers.cloudflare.com/realtime/realtimekit/ui-kit/api-reference/react-native/rtksettingstoggle/#page","headline":"RtkSettingsToggle · Cloudflare Realtime docs","description":"API reference for RtkSettingsToggle component (React Native Library)","url":"https://developers.cloudflare.com/realtime/realtimekit/ui-kit/api-reference/react-native/rtksettingstoggle/","inLanguage":"en","image":"https://developers.cloudflare.com/og-docs.png","dateModified":"2026-08-31","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/"}}
```