Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(theming): nested ColorSchemeProvider system color scheme handling #2000

Merged
merged 3 commits into from
Jan 16, 2025
Merged

fix(theming): nested ColorSchemeProvider system color scheme handling #2000

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a91e773
fix(theming): nested `ColorSchemeProvider` system color scheme handling
jzempel Jan 16, 2025
11478e0
Fix mediaQuery declaration
jzempel Jan 16, 2025
248b92f
Improve jsdoc
jzempel Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 40 additions & 36 deletions packages/theming/src/elements/ColorSchemeProvider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,58 +13,39 @@ import React, {
useMemo,
useState
} from 'react';
import PropTypes from 'prop-types';
import {
ColorScheme,
IColorSchemeContext,
IColorSchemeProviderProps,
IGardenTheme
} from '../types';

const useColorScheme = (initialState?: ColorScheme, colorSchemeKey = 'color-scheme') => {
const mediaQuery =
typeof window === 'undefined' ? undefined : window.matchMedia('(prefers-color-scheme: dark)');

const useColorScheme = (initialState: ColorScheme, colorSchemeKey: string) => {
/* eslint-disable-next-line n/no-unsupported-features/node-builtins */
const localStorage = typeof window === 'undefined' ? undefined : window.localStorage;
const mediaQuery =
typeof window === 'undefined' ? undefined : window.matchMedia('(prefers-color-scheme: dark)');

const getState = useCallback(
(_state?: ColorScheme | null) => {
const isSystem = _state === 'system' || _state === undefined || _state === null;
let colorScheme: IGardenTheme['colors']['base'];
const getState = useCallback((_state?: ColorScheme | null) => {
const isSystem = _state === 'system' || _state === undefined || _state === null;
let colorScheme: IGardenTheme['colors']['base'];

if (isSystem) {
colorScheme = mediaQuery?.matches ? 'dark' : 'light';
} else {
colorScheme = _state;
}
if (isSystem) {
colorScheme = mediaQuery?.matches ? 'dark' : 'light';
} else {
colorScheme = _state;
}

return { isSystem, colorScheme };
},
[mediaQuery?.matches]
);
return { isSystem, colorScheme };
}, []);

const [state, setState] = useState<{
isSystem: boolean;
colorScheme: IGardenTheme['colors']['base'];
}>(getState((localStorage?.getItem(colorSchemeKey) as ColorScheme) || initialState));

useEffect(() => {
// Listen for changes to the system color scheme
/* istanbul ignore next */
const eventListener = () => {
setState(getState('system'));
};

if (state.isSystem) {
mediaQuery?.addEventListener('change', eventListener);
} else {
mediaQuery?.removeEventListener('change', eventListener);
}

return () => {
mediaQuery?.removeEventListener('change', eventListener);
};
}, [getState, state.isSystem, mediaQuery]);

return {
isSystem: state.isSystem,
colorScheme: state.colorScheme,
Expand All @@ -79,8 +60,8 @@ export const ColorSchemeContext = createContext<IColorSchemeContext | undefined>

export const ColorSchemeProvider = ({
children,
colorSchemeKey,
initialColorScheme
colorSchemeKey = 'color-scheme',
initialColorScheme = 'system'
}: PropsWithChildren<IColorSchemeProviderProps>) => {
const { isSystem, colorScheme, setColorScheme } = useColorScheme(
initialColorScheme,
Expand All @@ -91,5 +72,28 @@ export const ColorSchemeProvider = ({
[isSystem, colorScheme, setColorScheme]
);

useEffect(() => {
// Listen for changes to the system color scheme
/* istanbul ignore next */
const eventListener = () => {
setColorScheme('system');
};

if (isSystem) {
mediaQuery?.addEventListener('change', eventListener);
} else {
mediaQuery?.removeEventListener('change', eventListener);
}

return () => {
mediaQuery?.removeEventListener('change', eventListener);
};
}, [isSystem, setColorScheme]);

return <ColorSchemeContext.Provider value={contextValue}>{children}</ColorSchemeContext.Provider>;
};

ColorSchemeProvider.propTypes = {
colorSchemeKey: PropTypes.string,
initialColorScheme: PropTypes.oneOf(['light', 'dark', 'system'])
};
16 changes: 16 additions & 0 deletions utils/test/jest.setup.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,19 @@ import '@testing-library/jest-dom';
import { TextEncoder } from 'node:util';

global.TextEncoder = TextEncoder;

// https://jestjs.io/docs/manual-mocks#mocking-methods-which-are-not-implemented-in-jsdom
Object.defineProperty(window, 'matchMedia', {
writable: true,
/* eslint-disable no-undef */
value: jest.fn().mockImplementation(query => ({
matches: false,
media: query,
onchange: null,
addListener: jest.fn(), // deprecated
removeListener: jest.fn(), // deprecated
addEventListener: jest.fn(),
removeEventListener: jest.fn(),
dispatchEvent: jest.fn()
}))
});
Loading