@bigbinary/neeto-commons-frontend 2.0.96 → 2.0.97

package/react-utils.d.ts

@@ -456,13 +456,25 @@ export function useFieldSubmit(onSubmit: () => any): {
 export function withTitle(Component: () => JSX.Element, title?: string): (props) => JSX.Element;
 /**
  *
- * A browser push notifications utility function which asks the user permissions to send notifications and then register the browser with the notification service.
+ * A browser push notifications utility function which asks the user permissions to
  *
- * After the user logs in, we need to ask the user permissions to send notifications and then register the browser with the notification service.
+ * send notifications and then register the browser with the notification service.
  *
- * You can use the registerBrowserNotifications utility function to do this. It can be called on any event after login based on the application's logic and requirement.
+ * After the user logs in, we need to ask the user permissions to send
  *
- * Here as an example, we are calling registerBrowserNotifications method inside the Login component after the Authentication API request. This helps to associate the browser for that particular user.
+ * notifications and then register the browser with the notification service.
+ *
+ * You can use the registerBrowserNotifications utility function to do this. It
+ *
+ * can be called on any event after login based on the application's logic and
+ *
+ * requirement.
+ *
+ * Here as an example, we are calling registerBrowserNotifications method inside
+ *
+ * the Login component after the Authentication API request. This helps to
+ *
+ * associate the browser for that particular user.
  *
  * @example 
  *
@@ -478,7 +490,7 @@ export function withTitle(Component: () => JSX.Element, title?: string): (props)
  * @endexample
  * The above mentioned feature is currently supported for chromium-based browsers.
  *
- * Safari (iOS) is currently  WIP.
+ * Safari (iOS) is currently WIP.
  *
  * Any other browser which is not mentioned in above will be considered as
  *
@@ -488,19 +500,31 @@ export function withTitle(Component: () => JSX.Element, title?: string): (props)
 export async function registerBrowserNotifications(): Promise<void>;
 /**
  *
- * A browser push notifications utility function which destroys the browser subscriptions from the user's devices. This helps in unsubscribing from browser push notifications.
+ * A browser push notifications utility function which destroys the browser
+ *
+ * subscriptions from the user's devices. This helps in unsubscribing from browser
+ *
+ * push notifications.
+ *
+ * When the browser subscriptions expires for the user's devices or when the user
  *
- * When the browser subscriptions expires for the user's devices or when the user decides to logout,then destroy the generated browser subscription for the user.
+ * decides to logout,then destroy the generated browser subscription for the user.
  *
- * You can use the destroyBrowserSubscription utility function to do this. It can be called on any event before logout based on the application's logic and requirement.
+ * You can use the destroyBrowserSubscription utility function to do this. It can
  *
- * Here as an example:
+ * be called on any event before logout based on the application's logic and
  *
- * In the Logout component, we are calling destroyBrowserSubscription method before the Logout API request. This helps to destroy the browser subscription from the user's devices.
+ * requirement.
+ *
+ * Here as an example: In the Logout component, we are calling
+ *
+ * destroyBrowserSubscription method before the Logout API request. This
+ *
+ * helps to destroy the browser subscription from the user's devices.
  *
  * @example 
  *
- * import {destroyBrowserSubscription } from "neetocommons/react-utils";
+ * import { destroyBrowserSubscription } from "neetocommons/react-utils";
  * 
  * const handleLogout = async () => {
  *   try {
@@ -512,7 +536,7 @@ export async function registerBrowserNotifications(): Promise<void>;
  * @endexample
  * The above mentioned feature is currently supported for chromium-based browsers.
  *
- * Safari (iOS) is currently  WIP.
+ * Safari (iOS) is currently WIP.
  *
  * Any other browser which is not mentioned in above will be considered as
  *
@@ -524,15 +548,20 @@ export async function destroyBrowserSubscription(): Promise<void>;
  *
  * Curried: true
  *
- * This 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 recieved. 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.
+ * This 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 recieved.
+ *
+ * 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.
  *
  * Usage:
  *
  * @example 
  *
  * handleMetaClick(history, "/dashboard", e); //Opens "/dashboard" in a new tab if metaKey/CtrlKey is pressed. Otherwise simply redirects to "/dashboard".
- * handleMetaClick(history, {pathname: "/dashboard", state: "abc"}, e); //Opens "/dashboard" in a new tab if metaKey/CtrlKey is pressed. Otherwise, redirects to "/dashboard" by preserving the state.
- * 
+ * handleMetaClick(history, { pathname: "/dashboard", state: "abc" }, e); //Opens "/dashboard" in a new tab if metaKey/CtrlKey is pressed. Otherwise, redirects to "/dashboard" by preserving the state.
  * @endexample
 */
 export function handleMetaClick(history: History, params: string | object, event: React.MouseEvent<HTMLElement, MouseEvent>): void;
@@ -540,15 +569,20 @@ export function handleMetaClick(history: History, params: string | object, event
  *
  * Curried: true
  *
- * This 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 recieved. 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.
+ * This 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 recieved.
+ *
+ * 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.
  *
  * Usage:
  *
  * @example 
  *
  * handleMetaClick(history, "/dashboard", e); //Opens "/dashboard" in a new tab if metaKey/CtrlKey is pressed. Otherwise simply redirects to "/dashboard".
- * handleMetaClick(history, {pathname: "/dashboard", state: "abc"}, e); //Opens "/dashboard" in a new tab if metaKey/CtrlKey is pressed. Otherwise, redirects to "/dashboard" by preserving the state.
- * 
+ * handleMetaClick(history, { pathname: "/dashboard", state: "abc" }, e); //Opens "/dashboard" in a new tab if metaKey/CtrlKey is pressed. Otherwise, redirects to "/dashboard" by preserving the state.
  * @endexample
 */
 export function handleMetaClick(history: History, params: string | object): (event: React.MouseEvent<HTMLElement, MouseEvent>) => void;
@@ -556,15 +590,20 @@ export function handleMetaClick(history: History, params: string | object): (eve
  *
  * Curried: true
  *
- * This 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 recieved. 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.
+ * This 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 recieved.
+ *
+ * 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.
  *
  * Usage:
  *
  * @example 
  *
  * handleMetaClick(history, "/dashboard", e); //Opens "/dashboard" in a new tab if metaKey/CtrlKey is pressed. Otherwise simply redirects to "/dashboard".
- * handleMetaClick(history, {pathname: "/dashboard", state: "abc"}, e); //Opens "/dashboard" in a new tab if metaKey/CtrlKey is pressed. Otherwise, redirects to "/dashboard" by preserving the state.
- * 
+ * handleMetaClick(history, { pathname: "/dashboard", state: "abc" }, e); //Opens "/dashboard" in a new tab if metaKey/CtrlKey is pressed. Otherwise, redirects to "/dashboard" by preserving the state.
  * @endexample
 */
 export function handleMetaClick(history: History): (params: string | object, event: React.MouseEvent<HTMLElement, MouseEvent>) => void;
@@ -572,14 +611,15 @@ export function handleMetaClick(history: History): (params: string | object, eve
  *
  * Curried: false
  *
- * This function can be used to check whether an onClick event has metaKey or ctrlKey pressed.
+ * This function can be used to check whether an onClick event has metaKey or
+ *
+ * ctrlKey pressed.
  *
  * Usage:
  *
  * @example 
  *
  * isMetaKeyPressed(event); //returns true if "event.metaKey || event.ctrlKey" is true, otherwise returns false.
- * 
  * @endexample
 */
 export function isMetaKeyPressed(event: React.MouseEvent<HTMLElement, MouseEvent>): boolean;
@@ -688,4 +728,16 @@ export function useRegisterNavigationCheckpoint(): (key: string, path: string) =
  * );
  * @endexample
 */
-export function useNavigationCheckpoint(key: string): string;
+export function useNavigationCheckpoint(key: string): string;
+/**
+ *
+ * An HOC which provides the t function from react-i18next to the wrapped
+ *
+ * component as a prop.
+ *
+ * @example 
+ *
+ * const Component = withT(({ t }) => <div>{t("some.key")}</div>);
+ * @endexample
+*/
+export const withT: <P extends object>(Component: React.ComponentType<P>) => React.FC<Omit<P, "t">>;

package/react-utils.js

@@ -3,7 +3,7 @@ import React__default, { useEffect, useState, useDebugValue, useRef, useMemo } f
 import { Honeybadger, HoneybadgerErrorBoundary as HoneybadgerErrorBoundary$1 } from '@honeybadger-io/react';
 import { Typography, Button } from '@bigbinary/neetoui';
 import { isNil, includes, __, prop, toPairs, mergeLeft, curry, keys, isEmpty, mergeDeepLeft, path, omit } from 'ramda';
-import { useTranslation, Trans } from 'react-i18next';
+import { useTranslation, Trans, withTranslation } from 'react-i18next';
 import ErrorPage from '@bigbinary/neeto-molecules/ErrorPage';
 import { Route, Redirect } from 'react-router-dom';
 import axios from 'axios';
@@ -4119,6 +4119,8 @@ var isMetaKeyPressed = function isMetaKeyPressed(event) {
   return !!(event !== null && event !== void 0 && event.ctrlKey || event !== null && event !== void 0 && event.metaKey);
 };
 
+var withT = withTranslation();
+
 var withTitle = function withTitle(Component) {
   var title = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : undefined;
   var PageTitle = function PageTitle(props) {
@@ -4707,5 +4709,5 @@ var useUpdateEffect = function useUpdateEffect(callback) {
   }, dependencies);
 };
 
-export { HoneybadgerErrorBoundary, PrivateRoute, destroyBrowserSubscription, handleMetaClick, isMetaKeyPressed, registerBrowserNotifications, useDebounce, useDisplayErrorPage, useErrorDisplayStore, useFuncDebounce, useHotKeys, useIsElementVisibleInDom, useKeyboardShortcutsPaneState, useLocalStorage, useNavigationCheckpoint, useOnClickOutside, usePrevious, useRegisterNavigationCheckpoint, useStateWithDependency, useTimer, useUpdateEffect, withImmutableActions, withTitle };
+export { HoneybadgerErrorBoundary, PrivateRoute, destroyBrowserSubscription, handleMetaClick, isMetaKeyPressed, registerBrowserNotifications, useDebounce, useDisplayErrorPage, useErrorDisplayStore, useFuncDebounce, useHotKeys, useIsElementVisibleInDom, useKeyboardShortcutsPaneState, useLocalStorage, useNavigationCheckpoint, useOnClickOutside, usePrevious, useRegisterNavigationCheckpoint, useStateWithDependency, useTimer, useUpdateEffect, withImmutableActions, withT, withTitle };
 //# sourceMappingURL=react-utils.js.map