1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
/* eslint-disable max-statements */
import {
createContext,
type FC,
type ReactNode,
useCallback,
useContext,
useEffect,
useState,
useMemo,
} from 'react';
import { useAttributes, useLocalStorage, useQuerySelectorAll } from '../hooks';
export type PrismTheme = 'dark' | 'light' | 'system';
export type ResolvedPrismTheme = Exclude<PrismTheme, 'system'>;
export type UsePrismThemeProps = {
themes: PrismTheme[];
theme?: PrismTheme;
setTheme: (theme: PrismTheme) => void;
resolvedTheme?: ResolvedPrismTheme;
codeBlocks?: NodeListOf<HTMLPreElement>;
};
export type PrismThemeProviderProps = {
attribute?: string;
children: ReactNode;
storageKey?: string;
themes?: PrismTheme[];
};
export const PrismThemeContext = createContext<UsePrismThemeProps>({
themes: ['dark', 'light', 'system'],
setTheme: (_) => {
// This is intentional.
},
});
export const usePrismTheme = () => useContext(PrismThemeContext);
/**
* Check if user prefers dark color scheme.
*
* @returns {boolean|undefined} True if `prefers-color-scheme` is set to `dark`.
*/
const prefersDarkScheme = (): boolean | undefined => {
if (typeof window === 'undefined') return undefined;
return window.matchMedia('(prefers-color-scheme: dark)').matches;
};
/**
* Check if a given string is a Prism theme name.
*
* @param {string} theme - A string.
* @returns {boolean} True if the given string match a Prism theme name.
*/
const isValidTheme = (theme: string): boolean =>
theme === 'dark' || theme === 'light' || theme === 'system';
const defaultThemes = ['dark', 'light', 'system'] satisfies PrismTheme[];
const validator = (value: unknown): value is PrismTheme =>
typeof value === 'string' && (defaultThemes as string[]).includes(value);
export const PrismThemeProvider: FC<PrismThemeProviderProps> = ({
attribute = 'data-prismjs-color-scheme-current',
storageKey = 'prismjs-color-scheme',
themes = defaultThemes,
children,
}) => {
/**
* Retrieve the theme to use depending on `prefers-color-scheme`.
*/
const getThemeFromSystem = useCallback(() => {
if (prefersDarkScheme()) return 'dark';
return 'light';
}, []);
const [prismTheme, setPrismTheme] = useLocalStorage<PrismTheme>(
storageKey,
'system',
validator
);
useEffect(() => {
if (!isValidTheme(prismTheme)) setPrismTheme('system');
}, [prismTheme, setPrismTheme]);
const [resolvedTheme, setResolvedTheme] = useState<ResolvedPrismTheme>();
useEffect(() => {
if (prismTheme === 'dark' || prismTheme === 'light') {
setResolvedTheme(prismTheme);
} else {
setResolvedTheme(getThemeFromSystem());
}
}, [prismTheme, getThemeFromSystem]);
const updateResolvedTheme = useCallback(() => {
setResolvedTheme(getThemeFromSystem());
}, [getThemeFromSystem]);
useEffect(() => {
window
.matchMedia('(prefers-color-scheme: dark)')
.addEventListener('change', updateResolvedTheme);
return () =>
window
.matchMedia('(prefers-color-scheme: dark)')
.removeEventListener('change', updateResolvedTheme);
}, [updateResolvedTheme]);
const preTags = useQuerySelectorAll<'pre'>('pre');
useAttributes({ elements: preTags, attribute, value: prismTheme });
/**
* Listen for changes on pre attributes and update theme.
*/
const listenAttributeChange = useCallback(
(pre: HTMLPreElement) => {
const observer = new MutationObserver((mutations) => {
mutations.forEach((record) => {
const mutatedPre = record.target as HTMLPreElement;
const newTheme = mutatedPre.getAttribute(attribute) as PrismTheme;
setPrismTheme(newTheme);
});
});
observer.observe(pre, {
attributes: true,
attributeFilter: [attribute],
});
},
[attribute, setPrismTheme]
);
useEffect(() => {
if (!preTags) return;
preTags.forEach(listenAttributeChange);
}, [preTags, listenAttributeChange]);
const value = useMemo(() => {
return {
themes,
theme: prismTheme,
setTheme: setPrismTheme,
codeBlocks: preTags,
resolvedTheme,
};
}, [preTags, prismTheme, resolvedTheme, setPrismTheme, themes]);
return (
<PrismThemeContext.Provider value={value}>
{children}
</PrismThemeContext.Provider>
);
};
|