@j2inn/fin5-ui-utils 6.0.4 → 6.0.5-beta.0

package/dist_es/react/components/navigation/HeaderSiderLayout.js

@@ -1,81 +1,81 @@
-/*
- * Copyright (c) 2024, J2 Innovations. All Rights Reserved
- */
-import { Container, Layout, Menu } from '@j2inn/ui';
-import classNames from 'classnames';
-import React, { useMemo, useState } from 'react';
-import { createUseStyles } from 'react-jss';
-import { DEFAULT_HEADER_HEIGHT, getMenuPages, } from './BasicLayout';
-import MenuTrigger from './MenuTrigger';
-const useStyles = createUseStyles({
-    header: ({ headerHeight }) => ({
-        position: 'fixed',
-        width: '100%',
-        zIndex: 1000,
-        padding: 0,
-        height: headerHeight,
-        lineHeight: `${headerHeight}px`,
-    }),
-    headerContent: {
-        height: '100%',
-    },
-    sider: ({ headerHeight }) => ({
-        overflow: 'auto',
-        height: '100vh',
-        position: 'fixed',
-        left: 0,
-        top: 0,
-        bottom: 0,
-        zIndex: 999,
-        paddingTop: headerHeight,
-    }),
-    content: ({ isMobile, compactSider, siderWidth = 200, headerHeight, }) => ({
-        paddingLeft: isMobile ? 0 : compactSider ? 45 : siderWidth,
-        paddingTop: headerHeight,
-    }),
-});
-// Workaround j2inn/ui exporting problem
-const Header = Layout.Header;
-const Sider = Layout.Sider;
-const Content = Layout.Content;
-/**
- * Layout with header and sider. Sider is collapsed on mobile.
- * Routing management can be plugged in, for examples @see ReactRouterLayout @see RouterLayout
- */
-export function HeaderSiderLayout({ pages = [], defaultPage, selectedPages = [], onSelect, compactSider, layoutProps, header, headerProps, siderProps, contentProps, menuProps, menuBefore, menuAfter, menuTriggerClassName, headerHeight = DEFAULT_HEADER_HEIGHT, children, }) {
-    const [isMobile, setIsMobile] = useState(false);
-    const [hiddenSider, setHiddenSider] = useState(false);
-    const siderWidth = siderProps?.width;
-    const classes = useStyles({
-        isMobile,
-        compactSider: compactSider?.isCompact,
-        siderWidth,
-        headerHeight,
-    });
-    const menuPages = useMemo(() => getMenuPages(pages), [pages]);
-    return (React.createElement(Layout, { hasSider: true, ...layoutProps },
-        React.createElement(Header, { ...headerProps, className: classNames(classes.header, headerProps?.className) },
-            React.createElement(Container, { horizontal: true, middle: true, className: classes.headerContent },
-                isMobile && (React.createElement(MenuTrigger, { hiddenSider: hiddenSider, headerHeight: headerHeight, className: menuTriggerClassName, onClick: () => {
-                        setHiddenSider(!hiddenSider);
-                    } })),
-                header)),
-        React.createElement(Sider, { ...siderProps, className: classNames(classes.sider, siderProps?.className), breakpoint: 'md', onBreakpoint: (broken) => {
-                setIsMobile(broken);
-                setHiddenSider(true);
-            }, collapsed: (isMobile && hiddenSider) || compactSider?.isCompact, collapsedWidth: isMobile && hiddenSider
-                ? 0
-                : compactSider
-                    ? headerHeight
-                    : 0, trigger: null },
-            menuBefore,
-            React.createElement(Menu, { ...menuProps, defaultSelectedKeys: defaultPage ? [defaultPage] : undefined, items: menuPages, selectedKeys: selectedPages, onSelect: ({ key }) => {
-                    if (!hiddenSider) {
-                        setHiddenSider(true);
-                    }
-                    onSelect?.(key);
-                } }),
-            menuAfter),
-        React.createElement(Content, { ...contentProps, className: classNames(classes.content, contentProps?.className) }, children)));
-}
+/*
+ * Copyright (c) 2024, J2 Innovations. All Rights Reserved
+ */
+import { Container, Layout, Menu } from '@j2inn/ui';
+import classNames from 'classnames';
+import React, { useMemo, useState } from 'react';
+import { createUseStyles } from 'react-jss';
+import { DEFAULT_HEADER_HEIGHT, getMenuPages, } from './BasicLayout';
+import MenuTrigger from './MenuTrigger';
+const useStyles = createUseStyles({
+    header: ({ headerHeight }) => ({
+        position: 'fixed',
+        width: '100%',
+        zIndex: 1000,
+        padding: 0,
+        height: headerHeight,
+        lineHeight: `${headerHeight}px`,
+    }),
+    headerContent: {
+        height: '100%',
+    },
+    sider: ({ headerHeight }) => ({
+        overflow: 'auto',
+        height: '100vh',
+        position: 'fixed',
+        left: 0,
+        top: 0,
+        bottom: 0,
+        zIndex: 999,
+        paddingTop: headerHeight,
+    }),
+    content: ({ isMobile, compactSider, siderWidth = 200, headerHeight, }) => ({
+        paddingLeft: isMobile ? 0 : compactSider ? 45 : siderWidth,
+        paddingTop: headerHeight,
+    }),
+});
+// Workaround j2inn/ui exporting problem
+const Header = Layout.Header;
+const Sider = Layout.Sider;
+const Content = Layout.Content;
+/**
+ * Layout with header and sider. Sider is collapsed on mobile.
+ * Routing management can be plugged in, for examples @see ReactRouterLayout @see RouterLayout
+ */
+export function HeaderSiderLayout({ pages = [], defaultPage, selectedPages = [], onSelect, compactSider, layoutProps, header, headerProps, siderProps, contentProps, menuProps, menuBefore, menuAfter, menuTriggerClassName, headerHeight = DEFAULT_HEADER_HEIGHT, children, }) {
+    const [isMobile, setIsMobile] = useState(false);
+    const [hiddenSider, setHiddenSider] = useState(false);
+    const siderWidth = siderProps?.width;
+    const classes = useStyles({
+        isMobile,
+        compactSider: compactSider?.isCompact,
+        siderWidth,
+        headerHeight,
+    });
+    const menuPages = useMemo(() => getMenuPages(pages), [pages]);
+    return (React.createElement(Layout, { hasSider: true, ...layoutProps },
+        React.createElement(Header, { ...headerProps, className: classNames(classes.header, headerProps?.className) },
+            React.createElement(Container, { horizontal: true, middle: true, className: classes.headerContent },
+                isMobile && (React.createElement(MenuTrigger, { hiddenSider: hiddenSider, headerHeight: headerHeight, className: menuTriggerClassName, onClick: () => {
+                        setHiddenSider(!hiddenSider);
+                    } })),
+                header)),
+        React.createElement(Sider, { ...siderProps, className: classNames(classes.sider, siderProps?.className), breakpoint: 'md', onBreakpoint: (broken) => {
+                setIsMobile(broken);
+                setHiddenSider(true);
+            }, collapsed: (isMobile && hiddenSider) || compactSider?.isCompact, collapsedWidth: isMobile && hiddenSider
+                ? 0
+                : compactSider
+                    ? headerHeight
+                    : 0, trigger: null },
+            menuBefore,
+            React.createElement(Menu, { ...menuProps, defaultSelectedKeys: defaultPage ? [defaultPage] : undefined, items: menuPages, selectedKeys: selectedPages, onSelect: ({ key }) => {
+                    if (!hiddenSider) {
+                        setHiddenSider(true);
+                    }
+                    onSelect?.(key);
+                } }),
+            menuAfter),
+        React.createElement(Content, { ...contentProps, className: classNames(classes.content, contentProps?.className) }, children)));
+}
 //# sourceMappingURL=HeaderSiderLayout.js.map

package/dist_es/react/components/navigation/MenuPage.d.ts

@@ -1,37 +1,37 @@
-import { ItemType } from 'antd/lib/menu/hooks/useItems';
-import React, { PropsWithChildren } from 'react';
-/**
- * Menu page has both the data required by the menu and the data required to actually render the page.
- */
-export declare type MenuPage<T = Record<string, unknown>> = ItemType & Page<T>;
-/**
- * Menu Item that represents an application page
- */
-interface Page<T = Record<string, unknown>> {
-    key: string;
-    component?: React.LazyExoticComponent<React.FC<T>>;
-    props?: PropsWithChildren<T>;
-    children?: MenuPage<T>[];
-    disabled?: boolean;
-    /**
-     * Set it to false to avoid showing the page in the menu. It is just used for routing purposes.
-     */
-    showInMenu?: boolean;
-}
-/**
- * Retrieve a specific page or subPage from a root page list
- * @param name the name of the searched page
- * @param pages the list of root pages
- */
-export declare function findPageByName<T extends MenuPage>(pages: T[], name?: string): T | undefined;
-/**
- * Expands the list of pages to include all the subpages
- */
-export declare function pageTreeToPageList<T extends MenuPage>(pages: T[]): T[];
-/**
- * Recursively get all the subPages of a root page
- * @param page root page
- * @returns the whole tree of subPages as a list
- */
-export declare function getAllSubPages<T extends MenuPage>(page: T): T[];
-export {};
+import { ItemType } from 'antd/lib/menu/hooks/useItems';
+import React, { PropsWithChildren } from 'react';
+/**
+ * Menu page has both the data required by the menu and the data required to actually render the page.
+ */
+export declare type MenuPage<T = Record<string, unknown>> = ItemType & Page<T>;
+/**
+ * Menu Item that represents an application page
+ */
+interface Page<T = Record<string, unknown>> {
+    key: string;
+    component?: React.LazyExoticComponent<React.FC<T>>;
+    props?: PropsWithChildren<T>;
+    children?: MenuPage<T>[];
+    disabled?: boolean;
+    /**
+     * Set it to false to avoid showing the page in the menu. It is just used for routing purposes.
+     */
+    showInMenu?: boolean;
+}
+/**
+ * Retrieve a specific page or subPage from a root page list
+ * @param name the name of the searched page
+ * @param pages the list of root pages
+ */
+export declare function findPageByName<T extends MenuPage>(pages: T[], name?: string): T | undefined;
+/**
+ * Expands the list of pages to include all the subpages
+ */
+export declare function pageTreeToPageList<T extends MenuPage>(pages: T[]): T[];
+/**
+ * Recursively get all the subPages of a root page
+ * @param page root page
+ * @returns the whole tree of subPages as a list
+ */
+export declare function getAllSubPages<T extends MenuPage>(page: T): T[];
+export {};

package/dist_es/react/components/navigation/MenuPage.js

@@ -1,31 +1,31 @@
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-/**
- * Retrieve a specific page or subPage from a root page list
- * @param name the name of the searched page
- * @param pages the list of root pages
- */
-export function findPageByName(pages, name) {
-    return pageTreeToPageList(pages).find((page) => page.key === name && !page.disabled);
-}
-/**
- * Expands the list of pages to include all the subpages
- */
-export function pageTreeToPageList(pages) {
-    return pages.flatMap((page) => getAllSubPages(page));
-}
-/**
- * Recursively get all the subPages of a root page
- * @param page root page
- * @returns the whole tree of subPages as a list
- */
-export function getAllSubPages(page) {
-    if (page.children) {
-        return [page].concat(...page.children.map((subPage) => getAllSubPages(subPage)));
-    }
-    else {
-        return [page];
-    }
-}
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+/**
+ * Retrieve a specific page or subPage from a root page list
+ * @param name the name of the searched page
+ * @param pages the list of root pages
+ */
+export function findPageByName(pages, name) {
+    return pageTreeToPageList(pages).find((page) => page.key === name && !page.disabled);
+}
+/**
+ * Expands the list of pages to include all the subpages
+ */
+export function pageTreeToPageList(pages) {
+    return pages.flatMap((page) => getAllSubPages(page));
+}
+/**
+ * Recursively get all the subPages of a root page
+ * @param page root page
+ * @returns the whole tree of subPages as a list
+ */
+export function getAllSubPages(page) {
+    if (page.children) {
+        return [page].concat(...page.children.map((subPage) => getAllSubPages(subPage)));
+    }
+    else {
+        return [page];
+    }
+}
 //# sourceMappingURL=MenuPage.js.map

package/dist_es/react/components/navigation/MenuPage.jsx

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+/**
+ * Retrieve a specific page or subPage from a root page list
+ * @param name the name of the searched page
+ * @param pages the list of root pages
+ */
+export function findPageByName(pages, name) {
+    return pageTreeToPageList(pages).find((page) => page.key === name && !page.disabled);
+}
+/**
+ * Expands the list of pages to include all the subpages
+ */
+export function pageTreeToPageList(pages) {
+    return pages.flatMap((page) => getAllSubPages(page));
+}
+/**
+ * Recursively get all the subPages of a root page
+ * @param page root page
+ * @returns the whole tree of subPages as a list
+ */
+export function getAllSubPages(page) {
+    if (page.children) {
+        return [page].concat(...page.children.map((subPage) => getAllSubPages(subPage)));
+    }
+    else {
+        return [page];
+    }
+}
+//# sourceMappingURL=MenuPage.jsx.map

package/dist_es/react/components/navigation/MenuPage.jsx.map

@@ -0,0 +1 @@
+{"version":3,"file":"MenuPage.jsx","sourceRoot":"","sources":["../../../../src/react/components/navigation/MenuPage.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAyBH;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAC7B,KAAU,EACV,IAAa;IAEb,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC,IAAI,CACpC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAC7C,CAAA;AACF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAqB,KAAU;IAChE,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,IAAS,CAAC,CAAC,CAAA;AAC1D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAqB,IAAO;IACzD,IAAI,IAAI,CAAC,QAAQ,EAAE;QAClB,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CACnB,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,cAAc,CAAC,OAAY,CAAC,CAAC,CAC/D,CAAA;KACD;SAAM;QACN,OAAO,CAAC,IAAI,CAAC,CAAA;KACb;AACF,CAAC"}

package/dist_es/react/components/navigation/MenuTrigger.d.ts

@@ -1,9 +1,9 @@
-import React from 'react';
-interface MenuTriggerProps {
-    hiddenSider: boolean;
-    headerHeight?: number;
-    className?: string;
-    onClick: () => void;
-}
-declare const MenuTrigger: React.FC<MenuTriggerProps>;
-export default MenuTrigger;
+import React from 'react';
+interface MenuTriggerProps {
+    hiddenSider: boolean;
+    headerHeight?: number;
+    className?: string;
+    onClick: () => void;
+}
+declare const MenuTrigger: React.FC<MenuTriggerProps>;
+export default MenuTrigger;

package/dist_es/react/components/navigation/MenuTrigger.js

@@ -1,29 +1,29 @@
-/*
- * Copyright (c) 2024, J2 Innovations. All Rights Reserved
- */
-import { MenuFoldOutlined, MenuUnfoldOutlined } from '@ant-design/icons';
-import classNames from 'classnames';
-import React from 'react';
-import { createUseStyles } from 'react-jss';
-const useStyles = createUseStyles((theme) => ({
-    menuTrigger: ({ headerHeight }) => ({
-        width: headerHeight,
-        height: '100%',
-        textAlign: 'center',
-        fontSize: 18,
-        cursor: 'pointer',
-        transition: 'color 0.3s ease-in-out',
-        backgroundColor: 'transparent',
-        color: theme.linkColor,
-        padding: '0 0.5rem',
-        '&:hover': {
-            color: theme.linkActiveColor,
-        },
-    }),
-}));
-const MenuTrigger = ({ hiddenSider, headerHeight = 45, onClick, className, }) => {
-    const classes = useStyles({ headerHeight });
-    return hiddenSider ? (React.createElement(MenuUnfoldOutlined, { className: classNames(classes.menuTrigger, className), onClick: onClick })) : (React.createElement(MenuFoldOutlined, { className: classNames(classes.menuTrigger, className), onClick: onClick }));
-};
-export default MenuTrigger;
+/*
+ * Copyright (c) 2024, J2 Innovations. All Rights Reserved
+ */
+import { MenuFoldOutlined, MenuUnfoldOutlined } from '@ant-design/icons';
+import classNames from 'classnames';
+import React from 'react';
+import { createUseStyles } from 'react-jss';
+const useStyles = createUseStyles((theme) => ({
+    menuTrigger: ({ headerHeight }) => ({
+        width: headerHeight,
+        height: '100%',
+        textAlign: 'center',
+        fontSize: 18,
+        cursor: 'pointer',
+        transition: 'color 0.3s ease-in-out',
+        backgroundColor: 'transparent',
+        color: theme.linkColor,
+        padding: '0 0.5rem',
+        '&:hover': {
+            color: theme.linkActiveColor,
+        },
+    }),
+}));
+const MenuTrigger = ({ hiddenSider, headerHeight = 45, onClick, className, }) => {
+    const classes = useStyles({ headerHeight });
+    return hiddenSider ? (React.createElement(MenuUnfoldOutlined, { className: classNames(classes.menuTrigger, className), onClick: onClick })) : (React.createElement(MenuFoldOutlined, { className: classNames(classes.menuTrigger, className), onClick: onClick }));
+};
+export default MenuTrigger;
 //# sourceMappingURL=MenuTrigger.js.map

package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.d.ts

@@ -1,11 +1,11 @@
-import type { Location } from '@remix-run/router';
-import React from 'react';
-import { HeaderSiderLayoutProps } from './HeaderSiderLayout';
-import { ReactRouterMenuPage } from './ReactRouterLayout';
-export interface ReactRouterHeaderSiderLayoutProps extends HeaderSiderLayoutProps<ReactRouterMenuPage> {
-    isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean;
-}
-/**
- * Header/Sider layout that uses React Router.
- */
-export declare const ReactRouterHeaderSiderLayout: React.FC<ReactRouterHeaderSiderLayoutProps>;
+import type { Location } from '@remix-run/router';
+import React from 'react';
+import { HeaderSiderLayoutProps } from './HeaderSiderLayout';
+import { ReactRouterMenuPage } from './ReactRouterLayout';
+export interface ReactRouterHeaderSiderLayoutProps extends HeaderSiderLayoutProps<ReactRouterMenuPage> {
+    isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean;
+}
+/**
+ * Header/Sider layout that uses React Router.
+ */
+export declare const ReactRouterHeaderSiderLayout: React.FC<ReactRouterHeaderSiderLayoutProps>;

package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.js

@@ -1,19 +1,19 @@
-/*
- * Copyright (c) 2024, J2 Innovations. All Rights Reserved
- */
-import React from 'react';
-import { Outlet, useNavigate } from 'react-router';
-import { HeaderSiderLayout } from './HeaderSiderLayout';
-import { useDefaultOnSelect, useGetPageKeyRouteMap, useSelectedRoutes, } from './ReactRouterLayout';
-/**
- * Header/Sider layout that uses React Router.
- */
-export const ReactRouterHeaderSiderLayout = ({ isSelectedRoute, pages = [], onSelect, ...otherProps }) => {
-    const navigate = useNavigate();
-    const selectedRoutes = useSelectedRoutes(pages, isSelectedRoute);
-    const pageKeyRouteMap = useGetPageKeyRouteMap(pages);
-    const defaultOnSelect = useDefaultOnSelect(navigate, pageKeyRouteMap, pages);
-    return (React.createElement(HeaderSiderLayout, { ...otherProps, pages: pages, onSelect: onSelect ?? defaultOnSelect, selectedPages: selectedRoutes },
-        React.createElement(Outlet, null)));
-};
+/*
+ * Copyright (c) 2024, J2 Innovations. All Rights Reserved
+ */
+import React from 'react';
+import { Outlet, useNavigate } from 'react-router';
+import { HeaderSiderLayout } from './HeaderSiderLayout';
+import { useDefaultOnSelect, useGetPageKeyRouteMap, useSelectedRoutes, } from './ReactRouterLayout';
+/**
+ * Header/Sider layout that uses React Router.
+ */
+export const ReactRouterHeaderSiderLayout = ({ isSelectedRoute, pages = [], onSelect, ...otherProps }) => {
+    const navigate = useNavigate();
+    const selectedRoutes = useSelectedRoutes(pages, isSelectedRoute);
+    const pageKeyRouteMap = useGetPageKeyRouteMap(pages);
+    const defaultOnSelect = useDefaultOnSelect(navigate, pageKeyRouteMap, pages);
+    return (React.createElement(HeaderSiderLayout, { ...otherProps, pages: pages, onSelect: onSelect ?? defaultOnSelect, selectedPages: selectedRoutes },
+        React.createElement(Outlet, null)));
+};
 //# sourceMappingURL=ReactRouterHeaderSiderLayout.js.map

package/dist_es/react/components/navigation/ReactRouterLayout.d.ts

@@ -1,46 +1,46 @@
-import type { Location } from '@remix-run/router';
-import React from 'react';
-import { NavigateFunction } from 'react-router';
-import { BasicLayoutProps } from './BasicLayout';
-import { MenuPage } from './MenuPage';
-export declare type ReactRouterMenuPage = MenuPage & {
-    route: string;
-};
-export interface ReactRouterLayoutProps extends BasicLayoutProps<ReactRouterMenuPage> {
-    isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean;
-}
-/**
- * This hook can be used with react-router/BasicLayout,
- * to ensure FIN5 URL is aligned with the internal frame URL.
- * This does not skip the hash update and should be used only with
- * FIN >= 5.1.7.92, otherwise FIN will reload the entire page.
- */
-export declare const useLocationUpdate: () => void;
-/**
- * This hook can be used with react-router/BasicLayout,
- * to ensure FIN5 URL is aligned with the internal frame URL.
- * This skips the hash update and should be used only with
- * FIN < 5.1.7.92.
- * @deprecated use only with FIN < 5.1.7.92
- * @see {@link useLocationUpdate} for FIN >= 5.1.7.92
- */
-export declare const useLocationUpdateSkippingHash: () => void;
-export declare const useSelectedRoutes: (pages: ReactRouterMenuPage[], isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean) => string[];
-/**
- * If we are inside a frame (FIN5), the route is left as is.
- * If we are outside FIN5 frame, the route needs to be prefixed with a segment containing the project name.
- * @param route
- * @returns the correct route for the environment
- */
-export declare const getRoute: (route: string) => string;
-/**
- * Create a map that holds the page key and its related route.
- * @param pages
- * @returns the map page key - route
- */
-export declare const useGetPageKeyRouteMap: (pages: ReactRouterMenuPage[]) => Map<string, string>;
-export declare const useDefaultOnSelect: (navigate: NavigateFunction, pageKeyRouteMap: Map<string, string>, pages: ReactRouterMenuPage[]) => (key: string) => void;
-/**
- * Basic layout that uses React Router.
- */
-export declare const ReactRouterLayout: React.FC<ReactRouterLayoutProps>;
+import type { Location } from '@remix-run/router';
+import React from 'react';
+import { NavigateFunction } from 'react-router';
+import { BasicLayoutProps } from './BasicLayout';
+import { MenuPage } from './MenuPage';
+export declare type ReactRouterMenuPage = MenuPage & {
+    route: string;
+};
+export interface ReactRouterLayoutProps extends BasicLayoutProps<ReactRouterMenuPage> {
+    isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean;
+}
+/**
+ * This hook can be used with react-router/BasicLayout,
+ * to ensure FIN5 URL is aligned with the internal frame URL.
+ * This does not skip the hash update and should be used only with
+ * FIN >= 5.1.7.92, otherwise FIN will reload the entire page.
+ */
+export declare const useLocationUpdate: () => void;
+/**
+ * This hook can be used with react-router/BasicLayout,
+ * to ensure FIN5 URL is aligned with the internal frame URL.
+ * This skips the hash update and should be used only with
+ * FIN < 5.1.7.92.
+ * @deprecated use only with FIN < 5.1.7.92
+ * @see {@link useLocationUpdate} for FIN >= 5.1.7.92
+ */
+export declare const useLocationUpdateSkippingHash: () => void;
+export declare const useSelectedRoutes: (pages: ReactRouterMenuPage[], isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean) => string[];
+/**
+ * If we are inside a frame (FIN5), the route is left as is.
+ * If we are outside FIN5 frame, the route needs to be prefixed with a segment containing the project name.
+ * @param route
+ * @returns the correct route for the environment
+ */
+export declare const getRoute: (route: string) => string;
+/**
+ * Create a map that holds the page key and its related route.
+ * @param pages
+ * @returns the map page key - route
+ */
+export declare const useGetPageKeyRouteMap: (pages: ReactRouterMenuPage[]) => Map<string, string>;
+export declare const useDefaultOnSelect: (navigate: NavigateFunction, pageKeyRouteMap: Map<string, string>, pages: ReactRouterMenuPage[]) => (key: string) => void;
+/**
+ * Basic layout that uses React Router.
+ */
+export declare const ReactRouterLayout: React.FC<ReactRouterLayoutProps>;