@transferwise/components 40.8.3 → 40.8.4

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [40.8.4](https://github.com/transferwise/neptune-web/compare/@transferwise/components@40.8.3...@transferwise/components@40.8.4) (2022-05-05)
+
+
+### Bug Fixes
+
+* types for `useConditionalListener` hooks ([#1437](https://github.com/transferwise/neptune-web/issues/1437)) ([f2ccb49](https://github.com/transferwise/neptune-web/commit/f2ccb492ea8624f01e077c3b2d001667c9deeb46))
+
+
+
+
+
 ## [40.8.3](https://github.com/transferwise/neptune-web/compare/@transferwise/components@40.8.2...@transferwise/components@40.8.3) (2022-05-04)
 
 

package/build/es/no-polyfill/common/hooks/useConditionalListener/useConditionalListener.js

@@ -1,12 +1,3 @@
-import{isUndefined}from"@transferwise/neptune-validation";import{useEffect}from"react";/**
- * useConditionalListener attaches an event to the document when a condition is met.
- *
- * @param {bool} attachListener - condition to be met for the listener to be attached
- * @param {Function} callback - function registered with the event listener
- * @param {string} eventType - type of event to attach to document
- * @usage `useConditionalListener({
- *  eventType: 'click',
- *  callback,
- *  attachListener: condition,
- * });`
- */export var useConditionalListener=function(a){var b=a.attachListener,c=a.callback,d=a.eventType,e=a.parent;useEffect(function(){return b&&!isUndefined(e)&&e.addEventListener(d,c,!0),function(){isUndefined(e)||e.removeEventListener(d,c,!0)}},[b])};
+// @ts-expect-error remove this when `@transferwise/neptune-validation` provides types
+import{isUndefined}from"@transferwise/neptune-validation";import{useEffect}from"react";export var useConditionalListener=function(a){var b=a.attachListener,c=a.callback,d=a.eventType,e=a.parent;useEffect(function(){return b&&// eslint-disable-next-line @typescript-eslint/no-unsafe-call
+!isUndefined(e)&&e.addEventListener(d,c,!0),function(){isUndefined(e)||e.removeEventListener(d,c,!0)}},[b,c,d,e])};

package/build/es/polyfill/common/hooks/useConditionalListener/useConditionalListener.js

@@ -1,12 +1,3 @@
-import{isUndefined}from"@transferwise/neptune-validation";import{useEffect}from"react";/**
- * useConditionalListener attaches an event to the document when a condition is met.
- *
- * @param {bool} attachListener - condition to be met for the listener to be attached
- * @param {Function} callback - function registered with the event listener
- * @param {string} eventType - type of event to attach to document
- * @usage `useConditionalListener({
- *  eventType: 'click',
- *  callback,
- *  attachListener: condition,
- * });`
- */export var useConditionalListener=function(a){var b=a.attachListener,c=a.callback,d=a.eventType,e=a.parent;useEffect(function(){return b&&!isUndefined(e)&&e.addEventListener(d,c,!0),function(){isUndefined(e)||e.removeEventListener(d,c,!0)}},[b])};
+// @ts-expect-error remove this when `@transferwise/neptune-validation` provides types
+import{isUndefined}from"@transferwise/neptune-validation";import{useEffect}from"react";export var useConditionalListener=function(a){var b=a.attachListener,c=a.callback,d=a.eventType,e=a.parent;useEffect(function(){return b&&// eslint-disable-next-line @typescript-eslint/no-unsafe-call
+!isUndefined(e)&&e.addEventListener(d,c,!0),function(){isUndefined(e)||e.removeEventListener(d,c,!0)}},[b,c,d,e])};

package/build/types/common/commonProps.d.ts

@@ -15,6 +15,7 @@ export declare type LinkProps = {
     target?: '_blank' | '_self' | '_parent' | '_top';
 };
 export declare type Heading = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+export declare type ParentElement = HTMLElement | Window | Document;
 export declare type OnClickHandler = {
     onClick: (event: Event) => void;
 };

package/build/types/common/hooks/useConditionalListener/useConditionalListener.d.ts

@@ -1 +1,9 @@
-export function useConditionalListener({ attachListener, callback, eventType, parent }: bool): void;
+import { ParentElement } from '../..';
+declare type Data = {
+    attachListener: boolean;
+    callback: EventListenerOrEventListenerObject;
+    eventType: string;
+    parent: ParentElement | undefined;
+};
+export declare const useConditionalListener: ({ attachListener, callback, eventType, parent }: Data) => void;
+export {};