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

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

@@ -1,100 +1,100 @@
-/*
- * Copyright (c) 2023, J2 Innovations. All Rights Reserved
- */
-import React, { useCallback, useEffect, useMemo } from 'react';
-import { Outlet, useLocation, useNavigate, } from 'react-router';
-import { IN_IFRAME, fin5SkipHashUpdate, getFin5HashFrameParameters, getTopLocation, } from '../../../fin5Top/useFin5AppURLHashParameter';
-import { BasicLayout } from './BasicLayout';
-import { pageTreeToPageList } from './MenuPage';
-/**
- * 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 const useLocationUpdate = () => {
-    const location = useLocation();
-    useEffect(() => {
-        if (IN_IFRAME) {
-            setHash(location);
-        }
-    }, [location]);
-};
-/**
- * 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 const useLocationUpdateSkippingHash = () => {
-    const location = useLocation();
-    useEffect(() => {
-        if (IN_IFRAME) {
-            fin5SkipHashUpdate()?.then(() => {
-                setHash(location);
-            });
-        }
-    }, [location]);
-};
-const setHash = (location) => {
-    const hash = location.pathname;
-    const queryParams = location.search;
-    const frameParameters = getFin5HashFrameParameters();
-    frameParameters.set('url', frameParameters.get('url')?.split('#')[0] + '#' + hash + queryParams);
-    getTopLocation().hash = `#${getTopLocation().hash.slice(1).split('?')[0]}?${frameParameters.toString()}`;
-};
-export const useSelectedRoutes = (pages, isSelectedRoute = (page, location) => location.pathname.includes(page.route)) => {
-    const location = useLocation();
-    const flatPages = useMemo(() => pageTreeToPageList(pages), [pages]);
-    return useMemo(() => {
-        return flatPages
-            .filter((page) => isSelectedRoute(page, location))
-            .map((page) => page.key);
-    }, [location, flatPages, isSelectedRoute]);
-};
-/**
- * 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 const getRoute = (route) => {
-    const prefixedRoute = route.startsWith('/') ? route : `/${route}`;
-    return !IN_IFRAME ? `/proj/:projectName${prefixedRoute}` : prefixedRoute;
-};
-/**
- * Create a map that holds the page key and its related route.
- * @param pages
- * @returns the map page key - route
- */
-export const useGetPageKeyRouteMap = (pages) => useMemo(() => {
-    const flatPages = pageTreeToPageList(pages);
-    const result = new Map();
-    flatPages.forEach((page) => {
-        result.set(page.key, page.route);
-    });
-    return result;
-}, [pages]);
-export const useDefaultOnSelect = (navigate, pageKeyRouteMap, pages) => useCallback((key) => {
-    const route = pageKeyRouteMap.get(key);
-    if (route) {
-        navigate(route);
-    }
-    else {
-        console.warn('Could not find route for page key', key, 'pages', pages);
-    }
-}, [navigate, pageKeyRouteMap]);
-/**
- * Basic layout that uses React Router.
- */
-export const ReactRouterLayout = ({ 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(BasicLayout, { ...otherProps, pages: pages, onSelect: onSelect ?? defaultOnSelect, selectedPages: selectedRoutes },
-        React.createElement(Outlet, null)));
-};
+/*
+ * Copyright (c) 2023, J2 Innovations. All Rights Reserved
+ */
+import React, { useCallback, useEffect, useMemo } from 'react';
+import { Outlet, useLocation, useNavigate, } from 'react-router';
+import { IN_IFRAME, fin5SkipHashUpdate, getFin5HashFrameParameters, getTopLocation, } from '../../../fin5Top/useFin5AppURLHashParameter';
+import { BasicLayout } from './BasicLayout';
+import { pageTreeToPageList } from './MenuPage';
+/**
+ * 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 const useLocationUpdate = () => {
+    const location = useLocation();
+    useEffect(() => {
+        if (IN_IFRAME) {
+            setHash(location);
+        }
+    }, [location]);
+};
+/**
+ * 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 const useLocationUpdateSkippingHash = () => {
+    const location = useLocation();
+    useEffect(() => {
+        if (IN_IFRAME) {
+            fin5SkipHashUpdate()?.then(() => {
+                setHash(location);
+            });
+        }
+    }, [location]);
+};
+const setHash = (location) => {
+    const hash = location.pathname;
+    const queryParams = location.search;
+    const frameParameters = getFin5HashFrameParameters();
+    frameParameters.set('url', frameParameters.get('url')?.split('#')[0] + '#' + hash + queryParams);
+    getTopLocation().hash = `#${getTopLocation().hash.slice(1).split('?')[0]}?${frameParameters.toString()}`;
+};
+export const useSelectedRoutes = (pages, isSelectedRoute = (page, location) => location.pathname.includes(page.route)) => {
+    const location = useLocation();
+    const flatPages = useMemo(() => pageTreeToPageList(pages), [pages]);
+    return useMemo(() => {
+        return flatPages
+            .filter((page) => isSelectedRoute(page, location))
+            .map((page) => page.key);
+    }, [location, flatPages, isSelectedRoute]);
+};
+/**
+ * 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 const getRoute = (route) => {
+    const prefixedRoute = route.startsWith('/') ? route : `/${route}`;
+    return !IN_IFRAME ? `/proj/:projectName${prefixedRoute}` : prefixedRoute;
+};
+/**
+ * Create a map that holds the page key and its related route.
+ * @param pages
+ * @returns the map page key - route
+ */
+export const useGetPageKeyRouteMap = (pages) => useMemo(() => {
+    const flatPages = pageTreeToPageList(pages);
+    const result = new Map();
+    flatPages.forEach((page) => {
+        result.set(page.key, page.route);
+    });
+    return result;
+}, [pages]);
+export const useDefaultOnSelect = (navigate, pageKeyRouteMap, pages) => useCallback((key) => {
+    const route = pageKeyRouteMap.get(key);
+    if (route) {
+        navigate(route);
+    }
+    else {
+        console.warn('Could not find route for page key', key, 'pages', pages);
+    }
+}, [navigate, pageKeyRouteMap]);
+/**
+ * Basic layout that uses React Router.
+ */
+export const ReactRouterLayout = ({ 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(BasicLayout, { ...otherProps, pages: pages, onSelect: onSelect ?? defaultOnSelect, selectedPages: selectedRoutes },
+        React.createElement(Outlet, null)));
+};
 //# sourceMappingURL=ReactRouterLayout.js.map

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

@@ -0,0 +1,12 @@
+import { PropsWithChildren, ReactElement } from 'react';
+import { MenuPage } from './MenuPage';
+export interface RouterProps<T extends MenuPage> {
+    pages?: T[];
+    currentPage: string;
+    onPageChange?: (selectedPage?: T) => void;
+    fallbackComponent?: ReactElement;
+}
+/**
+ * Renders the currently selected page from a tree of pages
+ */
+export declare function Router<T extends MenuPage>({ pages, currentPage, onPageChange, fallbackComponent, }: PropsWithChildren<RouterProps<T>>): JSX.Element;

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

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+import React, { Suspense, useEffect, useMemo, } from 'react';
+import { LoadingSpinner } from '../LoadingSpinner';
+import { findPageByName } from './MenuPage';
+/**
+ * Renders the currently selected page from a tree of pages
+ */
+export function Router({ pages = [], currentPage, onPageChange, fallbackComponent, }) {
+    const page = useMemo(() => findPageByName(pages, currentPage), [pages, currentPage]);
+    useEffect(() => {
+        onPageChange?.(page);
+    }, [page]);
+    return page?.component ? (React.createElement(Suspense, { fallback: React.createElement(LoadingSpinner, null) }, React.createElement(page.component, page?.props))) : (fallbackComponent ?? React.createElement("div", null,
+        currentPage,
+        " page not found"));
+}
+//# sourceMappingURL=Router.js.map

package/dist_es/react/components/navigation/Router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Router.js","sourceRoot":"","sources":["../../../../src/react/components/navigation/Router.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,EAGb,QAAQ,EACR,SAAS,EACT,OAAO,GACP,MAAM,OAAO,CAAA;AACd,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,cAAc,EAAY,MAAM,YAAY,CAAA;AASrD;;GAEG;AACH,MAAM,UAAU,MAAM,CAAqB,EAC1C,KAAK,GAAG,EAAE,EACV,WAAW,EACX,YAAY,EACZ,iBAAiB,GACkB;IACnC,MAAM,IAAI,GAAG,OAAO,CACnB,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,EAAE,WAAW,CAAC,EACxC,CAAC,KAAK,EAAE,WAAW,CAAC,CACpB,CAAA;IAED,SAAS,CAAC,GAAG,EAAE;QACd,YAAY,EAAE,CAAC,IAAI,CAAC,CAAA;IACrB,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;IAEV,OAAO,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CACxB,oBAAC,QAAQ,IAAC,QAAQ,EAAE,oBAAC,cAAc,OAAG,IACpC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,CACvC,CACX,CAAC,CAAC,CAAC,CACH,iBAAiB,IAAI;QAAM,WAAW;0BAAsB,CAC5D,CAAA;AACF,CAAC"}

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

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+import React, { Suspense, useEffect, useMemo, } from 'react';
+import { LoadingSpinner } from '../LoadingSpinner';
+import { findPageByName } from './MenuPage';
+/**
+ * Renders the currently selected page from a tree of pages
+ */
+export function Router({ pages = [], currentPage, onPageChange, fallbackComponent, }) {
+    const page = useMemo(() => findPageByName(pages, currentPage), [pages, currentPage]);
+    useEffect(() => {
+        onPageChange?.(page);
+    }, [page]);
+    return page?.component ? (<Suspense fallback={<LoadingSpinner />}>
+			{React.createElement(page.component, page?.props)}
+		</Suspense>) : (fallbackComponent ?? <div>{currentPage} page not found</div>);
+}
+//# sourceMappingURL=Router.jsx.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Router.jsx","sourceRoot":"","sources":["../../../../src/react/components/navigation/Router.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,EAGb,QAAQ,EACR,SAAS,EACT,OAAO,GACP,MAAM,OAAO,CAAA;AACd,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,cAAc,EAAY,MAAM,YAAY,CAAA;AASrD;;GAEG;AACH,MAAM,UAAU,MAAM,CAAqB,EAC1C,KAAK,GAAG,EAAE,EACV,WAAW,EACX,YAAY,EACZ,iBAAiB,GACkB;IACnC,MAAM,IAAI,GAAG,OAAO,CACnB,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,EAAE,WAAW,CAAC,EACxC,CAAC,KAAK,EAAE,WAAW,CAAC,CACpB,CAAA;IAED,SAAS,CAAC,GAAG,EAAE;QACd,YAAY,EAAE,CAAC,IAAI,CAAC,CAAA;IACrB,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;IAEV,OAAO,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CACxB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,AAAD,EAAG,CAAC,CACtC;GAAA,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,CAClD;EAAA,EAAE,QAAQ,CAAC,CACX,CAAC,CAAC,CAAC,CACH,iBAAiB,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,CAAE,eAAc,EAAE,GAAG,CAAC,CAC5D,CAAA;AACF,CAAC"}

package/dist_es/react/components/navigation/customRouting/Router.d.ts

@@ -1,12 +1,12 @@
-import { PropsWithChildren, ReactElement } from 'react';
-import { MenuPage } from '../MenuPage';
-export interface RouterProps<T extends MenuPage> {
-    pages?: T[];
-    currentPage: string;
-    onPageChange?: (selectedPage?: T) => void;
-    fallbackComponent?: ReactElement;
-}
-/**
- * Renders the currently selected page from a tree of pages
- */
-export declare function Router<T extends MenuPage>({ pages, currentPage, onPageChange, fallbackComponent, }: PropsWithChildren<RouterProps<T>>): JSX.Element;
+import { PropsWithChildren, ReactElement } from 'react';
+import { MenuPage } from '../MenuPage';
+export interface RouterProps<T extends MenuPage> {
+    pages?: T[];
+    currentPage: string;
+    onPageChange?: (selectedPage?: T) => void;
+    fallbackComponent?: ReactElement;
+}
+/**
+ * Renders the currently selected page from a tree of pages
+ */
+export declare function Router<T extends MenuPage>({ pages, currentPage, onPageChange, fallbackComponent, }: PropsWithChildren<RouterProps<T>>): JSX.Element;

package/dist_es/react/components/navigation/customRouting/Router.js

@@ -1,19 +1,19 @@
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-import React, { Suspense, useEffect, useMemo, } from 'react';
-import { LoadingSpinner } from '../../LoadingSpinner';
-import { findPageByName } from '../MenuPage';
-/**
- * Renders the currently selected page from a tree of pages
- */
-export function Router({ pages = [], currentPage, onPageChange, fallbackComponent, }) {
-    const page = useMemo(() => findPageByName(pages, currentPage), [pages, currentPage]);
-    useEffect(() => {
-        onPageChange?.(page);
-    }, [page]);
-    return page?.component ? (React.createElement(Suspense, { fallback: React.createElement(LoadingSpinner, null) }, React.createElement(page.component, page?.props))) : (fallbackComponent ?? React.createElement("div", null,
-        currentPage,
-        " page not found"));
-}
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+import React, { Suspense, useEffect, useMemo, } from 'react';
+import { LoadingSpinner } from '../../LoadingSpinner';
+import { findPageByName } from '../MenuPage';
+/**
+ * Renders the currently selected page from a tree of pages
+ */
+export function Router({ pages = [], currentPage, onPageChange, fallbackComponent, }) {
+    const page = useMemo(() => findPageByName(pages, currentPage), [pages, currentPage]);
+    useEffect(() => {
+        onPageChange?.(page);
+    }, [page]);
+    return page?.component ? (React.createElement(Suspense, { fallback: React.createElement(LoadingSpinner, null) }, React.createElement(page.component, page?.props))) : (fallbackComponent ?? React.createElement("div", null,
+        currentPage,
+        " page not found"));
+}
 //# sourceMappingURL=Router.js.map

package/dist_es/react/components/navigation/customRouting/RouterLayout.d.ts

@@ -1,11 +1,11 @@
-import React from 'react';
-import { BasicLayoutProps } from '../BasicLayout';
-import { MenuPage } from '../MenuPage';
-export interface RouterLayoutProps extends BasicLayoutProps<MenuPage> {
-    page?: string;
-    onPageChange?: (page: string) => void;
-}
-/**
- * Basic layout that uses a custom router.
- */
-export declare const RouterLayout: React.FC<RouterLayoutProps>;
+import React from 'react';
+import { BasicLayoutProps } from '../BasicLayout';
+import { MenuPage } from '../MenuPage';
+export interface RouterLayoutProps extends BasicLayoutProps<MenuPage> {
+    page?: string;
+    onPageChange?: (page: string) => void;
+}
+/**
+ * Basic layout that uses a custom router.
+ */
+export declare const RouterLayout: React.FC<RouterLayoutProps>;

package/dist_es/react/components/navigation/customRouting/RouterLayout.js

@@ -1,35 +1,35 @@
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-import { Button } from '@j2inn/ui';
-import React, { useCallback, useEffect, useState } from 'react';
-import { ErrorDisplayer } from '../../ErrorDisplayer';
-import { BasicLayout } from '../BasicLayout';
-import { findPageByName } from '../MenuPage';
-import { Router } from './Router';
-/**
- * Basic layout that uses a custom router.
- */
-export const RouterLayout = ({ pages = [], defaultPage = pages?.[0].key ?? '', onPageChange, page, ...otherProps }) => {
-    const [currentPage, setCurrentPage] = useState(page ?? defaultPage);
-    useEffect(() => {
-        if (page) {
-            setCurrentPage(page);
-        }
-    }, [page]);
-    // Fire onChange
-    useEffect(() => {
-        onPageChange?.(currentPage);
-    }, [currentPage]);
-    const onSelect = useCallback((key) => {
-        const page = findPageByName(pages, key);
-        if (page?.component) {
-            setCurrentPage(key);
-        }
-    }, [pages]);
-    return (React.createElement(BasicLayout, { ...otherProps, pages: pages, defaultPage: defaultPage, onSelect: onSelect, selectedPages: [currentPage] },
-        React.createElement(Router, { pages: pages, currentPage: currentPage, fallbackComponent: React.createElement(ErrorDisplayer, { error: new Error('Page Not Found'), extra: [
-                    React.createElement(Button, { type: 'primary', key: 'refresh', onClick: () => setCurrentPage(defaultPage) }, "Go Home"),
-                ] }) })));
-};
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+import { Button } from '@j2inn/ui';
+import React, { useCallback, useEffect, useState } from 'react';
+import { ErrorDisplayer } from '../../ErrorDisplayer';
+import { BasicLayout } from '../BasicLayout';
+import { findPageByName } from '../MenuPage';
+import { Router } from './Router';
+/**
+ * Basic layout that uses a custom router.
+ */
+export const RouterLayout = ({ pages = [], defaultPage = pages?.[0].key ?? '', onPageChange, page, ...otherProps }) => {
+    const [currentPage, setCurrentPage] = useState(page ?? defaultPage);
+    useEffect(() => {
+        if (page) {
+            setCurrentPage(page);
+        }
+    }, [page]);
+    // Fire onChange
+    useEffect(() => {
+        onPageChange?.(currentPage);
+    }, [currentPage]);
+    const onSelect = useCallback((key) => {
+        const page = findPageByName(pages, key);
+        if (page?.component) {
+            setCurrentPage(key);
+        }
+    }, [pages]);
+    return (React.createElement(BasicLayout, { ...otherProps, pages: pages, defaultPage: defaultPage, onSelect: onSelect, selectedPages: [currentPage] },
+        React.createElement(Router, { pages: pages, currentPage: currentPage, fallbackComponent: React.createElement(ErrorDisplayer, { error: new Error('Page Not Found'), extra: [
+                    React.createElement(Button, { type: 'primary', key: 'refresh', onClick: () => setCurrentPage(defaultPage) }, "Go Home"),
+                ] }) })));
+};
 //# sourceMappingURL=RouterLayout.js.map

package/dist_es/react/components/navigation/react-router/BasicLayout.d.ts

@@ -0,0 +1,23 @@
+import type { Location } from '@remix-run/router';
+import { LayoutProps, MenuProps, SiderProps } from 'antd';
+import React from 'react';
+import { MenuPage } from '../MenuPage';
+export interface BasicLayoutProps {
+    pages?: MenuPage[];
+    compactSider?: boolean;
+    layoutProps?: LayoutProps;
+    mobileHeaderProps?: LayoutProps;
+    siderProps?: SiderProps;
+    contentProps?: LayoutProps;
+    menuProps?: Omit<MenuProps, 'items' | 'selectedKeys' | 'onSelect'>;
+    isSelectedRoute?: (page: MenuPage, location: Location) => boolean;
+}
+/**
+ * This hook can be used with react-router/BasicLayout,
+ * to ensure FIN5 URL is aligned with the internal frame URL.
+ */
+export declare const useLocationUpdate: () => void;
+/**
+ * Basic layout that uses React Router.
+ */
+export declare const BasicLayout: React.FC<BasicLayoutProps>;

package/dist_es/react/components/navigation/react-router/BasicLayout.js

@@ -0,0 +1,82 @@
+/*
+ * Copyright (c) 2023, J2 Innovations. All Rights Reserved
+ */
+import { MenuFoldOutlined, MenuUnfoldOutlined } from '@ant-design/icons';
+import { Layout, Menu } from '@j2inn/ui';
+import classNames from 'classnames';
+import { IN_IFRAME, fin5SkipHashUpdate, getFin5HashFrameParameters, getTopLocation, } from 'fin5Top/useFin5AppURLHashParameter';
+import React, { useEffect, useMemo, useState } from 'react';
+import { Outlet, useLocation, useNavigate } from 'react-router';
+import { HEADER_HEIGHT, getMenuPages, useStyles } from '../BasicLayout';
+import { pageTreeToPageList } from '../MenuPage';
+// Workaround j2inn/ui exporting problem
+const Header = Layout.Header;
+const Sider = Layout.Sider;
+const Content = Layout.Content;
+/**
+ * This hook can be used with react-router/BasicLayout,
+ * to ensure FIN5 URL is aligned with the internal frame URL.
+ */
+export const useLocationUpdate = () => {
+    const location = useLocation();
+    useEffect(() => {
+        console.debug('Location changed', location);
+        const hash = location.pathname;
+        const queryParams = location.search;
+        if (IN_IFRAME) {
+            fin5SkipHashUpdate()?.then(() => {
+                const frameParameters = getFin5HashFrameParameters();
+                frameParameters.set('url', frameParameters.get('url')?.split('#')[0] +
+                    '#' +
+                    hash +
+                    queryParams);
+                getTopLocation().hash = `#${getTopLocation().hash.slice(1).split('?')[0]}?${frameParameters.toString()}`;
+            });
+        }
+    }, [location]);
+};
+const useSelectedRoutes = (pages, isSelectedRoute = (page, location) => location.pathname.includes(`/${page.key}`)) => {
+    const location = useLocation();
+    return useMemo(() => {
+        const flatPages = pageTreeToPageList(pages);
+        return flatPages
+            .filter((page) => isSelectedRoute(page, location))
+            .map((page) => page.key);
+    }, [location, pages]);
+};
+/**
+ * Basic layout that uses React Router.
+ */
+export const BasicLayout = ({ pages = [], compactSider, layoutProps, mobileHeaderProps, siderProps, contentProps, menuProps, isSelectedRoute, }) => {
+    const navigate = useNavigate();
+    const selectedRoutes = useSelectedRoutes(pages, isSelectedRoute);
+    // manage mobile navigation
+    const [isMobile, setIsMobile] = useState(false);
+    const [hiddenSider, setHiddenSider] = useState(false);
+    const siderWidth = siderProps?.width;
+    const classes = useStyles({ isMobile, compactSider, siderWidth });
+    const menuPages = useMemo(() => getMenuPages(pages), [pages]);
+    return (React.createElement(Layout, { hasSider: true, ...layoutProps },
+        isMobile && (React.createElement(Header, { ...mobileHeaderProps, className: classNames(classes.header, mobileHeaderProps?.className) }, hiddenSider ? (React.createElement(MenuUnfoldOutlined, { className: classes.menuTrigger, onClick: () => {
+                setHiddenSider(!hiddenSider);
+            } })) : (React.createElement(MenuFoldOutlined, { className: classes.menuTrigger, onClick: () => {
+                setHiddenSider(!hiddenSider);
+            } })))),
+        React.createElement(Sider, { ...siderProps, className: classNames(classes.sider, siderProps?.className), breakpoint: 'md', onBreakpoint: (broken) => {
+                setIsMobile(broken);
+                setHiddenSider(true);
+            }, collapsed: (isMobile && hiddenSider) || compactSider, collapsedWidth: isMobile && hiddenSider
+                ? 0
+                : compactSider
+                    ? HEADER_HEIGHT
+                    : 0, trigger: null },
+            React.createElement(Menu, { ...menuProps, items: menuPages, selectedKeys: selectedRoutes, onSelect: ({ key }) => {
+                    if (!hiddenSider) {
+                        setHiddenSider(true);
+                    }
+                    navigate(key);
+                } })),
+        React.createElement(Content, { ...contentProps, className: classNames(classes.content, contentProps?.className) },
+            React.createElement(Outlet, null))));
+};
+//# sourceMappingURL=BasicLayout.js.map

package/dist_es/react/components/navigation/react-router/BasicLayout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BasicLayout.js","sourceRoot":"","sources":["../../../../../src/react/components/navigation/react-router/BasicLayout.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AACxE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAGxC,OAAO,UAAU,MAAM,YAAY,CAAA;AACnC,OAAO,EACN,SAAS,EACT,kBAAkB,EAClB,0BAA0B,EAC1B,cAAc,GACd,MAAM,oCAAoC,CAAA;AAC3C,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAC3D,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC/D,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACvE,OAAO,EAAY,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAE1D,wCAAwC;AACxC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAiC,CAAA;AACvD,MAAM,KAAK,GAAG,MAAM,CAAC,KAA+B,CAAA;AACpD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAmC,CAAA;AAa1D;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,EAAE;IACrC,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAA;IAC9B,SAAS,CAAC,GAAG,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAA;QAC3C,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAA;QAC9B,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAA;QAEnC,IAAI,SAAS,EAAE;YACd,kBAAkB,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBAC/B,MAAM,eAAe,GAAG,0BAA0B,EAAE,CAAA;gBAEpD,eAAe,CAAC,GAAG,CAClB,KAAK,EACL,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;oBACxC,GAAG;oBACH,IAAI;oBACJ,WAAW,CACZ,CAAA;gBAED,cAAc,EAAE,CAAC,IAAI,GAAG,IACvB,cAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAC5C,IAAI,eAAe,CAAC,QAAQ,EAAE,EAAE,CAAA;YACjC,CAAC,CAAC,CAAA;SACF;IACF,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAA;AACf,CAAC,CAAA;AAED,MAAM,iBAAiB,GAAG,CACzB,KAAiB,EACjB,kBAAkB,CAAC,IAAc,EAAE,QAAkB,EAAE,EAAE,CACxD,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,EAC1C,EAAE;IACH,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAA;IAE9B,OAAO,OAAO,CAAC,GAAG,EAAE;QACnB,MAAM,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAA;QAC3C,OAAO,SAAS;aACd,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;aACjD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAC1B,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAA;AACtB,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAA+B,CAAC,EACvD,KAAK,GAAG,EAAE,EACV,YAAY,EACZ,WAAW,EACX,iBAAiB,EACjB,UAAU,EACV,YAAY,EACZ,SAAS,EACT,eAAe,GACf,EAAE,EAAE;IACJ,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAA;IAC9B,MAAM,cAAc,GAAG,iBAAiB,CAAC,KAAK,EAAE,eAAe,CAAC,CAAA;IAChE,2BAA2B;IAC3B,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC/C,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;IACrD,MAAM,UAAU,GAAG,UAAU,EAAE,KAAK,CAAA;IACpC,MAAM,OAAO,GAAG,SAAS,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CAAA;IAEjE,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAA;IAE7D,OAAO,CACN,oBAAC,MAAM,IAAC,QAAQ,WAAK,WAAW;QAC9B,QAAQ,IAAI,CACZ,oBAAC,MAAM,OACF,iBAAiB,EACrB,SAAS,EAAE,UAAU,CACpB,OAAO,CAAC,MAAM,EACd,iBAAiB,EAAE,SAAS,CAC5B,IACA,WAAW,CAAC,CAAC,CAAC,CACd,oBAAC,kBAAkB,IAClB,SAAS,EAAE,OAAO,CAAC,WAAW,EAC9B,OAAO,EAAE,GAAG,EAAE;gBACb,cAAc,CAAC,CAAC,WAAW,CAAC,CAAA;YAC7B,CAAC,GACA,CACF,CAAC,CAAC,CAAC,CACH,oBAAC,gBAAgB,IAChB,SAAS,EAAE,OAAO,CAAC,WAAW,EAC9B,OAAO,EAAE,GAAG,EAAE;gBACb,cAAc,CAAC,CAAC,WAAW,CAAC,CAAA;YAC7B,CAAC,GACA,CACF,CACO,CACT;QACD,oBAAC,KAAK,OACD,UAAU,EACd,SAAS,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,EAC3D,UAAU,EAAC,IAAI,EACf,YAAY,EAAE,CAAC,MAAe,EAAE,EAAE;gBACjC,WAAW,CAAC,MAAM,CAAC,CAAA;gBACnB,cAAc,CAAC,IAAI,CAAC,CAAA;YACrB,CAAC,EACD,SAAS,EAAE,CAAC,QAAQ,IAAI,WAAW,CAAC,IAAI,YAAY,EACpD,cAAc,EACb,QAAQ,IAAI,WAAW;gBACtB,CAAC,CAAC,CAAC;gBACH,CAAC,CAAC,YAAY;oBACd,CAAC,CAAC,aAAa;oBACf,CAAC,CAAC,CAAC,EAEL,OAAO,EAAE,IAAI;YACb,oBAAC,IAAI,OACA,SAAS,EACb,KAAK,EAAE,SAAS,EAChB,YAAY,EAAE,cAAc,EAC5B,QAAQ,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE;oBACrB,IAAI,CAAC,WAAW,EAAE;wBACjB,cAAc,CAAC,IAAI,CAAC,CAAA;qBACpB;oBACD,QAAQ,CAAC,GAAG,CAAC,CAAA;gBACd,CAAC,GACA,CACK;QACR,oBAAC,OAAO,OACH,YAAY,EAChB,SAAS,EAAE,UAAU,CACpB,OAAO,CAAC,OAAO,EACf,YAAY,EAAE,SAAS,CACvB;YACD,oBAAC,MAAM,OAAG,CACD,CACF,CACT,CAAA;AACF,CAAC,CAAA"}

package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.d.ts

@@ -0,0 +1,24 @@
+import type { Location } from '@remix-run/router';
+import { LayoutProps, MenuProps, SiderProps } from 'antd';
+import React from 'react';
+import { MenuPage } from '../MenuPage';
+export interface ReactRouterBasicLayoutProps {
+    pages?: MenuPage[];
+    defaultPage?: string;
+    compactSider?: boolean;
+    layoutProps?: LayoutProps;
+    mobileHeaderProps?: LayoutProps;
+    siderProps?: SiderProps;
+    contentProps?: LayoutProps;
+    menuProps?: Omit<MenuProps, 'items' | 'selectedKeys' | 'onSelect'>;
+    isSelectedRoute?: (page: MenuPage, location: Location) => boolean;
+}
+/**
+ * This hook can be used with react-router/BasicLayout,
+ * to ensure FIN5 URL is aligned with the internal frame URL.
+ */
+export declare const useLocationUpdate: () => void;
+/**
+ * Basic layout that uses React Router.
+ */
+export declare const ReactRouterBasicLayout: React.FC<ReactRouterBasicLayoutProps>;

package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.js

@@ -0,0 +1,82 @@
+/*
+ * Copyright (c) 2023, J2 Innovations. All Rights Reserved
+ */
+import { MenuFoldOutlined, MenuUnfoldOutlined } from '@ant-design/icons';
+import { Layout, Menu } from '@j2inn/ui';
+import classNames from 'classnames';
+import React, { useEffect, useMemo, useState } from 'react';
+import { Outlet, useLocation, useNavigate } from 'react-router';
+import { IN_IFRAME, fin5SkipHashUpdate, getFin5HashFrameParameters, getTopLocation, } from '../../../../fin5Top/useFin5AppURLHashParameter';
+import { HEADER_HEIGHT, getMenuPages, useStyles } from '../BasicLayout';
+import { pageTreeToPageList } from '../MenuPage';
+// Workaround j2inn/ui exporting problem
+const Header = Layout.Header;
+const Sider = Layout.Sider;
+const Content = Layout.Content;
+/**
+ * This hook can be used with react-router/BasicLayout,
+ * to ensure FIN5 URL is aligned with the internal frame URL.
+ */
+export const useLocationUpdate = () => {
+    const location = useLocation();
+    useEffect(() => {
+        console.debug('Location changed', location);
+        const hash = location.pathname;
+        const queryParams = location.search;
+        if (IN_IFRAME) {
+            fin5SkipHashUpdate()?.then(() => {
+                const frameParameters = getFin5HashFrameParameters();
+                frameParameters.set('url', frameParameters.get('url')?.split('#')[0] +
+                    '#' +
+                    hash +
+                    queryParams);
+                getTopLocation().hash = `#${getTopLocation().hash.slice(1).split('?')[0]}?${frameParameters.toString()}`;
+            });
+        }
+    }, [location]);
+};
+const useSelectedRoutes = (pages, isSelectedRoute = (page, location) => location.pathname.includes(`/${page.key}`)) => {
+    const location = useLocation();
+    return useMemo(() => {
+        const flatPages = pageTreeToPageList(pages);
+        return flatPages
+            .filter((page) => isSelectedRoute(page, location))
+            .map((page) => page.key);
+    }, [location, pages]);
+};
+/**
+ * Basic layout that uses React Router.
+ */
+export const ReactRouterBasicLayout = ({ pages = [], defaultPage, compactSider, layoutProps, mobileHeaderProps, siderProps, contentProps, menuProps, isSelectedRoute, }) => {
+    const navigate = useNavigate();
+    const selectedRoutes = useSelectedRoutes(pages, isSelectedRoute);
+    // manage mobile navigation
+    const [isMobile, setIsMobile] = useState(false);
+    const [hiddenSider, setHiddenSider] = useState(false);
+    const siderWidth = siderProps?.width;
+    const classes = useStyles({ isMobile, compactSider, siderWidth });
+    const menuPages = useMemo(() => getMenuPages(pages), [pages]);
+    return (React.createElement(Layout, { hasSider: true, ...layoutProps },
+        isMobile && (React.createElement(Header, { ...mobileHeaderProps, className: classNames(classes.header, mobileHeaderProps?.className) }, hiddenSider ? (React.createElement(MenuUnfoldOutlined, { className: classes.menuTrigger, onClick: () => {
+                setHiddenSider(!hiddenSider);
+            } })) : (React.createElement(MenuFoldOutlined, { className: classes.menuTrigger, onClick: () => {
+                setHiddenSider(!hiddenSider);
+            } })))),
+        React.createElement(Sider, { ...siderProps, className: classNames(classes.sider, siderProps?.className), breakpoint: 'md', onBreakpoint: (broken) => {
+                setIsMobile(broken);
+                setHiddenSider(true);
+            }, collapsed: (isMobile && hiddenSider) || compactSider, collapsedWidth: isMobile && hiddenSider
+                ? 0
+                : compactSider
+                    ? HEADER_HEIGHT
+                    : 0, trigger: null },
+            React.createElement(Menu, { ...menuProps, defaultSelectedKeys: defaultPage ? [defaultPage] : undefined, items: menuPages, selectedKeys: selectedRoutes, onSelect: ({ key }) => {
+                    if (!hiddenSider) {
+                        setHiddenSider(true);
+                    }
+                    navigate(key);
+                } })),
+        React.createElement(Content, { ...contentProps, className: classNames(classes.content, contentProps?.className) },
+            React.createElement(Outlet, null))));
+};
+//# sourceMappingURL=ReactRouterBasicLayout.js.map