Components

Toggle

Toggle button component with pressed state and variant options.

iOSAndroid
Preview Toggle on your device

Scan with Expo Go

Download Expo Go, then scan the QR code to preview native components.

Installation

pnpm dlx @docyrus/cli add @docyrus/rn-toggle

Usage

import { Toggle } from '@/components/docyrus-native/toggle';

<Toggle pressed={bold} onPressedChange={setBold}>B</Toggle>
<Toggle variant="outline" pressed={italic} onPressedChange={setItalic}>I</Toggle>

API Reference

PropTypeDefaultDescription
pressedbooleanfalseToggle pressed state
onPressedChange(pressed: boolean) => void—State change handler
childrenReactNode—Toggle content
variant'default' | 'outline''default'Visual style variant
size'sm' | 'md' | 'lg''md'Toggle size
disabledbooleanfalseDisable interaction
classNamestring—Additional CSS classes
textClassNamestring—Text CSS classes
accessibilityLabelstring—Accessibility label

Type Exports

TypeDescription
TogglePropsProps for Toggle component
ToggleVariant'default' | 'outline'
ToggleSize'sm' | 'md' | 'lg'

On this page