Skip to content

Latest commit

 

History

History
293 lines (211 loc) · 8.45 KB

install.md

File metadata and controls

293 lines (211 loc) · 8.45 KB
Raw

@vonovak/react-native-theme-control

iOS 13 or newer is required for theming logic. However, the package builds with iOS 12 and newer.

Version 4 supports RN 0.72 and Expo 49.

Version 3 supports RN 0.71 and Expo 48.

Version 2 supports RN 0.70 and Expo 47.

For version 1, the minimum required RN version is 0.66.1. Version 1 can also be used with Expo >=45 and < 47.

Installation

yarn add @vonovak/react-native-theme-control

OR

npm i @vonovak/react-native-theme-control

Then, run npx pod-install and rebuild your iOS and Android projects.

Expo

First, make sure that userInterfaceStyle in expo entry in expo config file is set to automatic and install expo-system-ui as documented.

{
  "expo": {
    "userInterfaceStyle": "automatic"
  }
}

then, only if you want to enable theme persistence across app restarts, or force a light / dark mode, add @vonovak/react-native-theme-control to the plugins entry in expo config file.

For example, the following will enable theme persistence across app restarts.

"plugins": ["@vonovak/react-native-theme-control"]

If you want to force light / dark mode always, to resolve issues like this then specify the theme like this:

"plugins": [
  [
    "@vonovak/react-native-theme-control", {
      "mode": "light"
    }
  ]
]

The mode values are 'light' | 'dark' | 'userPreference' ('userPreference') is default.

Native files setup:

There are manual installation steps that need to be performed:

Do not do this if you're using the Expo config plugin!

Android

  • in MainApplication.kt / java:
+ import eu.reactnativetraining.ThemeControlModule;

//...

@Override
public void onCreate() {
  super.onCreate();
+  ThemeControlModule.Companion.recoverApplicationTheme(getApplicationContext());

  SoLoader.init(this, /* native exopackage */ false);
}

If you want to force dark / light theme always, use:

ThemeControlModule.Companion.forceTheme(androidx.appcompat.app.AppCompatDelegate.MODE_NIGHT_YES);

or

ThemeControlModule.Companion.forceTheme(androidx.appcompat.app.AppCompatDelegate.MODE_NIGHT_NO);

If you want, androidxCoreVersion can be set to the version of the androidx core you want to use.

iOS

Add header search paths

This step usually isn't necessary, but may be required when you use use_frameworks! in your Podfile.

In that case, we need to add a header search path to the React-RCTAppDelegate project target. This can be done in the Podfile:

target 'YourApp' do
  use_frameworks! :linkage => :static
  config = use_native_modules!

  # ...

  post_install do |installer|
    installer.pods_project.targets.each do |target|
      if ["React-RCTAppDelegate"].any? { |t| t == target.name }
        # PODS_ROOT points to ios/Pods
        append_header_search_path(target, "$(PODS_ROOT)/some_path/node_modules/@vonovak/react-native-theme-control/ios")
      end
    end
  end
end

# https://github.com/software-mansion/react-native-svg/issues/2081#issuecomment-1656701180
def append_header_search_path(target, path)
  target.build_configurations.each do |config|
      # Note that there's a space character after `$(inherited)`.
      config.build_settings["HEADER_SEARCH_PATHS"] ||= "$(inherited) "
      config.build_settings["HEADER_SEARCH_PATHS"] << path
  end
end

Modify the AppDelegate

Recovering the application theme involves modification of native files. The following is required:

for RN >= 0.71

We need to modify the RCTAppDelegate.mm file located in node_modules/react-native/Libraries/AppDelegate/RCTAppDelegate.mm.

Use the modification shown below and apply it to the file in node_modules. Use tools such as yarn patch or patch-package to maintain the change. While it is a bit unusual to patch this file, you will get an efficient theme-switching solution (certainly better than loading the app, waiting to read theme from asyncStorage and re-drawing).

This is a snippet from a RN 0.74 project:

+// use the one you need
+#if __has_include(<RNThemeControl.h>)
+    #import <RNThemeControl.h>
+#else
+    #import "RNThemeControl.h"
+#endif

(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  // ...
  if (self.newArchEnabled || self.fabricEnabled) {
    [RCTComponentViewFactory currentComponentViewFactory].thirdPartyFabricComponentsProvider = self;
  }
  [self _logWarnIfCreateRootViewWithBridgeIsOverridden];
  [self customizeRootView:(RCTRootView *)rootView];

  self.window = [[UIWindow alloc] initWithFrame:[UIScreen mainScreen].bounds];
  UIViewController *rootViewController = [self createRootViewController];


+  [RNThemeControl recoverApplicationTheme];
+  // or use this for testing
+  [RNThemeControl forceTheme:UIUserInterfaceStyleDark];

  [self setRootView:rootView toRootViewController:rootViewController];
  self.window.rootViewController = rootViewController;
  self.window.windowScene.delegate = self;
  [self.window makeKeyAndVisible];

  return YES;
}
for RN <= 0.70
  • in AppDelegate.m make the following changes:
+// use the one you need
+#if __has_include(<RNThemeControl.h>)
+    #import <RNThemeControl.h>
+#else
+    #import "RNThemeControl.h"
+#endif

  // ...
  self.window = [[UIWindow alloc] initWithFrame:[UIScreen mainScreen].bounds];
  UIViewController *rootViewController = [UIViewController new];
  rootViewController.view = rootView;
+  [RNThemeControl recoverApplicationTheme];

  self.window.rootViewController = rootViewController;
  [self.window makeKeyAndVisible];

  return YES;
}

If you want to force dark / light theme always, prefer editing the plist file or use for testing:

[RNThemeControl forceTheme:UIUserInterfaceStyleDark];

or

[RNThemeControl forceTheme:UIUserInterfaceStyleLight];

Usage example

More examples can be found in the example project.

import * as React from 'react';

import { Text, useColorScheme, View } from 'react-native';
import {
  setThemePreference,
  SystemBars,
  ThemePreference,
  useThemePreference,
} from '@vonovak/react-native-theme-control';
import SegmentedControl from '@react-native-segmented-control/segmented-control';

export function SimpleScreen() {
  const colorScheme = useColorScheme();
  const isDarkMode = colorScheme === 'dark';
  const themePreference = useThemePreference();
  const bgColor = isDarkMode ? '#2A2550' : '#FFF6EA';
  const textColor = isDarkMode ? 'white' : 'black';
  const barsBackground = isDarkMode ? '#9900F0' : '#A0BCC2';
  const dividerColor = textColor;

  const textColorStyle = { color: textColor };

  const values: Array<ThemePreference> = ['light', 'dark', 'system'];

  return (
    <View
      style={{
        backgroundColor: bgColor,
        flexGrow: 1,
        flexShrink: 1,
        alignItems: 'center',
        justifyContent: 'space-evenly',
      }}
    >
      <SystemBars
        backgroundColor={barsBackground}
        dividerColor={dividerColor}
      />
      <SegmentedControl
        style={{ width: '100%' }}
        values={values}
        selectedIndex={values.indexOf(themePreference)}
        onChange={({ nativeEvent }) => {
          setThemePreference(nativeEvent.value as ThemePreference);
        }}
      />
      <Text style={textColorStyle}>useColorScheme(): {colorScheme}</Text>
      <Text style={textColorStyle}>
        useThemePreference(): {themePreference}
      </Text>
    </View>
  );
}

Troubleshooting

Android activity restarts upon theme change

Make sure that inside of the AndroidManifest.xml file, the android:configChanges include uiMode. For example:

android:configChanges="keyboard|keyboardHidden|orientation|screenSize|uiMode"

Note, however, that restarting the activity might be necessary for some theme-related changes to occur, for example for PlatformColor changes to take effect.

Android scroll bar's color is not changing

The list components might need to re-render once the theme changes for the scroll bars to re-draw.

For example, if you're using FlatList, you can add a key prop to it, and change the value of the key prop when the theme changes. For example:

const colorScheme = useColorScheme();

<FlatList key={colorScheme} />;