Switch

Switches allow users to toggle between two states, on or off. On mobile, these are often used as a replacement for checkboxes.

bpk-component-switch

Backpack React Native switch component.

Default

Day Night
bpk-component-switch default iPhone 8 simulator bpk-component-switch default iPhone 8 simulator - dark mode
bpk-component-switch default Google Pixel emulator bpk-component-switch default Google Pixel emulator - dark mode

Installation

Check the main Readme for a complete installation guide.

Usage


                                                
                                                import React, { Component } from 'react';
                                                import { View, StyleSheet, Text } from 'react-native';
                                                import BpkSwitch from 'backpack-react-native/bpk-component-switch';
                                                import { spacingBase } from '@skyscanner/bpk-foundations-react-native/tokens/base.react.native';
                                                
                                                const styles = StyleSheet.create({
                                                  container: {
                                                    flex: 1,
                                                    justifyContent: 'center',
                                                    padding: spacingBase,
                                                  }
                                                });
                                                
                                                export default class App extends Component {
                                                  render() {
                                                    return (
                                                      <View style={styles.container}>
                                                        <BpkSwitch />
                                                        <BpkSwitch value />
                                                      </View >
                                                    );
                                                  }
                                                }

Props

Property PropType Required Default Value
value bool false false
theme See Theme Props below false null

Theme Props

  • switchPrimaryColor