Skip to content
Open
Changes from all commits
Commits
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
75 changes: 48 additions & 27 deletions packages/docs-ui/src/providers/ColorMode/index.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
'use client';

import React, { createContext, useContext, useEffect, useLayoutEffect, useState } from 'react';
import React, {
createContext,
useContext,
useEffect,
useLayoutEffect,
useState,
} from 'react';

export type ColorMode = 'light' | 'dark';

Expand All @@ -16,48 +22,63 @@ export type ColorModeProviderProps = {
children: React.ReactNode;
};

const isColorMode = (value: unknown): value is ColorMode =>
value === 'light' || value === 'dark';

const readStoredTheme = (): ColorMode | null => {
try {
const stored = localStorage.getItem('theme');
return isColorMode(stored) ? stored : null;
} catch {
return null;
}
};

export const ColorModeProvider = ({ children }: ColorModeProviderProps) => {
const [colorMode, setColorMode] = useState<ColorMode>('light');
const [loaded, setLoaded] = useState(false);
const [colorMode, setColorModeState] = useState<ColorMode>('light');

// Only an explicit user choice is persisted. Persisting the resolved value
// would freeze the system default into localStorage and later override it.
const setColorMode = (value: ColorMode) => {
setColorModeState(value);
try {
localStorage.setItem('theme', value);
} catch {
// storage unavailable (e.g. private mode); choice applies to this session
}
};

const toggleColorMode = () =>
setColorMode(colorMode === 'light' ? 'dark' : 'light');

useLayoutEffect(() => {
if (loaded) {
return;
}
const media = window.matchMedia('(prefers-color-scheme: dark)');
const systemTheme = (): ColorMode => {
return media.matches ? 'dark' : 'light';
};

const urlTheme = new URLSearchParams(window.location.search).get(
'docusaurus-theme'
);
const theme = urlTheme ?? localStorage.getItem('theme');
if (theme && (theme === 'light' || theme === 'dark')) {
setColorMode(theme);
} else {
const prefersDark = window.matchMedia(
'(prefers-color-scheme: dark)'
).matches;
setColorMode(prefersDark ? 'dark' : 'light');
}
setLoaded(true);
// URL param wins for this view only (not persisted)
setColorModeState(
isColorMode(urlTheme) ? urlTheme : (readStoredTheme() ?? systemTheme())
);

// Follow live system changes unless the user chose explicitly
const onChange = () => {
if (!readStoredTheme()) {
setColorModeState(systemTheme());
}
};
media.addEventListener('change', onChange);
return () => media.removeEventListener('change', onChange);
}, []);

useEffect(() => {
document.querySelector('html')?.setAttribute('data-theme', colorMode);
}, [colorMode]);

useEffect(() => {
if (!loaded) {
return;
}

const theme = localStorage.getItem('theme');
if (theme !== colorMode) {
localStorage.setItem('theme', colorMode);
}
}, [loaded, colorMode]);

return (
<ColorModeContext.Provider
value={{
Expand Down
Loading