@siberiacancode/reactuse 0.2.26 → 0.2.28

package/dist/types/helpers/createStore/createStore.d.ts

@@ -1,10 +1,11 @@
-type SetStateAction<Value> = ((prev: Value) => Value) | Value;
-type StateCreator<Value> = (set: (action: SetStateAction<Value>) => void, get: () => Value) => Value;
+type StoreSetAction<Value> = ((prev: Value) => Partial<Value>) | Partial<Value>;
+type StoreListener<Value> = (state: Value, prevState: Value) => void;
+type StoreCreator<Value> = (set: (action: StoreSetAction<Value>) => void, get: () => Value) => Value;
 export interface StoreApi<Value> {
     getInitialState: () => Value;
     getState: () => Value;
-    setState: (action: SetStateAction<Value>) => void;
-    subscribe: (listener: (state: Value, prevState: Value) => void) => () => void;
+    setState: (action: StoreSetAction<Value>) => void;
+    subscribe: (listener: StoreListener<Value>) => () => void;
 }
 /**
  * @name createStore
@@ -21,10 +22,13 @@ export interface StoreApi<Value> {
  *   increment: () => set(state => ({ count: state.count + 1 }))
  * }));
  */
-export declare const createStore: <Value>(createState: StateCreator<Value> | Value) => {
-    set: (action: SetStateAction<Value>) => void;
+export declare const createStore: <Value>(createState: StoreCreator<Value> | Value) => {
+    set: (action: StoreSetAction<Value>) => void;
     get: () => Value;
-    use: <Selected>(selector?: (state: Value) => Selected) => Value | Selected;
-    subscribe: (listener: (state: Value, prevState: Value) => void) => () => boolean;
+    use: {
+        (): Value;
+        <Selected>(selector: (state: Value) => Selected): Selected;
+    };
+    subscribe: (listener: StoreListener<Value>) => () => boolean;
 };
 export {};

package/dist/types/hooks/browser.d.ts

@@ -28,5 +28,6 @@ export * from './useShare/useShare';
 export * from './useSpeechRecognition/useSpeechRecognition';
 export * from './useSpeechSynthesis/useSpeechSynthesis';
 export * from './useVibrate/useVibrate';
+export * from './useVirtualKeyboard/useVirtualKeyboard';
 export * from './useWakeLock/useWakeLock';
 export * from './useWebSocket/useWebSocket';

package/dist/types/hooks/elements.d.ts

@@ -9,6 +9,7 @@ export * from './useHover/useHover';
 export * from './useImage/useImage';
 export * from './useLongPress/useLongPress';
 export * from './usePaint/usePaint';
+export * from './useRightClick/useRightClick';
 export * from './useScript/useScript';
 export * from './useSticky/useSticky';
 export * from './useTextDirection/useTextDirection';

package/dist/types/hooks/useAsync/useAsync.d.ts

@@ -11,10 +11,10 @@ export interface UseAsyncReturn<Data> {
  * @category Async
  *
  * @param {() => Promise<Data>} callback The async callback
- * @param {DependencyList} deps The dependencies of the callback
+ * @param {DependencyList} [deps=[]] The dependencies of the callback
  * @returns {UseAsyncReturn<Data>} The state of the async callback
  *
  * @example
  * const { data, isLoading, isError, error } = useAsync(() => fetch('url'), [deps]);
  */
-export declare const useAsync: <Data>(callback: () => Promise<Data>, deps: DependencyList) => UseAsyncReturn<Data>;
+export declare const useAsync: <Data>(callback: () => Promise<Data>, deps?: DependencyList) => UseAsyncReturn<Data>;

package/dist/types/hooks/useImage/useImage.d.ts

@@ -31,14 +31,14 @@ export type UseImageReturn = UseQueryReturn<HTMLImageElement>;
  * @param {HTMLImageElement['loading']} [options.loading] The loading of the image
  * @param {string} [options.crossorigin] The crossorigin of the image
  * @param {HTMLImageElement['referrerPolicy']} [options.referrerPolicy] The referrerPolicy of the image
- * @param {DependencyList} [useQueryOptions.keys] The dependencies for the hook
- * @param {(data: Data) => void} [useQueryOptions.onSuccess] The callback function to be invoked on success
- * @param {(error: Error) => void} [useQueryOptions.onError] The callback function to be invoked on error
- * @param {number} [useQueryOptions.refetchInterval] The refetch interval
- * @param {boolean | number} [useQueryOptions.retry] The retry count of requests
+ * @param {DependencyList} [options.keys] The dependencies for the hook
+ * @param {(data: Data) => void} [options.onSuccess] The callback function to be invoked on success
+ * @param {(error: Error) => void} [options.onError] The callback function to be invoked on error
+ * @param {number} [options.refetchInterval] The refetch interval
+ * @param {boolean | number} [options.retry] The retry count of requests
  * @returns {UseImageReturn} An object with the state of the image
  *
  * @example
  * const { data, isLoading, isError, isSuccess, error, refetch, isRefetching } = useImage('https://example.com/image.png');
  */
-export declare const useImage: (src: string, options?: UseImageOptions, useQueryOptions?: Omit<UseQueryOptions<HTMLImageElement, HTMLImageElement>, "initialData" | "placeholderData" | "select">) => UseQueryReturn<HTMLImageElement>;
+export declare const useImage: (src: string, options?: UseImageOptions & Omit<UseQueryOptions<HTMLImageElement, HTMLImageElement>, "initialData" | "placeholderData" | "select">) => UseQueryReturn<HTMLImageElement>;

package/dist/types/hooks/useVirtualKeyboard/useVirtualKeyboard.d.ts

@@ -0,0 +1,41 @@
+declare global {
+    interface Navigator {
+        virtualKeyboard?: {
+            boundingRect: DOMRect;
+            overlaysContent: boolean;
+            show: () => void;
+            hide: () => void;
+            addEventListener: (type: 'geometrychange', listener: EventListener) => void;
+            removeEventListener: (type: 'geometrychange', listener: EventListener) => void;
+        };
+    }
+}
+/** The use virtual keyboard return type */
+export interface UseVirtualKeyboardReturn {
+    /** Whether the virtual keyboard is currently open */
+    opened: boolean;
+    /** Whether the VirtualKeyboard API is supported */
+    supported: boolean;
+    /** Change the overlays content */
+    changeOverlaysContent: (overlaysContent: boolean) => void;
+    /** Hide the virtual keyboard */
+    hide: () => void;
+    /** Show the virtual keyboard */
+    show: () => void;
+}
+/**
+ * @name useVirtualKeyboard
+ * @description - Hook that manages virtual keyboard state
+ * @category Browser
+ *
+ * @browserapi VirtualKeyboard https://developer.mozilla.org/en-US/docs/Web/API/VirtualKeyboard
+ *
+ * @warning - This hook has a fallback for virtual keyboard detection. If the virtual keyboard is not supported, the methods will not work.
+ *
+ * @param {boolean} [initialValue=false] The initial state value for keyboard visibility
+ * @returns {UseVirtualKeyboardReturn} An object containing keyboard state and control methods
+ *
+ * @example
+ * const { opened, show, hide, supported, changeOverlaysContent } = useVirtualKeyboard();
+ */
+export declare const useVirtualKeyboard: (initialValue?: boolean) => UseVirtualKeyboardReturn;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.2.26",
+  "version": "0.2.28",
   "description": "The ultimate collection of react hooks",
   "author": {
     "name": "SIBERIA CAN CODE 🧊",