[mantine.dev] Add default value documentation for use-local-storage `…

…getInitialValueInEffect` (#6388) * Update use-local-storage.mdx * Update use-local-storage.mdx * Update create-storage.ts
mantinedev · Jun 27, 2024 · c3b026e · c3b026e
1 parent d43d076
commit c3b026e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/apps/mantine.dev/src/pages/hooks/use-local-storage.mdx b/apps/mantine.dev/src/pages/hooks/use-local-storage.mdx
@@ -141,8 +141,8 @@ interface UseLocalStorage<T> {
   /** Default value that will be set if value is not found in local storage */
   defaultValue?: T;
 
-  /** If set to true, value will be updated in useEffect after mount */
-  getInitialValueInEffect: boolean;
+  /** If set to true, value will be updated in useEffect after mount. Default value is true. */
+  getInitialValueInEffect?: boolean;
 
   /** Function to serialize value into a string to be saved in local storage */
   serialize?: (value: T) => string;

diff --git a/packages/@mantine/hooks/src/use-local-storage/create-storage.ts b/packages/@mantine/hooks/src/use-local-storage/create-storage.ts
@@ -11,7 +11,7 @@ export interface StorageProperties<T> {
   /** Default value that will be set if value is not found in storage */
   defaultValue?: T;
 
-  /** If set to true, value will be update is useEffect after mount */
+  /** If set to true, value will be updated in useEffect after mount. Default value is true. */
   getInitialValueInEffect?: boolean;
 
   /** Function to serialize value into string to be save in storage */