@stack-spot/portal-layout 0.0.64 → 1.0.0-dev.1768482785050

package/dist/Layout.d.ts

@@ -1,32 +1,84 @@
-import { TourProps } from '@stack-spot/portal-components';
 import { WithStyle } from '@stack-spot/portal-theme';
 import '@stack-spot/portal-theme/dist/theme.css';
 import { ReactElement, ReactNode } from 'react';
 import { HeaderProps } from './components/Header.js';
 import { DescriptionFn, ErrorHandler } from './components/error/ErrorManager.js';
 import { MenuProps } from './components/menu/types.js';
-import { LayoutContext } from './layout-context.js';
 import './layout.css';
-interface Props extends WithStyle, LayoutContext {
+interface Props extends WithStyle {
+    /**
+     * The config for the menu.
+     */
     menu: MenuProps;
+    /**
+     * The config for the header.
+     */
     header: HeaderProps;
+    /**
+     * The React node to go in the page content.
+     */
     children: ReactNode;
+    /**
+     * A React node to place right after the page.
+     */
     extra?: ReactNode;
+    /**
+     * A function to convert errors into a readable format so they're properly rendered and logged.
+     */
     errorDescriptor?: DescriptionFn;
+    /**
+     * A function to run whenever an error is catch by an error boundary.
+     */
     onError?: ErrorHandler;
-    tourProps?: TourProps;
+    /**
+     * When true, the sections menu auto-collapses whenever a secondary (contextual) menu appears.
+     * @default false
+     */
+    autoCollapseSectionsMenu?: boolean;
 }
-interface RawProps extends WithStyle, LayoutContext {
+interface RawProps extends WithStyle {
+    /**
+     * The React element to go in the menu sections.
+     */
     menuSections?: ReactElement;
+    /**
+     * The React element to go in the menu content.
+     */
     menuContent?: ReactElement;
+    /**
+     * The React element to go in the menu inner content (third level nav).
+     */
+    menuInnerContent?: ReactElement;
+    /**
+     * The React element to go in the header.
+     */
     header?: ReactElement;
+    /**
+     * The React node to go in the page content.
+     */
     children?: ReactNode;
+    /**
+     * A React node to place right after the page.
+     */
     extra?: ReactNode;
+    /**
+     * A function to convert errors into a readable format so they're properly rendered and logged.
+     */
     errorDescriptor?: DescriptionFn;
+    /**
+     * A function to run whenever an error is catch by an error boundary.
+     */
     onError?: ErrorHandler;
-    tourProps?: TourProps;
 }
-export declare const RawLayout: ({ menuSections, menuContent, header, children, tourProps, extra, errorDescriptor, onError, className, style, anchorTag }: RawProps) => import("react/jsx-runtime").JSX.Element;
-export declare const Layout: ({ menu, header, children, extra, errorDescriptor, onError, className, style, tourProps }: Props) => import("react/jsx-runtime").JSX.Element;
+/**
+ * Renders the layout with the React elements passed in the props.
+ * @param props the component's props {@link RawProps}.
+ */
+export declare const RawLayout: ({ menuSections, menuContent, menuInnerContent, header, children, extra, errorDescriptor, onError, className, style }: RawProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * Renders the layout with a menu and header that follow the config objects passed as parameter.
+ * @param props the component's props {@link Props}.
+ */
+export declare const Layout: ({ menu, header, children, extra, errorDescriptor, onError, className, style }: Props) => import("react/jsx-runtime").JSX.Element;
 export {};
 //# sourceMappingURL=Layout.d.ts.map

package/dist/Layout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Layout.d.ts","sourceRoot":"","sources":["../src/Layout.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAkD,MAAM,+BAA+B,CAAA;AACzG,OAAO,EAAsB,SAAS,EAAe,MAAM,0BAA0B,CAAA;AACrF,OAAO,yCAAyC,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,SAAS,EAAa,MAAM,OAAO,CAAA;AAE1D,OAAO,EAAU,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAGzD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAgB,MAAM,iCAAiC,CAAA;AAI3F,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGnD,OAAO,EAAE,aAAa,EAAkB,MAAM,kBAAkB,CAAA;AAChE,OAAO,cAAc,CAAA;AAErB,UAAU,KAAM,SAAQ,SAAS,EAAE,aAAa;IAC9C,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,WAAW,CAAC;IACpB,QAAQ,EAAE,SAAS,CAAC;IACpB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,eAAe,CAAC,EAAE,aAAa,CAAC;IAChC,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED,UAAU,QAAS,SAAQ,SAAS,EAAE,aAAa;IACjD,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,eAAe,CAAC,EAAE,aAAa,CAAC;IAChC,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED,eAAO,MAAM,SAAS,6HAGlB,QAAQ,4CAsDX,CAAA;AAOD,eAAO,MAAM,MAAM,6FAA8F,KAAK,4CAiBrH,CAAA"}
+{"version":3,"file":"Layout.d.ts","sourceRoot":"","sources":["../src/Layout.tsx"],"names":[],"mappings":"AACA,OAAO,EAAmC,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACrF,OAAO,yCAAyC,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,SAAS,EAAa,MAAM,OAAO,CAAA;AAG1D,OAAO,EAAU,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAGzD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAgB,MAAM,iCAAiC,CAAA;AAI3F,OAAO,EAAE,SAAS,EAAmD,MAAM,yBAAyB,CAAA;AAEpG,OAAO,cAAc,CAAA;AAErB,UAAU,KAAM,SAAQ,SAAS;IAC/B;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;IAChB;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC;IACpB;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB;;OAEG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,UAAU,QAAS,SAAQ,SAAS;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB;;OAEG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB;AAED;;;GAGG;AACH,eAAO,MAAM,SAAS,GACpB,sHAEE,QAAQ,4CAkGX,CAAA;AAcD;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,+EAA+E,KAAK,4CAsB1G,CAAA"}

package/dist/Layout.js

@@ -1,9 +1,10 @@
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import { TourProvider, defaultTourConfig, isNewTourStep } from '@stack-spot/portal-components';
+import { FadingOverflow } from '@stack-spot/portal-components/FadingOverflow';
 import { CSSToCitricAdapter, listToClass } from '@stack-spot/portal-theme';
 import '@stack-spot/portal-theme/dist/theme.css';
 import { useEffect } from 'react';
 import { overlay } from './LayoutOverlayManager.js';
+import { WelcomeTour } from './WelcomeTour.js';
 import { Header } from './components/Header.js';
 import { Toaster } from './components/Toaster.js';
 import { ErrorBoundary } from './components/error/ErrorBoundary.js';
@@ -11,41 +12,75 @@ import { ErrorManager } from './components/error/ErrorManager.js';
 import { SilentErrorBoundary } from './components/error/SilentErrorBoundary.js';
 import { MenuContent } from './components/menu/MenuContent.js';
 import { MenuSections } from './components/menu/MenuSections.js';
-import { usePortalSwitcherStep } from './components/tour/PortalSwitcherStep.js';
-import { elementIds, getLayoutElements } from './elements.js';
-import { LayoutProvider } from './layout-context.js';
+import { elementIds } from './elements.js';
 import './layout.css';
-export const RawLayout = ({ menuSections, menuContent, header, children, tourProps, extra, errorDescriptor, onError, className, style, anchorTag }) => {
-    // @ts-ignore
+/**
+ * Renders the layout with the React elements passed in the props.
+ * @param props the component's props {@link RawProps}.
+ */
+export const RawLayout = ({ menuSections, menuContent, menuInnerContent, header, children, extra, errorDescriptor, onError, className, style }) => {
     const { bottomDialog, modal, rightPanel } = overlay.useOverlays();
-    const { layout } = getLayoutElements();
-    const isCompactedOnlyIcons = layout?.classList.contains('menu-compact');
-    const portalSwitcherStep = usePortalSwitcherStep();
-    const classes = [
-        menuContent && !isCompactedOnlyIcons ? 'menu-content-visible' : undefined,
-        menuSections ? undefined : 'no-menu-sections',
-        className,
-        isCompactedOnlyIcons ? 'menu-compact' : undefined,
-    ];
-    const tourPropsWithDefaults = { ...defaultTourConfig, ...(tourProps || {}) };
-    tourPropsWithDefaults.steps = [
-        portalSwitcherStep,
-        ...tourPropsWithDefaults.steps,
-    ].filter(isNewTourStep);
     useEffect(() => {
         if (errorDescriptor)
             ErrorManager.setDescriptionFunction(errorDescriptor);
         if (onError)
             ErrorManager.setErrorHandler(onError);
     }, []);
-    return (_jsx(CSSToCitricAdapter, { children: _jsx(LayoutProvider, { anchorTag: anchorTag, children: _jsx(TourProvider, { config: tourPropsWithDefaults, children: _jsxs("div", { id: elementIds.layout, className: listToClass(classes), style: style, children: [children && _jsx("div", { id: elementIds.page, children: _jsx("article", { id: elementIds.content, children: _jsx(ErrorBoundary, { children: children }) }) }), extra && _jsx(SilentErrorBoundary, { children: extra }), _jsxs("aside", { id: elementIds.menu, children: [_jsx("nav", { role: "menu", id: elementIds.menuContent, children: _jsx(SilentErrorBoundary, { children: menuContent }) }), menuSections &&
-                                    _jsx("nav", { role: "menu", id: elementIds.menuSections, children: _jsx(SilentErrorBoundary, { children: menuSections }) })] }), header && _jsx("header", { id: elementIds.header, children: _jsx(SilentErrorBoundary, { children: header }) }), _jsx("div", { id: elementIds.bottomDialog, role: "dialog", children: _jsx(ErrorBoundary, { children: bottomDialog }) }), _jsxs("div", { id: elementIds.backdrop, children: [_jsx("div", { id: elementIds.rightPanel, "aria-modal": true, role: "dialog", children: _jsx(ErrorBoundary, { children: rightPanel }) }), _jsx("div", { id: elementIds.modal, "aria-modal": true, role: "dialog", children: _jsx(ErrorBoundary, { children: modal }) })] }), _jsx(Toaster, {}), _jsx("div", { id: elementIds.accessibilityAnnouncer, "aria-atomic": true, "aria-live": "assertive" })] }) }) }) }));
+    // controls classes in the layout element. This can't be a React prop because we don't want classes to be replaced, we want them to be
+    // merged with the previous set of classes.
+    useEffect(() => {
+        const classList = document.getElementById(elementIds.layout)?.classList;
+        if (!classList)
+            return;
+        const hasMenuContent = !!menuContent && !!document.getElementById(elementIds.menuContent)?.children.length;
+        const hasMenuInnerContent = !!menuInnerContent && !!document.getElementById(elementIds.menuInnerContent)?.children.length;
+        if (hasMenuContent) {
+            classList.add('menu-content-visible');
+            if (!classList.contains('menu-manual')) {
+                classList.add('menu-compact');
+            }
+        }
+        else {
+            classList.remove('menu-content-visible');
+        }
+        if (hasMenuInnerContent) {
+            classList.add('menu-inner-content-visible');
+        }
+        else {
+            classList.remove('menu-inner-content-visible');
+        }
+        classList[menuSections ? 'remove' : 'add']('no-menu-sections');
+        if (className)
+            classList.add(...className.split(/\s+/));
+    }, [menuContent, menuInnerContent, menuSections, className]);
+    return (_jsxs(CSSToCitricAdapter, { children: [_jsx(WelcomeTour, {}), _jsxs("div", { id: elementIds.layout, style: style, className: "menu-manual menu-compact", children: [header && _jsx("header", { id: elementIds.header, children: _jsx(SilentErrorBoundary, { children: header }) }), extra && _jsx(SilentErrorBoundary, { children: extra }), _jsxs("aside", { id: elementIds.menu, children: [menuInnerContent &&
+                                _jsx("nav", { role: "menubar", id: elementIds.menuInnerContent, children: _jsx(SilentErrorBoundary, { children: menuInnerContent }) }), _jsx("nav", { role: "menubar", id: elementIds.menuContent, children: _jsx(SilentErrorBoundary, { children: menuContent }) }), menuSections &&
+                                _jsx(FadingOverflow, { sides: ['top', 'bottom'], scroll: "arrows", children: _jsx("nav", { role: "menubar", id: elementIds.menuSections, children: _jsx(SilentErrorBoundary, { children: menuSections }) }) })] }), children && _jsx("div", { id: elementIds.page, children: _jsx("article", { id: elementIds.content, children: _jsx(ErrorBoundary, { children: children }) }) }), _jsx("div", { id: elementIds.bottomDialog, role: "dialog", children: _jsx(ErrorBoundary, { children: bottomDialog }) }), _jsxs("div", { id: elementIds.backdrop, children: [_jsx("div", { id: elementIds.rightPanel, "aria-modal": true, role: "dialog", children: _jsx(ErrorBoundary, { children: rightPanel.length === 1 && !rightPanel[0].stack
+                                        ? rightPanel[0].element
+                                        : rightPanel.map((m, i) => _jsx("div", { className: listToClass([
+                                                'right-panel-instance',
+                                                (i === rightPanel.length - 1) && 'active',
+                                                modal.length > 0 && 'disabled',
+                                            ]), ...(modal.length > 0 ? { inert: true } : {}), children: m.element }, i)) }) }), _jsx("div", { id: elementIds.modal, "aria-modal": true, role: "dialog", children: _jsx(ErrorBoundary, { children: modal.length === 1 && !modal[0].stack
+                                        ? modal[0].element
+                                        : modal.map((m, i) => _jsx("div", { className: listToClass(['modal-instance', (i === modal.length - 1) && 'active']), children: m.element }, i)) }) })] }), _jsx(Toaster, {}), _jsx("div", { id: elementIds.accessibilityAnnouncer, "aria-atomic": true, "aria-live": "assertive" })] })] }));
 };
 const MenuContentRenderer = ({ content }) => {
     const menuContent = typeof content === 'function' ? content() : content;
     return _jsx(MenuContent, { ...menuContent });
 };
-export const Layout = ({ menu, header, children, extra, errorDescriptor, onError, className, style, tourProps }) => (_jsx(RawLayout, { header: _jsx(Header, { ...header }), menuSections: menu.sections ? _jsx(MenuSections, { ...menu }) : undefined, menuContent: menu.content
+const MenuInnerContentRenderer = ({ content }) => {
+    const menuContent = typeof content === 'function' ? content() : content;
+    return menuContent && _jsx(MenuContent, { ...menuContent });
+};
+const hasInnerContent = (menu) => 'innerContent' in menu;
+/**
+ * Renders the layout with a menu and header that follow the config objects passed as parameter.
+ * @param props the component's props {@link Props}.
+ */
+export const Layout = ({ menu, header, children, extra, errorDescriptor, onError, className, style }) => (_jsx(RawLayout, { header: _jsx(Header, { ...header }), menuSections: menu.sections ? _jsx(MenuSections, { ...menu }) : undefined, menuContent: menu.content
         ? _jsx(MenuContentRenderer, { content: menu.content }, 'contentKey' in menu ? menu.contentKey : undefined)
-        : undefined, errorDescriptor: errorDescriptor, onError: onError, extra: extra, className: className, style: style, tourProps: tourProps, children: children }));
+        : undefined, menuInnerContent: hasInnerContent(menu) && menu.innerContent
+        ? _jsx(MenuInnerContentRenderer, { content: menu.innerContent }, 'contentKey' in menu ? menu.contentKey : undefined)
+        : undefined, errorDescriptor: errorDescriptor, onError: onError, extra: extra, className: className, style: style, children: children }));
 //# sourceMappingURL=Layout.js.map

package/dist/Layout.js.map

@@ -1 +1 @@
-{"version":3,"file":"Layout.js","sourceRoot":"","sources":["../src/Layout.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAa,YAAY,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AACzG,OAAO,EAAE,kBAAkB,EAAa,WAAW,EAAE,MAAM,0BAA0B,CAAA;AACrF,OAAO,yCAAyC,CAAA;AAChD,OAAO,EAA2B,SAAS,EAAE,MAAM,OAAO,CAAA;AAC1D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAChD,OAAO,EAAE,MAAM,EAAe,MAAM,qBAAqB,CAAA;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAA+B,YAAY,EAAE,MAAM,iCAAiC,CAAA;AAC3F,OAAO,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAA;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAA;AAE7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAA;AAC5E,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAC1D,OAAO,EAAiB,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAChE,OAAO,cAAc,CAAA;AAuBrB,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EACtD,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EACpD,EACV,EAAE;IACF,aAAa;IACb,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,CAAA;IACjE,MAAM,EAAE,MAAM,EAAE,GAAG,iBAAiB,EAAE,CAAA;IACtC,MAAM,oBAAoB,GAAG,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;IACvE,MAAM,kBAAkB,GAAG,qBAAqB,EAAE,CAAA;IAElD,MAAM,OAAO,GAAG;QACd,WAAW,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS;QACzE,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,kBAAkB;QAC7C,SAAS;QACT,oBAAoB,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS;KAClD,CAAA;IAED,MAAM,qBAAqB,GAAG,EAAE,GAAG,iBAAiB,EAAE,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,CAAA;IAC5E,qBAAqB,CAAC,KAAK,GAAG;QAC5B,kBAAkB;QAClB,GAAG,qBAAqB,CAAC,KAAK;KAC/B,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;IAEvB,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,eAAe;YAAE,YAAY,CAAC,sBAAsB,CAAC,eAAe,CAAC,CAAA;QACzE,IAAI,OAAO;YAAE,YAAY,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;IACpD,CAAC,EAAE,EAAE,CAAC,CAAA;IAEN,OAAO,CACL,KAAC,kBAAkB,cACjB,KAAC,cAAc,IAAC,SAAS,EAAE,SAAS,YAClC,KAAC,YAAY,IAAC,MAAM,EAAE,qBAAqB,YACzC,eAAK,EAAE,EAAE,UAAU,CAAC,MAAM,EAAE,SAAS,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,KAAK,aACtE,QAAQ,IAAI,cAAK,EAAE,EAAE,UAAU,CAAC,IAAI,YACnC,kBAAS,EAAE,EAAE,UAAU,CAAC,OAAO,YAAE,KAAC,aAAa,cAAE,QAAQ,GAAiB,GAAU,GAChF,EACL,KAAK,IAAI,KAAC,mBAAmB,cAAE,KAAK,GAAuB,EAC5D,iBAAO,EAAE,EAAE,UAAU,CAAC,IAAI,aACxB,cAAK,IAAI,EAAC,MAAM,EAAC,EAAE,EAAE,UAAU,CAAC,WAAW,YAAE,KAAC,mBAAmB,cAAE,WAAW,GAAuB,GAAM,EAC1G,YAAY;oCACX,cAAK,IAAI,EAAC,MAAM,EAAC,EAAE,EAAE,UAAU,CAAC,YAAY,YAAE,KAAC,mBAAmB,cAAE,YAAY,GAAuB,GAAM,IACzG,EACP,MAAM,IAAI,iBAAQ,EAAE,EAAE,UAAU,CAAC,MAAM,YAAE,KAAC,mBAAmB,cAAE,MAAM,GAAuB,GAAS,EACtG,cAAK,EAAE,EAAE,UAAU,CAAC,YAAY,EAAE,IAAI,EAAC,QAAQ,YAAC,KAAC,aAAa,cAAE,YAAY,GAAiB,GAAM,EACnG,eAAK,EAAE,EAAE,UAAU,CAAC,QAAQ,aAC1B,cAAK,EAAE,EAAE,UAAU,CAAC,UAAU,sBAAa,IAAI,EAAC,QAAQ,YAAC,KAAC,aAAa,cAAE,UAAU,GAAiB,GAAM,EAC1G,cAAK,EAAE,EAAE,UAAU,CAAC,KAAK,sBAAa,IAAI,EAAC,QAAQ,YAAC,KAAC,aAAa,cAAE,KAAK,GAAiB,GAAM,IAC5F,EACN,KAAC,OAAO,KAAG,EACX,cAAK,EAAE,EAAE,UAAU,CAAC,sBAAsB,oCAAwB,WAAW,GACvE,IACF,GACO,GACA,GACE,CACtB,CAAA;AACH,CAAC,CAAA;AAED,MAAM,mBAAmB,GAAG,CAAC,EAAE,OAAO,EAA4C,EAAE,EAAE;IACpF,MAAM,WAAW,GAAG,OAAO,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAA;IACvE,OAAO,KAAC,WAAW,OAAK,WAAW,GAAI,CAAA;AACzC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAS,EAAE,EAAE,CAAC,CACzH,KAAC,SAAS,IACR,MAAM,EAAE,KAAC,MAAM,OAAK,MAAM,GAAI,EAC9B,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAC,YAAY,OAAK,IAAI,GAAI,CAAC,CAAC,CAAC,SAAS,EACpE,WAAW,EAAE,IAAI,CAAC,OAAO;QACvB,CAAC,CAAC,KAAC,mBAAmB,IAA0D,OAAO,EAAE,IAAI,CAAC,OAAO,IAAzE,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAA2B;QACzG,CAAC,CAAC,SAAS,EAEb,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,SAAS,YAEnB,QAAQ,GACC,CACb,CAAA"}
+{"version":3,"file":"Layout.js","sourceRoot":"","sources":["../src/Layout.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,8CAA8C,CAAA;AAC7E,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAa,MAAM,0BAA0B,CAAA;AACrF,OAAO,yCAAyC,CAAA;AAChD,OAAO,EAA2B,SAAS,EAAE,MAAM,OAAO,CAAA;AAC1D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAe,MAAM,qBAAqB,CAAA;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAA+B,YAAY,EAAE,MAAM,iCAAiC,CAAA;AAC3F,OAAO,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAA;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAA;AAE7D,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,cAAc,CAAA;AAqErB;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,EAAE,YAAY,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAC7D,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EACzC,EACV,EAAE;IACF,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,CAAA;IAEjE,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,eAAe;YAAE,YAAY,CAAC,sBAAsB,CAAC,eAAe,CAAC,CAAA;QACzE,IAAI,OAAO;YAAE,YAAY,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;IACpD,CAAC,EAAE,EAAE,CAAC,CAAA;IAEN,sIAAsI;IACtI,2CAA2C;IAC3C,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,SAAS,GAAG,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,SAAS,CAAA;QACvE,IAAI,CAAC,SAAS;YAAE,OAAM;QACtB,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAA;QAC1G,MAAM,mBAAmB,GAAG,CAAC,CAAC,gBAAgB,IAAI,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAA;QAEzH,IAAI,cAAc,EAAE,CAAC;YACnB,SAAS,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;YACrC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;gBACvC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;YAC/B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,SAAS,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAA;QAC1C,CAAC;QAED,IAAI,mBAAmB,EAAE,CAAC;YACxB,SAAS,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAA;QAC7C,CAAC;aAAM,CAAC;YACN,SAAS,CAAC,MAAM,CAAC,4BAA4B,CAAC,CAAA;QAChD,CAAC;QAED,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,kBAAkB,CAAC,CAAA;QAC9D,IAAI,SAAS;YAAE,SAAS,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAA;IACzD,CAAC,EAAE,CAAC,WAAW,EAAE,gBAAgB,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAA;IAE5D,OAAO,CACL,MAAC,kBAAkB,eACjB,KAAC,WAAW,KAAG,EACf,eAAK,EAAE,EAAE,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAC,0BAA0B,aAC3E,MAAM,IAAI,iBAAQ,EAAE,EAAE,UAAU,CAAC,MAAM,YAAE,KAAC,mBAAmB,cAAE,MAAM,GAAuB,GAAS,EACrG,KAAK,IAAI,KAAC,mBAAmB,cAAE,KAAK,GAAuB,EAC5D,iBAAO,EAAE,EAAE,UAAU,CAAC,IAAI,aACvB,gBAAgB;gCACf,cAAK,IAAI,EAAC,SAAS,EAAC,EAAE,EAAE,UAAU,CAAC,gBAAgB,YAAE,KAAC,mBAAmB,cAAE,gBAAgB,GAAuB,GAAM,EAE1H,cAAK,IAAI,EAAC,SAAS,EAAC,EAAE,EAAE,UAAU,CAAC,WAAW,YAAE,KAAC,mBAAmB,cAAE,WAAW,GAAuB,GAAM,EAC7G,YAAY;gCACX,KAAC,cAAc,IAAC,KAAK,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAC,QAAQ,YACvD,cAAK,IAAI,EAAC,SAAS,EAAC,EAAE,EAAE,UAAU,CAAC,YAAY,YAC7C,KAAC,mBAAmB,cAAE,YAAY,GAAuB,GACrD,GACS,IAEb,EACP,QAAQ,IAAI,cAAK,EAAE,EAAE,UAAU,CAAC,IAAI,YACnC,kBAAS,EAAE,EAAE,UAAU,CAAC,OAAO,YAAE,KAAC,aAAa,cAAE,QAAQ,GAAiB,GAAU,GAChF,EACN,cAAK,EAAE,EAAE,UAAU,CAAC,YAAY,EAAE,IAAI,EAAC,QAAQ,YAAC,KAAC,aAAa,cAAE,YAAY,GAAiB,GAAM,EACnG,eAAK,EAAE,EAAE,UAAU,CAAC,QAAQ,aAC1B,cAAK,EAAE,EAAE,UAAU,CAAC,UAAU,sBAAa,IAAI,EAAC,QAAQ,YACtD,KAAC,aAAa,cACX,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK;wCAC9C,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO;wCACvB,CAAC,CAAC,UAAU,CAAC,GAAG,CACd,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,cAER,SAAS,EAAE,WAAW,CAAC;gDACrB,sBAAsB;gDACtB,CAAC,CAAC,KAAK,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,QAAQ;gDACzC,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU;6CAC/B,CAAC,KACE,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,YAE5C,CAAC,CAAC,OAAO,IARL,CAAC,CASF,CACP,GAEW,GACZ,EACN,cAAK,EAAE,EAAE,UAAU,CAAC,KAAK,sBAAa,IAAI,EAAC,QAAQ,YACjD,KAAC,aAAa,cACX,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK;wCACpC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO;wCAClB,CAAC,CAAC,KAAK,CAAC,GAAG,CACT,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACP,cAAa,SAAS,EAAE,WAAW,CAAC,CAAC,gBAAgB,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,YAAG,CAAC,CAAC,OAAO,IAA/F,CAAC,CAAqG,CACnH,GAEW,GACZ,IACF,EACN,KAAC,OAAO,KAAG,EACX,cAAK,EAAE,EAAE,UAAU,CAAC,sBAAsB,oCAAwB,WAAW,GACvE,IACF,IACa,CACtB,CAAA;AACH,CAAC,CAAA;AAED,MAAM,mBAAmB,GAAG,CAAC,EAAE,OAAO,EAA4C,EAAE,EAAE;IACpF,MAAM,WAAW,GAAG,OAAO,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAA;IACvE,OAAO,KAAC,WAAW,OAAK,WAAW,GAAI,CAAA;AAEzC,CAAC,CAAA;AACD,MAAM,wBAAwB,GAAG,CAAC,EAAE,OAAO,EAA6E,EAAE,EAAE;IAC1H,MAAM,WAAW,GAAG,OAAO,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAA;IACvE,OAAO,WAAW,IAAI,KAAC,WAAW,OAAK,WAAW,GAAI,CAAA;AACxD,CAAC,CAAA;AAED,MAAM,eAAe,GAAG,CAAC,IAAe,EAAuC,EAAE,CAAC,cAAc,IAAI,IAAI,CAAA;AAExG;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAS,EAAE,EAAE,CAAC,CAC9G,KAAC,SAAS,IACR,MAAM,EAAE,KAAC,MAAM,OAAK,MAAM,GAAI,EAC9B,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAC,YAAY,OAAK,IAAI,GAAI,CAAC,CAAC,CAAC,SAAS,EACpE,WAAW,EACT,IAAI,CAAC,OAAO;QACV,CAAC,CAAC,KAAC,mBAAmB,IAA0D,OAAO,EAAE,IAAI,CAAC,OAAO,IAAzE,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAA2B;QACzG,CAAC,CAAC,SAAS,EAEf,gBAAgB,EACd,eAAe,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,YAAY;QACxC,CAAC,CAAC,KAAC,wBAAwB,IAA0D,OAAO,EAAE,IAAI,CAAC,YAAY,IAA9E,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAgC;QACnH,CAAC,CAAC,SAAS,EAEf,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,KAAK,YAEX,QAAQ,GACC,CACb,CAAA"}

package/dist/LayoutOverlayManager.d.ts

@@ -1,63 +1,318 @@
 import { ReactElement } from 'react';
 import { DialogOptions } from './components/Dialog.js';
 import { OverlayContentProps } from './components/OverlayContent.js';
-import { showToaster as showReactToaster } from './toaster.js';
+import { CustomToasterOptions, DefaultToasterOptions, closeReactToaster } from './toaster.js';
+import { CustomModalSize, ModalSize, RightPanelSize } from './types.js';
 interface AlertOptions extends Omit<DialogOptions, 'cancel'> {
+    /**
+     * Whether or not to show an "ok" button. If false, the dialog can still be closed through the close button, by clicking outside it or by
+     * pressing ESC.
+     */
     showButton?: boolean;
 }
 type BottomDialogOptions = Omit<DialogOptions, 'title'>;
-type OverlaySize = 'small' | 'medium' | 'large';
-type ModalSize = 'fit-content' | OverlaySize;
 interface CustomModalOptions {
-    size?: ModalSize;
+    /**
+     * An optional, unique identifier for this modal.
+     */
+    id?: string;
+    /**
+     * The size of the modal.
+     */
+    size?: CustomModalSize;
+    /**
+     * A function to call when the modal closes.
+     */
     onClose?: () => void;
+    /**
+     * Property that defines whether the modal should ignore the initial focus on the close button.
+     * @default true
+     */
+    ignoreFirstFocusOnCloseButton?: boolean;
+    /**
+     * If true, instead of replacing the previously opened modal (if any), it will open on top of it (stacked).
+     *
+     * When a modal is stacked on top of another:
+     *   - Closing the modal, closes all opened modals.
+     *   - Popping the modal, closes only the modal at the top of the stack.
+     *   - Only the modal at the top of the stack can be interacted with.
+     *
+     * @default false
+     */
+    stack?: boolean;
 }
 interface CustomRightPanelOptions {
-    size?: OverlaySize;
+    /**
+     * An optional, unique identifier for this right panel.
+     */
+    id?: string;
+    /**
+     * The size of the right panel.
+     */
+    size?: RightPanelSize;
+    /**
+     * A function to call when the right panel closes.
+     */
     onClose?: () => void;
+    /**
+     * Property that defines whether the modal should ignore the initial focus on the close button.
+     * @default true
+     */
+    ignoreFirstFocusOnCloseButton?: boolean;
+    /**
+     * If true, instead of replacing the previously opened right panel (if any), it will open on top of it (stacked).
+     *
+     * When a right panel is stacked on top of another:
+     *   - Closing the panel, closes all opened panels.
+     *   - Popping the panel, closes only the panel at the top of the stack.
+     *   - Only the panel at the top of the stack can be interacted with.
+     *
+     * @default false
+     */
+    stack?: boolean;
 }
 declare class LayoutOverlayManager {
     static readonly instance?: LayoutOverlayManager;
     private setContent;
     private elements?;
-    private onModalClose?;
     /**
      * Last element with focus before an overlay is shown.
      */
     private lastActiveElement;
+    private modals;
+    private panels;
+    private closeCustomBackdrops;
+    private onClickBackdrop;
+    private onPressKeyInBackdrop;
     private setupElements;
-    private useOverlays;
+    private getAllVisibleCustomBackdrops;
+    /**
+     * Enables or disables the interactivity of an element.
+     * @param element the element to have its interactivity changed.
+     * @param interactive false to disable interactivity, true to enable.
+     */
     private setInteractivity;
     private setMainContentInteractivity;
     private showOverlay;
     private hideOverlay;
+    /**
+     * Shows the backdrop. The element passed as parameter must be a child of backdrop. Some accessibility features will be attached to
+     * the element.
+     *
+     * Consider using the component <Backdrop> from this library instead of calling this function directly.
+     * @param element the element to show inside the backdrop. It must already be a child of the backdrop.
+     */
+    showBackdrop(element?: HTMLElement | null): void;
+    /**
+     * Closes the backdrop. The element passed as parameter must be a child of backdrop. Some accessibility features will be run on the
+     * element.
+     *
+     * Consider using the component <Backdrop> from this library instead of calling this function directly.
+     * @param element the element showing inside the backdrop. It must be a child of the backdrop.
+     */
+    closeBackdrop(element?: HTMLElement | null): void;
+    /**
+     * @returns true if the modal is currently opened. False otherwise.
+     */
     isModalOpen(): boolean;
+    /**
+     * @returns the number of modals currently tracked.
+     */
+    getNumberOfOpenModals(): number;
+    /**
+     * @returns the number of right panels currently tracked.
+     */
+    getNumberOfOpenRightPanels(): number;
+    /**
+     * @returns true if the right panel is currently opened. False otherwise.
+     */
     isRightPanelOpen(): boolean;
+    /**
+     * @returns true if the bottom dialog is currently opened. False otherwise.
+     */
     isBottomDialogOpen(): boolean;
-    showCustomModal(content: React.ReactElement, { size, onClose }?: CustomModalOptions): void;
-    showModal({ size, ...props }: OverlayContentProps & {
+    /**
+     * Opens a modal with custom content.
+     *
+     * Attention: the modal state must be declared within the modal. If the state is declared outside the modal, its content won't be updated
+     * accordingly. To force an update of an outside state, you need to call `showCustomModal` again with the new state value.
+     *
+     * @param content a react element with the modal content.
+     * @param options the modal options {@link CustomModalOptions}.
+     */
+    showCustomModal(content: React.ReactElement, { size, onClose, ignoreFirstFocusOnCloseButton, stack, id }?: CustomModalOptions): void;
+    /**
+     * Opens a modal.
+     *
+     * Attention: the modal state must be declared within the modal. If the state is declared outside the modal, its content won't be updated
+     * accordingly. To force an update of an outside state, you need to call `showModal` again with the new state value.
+     *
+     * @param options the modal options: {@link OverlayContentProps} & { size: {@link ModalSize} }.
+     */
+    showModal({ size, ignoreFirstFocusOnCloseButton, stack, onGoBack, id, ...props }: OverlayContentProps & {
         size?: ModalSize;
-    }): void;
+    } & Pick<CustomModalOptions, 'ignoreFirstFocusOnCloseButton' | 'stack' | 'id'>): void;
     private showDialog;
-    confirm({ confirm, cancel, ...options }: DialogOptions): Promise<boolean>;
+    /**
+     * Shows a confirmation dialog and returns a promise that resolves as soon as the dialog is closed. The result of the promise is true if
+     * the user confirms and false otherwise.
+     *
+     * If you need the user to type something to confirm the action, use the property `validate` in the options parameter.
+     * @param options the dialog options and its size: {@link DialogOptions}.
+     * @returns a promise that resolves with the user's answer.
+     */
+    confirm({ confirm, cancel, size, ...options }: DialogOptions & {
+        size?: CustomModalSize;
+    }): Promise<boolean>;
+    /**
+     * Shows an alert dialog and returns a promise that resolves as soon as the dialog is closed.
+     *
+     * @param options the dialog options: {@link AlertOptions}.
+     * @returns a promise that resolves to undefined as soon as the dialog is closed.
+     */
     alert({ confirm, showButton, ...options }: AlertOptions): Promise<void>;
-    showBottomDialog({ message, cancel, confirm }: BottomDialogOptions): Promise<boolean>;
-    showCustomRightPanel(content: ReactElement, { size, onClose }?: CustomRightPanelOptions): void;
-    showRightPanel({ size, ...props }: OverlayContentProps & {
-        size?: OverlaySize;
-    }): void;
     /**
-     * Focus the element that had focus before the last overlay was opened. If the element is not visible anymore, another one that makes
-     * sense (accessibility-wise) is focused.
+     * Shows a message at the bottom of the window and asks the user to confirm or decline it. The return value is a promise that resolves as
+     * soon as the user presses one of the buttons. The result of the promise is true if the user confirms and false otherwise.
+     *
+     * Differently than `confirm` and `alert`, this message can only be closed if the user clicks one of the buttons or `closeBottomDialog`
+     * is called.
+     *
+     * @param options the dialog options: {@link BottomDialogOptions}.
+     * @returns a promise that resolves with the user's answer.
+     */
+    showBottomDialog({ children, cancel, confirm }: BottomDialogOptions): Promise<boolean>;
+    /**
+     * Opens a right panel with custom content.
+     *
+     * Attention: the right panel state must be declared within the right panel. If the state is declared outside the right panel, its content
+     * won't be updated accordingly. To force an update of an outside state, you need to call `showCustomRightPanel` again with the new state
+     * value.
+     *
+     * @param content a react element with the modal content.
+     * @param options the modal options {@link CustomModalOptions}.
      */
+    showCustomRightPanel(content: ReactElement, { size, onClose, ignoreFirstFocusOnCloseButton, stack, id }?: CustomRightPanelOptions): void;
+    /**
+     * Opens a right panel.
+     *
+     * Attention: the right panel state must be declared within the right panel. If the state is declared outside the right panel, its content
+     * won't be updated accordingly. To force an update of an outside state, you need to call `showRightPanel` again with the new state value.
+     *
+     * @param options the modal options: {@link OverlayContentProps} & { size: {@link ModalSize} }.
+     */
+    showRightPanel({ size, ignoreFirstFocusOnCloseButton, stack, onGoBack, id, ...props }: OverlayContentProps & Pick<CustomRightPanelOptions, 'size' | 'ignoreFirstFocusOnCloseButton' | 'stack' | 'id'>): void;
     private focusLastActiveElement;
+    /**
+     * Closes all opened modals.
+     * @param runCloseListener whether or not to run the function `onClose` passed to `showModal` or `showCustomModal`. Defaults to true.
+     */
     closeModal(runCloseListener?: boolean): void;
+    /**
+     * Closes the top-most modal in the stack. Will behave like `closeModal` if only a single modal exists in the stack.
+     * @param amount number of modals to pop. Defaults to 1.
+     * @param runCloseListener whether or not to run the function `onClose` passed to `showModal` or `showCustomModal`. Defaults to true.
+     */
+    popModal(amount?: number, runCloseListener?: boolean): void;
+    /**
+     * Close all modals in the stack of modal until the modal with the given id is found. If no modal with the given id is found, nothing
+     * happens.
+     * @param id the id of the modal to pop to.
+     * @param inclusive when true, the modal with the given id is also popped. Defaults to false.
+     */
+    popModalTo(id: string, inclusive?: boolean): void;
+    /**
+     * Closes all opened right panels.
+     * @param runCloseListener whether or not to run the function `onClose` passed to `showRightPanel` or `showCustomRightPanel`. Defaults to
+     * true.
+     */
     closeRightPanel(runCloseListener?: boolean): void;
+    /**
+     * Closes the top-most modal in the stack. Will behave like `closeModal` if only a single modal exists in the stack.
+     * @param runCloseListener whether or not to run the function `onClose` passed to `showModal` or `showCustomModal`. Defaults to true.
+     */
+    popRightPanel(amount?: number, runCloseListener?: boolean): void;
+    /**
+     * Close all right panels in the stack of panels until the panel with the given id is found. If no panel with the given id is found,
+     * nothing happens.
+     * @param id the id of the right panel to pop to.
+     * @param inclusive when true, the right panel with the given id is also popped. Defaults to false.
+     */
+    popRightPanelTo(id: string, inclusive?: boolean): void;
+    /**
+     * Closes the bottom dialog if it's open.
+     */
     closeBottomDialog(): void;
+    /**
+     * Verifies if the HTML element passed as parameter is inside the modal.
+     * @param element the HTML element to check.
+     * @returns true if `element` is inside the modal; false otherwise.
+     */
     isInsideModal(element: HTMLElement): boolean;
+    /**
+     * Verifies if the HTML element passed as parameter is inside the right panel.
+     * @param element the HTML element to check.
+     * @returns true if `element` is inside the right panel; false otherwise.
+     */
     isInsideRightPanel(element: HTMLElement): boolean;
-    showToaster: typeof showReactToaster;
+    /**
+     * Shows a new toaster on the top right corner of the layout.
+     * @example
+     * ```
+     * overlay.showToaster({ title: 'Welcome', message: 'Hello World' })
+     * overlay.showToaster({
+     *   title: 'Welcome',
+     *   message: 'Hello World',
+     *   actions: [
+     *     { label: 'Got it!' },
+     *     {
+     *       label: 'Tell me more',
+     *       closeOnClick: false,
+     *       onClick: (event) => {
+     *         // do something...
+     *       },
+     *     },
+     *   ]
+     * })
+     * ```
+     * @param options the options for the toaster: {@link DefaultToasterOptions}.
+     * @returns the toaster's id.
+     */
+    showToaster(defaultToasterConfig: DefaultToasterOptions): number | string;
+    /**
+     * Shows a fully customized toaster on the top right corner of the layout.
+     * @example
+     * ```
+     * overlay.showToaster({
+     *   custom: true,
+     *   message: <MyCustomToasterContent />,
+     *   closeButton: <MyCustomCloseButton />,
+     * })
+     * ```
+     * @param options the options for the toaster: {@link CustomToasterOptions}.
+     * @returns the toaster's id.
+     */
+    showToaster(customToasterConfig: CustomToasterOptions): number | string;
+    /**
+     * Shows the message passed as parameter in a new toaster on the top right corner of the layout.
+     * @example
+     * ```
+     * overlay.showToaster('Hello World!')
+     * overlay.showToaster(<p>Hello World</p>)
+     * ```
+     * @param message the message to show, can be either a string or React Element.
+     * @returns the toaster's id.
+     */
+    showToaster(message: React.ReactNode): number | string;
+    /**
+     * Closes the toaster with the specified id.
+     * @param id the id of the toaster to close.
+     */
+    closeToaster: typeof closeReactToaster;
 }
+/**
+ * Manages overlay components of the layout like: modal, rightPanel, bottomDialog and toaster.
+ */
 export declare const overlay: LayoutOverlayManager;
 export {};
 //# sourceMappingURL=LayoutOverlayManager.d.ts.map

package/dist/LayoutOverlayManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LayoutOverlayManager.d.ts","sourceRoot":"","sources":["../src/LayoutOverlayManager.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAA6B,MAAM,OAAO,CAAA;AAC/D,OAAO,EAAU,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAC3D,OAAO,EAAoC,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AAInG,OAAO,EAAE,WAAW,IAAI,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAG3D,UAAU,YAAa,SAAQ,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC;IAC1D,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,KAAK,mBAAmB,GAAG,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;AACvD,KAAK,WAAW,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;AAC/C,KAAK,SAAS,GAAG,aAAa,GAAG,WAAW,CAAA;AAS5C,UAAU,kBAAkB;IAC1B,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB;AAED,UAAU,uBAAuB;IAC/B,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB;AAWD,cAAM,oBAAoB;IACxB,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,oBAAoB,CAAA;IAC/C,OAAO,CAAC,UAAU,CAA2B;IAC7C,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC,OAAO,CAAC,YAAY,CAAC,CAAY;IACjC;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAuB;IAEhD,OAAO,CAAC,aAAa;IAqBrB,OAAO,CAAC,WAAW;IAanB,OAAO,CAAC,gBAAgB;IAUxB,OAAO,CAAC,2BAA2B;IAOnC,OAAO,CAAC,WAAW;IAWnB,OAAO,CAAC,WAAW;IAMnB,WAAW;IAIX,gBAAgB;IAIhB,kBAAkB;IAIlB,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC,YAAY,EAAE,EAAE,IAAe,EAAE,OAAO,EAAE,GAAE,kBAAuB;IAQlG,SAAS,CAAC,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,mBAAmB,GAAG;QAAE,IAAI,CAAC,EAAE,SAAS,CAAA;KAAE;IAIxE,OAAO,CAAC,UAAU;IAqBlB,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAKnE,KAAK,CAAC,EAAE,OAAO,EAAE,UAAiB,EAAE,GAAG,OAAO,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAKpF,gBAAgB,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBrF,oBAAoB,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,IAAe,EAAE,OAAO,EAAE,GAAE,uBAA4B;IAWtG,cAAc,CAAC,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,mBAAmB,GAAG;QAAE,IAAI,CAAC,EAAE,WAAW,CAAA;KAAE;IAO/E;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAK9B,UAAU,CAAC,gBAAgB,UAAO;IAyBlC,eAAe,CAAC,gBAAgB,UAAO;IAyBvC,iBAAiB;IAIjB,aAAa,CAAC,OAAO,EAAE,WAAW;IAIlC,kBAAkB,CAAC,OAAO,EAAE,WAAW;IAIvC,WAAW,0BAAmB;CAC/B;AAED,eAAO,MAAM,OAAO,sBAA6B,CAAA"}
+{"version":3,"file":"LayoutOverlayManager.d.ts","sourceRoot":"","sources":["../src/LayoutOverlayManager.tsx"],"names":[],"mappings":"AAMA,OAAO,EAAE,YAAY,EAA6B,MAAM,OAAO,CAAA;AAC/D,OAAO,EAAU,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAC3D,OAAO,EAAoC,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AAInG,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,iBAAiB,EAAmC,MAAM,WAAW,CAAA;AAC3H,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAGpE,UAAU,YAAa,SAAQ,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC;IAC1D;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAUD,KAAK,mBAAmB,GAAG,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;AASvD,UAAU,kBAAkB;IAC1B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB;;;OAGG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,UAAU,uBAAuB;IAC/B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB;;;OAGG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAWD,cAAM,oBAAoB;IACxB,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,oBAAoB,CAAA;IAC/C,OAAO,CAAC,UAAU,CAA2B;IAC7C,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAuB;IAChD,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,MAAM,CAAqB;IAEnC,OAAO,CAAC,oBAAoB;IAM5B,OAAO,CAAC,eAAe;IAiBvB,OAAO,CAAC,oBAAoB;IAY5B,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,4BAA4B;IA4BpC;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAUxB,OAAO,CAAC,2BAA2B;IAOnC,OAAO,CAAC,WAAW;IAmBnB,OAAO,CAAC,WAAW;IAMnB;;;;;;OAMG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,IAAI;IAIzC;;;;;;OAMG;IACH,aAAa,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,IAAI;IAM1C;;OAEG;IACH,WAAW;IAIX;;OAEG;IACH,qBAAqB;IAIrB;;OAEG;IACH,0BAA0B;IAI1B;;OAEG;IACH,gBAAgB;IAIhB;;OAEG;IACH,kBAAkB;IAIlB;;;;;;;;OAQG;IACH,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC,YAAY,EACzC,EAAE,IAAe,EAAE,OAAO,EAAE,6BAAoC,EAAE,KAAa,EAAE,EAAE,EAAE,GAAE,kBAAuB;IAYhH;;;;;;;OAOG;IACH,SAAS,CAAC,EACR,IAAI,EAAE,6BAA6B,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,KAAK,EACnE,EAAE,mBAAmB,GAAG;QAAE,IAAI,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,IAAI,CAAC,kBAAkB,EAAE,+BAA+B,GAAG,OAAO,GAAG,IAAI,CAAC;IAQ1H,OAAO,CAAC,UAAU;IAoClB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,aAAa,GAAG;QAAE,IAAI,CAAC,EAAE,eAAe,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAa5G;;;;;OAKG;IACG,KAAK,CAAC,EAAE,OAAO,EAAE,UAAiB,EAAE,GAAG,OAAO,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAWpF;;;;;;;;;OASG;IACH,gBAAgB,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBtF;;;;;;;;;OASG;IACH,oBAAoB,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,IAAe,EAAE,OAAO,EAAE,6BAAoC,EAAE,KAAa,EAAE,EAAE,EAAE,GAC/H,uBAA4B;IAa9B;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,IAAI,EAAE,6BAA6B,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,KAAK,EAAE,EACnF,mBAAmB,GAAG,IAAI,CAAC,uBAAuB,EAAE,MAAM,GAAG,+BAA+B,GAAG,OAAO,GAAG,IAAI,CAAC;IAYhH,OAAO,CAAC,sBAAsB;IAK9B;;;OAGG;IACH,UAAU,CAAC,gBAAgB,UAAO;IA4BlC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,SAAI,EAAE,gBAAgB,UAAO;IAa5C;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,UAAQ;IAKxC;;;;OAIG;IACH,eAAe,CAAC,gBAAgB,UAAO;IA4BvC;;;OAGG;IACH,aAAa,CAAC,MAAM,SAAI,EAAE,gBAAgB,UAAO;IAajD;;;;;OAKG;IACH,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,UAAQ;IAK7C;;OAEG;IACH,iBAAiB;IAIjB;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,WAAW;IAIlC;;;;OAIG;IACH,kBAAkB,CAAC,OAAO,EAAE,WAAW;IAIvC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,WAAW,CAAC,oBAAoB,EAAE,qBAAqB,GAAG,MAAM,GAAG,MAAM;IACzE;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,mBAAmB,EAAE,oBAAoB,GAAG,MAAM,GAAG,MAAM;IACvE;;;;;;;;;OASG;IACH,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,SAAS,GAAG,MAAM,GAAG,MAAM;IAKtD;;;OAGG;IACH,YAAY,2BAAoB;CACjC;AAED;;GAEG;AACH,eAAO,MAAM,OAAO,sBAA6B,CAAA"}