Switch | NativeBase

NativeBase

3.4.x

⌘

Hire us

NativeBase

Introduction

Getting Started

Installation

Setup NativeBase Provider

Resources

Contribution

Core Concepts

Utility First

Utility Props Specificity

Design Tokens

Pseudo Props: Overview

Pseudo Props: Dos & Don'ts

Responsive

Features

Utility Props

Color mode (Dark Mode)

Theme

Customizing Components

Making components dark mode compatible

Layout

Forms

Data Display

Feedback

Typography

Overlay

Disclosure

Media and Icons

Transition

Others

ReactNative Components

Hooks

Examples

Recipes

Designs

Forms

Layout

Migration

Upgrading to 3.2.0 from 3.x

Components Migration

If you are starting a new project, please try gluestack-ui for better performance and new design.

Switch

The Switch provides an alternative to the Checkbox component. It also allows a user to switch between enabled or disabled states.


Show Code
Playground
const Example = () => {
  return <Switch size="lg" />;
};const Example = () => {
  return <Switch size="lg" />;
};

Examples

Basic


Playground
const Example = () => {
  return <HStack alignItems="center" space={4}>
      <Text>Bluetooth</Text>
      <Switch size="sm" />
    </HStack>;
};const Example = () => {
  return <HStack alignItems="center" space={4}>
      <Text>Bluetooth</Text>
      <Switch size="sm" />
    </HStack>;
};

Sizes


Playground
const Example = () => {
  return <VStack space={4} alignItems="center">
      <Switch size="sm" />
      <Switch size="md" />
      <Switch size="lg" />
    </VStack>;
};const Example = () => {
  return <VStack space={4} alignItems="center">
      <Switch size="sm" />
      <Switch size="md" />
      <Switch size="lg" />
    </VStack>;
};

Track & Thumb Color


Playground
const Example = () => {
  return <VStack space={4} alignItems="center">
      <Switch />
      <Switch offTrackColor="orange.100" onTrackColor="orange.200" onThumbColor="orange.500" offThumbColor="orange.50" />
      <Switch offTrackColor="indigo.100" onTrackColor="indigo.200" onThumbColor="indigo.500" offThumbColor="indigo.50" />
    </VStack>;
};const Example = () => {
  return <VStack space={4} alignItems="center">
      <Switch />
      <Switch offTrackColor="orange.100" onTrackColor="orange.200" onThumbColor="orange.500" offThumbColor="orange.50" />
      <Switch offTrackColor="indigo.100" onTrackColor="indigo.200" onThumbColor="indigo.500" offThumbColor="indigo.50" />
    </VStack>;
};

Color Schemes


Playground
const Example = () => {
  return <VStack space={4} alignItems="center">
      <Switch defaultIsChecked colorScheme="primary" />
      <Switch defaultIsChecked colorScheme="secondary" />
      <Switch defaultIsChecked colorScheme="emerald" />
    </VStack>;
};const Example = () => {
  return <VStack space={4} alignItems="center">
      <Switch defaultIsChecked colorScheme="primary" />
      <Switch defaultIsChecked colorScheme="secondary" />
      <Switch defaultIsChecked colorScheme="emerald" />
    </VStack>;
};

Props

Switch implements

Switch from React Native

size

The size (width and height) of the switch.

Type: ResponsiveValue<number | "full" | "sm" | "6" | "2xs" | "8" | "xs" | "12" | "md" | "16" | "xl" | "24" | "32" | "2" | "0.5" | "4" | "3" | "lg" | "1" | "2xl" | "10" | "20" | "64" | "0" | "px" | (string & {}) | ... 28 more ... | "5/6">

Default: md

isDisabled

If true, set the disabled to the invalid state.

Type: boolean

isHovered

If true, set the hovered state.

Type: boolean

name

The input name of the Switch when used in a form.

Type: string

onToggle

Function called when the state of the Switch changes.

Type: () => any

isChecked

If true, set the Switch to the checked state.

Type: boolean

defaultIsChecked

If true, the checkbox will be initially checked.

Type: boolean

isInvalid

If true, set the switch to the invalid state.

Type: boolean

onTrackColor

The track color of the Switch when on.

Type: ResponsiveValue<"gray.300" | "primary.500" | "gray.500" | (string & {}) | "contrastThreshold" | "white" | "black" | "lightText" | "darkText" | "primary.50" | "primary.100" | "primary.200" | ... 333 more ... | "tertiary.900">

offTrackColor

The track color of the Switch when off.

onThumbColor

The thumb color of the Switch when on.

offThumbColor

The thumb color of the Switch when off.

colorScheme

Color scheme to be used for the Switch

Type: string

_hover

Props when Switch is hovered. Accepts all the Switch props.

Type: Omit<InterfaceSwitchProps, "_hover">