Switch
The Switch component is used as an alternative for the checkbox component.
The Switch
component is used as an alternative for the
Checkbox component. You can switch between
enabled or disabled states.
Switch
must always be accompanied by a label, and follows the same keyboard
workflow as a Checkbox
.
Import#
import { Switch } from '@chakra-ui/react'
Usage#
<FormControl display='flex' alignItems='center'><FormLabel htmlFor='email-alerts' mb='0'>Enable email alerts?</FormLabel><Switch id='email-alerts' /></FormControl>
Sizes#
Pass the size
prop to change the size of the Switch
.
<Stack align='center' direction='row'><Switch size='sm' /><Switch size='md' /><Switch size='lg' /></Stack>
Switch background color#
You can change the checked background color of the Switch
by passing the
colorScheme
prop.
<Stack direction='row'><Switch colorScheme='red' /><Switch colorScheme='teal' size='lg' /></Stack>
State depending behavior#
States like isDisabled
have an impact on the usability of a Switch
and on
the styles, except for the isInvalid
and the isRequired
prop.
<FormControl as={SimpleGrid} columns={{ base: 2, lg: 4 }}><FormLabel htmlFor='isChecked'>isChecked:</FormLabel><Switch id='isChecked' isChecked /><FormLabel htmlFor='isDisabled'>isDisabled:</FormLabel><Switch id='isDisabled' isDisabled defaultChecked /><FormLabel htmlFor='isFocusable'>isFocusable:</FormLabel><Switch id='isFocusable' isFocusable isDisabled /><FormLabel htmlFor='isInvalid'>isInvalid:</FormLabel><Switch id='isInvalid' isInvalid /><FormLabel htmlFor='isReadOnly'>isReadOnly:</FormLabel><Switch id='isReadOnly' isReadOnly /><FormLabel htmlFor='isRequired'>isRequired:</FormLabel><Switch id='isRequired' isRequired /></FormControl>
Props#
The Switch
component is a multipart component. The styling needs to be applied
to each part specifically.
To learn more about styling multipart components, visit the Component Style page.
Anatomy#
- A:
container
- B:
thumb
- C:
track
Theming properties#
The properties that affect the theming of the Switch
component are:
colorScheme
: The color scheme of the Switch component. Defaults toblue
.size
: The size of the Switch component. Defaults tomd
.
Theming utilities#
createMultiStyleConfigHelpers
: a function that returns a set of utilities for creating style configs for a multipart component (definePartsStyle
anddefineMultiStyleConfig
).definePartsStyle
: a function used to create multipart style objects.defineMultiStyleConfig
: a function used to define the style configuration for a multipart component.
import { switchAnatomy } from '@chakra-ui/anatomy'import { createMultiStyleConfigHelpers } from '@chakra-ui/react'const { definePartsStyle, defineMultiStyleConfig } =createMultiStyleConfigHelpers(switchAnatomy.keys)
Customizing the default theme#
import { switchAnatomy } from '@chakra-ui/anatomy'import { createMultiStyleConfigHelpers } from '@chakra-ui/react'const { definePartsStyle, defineMultiStyleConfig } =createMultiStyleConfigHelpers(switchAnatomy.keys)const baseStyle = definePartsStyle({// define the part you're going to stylecontainer: {// ...},thumb: {bg: 'red.500',},track: {bg: 'gray.100',_checked: {bg: 'gray.100',},},})export const switchTheme = defineMultiStyleConfig({ baseStyle })
After customizing the switch theme, we can import it in our theme file and add
it in the components
property:
import { extendTheme } from '@chakra-ui/react'import { switchTheme } from './components/switch'export const theme = extendTheme({components: { Switch: switchTheme },})
This is a crucial step to make sure that any changes that we make to the switch theme are applied.
Using a custom color scheme#
Let's assume we want to use our own custom color scale based on our brand. We'd need to define the color scale first in the main theme file:
import { extendTheme } from '@chakra-ui/react'export const theme = extendTheme({colors: {brand: {50: '#f7fafc',...500: '#718096',...900: '#171923',}}})
Then, we can use the custom color scale as the color scheme for the button:
<Switch colorScheme='brand' />
Every time you're adding anything new to the theme, you'd need to run the CLI command to get proper autocomplete in your IDE. You can learn more about the CLI tool here.
Adding a custom variant#
Let's assume we want to include a custom boxy variant. Here's how you can do that:
import { switchAnatomy } from '@chakra-ui/anatomy'import { createMultiStyleConfigHelpers } from '@chakra-ui/react'const { definePartsStyle, defineMultiStyleConfig } =createMultiStyleConfigHelpers(switchAnatomy.keys)const boxy = definePartsStyle({track: {borderRadius: 'sm',p: 1,}})export const switchTheme = defineMultiStyleConfig({ variants: { boxy }})// Now we can use the new `boxy` variant<Switch variant="boxy"/>
Changing the default properties#
Let's assume we want to change the default size and color scheme of every switch in our app. Here's how we can do that:
import { switchAnatomy } from '@chakra-ui/anatomy'import { createMultiStyleConfigHelpers, defineStyle } from '@chakra-ui/react'const { defineMultiStyleConfig } = createMultiStyleConfigHelpers(switchAnatomy.keys,)export const switchTheme = defineMultiStyleConfig({defaultProps: {size: 'xl',colorScheme: 'brand',},})// This saves you time, instead of manually setting the size and variant every time you use an input:<Switch size="xl" colorScheme="brand" ... />
Showcase#
import { Box, HStack, IconButton, Switch, useColorMode } from "@chakra-ui/react"; import { FaMoon, FaSun } from "react-icons/fa"; export default function App() { const { toggleColorMode, colorMode } = useColorMode(); return ( <Box position="relative" h="100vh"> <HStack spacing={8} p={12}> <Switch size="sm" /> <Switch size="md" /> <Switch size="lg" /> <Switch size="sm" colorScheme='red' /> <Switch size="md" colorScheme='green' /> <Switch size="lg" colorScheme='purple' /> <Switch variant="boxy" colorScheme='yellow' /> </HStack> <IconButton aria-label="toggle theme" rounded="full" size="xs" position="absolute" bottom={4} left={4} onClick={toggleColorMode} icon={colorMode === "dark" ? <FaSun /> : <FaMoon />} /> </Box> ) }