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
37 lines
1021 B
JavaScript
37 lines
1021 B
JavaScript
/**
|
|
* 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.
|
|
*
|
|
* @flow strict
|
|
* @format
|
|
*/
|
|
|
|
import type {TurboModule} from '../TurboModule/RCTExport';
|
|
|
|
import * as TurboModuleRegistry from '../TurboModule/TurboModuleRegistry';
|
|
|
|
export type ColorSchemeName = 'light' | 'dark';
|
|
|
|
export type AppearancePreferences = {|
|
|
// TODO: (hramos) T52919652 Use ?ColorSchemeName once codegen supports union
|
|
// types.
|
|
/* 'light' | 'dark' */
|
|
colorScheme?: ?string,
|
|
|};
|
|
|
|
export interface Spec extends TurboModule {
|
|
// TODO: (hramos) T52919652 Use ?ColorSchemeName once codegen supports union
|
|
// types.
|
|
/* 'light' | 'dark' */
|
|
+getColorScheme: () => ?string;
|
|
+setColorScheme?: (colorScheme: string) => void;
|
|
|
|
// RCTEventEmitter
|
|
+addListener: (eventName: string) => void;
|
|
+removeListeners: (count: number) => void;
|
|
}
|
|
|
|
export default (TurboModuleRegistry.get<Spec>('Appearance'): ?Spec);
|