@bigbinary/neeto-commons-frontend 3.2.0 → 3.2.1

package/cjs/react-utils/metaClick/metaClick.js

@@ -6,7 +6,14 @@ Object.defineProperty(exports, "__esModule", {
 exports.isMetaKeyPressed = exports.handleMetaClick = void 0;
 var _ramda = require("ramda");
 var handleMetaClick = (0, _ramda.curry)(function (history, params, event) {
-  return isMetaKeyPressed(event) ? window.open(params.pathname || params, "_blank") : history.push(params);
+  var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+  if (isMetaKeyPressed(event)) {
+    return window.open(params.pathname || params, "_blank");
+  }
+  var _options$isHistoryRep = options.isHistoryReplace,
+    isHistoryReplace = _options$isHistoryRep === void 0 ? false : _options$isHistoryRep;
+  var historyMethod = isHistoryReplace ? history.replace : history.push;
+  return historyMethod(params);
 });
 exports.handleMetaClick = handleMetaClick;
 var isMetaKeyPressed = function isMetaKeyPressed(event) {

package/cjs/react-utils/metaClick/metaClick.js.map

@@ -1 +1 @@
-{"version":3,"file":"metaClick.js","names":["_ramda","require","handleMetaClick","curry","history","params","event","isMetaKeyPressed","window","open","pathname","push","exports","ctrlKey","metaKey"],"sources":["../../../../src/react-utils/metaClick/metaClick.js"],"sourcesContent":["import { curry } from \"ramda\";\n\nexport const handleMetaClick = curry((history, params, event) =>\n  isMetaKeyPressed(event)\n    ? window.open(params.pathname || params, \"_blank\")\n    : history.push(params)\n);\n\nexport const isMetaKeyPressed = event => !!(event?.ctrlKey || event?.metaKey);\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAEO,IAAMC,eAAe,GAAG,IAAAC,YAAK,EAAC,UAACC,OAAO,EAAEC,MAAM,EAAEC,KAAK;EAAA,OAC1DC,gBAAgB,CAACD,KAAK,CAAC,GACnBE,MAAM,CAACC,IAAI,CAACJ,MAAM,CAACK,QAAQ,IAAIL,MAAM,EAAE,QAAQ,CAAC,GAChDD,OAAO,CAACO,IAAI,CAACN,MAAM,CAAC;AAAA,EACzB;AAACO,OAAA,CAAAV,eAAA,GAAAA,eAAA;AAEK,IAAMK,gBAAgB,GAAG,SAAnBA,gBAAgBA,CAAGD,KAAK;EAAA,OAAI,CAAC,EAAEA,KAAK,aAALA,KAAK,eAALA,KAAK,CAAEO,OAAO,IAAIP,KAAK,aAALA,KAAK,eAALA,KAAK,CAAEQ,OAAO,CAAC;AAAA;AAACF,OAAA,CAAAL,gBAAA,GAAAA,gBAAA"}
+{"version":3,"file":"metaClick.js","names":["_ramda","require","handleMetaClick","curry","history","params","event","options","arguments","length","undefined","isMetaKeyPressed","window","open","pathname","_options$isHistoryRep","isHistoryReplace","historyMethod","replace","push","exports","ctrlKey","metaKey"],"sources":["../../../../src/react-utils/metaClick/metaClick.js"],"sourcesContent":["import { curry } from \"ramda\";\n\nexport const handleMetaClick = curry((history, params, event, options = {}) => {\n  if (isMetaKeyPressed(event)) {\n    return window.open(params.pathname || params, \"_blank\");\n  }\n\n  const { isHistoryReplace = false } = options;\n  const historyMethod = isHistoryReplace ? history.replace : history.push;\n\n  return historyMethod(params);\n});\n\nexport const isMetaKeyPressed = event => !!(event?.ctrlKey || event?.metaKey);\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAEO,IAAMC,eAAe,GAAG,IAAAC,YAAK,EAAC,UAACC,OAAO,EAAEC,MAAM,EAAEC,KAAK,EAAmB;EAAA,IAAjBC,OAAO,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;EACxE,IAAIG,gBAAgB,CAACL,KAAK,CAAC,EAAE;IAC3B,OAAOM,MAAM,CAACC,IAAI,CAACR,MAAM,CAACS,QAAQ,IAAIT,MAAM,EAAE,QAAQ,CAAC;EACzD;EAEA,IAAAU,qBAAA,GAAqCR,OAAO,CAApCS,gBAAgB;IAAhBA,gBAAgB,GAAAD,qBAAA,cAAG,KAAK,GAAAA,qBAAA;EAChC,IAAME,aAAa,GAAGD,gBAAgB,GAAGZ,OAAO,CAACc,OAAO,GAAGd,OAAO,CAACe,IAAI;EAEvE,OAAOF,aAAa,CAACZ,MAAM,CAAC;AAC9B,CAAC,CAAC;AAACe,OAAA,CAAAlB,eAAA,GAAAA,eAAA;AAEI,IAAMS,gBAAgB,GAAG,SAAnBA,gBAAgBA,CAAGL,KAAK;EAAA,OAAI,CAAC,EAAEA,KAAK,aAALA,KAAK,eAALA,KAAK,CAAEe,OAAO,IAAIf,KAAK,aAALA,KAAK,eAALA,KAAK,CAAEgB,OAAO,CAAC;AAAA;AAACF,OAAA,CAAAT,gBAAA,GAAAA,gBAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-commons-frontend",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "description": "A package encapsulating common code across neeto projects including initializers, utility functions, common components and hooks and so on.",
   "repository": "git@github.com:bigbinary/neeto-commons-frontend.git",
   "author": "Amaljith K <amaljith.k@bigbinary.com>",

package/react-utils/metaClick/metaClick.js

@@ -1,6 +1,13 @@
 import { curry } from "ramda";
 export var handleMetaClick = curry(function (history, params, event) {
-  return isMetaKeyPressed(event) ? window.open(params.pathname || params, "_blank") : history.push(params);
+  var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+  if (isMetaKeyPressed(event)) {
+    return window.open(params.pathname || params, "_blank");
+  }
+  var _options$isHistoryRep = options.isHistoryReplace,
+    isHistoryReplace = _options$isHistoryRep === void 0 ? false : _options$isHistoryRep;
+  var historyMethod = isHistoryReplace ? history.replace : history.push;
+  return historyMethod(params);
 });
 export var isMetaKeyPressed = function isMetaKeyPressed(event) {
   return !!(event !== null && event !== void 0 && event.ctrlKey || event !== null && event !== void 0 && event.metaKey);

package/react-utils/metaClick/metaClick.js.map

@@ -1 +1 @@
-{"version":3,"file":"metaClick.js","names":["curry","handleMetaClick","history","params","event","isMetaKeyPressed","window","open","pathname","push","ctrlKey","metaKey"],"sources":["../../../src/react-utils/metaClick/metaClick.js"],"sourcesContent":["import { curry } from \"ramda\";\n\nexport const handleMetaClick = curry((history, params, event) =>\n  isMetaKeyPressed(event)\n    ? window.open(params.pathname || params, \"_blank\")\n    : history.push(params)\n);\n\nexport const isMetaKeyPressed = event => !!(event?.ctrlKey || event?.metaKey);\n"],"mappings":"AAAA,SAASA,KAAK,QAAQ,OAAO;AAE7B,OAAO,IAAMC,eAAe,GAAGD,KAAK,CAAC,UAACE,OAAO,EAAEC,MAAM,EAAEC,KAAK;EAAA,OAC1DC,gBAAgB,CAACD,KAAK,CAAC,GACnBE,MAAM,CAACC,IAAI,CAACJ,MAAM,CAACK,QAAQ,IAAIL,MAAM,EAAE,QAAQ,CAAC,GAChDD,OAAO,CAACO,IAAI,CAACN,MAAM,CAAC;AAAA,EACzB;AAED,OAAO,IAAME,gBAAgB,GAAG,SAAnBA,gBAAgBA,CAAGD,KAAK;EAAA,OAAI,CAAC,EAAEA,KAAK,aAALA,KAAK,eAALA,KAAK,CAAEM,OAAO,IAAIN,KAAK,aAALA,KAAK,eAALA,KAAK,CAAEO,OAAO,CAAC;AAAA"}
+{"version":3,"file":"metaClick.js","names":["curry","handleMetaClick","history","params","event","options","arguments","length","undefined","isMetaKeyPressed","window","open","pathname","_options$isHistoryRep","isHistoryReplace","historyMethod","replace","push","ctrlKey","metaKey"],"sources":["../../../src/react-utils/metaClick/metaClick.js"],"sourcesContent":["import { curry } from \"ramda\";\n\nexport const handleMetaClick = curry((history, params, event, options = {}) => {\n  if (isMetaKeyPressed(event)) {\n    return window.open(params.pathname || params, \"_blank\");\n  }\n\n  const { isHistoryReplace = false } = options;\n  const historyMethod = isHistoryReplace ? history.replace : history.push;\n\n  return historyMethod(params);\n});\n\nexport const isMetaKeyPressed = event => !!(event?.ctrlKey || event?.metaKey);\n"],"mappings":"AAAA,SAASA,KAAK,QAAQ,OAAO;AAE7B,OAAO,IAAMC,eAAe,GAAGD,KAAK,CAAC,UAACE,OAAO,EAAEC,MAAM,EAAEC,KAAK,EAAmB;EAAA,IAAjBC,OAAO,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;EACxE,IAAIG,gBAAgB,CAACL,KAAK,CAAC,EAAE;IAC3B,OAAOM,MAAM,CAACC,IAAI,CAACR,MAAM,CAACS,QAAQ,IAAIT,MAAM,EAAE,QAAQ,CAAC;EACzD;EAEA,IAAAU,qBAAA,GAAqCR,OAAO,CAApCS,gBAAgB;IAAhBA,gBAAgB,GAAAD,qBAAA,cAAG,KAAK,GAAAA,qBAAA;EAChC,IAAME,aAAa,GAAGD,gBAAgB,GAAGZ,OAAO,CAACc,OAAO,GAAGd,OAAO,CAACe,IAAI;EAEvE,OAAOF,aAAa,CAACZ,MAAM,CAAC;AAC9B,CAAC,CAAC;AAEF,OAAO,IAAMM,gBAAgB,GAAG,SAAnBA,gBAAgBA,CAAGL,KAAK;EAAA,OAAI,CAAC,EAAEA,KAAK,aAALA,KAAK,eAALA,KAAK,CAAEc,OAAO,IAAId,KAAK,aAALA,KAAK,eAALA,KAAK,CAAEe,OAAO,CAAC;AAAA"}

package/react-utils.d.ts

@@ -777,6 +777,57 @@ export async function registerBrowserNotifications(): Promise<void>;
  *
 */
 export async function destroyBrowserSubscription(): Promise<void>;
+type handleMetaClickOptions = {
+  isHistoryReplace?: boolean;
+};
+/**
+ *
+ * The handleMetaClick function can be used to handle onClick actions that
+ *
+ * redirects to a URL. It opens up the URL in a new tab if ctrl/cmd + click event
+ *
+ * is received. Otherwise, simply redirects to the provided URL in the same tab.
+ *
+ * URL can be passed as string or a history location object can be passed instead.
+ *
+ * Let's say you have a navigation menu with several links, and you want to allow
+ *
+ * users to open these links in a new tab if they hold down the Ctrl (or Cmd on
+ *
+ * macOS) key while clicking, and if they click without holding down the Ctrl key,
+ *
+ * the link should open in the same tab. You can use handleMetaClick to achieve
+ *
+ * this behavior.
+ *
+ * @example 
+ *
+ * const NavigationMenu = () => {
+ *   const history = useHistory();
+ * 
+ *   const handleLinkClick = (url, event) => {
+ *     // Opens url in a new tab if metaKey/CtrlKey is pressed.
+ *     // Otherwise simply redirects to url.
+ *     handleMetaClick(history, url, event);
+ *   };
+ * 
+ *   return (
+ *     <div>
+ *       <a href="/home" onClick={e => handleLinkClick("/home", e)}>
+ *         Home
+ *       </a>
+ *       <a href="/dashboard" onClick={e => handleLinkClick("/dashboard", e)}>
+ *         Dashboard
+ *       </a>
+ *       <a href="/profile" onClick={e => handleLinkClick("/profile", e)}>
+ *         Profile
+ *       </a>
+ *     </div>
+ *   );
+ * };
+ * @endexample
+*/
+export function handleMetaClick(history: History, params: string | object, event: React.MouseEvent<HTMLElement, MouseEvent>, options?: handleMetaClickOptions): void;
 /**
  *
  * The handleMetaClick function can be used to handle onClick actions that
@@ -824,7 +875,7 @@ export async function destroyBrowserSubscription(): Promise<void>;
  * };
  * @endexample
 */
-export function handleMetaClick(history: History, params: string | object, event: React.MouseEvent<HTMLElement, MouseEvent>): void;
+export function handleMetaClick(history: History, params: string | object, event: React.MouseEvent<HTMLElement, MouseEvent>): (options?: handleMetaClickOptions) => void;
 /**
  *
  * The handleMetaClick function can be used to handle onClick actions that
@@ -872,7 +923,7 @@ export function handleMetaClick(history: History, params: string | object, event
  * };
  * @endexample
 */
-export function handleMetaClick(history: History, params: string | object): (event: React.MouseEvent<HTMLElement, MouseEvent>) => void;
+export function handleMetaClick(history: History, params: string | object): (event: React.MouseEvent<HTMLElement, MouseEvent>, options?: handleMetaClickOptions) => void;
 /**
  *
  * The handleMetaClick function can be used to handle onClick actions that
@@ -920,7 +971,7 @@ export function handleMetaClick(history: History, params: string | object): (eve
  * };
  * @endexample
 */
-export function handleMetaClick(history: History): (params: string | object, event: React.MouseEvent<HTMLElement, MouseEvent>) => void;
+export function handleMetaClick(history: History): (params: string | object, event: React.MouseEvent<HTMLElement, MouseEvent>, options?: handleMetaClickOptions) => void;
 /**
  *
  * The isMetaKeyPressed function can be used to check whether an onClick event