mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Birkir Gudjonsson
c18566ffdb
Summary: Both Android and iOS allow you to set application specific user interface style, which is useful for applications that support both light and dark mode. With the newly added `Appearance.setColorScheme`, you can natively manage the application's user interface style rather than keeping that preference in JavaScript. The benefit is that native dialogs like alert, keyboard, action sheets and more will also be affected by this change. Implemented using Android X [AppCompatDelegate.setDefaultNightMode](https://developer.android.com/reference/androidx/appcompat/app/AppCompatDelegate#setDefaultNightMode(int)) and iOS 13+ [overrideUserInterfaceStyle](https://developer.apple.com/documentation/uikit/uiview/3238086-overrideuserinterfacestyle?language=objc) ```tsx // Lets assume a given device is set to **dark** mode. Appearance.getColorScheme(); // `dark` // Set the app's user interface to `light` Appearance.setColorScheme('light'); Appearance.getColorScheme(); // `light` // Set the app's user interface to `unspecified` Appearance.setColorScheme(null); Appearance.getColorScheme() // `dark` ``` ## Changelog [GENERAL] [ADDED] - Added `setColorScheme` to `Appearance` module Pull Request resolved: https://github.com/facebook/react-native/pull/36122 Test Plan: Added a RNTester for the feature in the Appearance section. Three buttons for toggling all set of modes. Reviewed By: lunaleaps Differential Revision: D43331405 Pulled By: NickGerleman fbshipit-source-id: 3b15f1ed0626d1ad7a8266ec026e903cd3ec46aa
54 lines
1.7 KiB
TypeScript
54 lines
1.7 KiB
TypeScript
/**
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @format
|
|
*/
|
|
|
|
import {NativeEventSubscription} from '../EventEmitter/RCTNativeAppEventEmitter';
|
|
|
|
type ColorSchemeName = 'light' | 'dark' | null | undefined;
|
|
|
|
export namespace Appearance {
|
|
type AppearancePreferences = {
|
|
colorScheme: ColorSchemeName;
|
|
};
|
|
|
|
type AppearanceListener = (preferences: AppearancePreferences) => void;
|
|
|
|
/**
|
|
* Note: Although color scheme is available immediately, it may change at any
|
|
* time. Any rendering logic or styles that depend on this should try to call
|
|
* this function on every render, rather than caching the value (for example,
|
|
* using inline styles rather than setting a value in a `StyleSheet`).
|
|
*
|
|
* Example: `const colorScheme = Appearance.getColorScheme();`
|
|
*/
|
|
export function getColorScheme(): ColorSchemeName;
|
|
|
|
/**
|
|
* Set the color scheme preference. This is useful for overriding the default
|
|
* color scheme preference for the app. Note that this will not change the
|
|
* appearance of the system UI, only the appearance of the app.
|
|
* Only available on iOS 13+ and Android 10+.
|
|
*/
|
|
export function setColorScheme(
|
|
scheme: ColorSchemeName | null | undefined,
|
|
): void;
|
|
|
|
/**
|
|
* Add an event handler that is fired when appearance preferences change.
|
|
*/
|
|
export function addChangeListener(
|
|
listener: AppearanceListener,
|
|
): NativeEventSubscription;
|
|
}
|
|
|
|
/**
|
|
* A new useColorScheme hook is provided as the preferred way of accessing
|
|
* the user's preferred color scheme (e.g. Dark Mode).
|
|
*/
|
|
export function useColorScheme(): ColorSchemeName;
|