Skip to content

feat(theming): allow null color scheme key to bypass ColorSchemeProvider local storage #2032

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

Merged
merged 1 commit into from
Jul 15, 2025
Merged

feat(theming): allow null color scheme key to bypass ColorSchemeProvider local storage #2032

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 9 additions & 4 deletions packages/theming/demo/stories/ColorSchemeProviderStory.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,12 @@ const Content = ({
};

const handleClear = () => {
localStorage?.removeItem(colorSchemeKey);
localStorage?.removeItem(colorSchemeKey!);
setInputValue('');
};

useEffect(() => {
setInputValue(localStorage?.getItem(colorSchemeKey) || '');
setInputValue(localStorage?.getItem(colorSchemeKey!) || '');
}, [colorSchemeKey, colorScheme, isSystem, localStorage]);

return (
Expand All @@ -75,7 +75,12 @@ const Content = ({
<Field.Label>
Local {!!colorSchemeKey && <Code>{colorSchemeKey}</Code>} storage
</Field.Label>
<Input placeholder="unspecified" readOnly value={inputValue} />
<Input
disabled={colorSchemeKey === null ? true : undefined}
placeholder={colorSchemeKey === null ? 'unused' : 'unspecified'}
readOnly
value={inputValue}
/>
{!!inputValue && (
<Tooltip content={`Clear ${colorSchemeKey} storage`}>
<StyledIconButton focusInset onClick={handleClear} size="small">
Expand All @@ -98,7 +103,7 @@ const Content = ({
placement="bottom-end"
selectedItems={[{ value: isSystem ? 'system' : colorScheme }]}
>
<ItemGroup type="radio">
<ItemGroup aria-label="appearance" type="radio">
<Item icon={<LightIcon />} value="light">
Light
</Item>
Expand Down
14 changes: 9 additions & 5 deletions packages/theming/src/elements/ColorSchemeProvider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,13 @@ import {
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 useColorScheme = (
initialState: ColorScheme,
colorSchemeKey: IColorSchemeProviderProps['colorSchemeKey']
) => {
const localStorage =
/* eslint-disable-next-line n/no-unsupported-features/node-builtins */
typeof window === 'undefined' || colorSchemeKey === null ? undefined : window.localStorage;

const getState = useCallback((_state?: ColorScheme | null) => {
const isSystem = _state === 'system' || _state === undefined || _state === null;
Expand All @@ -44,14 +48,14 @@ const useColorScheme = (initialState: ColorScheme, colorSchemeKey: string) => {
const [state, setState] = useState<{
isSystem: boolean;
colorScheme: IGardenTheme['colors']['base'];
}>(getState((localStorage?.getItem(colorSchemeKey) as ColorScheme) || initialState));
}>(getState((localStorage?.getItem(colorSchemeKey!) as ColorScheme) || initialState));

return {
isSystem: state.isSystem,
colorScheme: state.colorScheme,
setColorScheme: (colorScheme: ColorScheme) => {
setState(getState(colorScheme));
localStorage?.setItem(colorSchemeKey, colorScheme);
localStorage?.setItem(colorSchemeKey!, colorScheme);
}
};
};
Expand Down
4 changes: 2 additions & 2 deletions packages/theming/src/types/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,9 +226,9 @@ export interface IColorSchemeProviderProps {
initialColorScheme?: ColorScheme;
/**
* Specifies the key used to store the user's preferred color scheme in
* `localStorage`
* `localStorage` or `null` to bypass local storage persistence
*/
colorSchemeKey?: string;
colorSchemeKey?: string | null;
}

export interface IThemeProviderProps extends Partial<ThemeProviderProps<IGardenTheme>> {
Expand Down
15 changes: 15 additions & 0 deletions packages/theming/src/utils/useColorScheme.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,21 @@ describe('useColorScheme', () => {
});
});

it('bypasses localStorage as expected', () => {
const Test = () => (
<ColorSchemeProvider colorSchemeKey={null}>
<ColorSchemeConsumer />
</ColorSchemeProvider>
);

expect(() => {
render(<Test />);
}).not.toThrow();

/* eslint-disable-next-line n/no-unsupported-features/node-builtins */
expect(window.localStorage.getItem('color-scheme')).toBeNull();
});

it('sets the color scheme as expected', () => {
const Test = () => (
<ColorSchemeProvider initialColorScheme="light">
Expand Down