From a7fbe8117f02ccc00e29cfebe6430562e5219e8d Mon Sep 17 00:00:00 2001 From: Tim Yung Date: Wed, 21 Aug 2024 01:48:58 -0700 Subject: [PATCH] Appearance: Migrate to ESM Named Exports (#46119) Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/46119 Straightforward migration of the `Appearance` module to use ESM named exports. Changelog: [Internal] Reviewed By: TheSavior Differential Revision: D61567882 fbshipit-source-id: a4a5a9771de001bd41cb0e23ba066f150267a55d --- .../Libraries/Utilities/Appearance.js | 94 +++++++++---------- .../Libraries/Utilities/DevLoadingView.js | 6 +- .../Libraries/Utilities/useColorScheme.js | 6 +- .../__snapshots__/public-api-test.js.snap | 10 +- packages/react-native/index.js | 2 +- 5 files changed, 57 insertions(+), 61 deletions(-) diff --git a/packages/react-native/Libraries/Utilities/Appearance.js b/packages/react-native/Libraries/Utilities/Appearance.js index f08588774d5..ad4529b027c 100644 --- a/packages/react-native/Libraries/Utilities/Appearance.js +++ b/packages/react-native/Libraries/Utilities/Appearance.js @@ -51,57 +51,55 @@ if (NativeAppearance) { ); } -module.exports = { - /** - * 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();` - * - * @returns {?ColorSchemeName} Value for the color scheme preference. - */ - getColorScheme(): ?ColorSchemeName { - if (__DEV__) { - if (isAsyncDebugging) { - // Hard code light theme when using the async debugger as - // sync calls aren't supported - return 'light'; - } +/** + * 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();` + * + * @returns {?ColorSchemeName} Value for the color scheme preference. + */ +export function getColorScheme(): ?ColorSchemeName { + if (__DEV__) { + if (isAsyncDebugging) { + // Hard code light theme when using the async debugger as + // sync calls aren't supported + return 'light'; } + } - // TODO: (hramos) T52919652 Use ?ColorSchemeName once codegen supports union - const nativeColorScheme: ?string = - NativeAppearance == null - ? null - : NativeAppearance.getColorScheme() || null; - invariant( - nativeColorScheme === 'dark' || - nativeColorScheme === 'light' || - nativeColorScheme == null, - "Unrecognized color scheme. Did you mean 'dark' or 'light'?", - ); - return nativeColorScheme; - }, + // TODO: (hramos) T52919652 Use ?ColorSchemeName once codegen supports union + const nativeColorScheme: ?string = + NativeAppearance == null ? null : NativeAppearance.getColorScheme() || null; + invariant( + nativeColorScheme === 'dark' || + nativeColorScheme === 'light' || + nativeColorScheme == null, + "Unrecognized color scheme. Did you mean 'dark' or 'light'?", + ); + return nativeColorScheme; +} - setColorScheme(colorScheme: ?ColorSchemeName): void { - const nativeColorScheme = colorScheme == null ? 'unspecified' : colorScheme; +export function setColorScheme(colorScheme: ?ColorSchemeName): void { + const nativeColorScheme = colorScheme == null ? 'unspecified' : colorScheme; - invariant( - colorScheme === 'dark' || colorScheme === 'light' || colorScheme == null, - "Unrecognized color scheme. Did you mean 'dark', 'light' or null?", - ); + invariant( + colorScheme === 'dark' || colorScheme === 'light' || colorScheme == null, + "Unrecognized color scheme. Did you mean 'dark', 'light' or null?", + ); - if (NativeAppearance != null && NativeAppearance.setColorScheme != null) { - NativeAppearance.setColorScheme(nativeColorScheme); - } - }, + if (NativeAppearance != null && NativeAppearance.setColorScheme != null) { + NativeAppearance.setColorScheme(nativeColorScheme); + } +} - /** - * Add an event handler that is fired when appearance preferences change. - */ - addChangeListener(listener: AppearanceListener): EventSubscription { - return eventEmitter.addListener('change', listener); - }, -}; +/** + * Add an event handler that is fired when appearance preferences change. + */ +export function addChangeListener( + listener: AppearanceListener, +): EventSubscription { + return eventEmitter.addListener('change', listener); +} diff --git a/packages/react-native/Libraries/Utilities/DevLoadingView.js b/packages/react-native/Libraries/Utilities/DevLoadingView.js index aeb216780e7..45119f94fcc 100644 --- a/packages/react-native/Libraries/Utilities/DevLoadingView.js +++ b/packages/react-native/Libraries/Utilities/DevLoadingView.js @@ -9,7 +9,7 @@ */ import processColor from '../StyleSheet/processColor'; -import Appearance from './Appearance'; +import {getColorScheme} from './Appearance'; import NativeDevLoadingView from './NativeDevLoadingView'; const COLOR_SCHEME = { @@ -39,9 +39,7 @@ module.exports = { showMessage(message: string, type: 'load' | 'refresh') { if (NativeDevLoadingView) { const colorScheme = - Appearance.getColorScheme() === 'dark' - ? COLOR_SCHEME.dark - : COLOR_SCHEME.default; + getColorScheme() === 'dark' ? COLOR_SCHEME.dark : COLOR_SCHEME.default; const colorSet = colorScheme[type]; diff --git a/packages/react-native/Libraries/Utilities/useColorScheme.js b/packages/react-native/Libraries/Utilities/useColorScheme.js index 180a32e0322..fb5c8ef153e 100644 --- a/packages/react-native/Libraries/Utilities/useColorScheme.js +++ b/packages/react-native/Libraries/Utilities/useColorScheme.js @@ -12,14 +12,14 @@ import type {ColorSchemeName} from './NativeAppearance'; -import Appearance from './Appearance'; +import {addChangeListener, getColorScheme} from './Appearance'; import {useSyncExternalStore} from 'react'; const subscribe = (onStoreChange: () => void) => { - const appearanceSubscription = Appearance.addChangeListener(onStoreChange); + const appearanceSubscription = addChangeListener(onStoreChange); return () => appearanceSubscription.remove(); }; export default function useColorScheme(): ?ColorSchemeName { - return useSyncExternalStore(subscribe, Appearance.getColorScheme); + return useSyncExternalStore(subscribe, getColorScheme); } diff --git a/packages/react-native/Libraries/__tests__/__snapshots__/public-api-test.js.snap b/packages/react-native/Libraries/__tests__/__snapshots__/public-api-test.js.snap index 4271caff8d1..92e994b858e 100644 --- a/packages/react-native/Libraries/__tests__/__snapshots__/public-api-test.js.snap +++ b/packages/react-native/Libraries/__tests__/__snapshots__/public-api-test.js.snap @@ -9156,11 +9156,11 @@ declare export default typeof UTFSequence; exports[`public API should not change unintentionally Libraries/Utilities/Appearance.js 1`] = ` "type AppearanceListener = (preferences: AppearancePreferences) => void; -declare module.exports: { - getColorScheme(): ?ColorSchemeName, - setColorScheme(colorScheme: ?ColorSchemeName): void, - addChangeListener(listener: AppearanceListener): EventSubscription, -}; +declare export function getColorScheme(): ?ColorSchemeName; +declare export function setColorScheme(colorScheme: ?ColorSchemeName): void; +declare export function addChangeListener( + listener: AppearanceListener +): EventSubscription; " `; diff --git a/packages/react-native/index.js b/packages/react-native/index.js index a15bd53bdb5..fc5fbe58e63 100644 --- a/packages/react-native/index.js +++ b/packages/react-native/index.js @@ -82,7 +82,7 @@ import typeof StyleSheet from './Libraries/StyleSheet/StyleSheet'; import typeof Text from './Libraries/Text/Text'; import typeof * as TurboModuleRegistry from './Libraries/TurboModule/TurboModuleRegistry'; import typeof UTFSequence from './Libraries/UTFSequence'; -import typeof Appearance from './Libraries/Utilities/Appearance'; +import typeof * as Appearance from './Libraries/Utilities/Appearance'; import typeof BackHandler from './Libraries/Utilities/BackHandler'; import typeof DeviceInfo from './Libraries/Utilities/DeviceInfo'; import typeof DevSettings from './Libraries/Utilities/DevSettings';