docs(changeset): Support do not persist prop -> dp

Author: mayank1513

.changeset/young-onions-help.md

@@ -0,0 +1,5 @@
+---
+"nextjs-darkmode": minor
+---
+
+Support do not persist prop -> `dp`

lib/src/client/core/core.tsx

@@ -7,6 +7,8 @@ export interface CoreProps {
   t?: string;
   /** The nonce value for your Content Security Policy. */
   nonce?: string;
+  /** dp -> Do Not Persist. Set this prop when you do not want to persist the mode. e.g., when using Tailwind, but you prefer SSG */
+  dp?: boolean;
 }
 
 /** Modify transition globally to avoid patched transitions */
@@ -36,8 +38,8 @@ const modifyTransition = (themeTransition = "none", nonce = "") => {
  *
  * @source - Source code
  */
-export const Core = ({ t, nonce }: CoreProps) => {
-  const [{ m: mode, s: systemMode }, setThemeState] = useStore();
+export const Core = ({ t, nonce, dp }: CoreProps) => {
+  const [{ m: mode, s: systemMode }, setThemeState] = useStore(dp);
   const resolvedMode = mode === SYSTEM ? systemMode : mode; // resolvedMode is the actual mode that will be used
 
   useEffect(() => {
@@ -73,8 +75,8 @@ export const Core = ({ t, nonce }: CoreProps) => {
     });
     restoreTransitions();
     // System mode is decided by current system state and need not be stored in localStorage
-    localStorage.setItem(COOKIE_KEY, mode);
-    if (serverTargetEl)
+    !dp && localStorage.setItem(COOKIE_KEY, mode);
+    if (!dp && serverTargetEl)
       document.cookie = `${COOKIE_KEY}=${resolvedMode};max-age=31536000;SameSite=Strict;`;
   }, [resolvedMode, systemMode, mode, t, nonce]);
 

lib/src/utils.ts

@@ -9,13 +9,13 @@ export interface Store {
 }
 
 /** local abstaction of RGS to avoid multiple imports */
-export const useStore = () =>
+export const useStore = (/** Do not persist */ dp?: boolean) =>
   useRGS<Store>("ndm", () =>
     typeof localStorage === "undefined"
       ? /* v8 ignore next */
         { m: SYSTEM, s: DARK as ResolvedScheme }
       : {
-          m: (localStorage.getItem(COOKIE_KEY) ?? SYSTEM) as ColorSchemePreference,
+          m: (dp ? SYSTEM : localStorage.getItem(COOKIE_KEY) ?? SYSTEM) as ColorSchemePreference,
           s: (matchMedia(MEDIA).matches ? DARK : LIGHT) as ResolvedScheme,
         },
   );