Update doc comments

mayank1513 · mayank1513 · commit 25db39ec5b11 · 2024-06-09T18:32:31.000+05:30
diff --git a/lib/src/client/core/core.tsx b/lib/src/client/core/core.tsx
@@ -9,6 +9,7 @@ export interface CoreProps {
   t?: string;
 }
 
+/** Modify transition globally to avoid patched transitions */
 const modifyTransition = (documentMinify: Document, themeTransition = "none") => {
   const css = documentMinify.createElement("style");
   /** split by ';' to prevent CSS injection */
@@ -25,11 +26,12 @@ const modifyTransition = (documentMinify: Document, themeTransition = "none") =>
 };
 
 /**
- *
+ *  The Core component wich applies classes and transitions.
+ * Cookies are set only if corresponding ServerTarget is detected.
  *
  * @example
  * ```tsx
- * <Core />
+ * <Core [t="background-color .3s"]/>
  * ```
  *
  * @source - Source code
@@ -48,7 +50,7 @@ export const Core = ({ t }: CoreProps) => {
 
     setThemeState(state => ({
       ...state,
-      m: (localStorageMinify.getItem(COOKIE_KEY) ?? SYSTEM) as ColorSchemePreference,
+      m: (localStorageMinify?.getItem(COOKIE_KEY) ?? SYSTEM) as ColorSchemePreference,
     }));
     /** Sync the tabs */
     const storageListener = (e: StorageEvent): void => {
@@ -78,7 +80,7 @@ export const Core = ({ t }: CoreProps) => {
     });
     restoreTransitions();
     // System mode is decided by current system state and need not be stored in localStorage
-    localStorageMinify.setItem(COOKIE_KEY, mode);
+    localStorageMinify?.setItem(COOKIE_KEY, mode);
     if (serverTargetEl)
       documentMinify.cookie = `${COOKIE_KEY}=${resolvedMode};max-age=31536000;SameSite=Strict;`;
   }, [resolvedMode, systemMode, mode, t]);
diff --git a/lib/src/client/switch/switch.tsx b/lib/src/client/switch/switch.tsx
@@ -13,11 +13,11 @@ export interface SwitchProps extends HTMLProps<HTMLElement> {
 }
 
 /**
- *
+ * Switch button to quickly toggle user preference.
  *
  * @example
  * ```tsx
- * <Switch />
+ * <Switch [size={20} skipSystem]/>
  * ```
  *
  * @source - Source code
diff --git a/lib/src/hooks/use-mode.ts b/lib/src/hooks/use-mode.ts
@@ -9,11 +9,11 @@ export interface UseModeYeild {
 }
 
 /**
- *
+ * use this hook to gain access to mode state and setter.
  *
  * @example
  * ```tsx
- * const [] = useMode(options);
+ * const {resolvedMode, setMode} = useMode(options);
  * ```
  *
  * @source - Source code
diff --git a/lib/src/server/server-target/server-target.tsx b/lib/src/server/server-target/server-target.tsx
@@ -3,6 +3,7 @@ import { COOKIE_KEY, LIGHT } from "../../constants";
 
 /**
  * Server Side target for avoiding flash of un-themed content.
+ *
  * @example
  * ```tsx
  * <html>
@@ -13,6 +14,8 @@ import { COOKIE_KEY, LIGHT } from "../../constants";
  *   </body>
  * </html>
  * ```
+ *
+ * @source - Source code
  */
 export const ServerTarget = () => {
   const rm = cookies().get(COOKIE_KEY)?.value ?? LIGHT;

Original file line number	Diff line number	Diff line change
`@@ -13,11 +13,11 @@ export interface SwitchProps extends HTMLProps<HTMLElement> {`
`13`	`13`	`}`
`14`	`14`
`15`	`15`	`/**`
`16`		`- *`
	`16`	`+ * Switch button to quickly toggle user preference.`
`17`	`17`	`*`
`18`	`18`	`* @example`
`19`	`19`	* ```tsx
`20`		`- * <Switch />`
	`20`	`+ * <Switch [size={20} skipSystem]/>`
`21`	`21`	* ```
`22`	`22`	`*`
`23`	`23`	`* @source - Source code`
Original file line number	Diff line number	Diff line change
`@@ -9,11 +9,11 @@ export interface UseModeYeild {`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`/**`
`12`		`- *`
	`12`	`+ * use this hook to gain access to mode state and setter.`
`13`	`13`	`*`
`14`	`14`	`* @example`
`15`	`15`	* ```tsx
`16`		`- * const [] = useMode(options);`
	`16`	`+ * const {resolvedMode, setMode} = useMode(options);`
`17`	`17`	* ```
`18`	`18`	`*`
`19`	`19`	`* @source - Source code`