@contentful/f36-utils - npm Package Compare versions

Comparing version 4.0.1-next-v4-9086.2408 to 4.0.1-next-v4-9126.2410

dist/main.js

@@ -1,2 +0,2 @@
-var e=require("react"),r=d(e),{useRef:t,useEffect:n,useState:u,useCallback:c}=e,{createPortal:o}=require("react-dom"),a=d(require("@babel/runtime/helpers/extends")),{cx:l,css:i}=require("emotion");function s(e,r,t,n){Object.defineProperty(e,r,{get:t,set:n,enumerable:!0,configurable:!0})}function d(e){return e&&e.__esModule?e.default:e}var f={};function m({children:e,container:r}){const u=t(r),c=t(document.createElement("div"));return n((()=>{u.current||(u.current=document.body);const e=c.current;return e.setAttribute("data-cf-ui-portal",""),u.current.appendChild(e),()=>{u.current&&u.current.removeChild(e)}}),[]),c.current?o(e,c.current):null}function p({className:e,children:t,...n}){return r.createElement("span",a({tabIndex:-1,className:l(i({name:"t8ljbi",styles:"display:inherit;outline:0;"}),e)},n),t)}s(f,"Portal",(()=>m)),s(f,"TabFocusTrap",(()=>p)),s(f,"useArrowKeyNavigation",(()=>h));const b={vertical:{prev:"ArrowUp",next:"ArrowDown"},horizontal:{prev:"ArrowLeft",next:"ArrowRight"}},h=({itemsContainerRef:e,itemsSelector:r,keyType:t="vertical"})=>{const[n,o]=u(0),a=c((u=>{const c=e.current;if(!c)return;const a=c.querySelectorAll(r);if(0===a.length)return;const l=a.length-1,i={[b[t].next]:()=>{o(n===l?0:n+1)},[b[t].prev]:()=>{o(0===n?l:n-1)}}[u.key];i&&(u.preventDefault(),i())}),[n,r,e,t]);return{focusedIndex:n,handleArrowsKeyDown:a}};var v,y;v=module.exports,y=f,Object.keys(y).forEach((function(e){"default"!==e&&"__esModule"!==e&&Object.defineProperty(v,e,{enumerable:!0,get:function(){return y[e]}})}));
+var e=require("react"),r=d(e),{useEffect:t,useRef:n,useState:o,useCallback:c}=e,{createPortal:u}=require("react-dom"),a=d(require("@babel/runtime/helpers/extends")),{cx:l,css:s}=require("emotion");function i(e,r,t,n){Object.defineProperty(e,r,{get:t,set:n,enumerable:!0,configurable:!0})}function d(e){return e&&e.__esModule?e.default:e}var f={};function p({children:e,container:r}){const o=n(r),c=n(document.createElement("div"));return t((()=>{o.current||(o.current=document.body);const e=c.current;return e.setAttribute("data-cf-ui-portal",""),o.current.appendChild(e),()=>{o.current&&o.current.removeChild(e)}}),[]),c.current?u(e,c.current):null}function y({className:e,children:t,...n}){return r.createElement("span",a({tabIndex:-1,className:l(s({name:"t8ljbi",styles:"display:inherit;outline:0;"}),e)},n),t)}i(f,"Portal",(()=>p)),i(f,"TabFocusTrap",(()=>y)),i(f,"useArrowKeyNavigation",(()=>b)),i(f,"useKeyboard",(()=>v));const m={vertical:{prev:"ArrowUp",next:"ArrowDown"},horizontal:{prev:"ArrowLeft",next:"ArrowRight"}},b=({itemsContainerRef:e,itemsSelector:r,keyType:t="vertical"})=>{const[n,u]=o(0),a=c((o=>{const c=e.current;if(!c)return;const a=c.querySelectorAll(r);if(0===a.length)return;const l=a.length-1,s={[m[t].next]:()=>{u(n===l?0:n+1)},[m[t].prev]:()=>{u(0===n?l:n-1)}}[o.key];s&&(o.preventDefault(),s())}),[n,r,e,t]);return{focusedIndex:n,handleArrowsKeyDown:a}},v=e=>{const{ref:r,keys:n,event:o="keydown"}=e;let u=document;const a=c((e=>{Object.prototype.hasOwnProperty.call(n,e.key)&&n[e.key](e)}),[n]);t((()=>(r&&r.current&&(u=r.current),u.addEventListener(o,a),()=>{u.removeEventListener(o,a)})),[o,a])};var h,w;h=module.exports,w=f,Object.keys(w).forEach((function(e){"default"!==e&&"__esModule"!==e&&Object.defineProperty(h,e,{enumerable:!0,get:function(){return w[e]}})}));
 //# sourceMappingURL=main.js.map

dist/module.js

@@ -1,2 +0,2 @@
-import e,{useEffect as r,useRef as t,useCallback as n,useState as o}from"react";import{createPortal as a}from"react-dom";import c from"@babel/runtime/helpers/esm/extends";import{cx as s,css as u}from"emotion";function i(e,r,t,n){Object.defineProperty(e,r,{get:t,set:n,enumerable:!0,configurable:!0})}var l={};function m({children:e,container:n}){const o=t(n),c=t(document.createElement("div"));return r((()=>{o.current||(o.current=document.body);const e=c.current;return e.setAttribute("data-cf-ui-portal",""),o.current.appendChild(e),()=>{o.current&&o.current.removeChild(e)}}),[]),c.current?a(e,c.current):null}function p({className:r,children:t,...n}){return e.createElement("span",c({tabIndex:-1,className:s(u({name:"t8ljbi",styles:"display:inherit;outline:0;"}),r)},n),t)}i(l,"Portal",(()=>m)),i(l,"TabFocusTrap",(()=>p)),i(l,"useArrowKeyNavigation",(()=>d));const f={vertical:{prev:"ArrowUp",next:"ArrowDown"},horizontal:{prev:"ArrowLeft",next:"ArrowRight"}},d=({itemsContainerRef:e,itemsSelector:r,keyType:t="vertical"})=>{const[a,c]=o(0),s=n((n=>{const o=e.current;if(!o)return;const s=o.querySelectorAll(r);if(0===s.length)return;const u=s.length-1,i={[f[t].next]:()=>{c(a===u?0:a+1)},[f[t].prev]:()=>{c(0===a?u:a-1)}}[n.key];i&&(n.preventDefault(),i())}),[a,r,e,t]);return{focusedIndex:a,handleArrowsKeyDown:s}};export{m as Portal,p as TabFocusTrap,d as useArrowKeyNavigation};
+import e,{useRef as r,useEffect as t,useCallback as n,useState as o}from"react";import{createPortal as a}from"react-dom";import s from"@babel/runtime/helpers/esm/extends";import{css as c,cx as u}from"emotion";function i(e,r,t,n){Object.defineProperty(e,r,{get:t,set:n,enumerable:!0,configurable:!0})}var l={};function m({children:e,container:n}){const o=r(n),s=r(document.createElement("div"));return t((()=>{o.current||(o.current=document.body);const e=s.current;return e.setAttribute("data-cf-ui-portal",""),o.current.appendChild(e),()=>{o.current&&o.current.removeChild(e)}}),[]),s.current?a(e,s.current):null}function d({className:r,children:t,...n}){return e.createElement("span",s({tabIndex:-1,className:u(c({name:"t8ljbi",styles:"display:inherit;outline:0;"}),r)},n),t)}i(l,"Portal",(()=>m)),i(l,"TabFocusTrap",(()=>d)),i(l,"useArrowKeyNavigation",(()=>f)),i(l,"useKeyboard",(()=>y));const p={vertical:{prev:"ArrowUp",next:"ArrowDown"},horizontal:{prev:"ArrowLeft",next:"ArrowRight"}},f=({itemsContainerRef:e,itemsSelector:r,keyType:t="vertical"})=>{const[a,s]=o(0),c=n((n=>{const o=e.current;if(!o)return;const c=o.querySelectorAll(r);if(0===c.length)return;const u=c.length-1,i={[p[t].next]:()=>{s(a===u?0:a+1)},[p[t].prev]:()=>{s(0===a?u:a-1)}}[n.key];i&&(n.preventDefault(),i())}),[a,r,e,t]);return{focusedIndex:a,handleArrowsKeyDown:c}},y=e=>{const{ref:r,keys:o,event:a="keydown"}=e;let s=document;const c=n((e=>{Object.prototype.hasOwnProperty.call(o,e.key)&&o[e.key](e)}),[o]);t((()=>(r&&r.current&&(s=r.current),s.addEventListener(a,c),()=>{s.removeEventListener(a,c)})),[a,c])};export{m as Portal,d as TabFocusTrap,f as useArrowKeyNavigation,y as useKeyboard};
 //# sourceMappingURL=module.js.map

dist/types.d.ts

@@ -1,2 +0,2 @@
-import React from "react";
+import React, { MutableRefObject } from "react";
 export interface PortalProps {
@@ -21,3 +21,35 @@ children: React.ReactElement;
 };
+export interface UseKeyboardProps {
+    /**
+     * @description object of key names and handlers defines which key to look for i.e. `ArrowUp`, `Escape`, `Shift`
+     * value is a callback function to be called when key matches
+     */
+    keys: {
+        [key: string]: (e: KeyboardEvent) => void;
+    };
+    /**
+     * @description defines the attached event type
+     * @default 'keydown'
+     */
+    event?: 'keyup' | 'keypress' | 'keydown';
+    /**
+     * @description React reference to attach the event to its current element
+     */
+    ref?: MutableRefObject<HTMLElement>;
+}
+/**
+ *
+ * @description hook to attach a handler keyboard event listener to `document` or `HTMLElements` with garbage collection
+ * @example
+ * useKeyboard({
+ *  event: 'keydown', // Optional, default is `keydown`
+ *  ref: yourReactRef, // Optional, by default event is attached to document
+ *  keys: {
+ *    ArrowUp: (e) => handleArrowUp(e),
+ *    Tab: (e) => handleTab(e)
+ *  }
+ * })
+ */
+export const useKeyboard: (props: UseKeyboardProps) => void;
 
 //# sourceMappingURL=types.d.ts.map

package.json

 {
   "name": "@contentful/f36-utils",
-  "version": "4.0.1-next-v4-9086.2408+0ed6a692",
+  "version": "4.0.1-next-v4-9126.2410+0e8e8699",
   "description": "Forma 36: utils React Component",
@@ -34,3 +34,3 @@ "license": "MIT",
   },
-  "gitHead": "0ed6a6924eec4e8b34a999cd6651c579cbb446ac"
+  "gitHead": "0e8e8699c78047a8e05f32ee99083fe7388fd050"
 }

src/index.ts

@@ -6,1 +6,3 @@ export { Portal } from './Portal/Portal';
 export { useArrowKeyNavigation } from './ArrowKeyNavigation/useArrowKeyNavigation';
+export { useKeyboard } from './useKeyboard/useKeyboard';
+export type { UseKeyboardProps } from './useKeyboard/useKeyboard';

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

38424

increased by35.05%

Number of package files

17

increased by13.33%

Lines of code

344

increased by71.14%

No dependency changes