@dfds-ui/hooks 2.2.0-alpha.9edc847c → 2.2.0-alpha.a78c2264

package/index.d.ts

@@ -0,0 +1,6 @@
+export { default as useScript } from './useScript';
+export { default as useResizeObserver } from './useResizeObserver';
+export { default as useForwardedRef } from './useForwardedRef';
+export { default as useOffline } from './useOffline';
+export { default as useDimensions } from './useDimensions';
+export * from './useGoogleReCaptchaV3';

package/package.json

@@ -3,7 +3,7 @@
   "description": "React hooks",
   "license": "MIT",
   "private": false,
-  "version": "2.2.0-alpha.9edc847c",
+  "version": "2.2.0-alpha.a78c2264",
   "sideEffects": false,
   "main": "./cjs/index.js",
   "module": "./index.js",
@@ -16,7 +16,7 @@
   "dependencies": {
     "use-resize-observer": "^9.1.0"
   },
-  "gitHead": "9edc847c21d2f86054d768d1f84d34027ca9d675",
+  "gitHead": "a78c2264aa558061cf24673e789db86617e849cc",
   "publishConfig": {
     "access": "public"
   }

package/useDimensions.d.ts

@@ -0,0 +1,16 @@
+export interface DimensionObject {
+    width: number;
+    height: number;
+    top: number;
+    left: number;
+    x: number;
+    y: number;
+    right: number;
+    bottom: number;
+}
+export type UseDimensionsHook = [(node: HTMLElement | null) => void, DimensionObject, HTMLElement | null];
+export interface UseDimensionsArgs {
+    liveMeasure?: boolean;
+}
+declare function useDimensions({ liveMeasure }?: UseDimensionsArgs): UseDimensionsHook;
+export default useDimensions;

package/useForwardedRef.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare function useForwardedRef<T>(forwardedRef: ((instance: T | null) => void) | React.MutableRefObject<T | null> | null): React.RefObject<T>;
+export default useForwardedRef;

package/useGoogleReCaptchaV3.d.ts

@@ -0,0 +1,18 @@
+declare global {
+    interface Window {
+        grecaptcha: any;
+    }
+}
+export type GoogleReCaptchaV3Options = {
+    /**
+     * The `sitekey` to use with reCAPTCHA v3.
+     * https://developers.google.com/recaptcha/docs/v3
+     */
+    siteKey: string;
+    /**
+     * Disable ReCaptcha preventing the script from loading and return undefined from the execute function.
+     * This is useful when consumer needs to conditionally enable or disable ReCaptcha
+     */
+    disabled?: boolean;
+};
+export declare function useGoogleReCaptchaV3({ siteKey, disabled }: GoogleReCaptchaV3Options): (action?: string) => Promise<string | undefined>;

package/useOffline.d.ts

@@ -0,0 +1,5 @@
+declare const useOffline: () => {
+    isOnline: boolean;
+    isOffline: boolean;
+};
+export default useOffline;

package/useResizeObserver.d.ts

@@ -0,0 +1,2 @@
+import useResizeObserver from 'use-resize-observer/polyfilled';
+export default useResizeObserver;

package/useScript.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Hook for loading external script
+ * @param {string} src - The URL of the script
+ * @param {boolean} [doNotLoad=false] - If set to true the script will not be loaded
+ *  This can be handy because hooks can not be called conditionally by the consumer
+ */
+declare function useScript(src: string, doNotLoad?: boolean): boolean[];
+export default useScript;