@bigbinary/neeto-commons-frontend 2.0.87 → 2.0.89

package/react-utils.d.ts

@@ -616,17 +616,76 @@ type ConfigType = {
 export function useHotKeys(hotkey: string | string[], handler: (event: React.KeyboardEvent) => void, config?: ConfigType): React.MutableRefObject | null;
 /**
  *
- * This hook returns a state that automatically updates its value to defaultValue whenever defaultValue changes. We can also specify a dependencies array to listen to other variable changes.
+ * This hook returns a state that automatically updates its value to defaultValue
  *
- * This hook accepts a defaultValue and an optional array called dependencies. If dependencies is passed, the hook returns a state variable whose value will be updated to defaultValue in a useEffect that depends on the dependencies array. Otherwise, the useEffect will depend only on the defaultValue.
+ * whenever defaultValue changes. We can also specify a dependencies array to
+ *
+ * listen to other variable changes.
+ *
+ * This hook accepts a defaultValue and an optional array called dependencies.
+ *
+ * If dependencies is passed, the hook returns a state variable whose value will
+ *
+ * be updated to defaultValue in a useEffect that depends on the dependencies
+ *
+ * array. Otherwise, the useEffect will depend only on the defaultValue.
  *
  * @example 
  *
- * const [value, setValue] = useStateWithDependency(defaultValue);// reset state to `defaultValue` whenever `defaultValue` changes.
- * const [value, setValue] = useStateWithDependency(defaultValue, [value1, value2]); // reset state to `defaultValue` only when `value1` or `value2` changes.
+ * const [value, setValue] = useStateWithDependency(defaultValue); // reset state to `defaultValue` whenever `defaultValue` changes.
+ * const [value, setValue] = useStateWithDependency(defaultValue, [
+ *   value1,
+ *   value2,
+ * ]); // reset state to `defaultValue` only when `value1` or `value2` changes.
  * 
  * // In a case, where the value needs to be reset when defaultValue changes too, defaultValue can be passed with the dependencies, as shown below.
- * const [value, setValue] = useStateWithDependency(defaultValue, [ value1, value2, defaultValue ]);
+ * const [value, setValue] = useStateWithDependency(defaultValue, [
+ *   value1,
+ *   value2,
+ *   defaultValue,
+ * ]);
+ * @endexample
+*/
+export function useStateWithDependency<T>(defaultValue: T, dependencies?: any[]): T;
+/**
+ *
+ * This hook returns a function that can be used to register navigation checkpoint
+ *
+ * to a Zustand store.
+ *
+ * The function returned by this hook accepts key and path as arguments. It
+ *
+ * will store the path as the value for the key in a Zustand store. This
+ *
+ * registered checkpoint can be retrieved using the useNavigationCheckpoint hook.
+ *
+ * @example 
+ *
+ * const registerNavigationCheckpoint = useRegisterNavigationCheckpoint();
+ * 
+ * useEffect(() => {
+ *   registerNavigationCheckpoint(CHECKPOINT_KEY, CHECKPOINT_PATH);
+ * }, []);
+ * @endexample
+*/
+export function useRegisterNavigationCheckpoint(): (key: string, path: string) => void;
+/**
+ *
+ * This hook returns the registered navigation checkpoint.
+ *
+ * This hook accepts key and will return the checkpoint path corresponding to the
+ *
+ * key from a Zustand store.
+ *
+ * @example 
+ *
+ * const navigationCheckpoint = useRegisterNavigationCheckpoint(CHECK_POINT_KEY);
+ * 
+ * return (
+ *   <>
+ *     <Link to={navigationCheckpoint}>Navigate</Link>
+ *   </>
+ * );
  * @endexample
 */
-export function useStateWithDependency<T>(defaultValue: T, dependencies?: any[]): T;
+export function useNavigationCheckpoint(key: string): string;