react-native-theme-switch-animation

A Plug & Play Animations for Switching (Dark/Light) themes. 🌗

🦄 Features

✅ Supports multiple animation types.
✅ Blazing fast - [60/120]fps
✅ Plug and Play, doesn't matter what you use for switching themes
✅ Can be used for different theme colors, not necessarily for dark/light
✅ Supports turbo modules for new architecture

Installation

npm install react-native-theme-switch-animation

yarn add react-native-theme-switch-animation

Link

(if you are using expo managed project, do a prebuild - npx expo prebuild)

npx pod-install

For React Native Versions 0.67 and Below

follow those instructions

Usage

import switchTheme from 'react-native-theme-switch-animation';

export default function Example() {
  const [theme, setTheme] = React.useState('light');

  return (
    <Button
      title="Switch Theme"
      onPress={() => {

        switchTheme({
          switchThemeFunction: () => {
            setTheme(theme === 'light' ? 'dark' : 'light'); // your switch theme function
          },
          animationConfig: {
            type: 'fade',
            duration: 900,
          },
        });

      }}
    />
  );
}

Circular Example

switchTheme({
  switchThemeFunction: () => {
    setTheme(theme === 'light' ? 'dark' : 'light'); // your switch theme function
  },
  animationConfig: {
    type: 'circular',
    duration: 900,
    startingPoint: {
      cxRatio: 0.5,
      cyRatio: 0.5
    }
  },
});

switchTheme Function Props

Name	Type	Description
`switchThemeFunction`	`() => void`	Adds the function you use in your app to switch themes, doesn't matter if you use redux/context/zustand/mobx or any other way
`animationConfig`	`AnimationConfig`	Configuration for the animation -> type, duration, starting point (`default is 'fade' with 500ms duration`)

animationConfig options

Name	Type	Description
`type`	`fade` `circular` `inverted-circular`	Specifies animation type
`duration`	`number`	Specifies duration in milliseconds
`startingPoint`	`StartingPointConfig`	Configuration for the `circular` animation, where does the animation start in the screen
`captureType`	`layer` or `hierarchy`	(iOS only) `layer` is the default and suitable for most cases, `hierarchy` is more complex and can cause flickering in (inverted-circular) animation, but it solves issue where some elements are not visible while animation is happening

startingPoint options

Name	Type	Description
`cx`	`number`	Specifies starting x point for `circular` and `inverted-circular` animation (should not exceed your screen width)
`cy`	`number`	Specifies starting y point for `circular` and `inverted-circular` animation (should not exceed your screen height)
`cxRatio`	`number`	Specifies starting percentage of x point for `circular` and `inverted-circular` animation (should be number between -1 and 1)
`cyRatio`	`number`	Specifies starting percentage of y point for `circular` and `inverted-circular` animation (should be number between -1 and 1)

Start Circular Animation from/to specific Button

If you would like the circular animation to start from/to a button/view on your ui automatically, you can do the following

import switchTheme from 'react-native-theme-switch-animation';

<TouchableOpacity
  onPress={(e) => {
    e.currentTarget.measure((x1, y1, width, height, px, py) => {
      switchTheme({
        switchThemeFunction: () => {
          setTheme(theme === 'light' ? 'dark' : 'light');
        },
        animationConfig: {
          type: 'circular',
          duration: 900,
          startingPoint: {
            cy: py + height / 2,
            cx: px + width / 2,
          }
        },
      });
    });
  }}
/>

Trouble shooting

[iOS] Artifact for some components with border

https://github.com/WadhahEssam/react-native-theme-switch-animation/assets/24798045/8ad14c41-8757-4c21-b7e7-bf47b23e7f8b

this can be solved by adding a borderRadius of any value more than 1.2 for the component

<View
  style={{
    borderWidth: 1,
    borderColor: theme === 'light' ? 'black' : 'white',
    borderRadius: 1.2, // -> Add This
    padding: 20,
    marginBottom: 20,
  }}
>
  <Text
    style={{
      color: theme === 'light' ? 'black' : 'white',
    }}
  >
    test
  </Text>
</View>

License

MIT

WadhahEssam / react-native-theme-switch-animation

readme