Color mode (Dark Mode)

By default, most components are dark mode compatible. To handle color mode manually in your application, use the useColorMode or useColorModeValue hooks.

useColorMode

useColorMode is a React hook that gives you access to the current color mode, and a function to toggle the color mode.

Calling toggleColorMode anywhere in your app tree toggles the color mode.

useColorModeValue

useColorModeValue is a React hook used to change any value or style based on the color mode. It takes 2 arguments: the value in light mode, and the value in dark mode.


Playground
function ColorModeExample() {
  const {
    colorMode,
    toggleColorMode
  } = useColorMode();
  return <>
      <Heading>I'm a Heading</Heading>
      <Button colorScheme={colorMode === 'light' ? 'blue' : 'red'} onPress={() => {
      toggleColorMode();
    }}>
        Change mode
      </Button>
      <HStack space={2} mt={3}>
        <Avatar name="Ankur" borderWidth={2} source={{
        uri: 'https://pbs.twimg.com/profile_images/1309797238651060226/18cm6VhQ_400x400.jpg'
      }} />
        <Avatar name="Rohit" borderWidth={2} source={{
        uri: 'https://pbs.twimg.com/profile_images/1352844693151731713/HKO7cnlW_400x400.jpg'
      }} />
      </HStack>
    </>;
}

const LocalWrapper = ({
  children
}) => {
  const bg = useColorModeValue('gray.200', 'gray.800');
  return <Center flex={1} bg={bg}>
      {children}
    </Center>;
};

function Example() {
  return <NativeBaseProvider>
      <LocalWrapper>
        <ColorModeExample />
      </LocalWrapper>
    </NativeBaseProvider>;
}function ColorModeExample() {
  const {
    colorMode,
    toggleColorMode
  } = useColorMode();
  return <>
      <Heading>I'm a Heading</Heading>
      <Button colorScheme={colorMode === 'light' ? 'blue' : 'red'} onPress={() => {
      toggleColorMode();
    }}>
        Change mode
      </Button>
      <HStack space={2} mt={3}>
        <Avatar name="Ankur" borderWidth={2} source={{
        uri: 'https://pbs.twimg.com/profile_images/1309797238651060226/18cm6VhQ_400x400.jpg'
      }} />
        <Avatar name="Rohit" borderWidth={2} source={{
        uri: 'https://pbs.twimg.com/profile_images/1352844693151731713/HKO7cnlW_400x400.jpg'
      }} />
      </HStack>
    </>;
}

const LocalWrapper = ({
  children
}) => {
  const bg = useColorModeValue('gray.200', 'gray.800');
  return <Center flex={1} bg={bg}>
      {children}
    </Center>;
};

function Example() {
  return <NativeBaseProvider>
      <LocalWrapper>
        <ColorModeExample />
      </LocalWrapper>
    </NativeBaseProvider>;
}

Default color mode

You can set default color mode. By default, the color mode will be light. To support this, extend the default theme with a config

Copy
import { NativeBaseProvider, extendTheme, Text } from 'native-base';

// Define the config
const config = {
  useSystemColorMode: false,
  initialColorMode: 'dark',
};

// extend the theme
const customTheme = extendTheme({ config });
function App() {
  return (
    // pass itto NativeBaseProvider
    <NativeBaseProvider theme={customTheme}>
      // Your component
    </NativeBaseProvider>
  );
}

Persisting the color mode

You can persist the color mode in you app by defining you color mode manager of type StorageManager and passing it to the NativeBaseProvider. This will retain the color mode even when the app is refreshed.

For Native

Copy
import React from 'react';
import { NativeBaseProvider, StorageManager, ColorMode } from 'native-base';
import AsyncStorage from '@react-native-async-storage/async-storage';

// Define the colorModeManager,
// here we are using react-native-async-storage (https://react-native-async-storage.github.io/async-storage/)
const colorModeManager: StorageManager = {
  get: async () => {
    try {
      let val = await AsyncStorage.getItem('@color-mode');
      return val === 'dark' ? 'dark' : 'light';
    } catch (e) {
      return 'light';
    }
  },
  set: async (value: ColorMode) => {
    try {
      await AsyncStorage.setItem('@color-mode', value);
    } catch (e) {
      console.log(e);
    }
  },
};
export default function () {
  return (
    // pass it to NativeBaseProvider
    <NativeBaseProvider colorModeManager={colorModeManager}>
      // Your components
    </NativeBaseProvider>
  );
}

For web

Copy
import React from 'react';
import { ColorMode, NativeBaseProvider, StorageManager } from 'native-base';
const colorModeManager: StorageManager = {
  get: async () => {
    let val = localStorage.getItem('@color-mode');
    return val === 'dark' ? 'dark' : 'light';
  },
  set: async (value: ColorMode) => {
    let strValue = value ? value.toString() : '';
    localStorage.setItem('@color-mode', strValue);
  },
};

export default function () {
  return (
    // pass it to NativeBaseProvider
    <NativeBaseProvider colorModeManager={colorModeManager}>
      // Your components
    </NativeBaseProvider>
  );
}

Quick Nav

Persisting the color mode

MadeWithNativeBase

gluestack-ui

Color mode (Dark Mode) | NativeBase | Universal Components for React and React Native