@itwin/map-layers 4.0.0-dev.41 → 4.0.0-dev.47

package/lib/cjs/ui/widget/AttachLayerPopupButton.js

@@ -1,336 +1,336 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AttachLayerPopupButton = exports.AttachLayerButtonType = void 0;
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-const React = require("react");
-const core_frontend_1 = require("@itwin/core-frontend");
-const appui_abstract_1 = require("@itwin/appui-abstract");
-const UiCore = require("@itwin/core-react");
-const appui_react_1 = require("@itwin/appui-react");
-const MapLayerManager_1 = require("./MapLayerManager");
-const MapUrlDialog_1 = require("./MapUrlDialog");
-const ConfirmMessageDialog_1 = require("./ConfirmMessageDialog");
-const itwinui_react_1 = require("@itwin/itwinui-react");
-const MapLayerPreferences_1 = require("../../MapLayerPreferences");
-const mapLayers_1 = require("../../mapLayers");
-// cSpell:ignore droppable Sublayer
-var LayerAction;
-(function (LayerAction) {
-    LayerAction[LayerAction["Attached"] = 0] = "Attached";
-    LayerAction[LayerAction["Edited"] = 1] = "Edited";
-})(LayerAction || (LayerAction = {}));
-// eslint-disable-next-line @typescript-eslint/naming-convention
-function AttachLayerPanel({ isOverlay, onLayerAttached, onHandleOutsideClick }) {
-    const [layerNameToAdd, setLayerNameToAdd] = React.useState();
-    const [sourceFilterString, setSourceFilterString] = React.useState();
-    const { placeholderLabel, addCustomLayerLabel, addCustomLayerToolTip, loadingMapSources, removeLayerDefButtonTitle, editLayerDefButtonTitle, removeLayerDefDialogTitle } = React.useMemo(() => {
-        return {
-            placeholderLabel: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.SearchPlaceholder"),
-            addCustomLayerLabel: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.Custom"),
-            addCustomLayerToolTip: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.AttachCustomLayer"),
-            loadingMapSources: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.LoadingMapSources"),
-            removeLayerDefButtonTitle: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefButtonTitle"),
-            editLayerDefButtonTitle: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.EditLayerDefButtonTitle"),
-            removeLayerDefDialogTitle: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefDialogTitle"),
-        };
-    }, []);
-    const [loading, setLoading] = React.useState(false);
-    const [layerNameUnderCursor, setLayerNameUnderCursor] = React.useState();
-    const resumeOutsideClick = React.useCallback(() => {
-        if (onHandleOutsideClick) {
-            onHandleOutsideClick(true);
-        }
-    }, [onHandleOutsideClick]);
-    // 'isMounted' is used to prevent any async operation once the hook has been
-    // unloaded.  Otherwise we get a 'Can't perform a React state update on an unmounted component.' warning in the console.
-    const isMounted = React.useRef(false);
-    React.useEffect(() => {
-        isMounted.current = true;
-        return () => {
-            isMounted.current = false;
-            // We close any open dialogs that we might have opened
-            // This was added because the modal dialog remained remained displayed after the session expired.
-            appui_react_1.UiFramework.dialogs.modal.close();
-        };
-    }, []);
-    const handleFilterTextChanged = React.useCallback((event) => {
-        setSourceFilterString(event.target.value);
-    }, []);
-    const { loadingSources, sources, activeViewport, backgroundLayers, overlayLayers, mapLayerOptions } = (0, MapLayerManager_1.useSourceMapContext)();
-    const mapTypesOptions = mapLayerOptions?.mapTypeOptions;
-    const iTwinId = activeViewport?.iModel?.iTwinId;
-    const iModelId = activeViewport?.iModel?.iModelId;
-    const styleContainsLayer = React.useCallback((name) => {
-        if (backgroundLayers) {
-            if (-1 !== backgroundLayers.findIndex((layer) => layer.name === name))
-                return true;
-        }
-        if (overlayLayers) {
-            if (-1 !== overlayLayers.findIndex((layer) => layer.name === name))
-                return true;
-        }
-        return false;
-    }, [backgroundLayers, overlayLayers]);
-    const handleModalUrlDialogOk = React.useCallback((action) => {
-        if (LayerAction.Attached === action) {
-            // close popup and refresh UI
-            onLayerAttached();
-        }
-        resumeOutsideClick();
-    }, [onLayerAttached, resumeOutsideClick]);
-    const handleModalUrlDialogCancel = React.useCallback(() => {
-        // close popup and refresh UI
-        setLoading(false);
-        appui_react_1.UiFramework.dialogs.modal.close();
-        resumeOutsideClick();
-    }, [resumeOutsideClick]);
-    React.useEffect(() => {
-        async function attemptToAddLayer(layerName) {
-            if (layerName && activeViewport) {
-                // if the layer is not in the style add it now.
-                if (undefined === backgroundLayers?.find((layer) => layerName === layer.name) && undefined === overlayLayers?.find((layer) => layerName === layer.name)) {
-                    const mapLayerSettings = sources?.find((source) => source.name === layerName);
-                    if (mapLayerSettings === undefined) {
-                        return;
-                    }
-                    try {
-                        if (isMounted.current) {
-                            setLoading(true);
-                        }
-                        const { status, subLayers } = await mapLayerSettings.validateSource();
-                        if (status === core_frontend_1.MapLayerSourceStatus.Valid || status === core_frontend_1.MapLayerSourceStatus.RequireAuth) {
-                            if (status === core_frontend_1.MapLayerSourceStatus.Valid) {
-                                const settings = mapLayerSettings.toLayerSettings(subLayers);
-                                if (settings) {
-                                    activeViewport.displayStyle.attachMapLayer({ settings, isOverlay });
-                                    activeViewport.invalidateRenderPlan();
-                                    const msg = core_frontend_1.IModelApp.localization.getLocalizedString("mapLayers:Messages.MapLayerAttached", { sourceName: settings.name, sourceUrl: settings.url });
-                                    core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, msg));
-                                }
-                                if (isMounted.current) {
-                                    setLoading(false);
-                                }
-                                if (onLayerAttached) {
-                                    onLayerAttached();
-                                }
-                            }
-                            else if (status === core_frontend_1.MapLayerSourceStatus.RequireAuth && isMounted.current) {
-                                appui_react_1.UiFramework.dialogs.modal.open(React.createElement(MapUrlDialog_1.MapUrlDialog, { activeViewport: activeViewport, isOverlay: isOverlay, layerRequiringCredentials: mapLayerSettings.toJSON(), onOkResult: () => handleModalUrlDialogOk(LayerAction.Attached), onCancelResult: handleModalUrlDialogCancel, mapTypesOptions: mapTypesOptions }));
-                                if (onHandleOutsideClick) {
-                                    onHandleOutsideClick(false);
-                                }
-                            }
-                        }
-                        else {
-                            const msg = core_frontend_1.IModelApp.localization.getLocalizedString("mapLayers:Messages.MapLayerValidationFailed", { sourceUrl: mapLayerSettings.url });
-                            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Error, msg));
-                            if (isMounted.current) {
-                                setLoading(false);
-                            }
-                        }
-                    }
-                    catch (err) {
-                        if (isMounted.current) {
-                            setLoading(false);
-                        }
-                        const msg = core_frontend_1.IModelApp.localization.getLocalizedString("mapLayers:Messages.MapLayerAttachError", { error: err, sourceUrl: mapLayerSettings.url });
-                        core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Error, msg));
-                    }
-                }
-            }
-            return;
-        }
-        if (layerNameToAdd) {
-            attemptToAddLayer(layerNameToAdd); // eslint-disable-line @typescript-eslint/no-floating-promises
-            if (isMounted.current) {
-                setLayerNameToAdd(undefined);
-            }
-        }
-    }, [setLayerNameToAdd, layerNameToAdd, activeViewport, sources, backgroundLayers, isOverlay, overlayLayers, onLayerAttached, handleModalUrlDialogOk, mapTypesOptions, handleModalUrlDialogCancel, onHandleOutsideClick]);
-    const options = React.useMemo(() => sources?.filter((source) => !styleContainsLayer(source.name)), [sources, styleContainsLayer]);
-    const filteredOptions = React.useMemo(() => {
-        if (undefined === sourceFilterString || 0 === sourceFilterString.length) {
-            return options;
-        }
-        else {
-            return options?.filter((option) => option.name.toLowerCase().includes(sourceFilterString?.toLowerCase()));
-        }
-    }, [options, sourceFilterString]);
-    const handleAddNewMapSource = React.useCallback(() => {
-        appui_react_1.UiFramework.dialogs.modal.open(React.createElement(MapUrlDialog_1.MapUrlDialog, { activeViewport: activeViewport, isOverlay: isOverlay, onOkResult: () => handleModalUrlDialogOk(LayerAction.Attached), onCancelResult: handleModalUrlDialogCancel, mapTypesOptions: mapTypesOptions }));
-        if (onHandleOutsideClick) {
-            onHandleOutsideClick(false);
-        }
-        return;
-    }, [activeViewport, handleModalUrlDialogCancel, handleModalUrlDialogOk, isOverlay, mapTypesOptions, onHandleOutsideClick]);
-    const handleAttach = React.useCallback((mapName) => {
-        setLayerNameToAdd(mapName);
-    }, []);
-    const handleKeypressOnSourceList = React.useCallback((event) => {
-        const key = event.key;
-        if (key === "Enter") {
-            event.preventDefault();
-            const mapName = event.currentTarget?.dataset?.value;
-            if (mapName && mapName.length) {
-                handleAttach(mapName);
-            }
-        }
-    }, [handleAttach]);
-    const onListboxValueChange = React.useCallback((mapName) => {
-        setLayerNameToAdd(mapName);
-    }, []);
-    const handleNoConfirmation = React.useCallback((_layerName) => {
-        appui_react_1.UiFramework.dialogs.modal.close();
-        resumeOutsideClick();
-    }, [resumeOutsideClick]);
-    const handleYesConfirmation = React.useCallback(async (source) => {
-        const layerName = source.name;
-        if (!!iTwinId) {
-            try {
-                await MapLayerPreferences_1.MapLayerPreferences.deleteByName(source, iTwinId, iModelId);
-                const msg = mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefSuccess", { layerName });
-                core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, msg));
-            }
-            catch (err) {
-                const msg = mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefError", { layerName });
-                core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Error, msg));
-            }
-        }
-        appui_react_1.UiFramework.dialogs.modal.close();
-        resumeOutsideClick();
-    }, [iTwinId, iModelId, resumeOutsideClick]);
-    /*
-     Handle Remove layer button clicked
-     */
-    const onItemRemoveButtonClicked = React.useCallback((source, event) => {
-        event.stopPropagation(); // We don't want the owning ListBox to react on mouse click.
-        const layerName = source.name;
-        const msg = mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefDialogMessage", { layerName });
-        appui_react_1.UiFramework.dialogs.modal.open(React.createElement(ConfirmMessageDialog_1.ConfirmMessageDialog, { className: "map-sources-delete-confirmation", title: removeLayerDefDialogTitle, message: msg, maxWidth: 400, onClose: () => handleNoConfirmation(layerName), onEscape: () => handleNoConfirmation(layerName), onYesResult: async () => handleYesConfirmation(source), onNoResult: () => handleNoConfirmation(layerName) }));
-        if (onHandleOutsideClick) {
-            onHandleOutsideClick(false);
-        }
-    }, [handleNoConfirmation, handleYesConfirmation, onHandleOutsideClick, removeLayerDefDialogTitle]);
-    /*
-   Handle Edit layer button clicked
-   */
-    const onItemEditButtonClicked = React.useCallback((event) => {
-        event.stopPropagation(); // We don't want the owning ListBox to react on mouse click.
-        const targetLayerName = event?.currentTarget?.parentNode?.dataset?.value;
-        const matchingSource = sources.find((layerSource) => layerSource.name === targetLayerName);
-        // we expect a single layer source matching this name
-        if (matchingSource === undefined) {
-            return;
-        }
-        appui_react_1.UiFramework.dialogs.modal.open(React.createElement(MapUrlDialog_1.MapUrlDialog, { activeViewport: activeViewport, isOverlay: isOverlay, mapLayerSourceToEdit: matchingSource, onOkResult: () => handleModalUrlDialogOk(LayerAction.Edited), onCancelResult: handleModalUrlDialogCancel, mapTypesOptions: mapTypesOptions }));
-        if (onHandleOutsideClick) {
-            onHandleOutsideClick(false);
-        }
-    }, [activeViewport, handleModalUrlDialogCancel, handleModalUrlDialogOk, isOverlay, mapTypesOptions, onHandleOutsideClick, sources]);
-    return (React.createElement("div", { className: "map-manager-header" },
-        (loading || loadingSources) && React.createElement(UiCore.LoadingSpinner, { message: loadingMapSources }),
-        React.createElement("div", { className: "map-manager-source-listbox-header" },
-            React.createElement(itwinui_react_1.Input, { type: "text", className: "map-manager-source-list-filter", placeholder: placeholderLabel, value: sourceFilterString, onChange: handleFilterTextChanged, size: "small" }),
-            React.createElement(itwinui_react_1.Button, { className: "map-manager-add-source-button", title: addCustomLayerToolTip, onClick: handleAddNewMapSource }, addCustomLayerLabel)),
-        React.createElement("div", { className: "map-manager-sources" },
-            React.createElement(UiCore.Listbox, { id: "map-sources", selectedValue: layerNameToAdd, className: "map-manager-source-list", onKeyPress: handleKeypressOnSourceList, onListboxValueChange: onListboxValueChange }, filteredOptions?.map((source) => React.createElement(UiCore.ListboxItem, { key: source.name, className: "map-source-list-entry", value: source.name, onMouseEnter: () => setLayerNameUnderCursor(source.name), onMouseLeave: () => setLayerNameUnderCursor(undefined) },
-                React.createElement("span", { className: "map-source-list-entry-name", title: source.name }, source.name),
-                // otherwise list feels cluttered.
-                (!!iTwinId && layerNameUnderCursor && layerNameUnderCursor === source.name) &&
-                    React.createElement(React.Fragment, null,
-                        React.createElement(itwinui_react_1.Button, { size: "small", styleType: "borderless", className: "map-source-list-entry-button", title: editLayerDefButtonTitle, onClick: onItemEditButtonClicked },
-                            React.createElement(UiCore.Icon, { iconSpec: "icon-edit" })),
-                        React.createElement(itwinui_react_1.Button, { size: "small", styleType: "borderless", className: "map-source-list-entry-button", title: removeLayerDefButtonTitle, onClick: (event) => { onItemRemoveButtonClicked(source, event); } },
-                            React.createElement(UiCore.Icon, { iconSpec: "icon-delete" })))))))));
-}
-/** @internal */
-var AttachLayerButtonType;
-(function (AttachLayerButtonType) {
-    AttachLayerButtonType[AttachLayerButtonType["Primary"] = 0] = "Primary";
-    AttachLayerButtonType[AttachLayerButtonType["Blue"] = 1] = "Blue";
-    AttachLayerButtonType[AttachLayerButtonType["Icon"] = 2] = "Icon";
-})(AttachLayerButtonType = exports.AttachLayerButtonType || (exports.AttachLayerButtonType = {}));
-/** @internal */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-function AttachLayerPopupButton(props) {
-    const { showAttachLayerLabel, hideAttachLayerLabel, addCustomLayerButtonLabel } = React.useMemo(() => {
-        return {
-            showAttachLayerLabel: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:AttachLayerPopup.Attach"),
-            hideAttachLayerLabel: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:AttachLayerPopup.Close"),
-            addCustomLayerButtonLabel: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.AddCustomLayerButtonLabel"),
-        };
-    }, []);
-    const [handleOutsideClick, setHandleOutsideClick] = React.useState(true);
-    const [popupOpen, setPopupOpen] = React.useState(false);
-    const buttonRef = React.useRef(null);
-    const panelRef = React.useRef(null);
-    // 'isMounted' is used to prevent any async operation once the hook has been
-    // unloaded.  Otherwise we get a 'Can't perform a React state update on an unmounted component.' warning in the console.
-    const isMounted = React.useRef(false);
-    React.useEffect(() => {
-        isMounted.current = true;
-        return () => {
-            isMounted.current = false;
-        };
-    }, []);
-    const togglePopup = React.useCallback(() => {
-        setPopupOpen(!popupOpen);
-    }, [popupOpen]);
-    const handleClosePopup = React.useCallback(() => {
-        setPopupOpen(false);
-    }, []);
-    const onHandleOutsideClick = React.useCallback((event) => {
-        if (!handleOutsideClick) {
-            return;
-        }
-        // If clicking on button that open panel -  don't trigger outside click processing
-        if (buttonRef?.current && buttonRef?.current.contains(event.target)) {
-            return;
-        }
-        // If clicking the panel, this is not an outside clicked
-        if (panelRef.current && panelRef?.current.contains(event.target)) {
-            return;
-        }
-        // If we reach this point, we got an outside clicked, no close the popup
-        setPopupOpen(false);
-    }, [handleOutsideClick]);
-    const { refreshFromStyle } = (0, MapLayerManager_1.useSourceMapContext)();
-    const handleLayerAttached = React.useCallback(() => {
-        if (!isMounted.current) {
-            return;
-        }
-        setPopupOpen(false);
-        refreshFromStyle();
-    }, [refreshFromStyle]);
-    function renderButton() {
-        let button;
-        if (props.buttonType === undefined || props.buttonType === AttachLayerButtonType.Icon) {
-            button = (React.createElement(itwinui_react_1.Button, { disabled: props.disabled, size: "small", styleType: "borderless", ref: buttonRef, className: "map-manager-attach-layer-button", title: popupOpen ? hideAttachLayerLabel : showAttachLayerLabel, onClick: togglePopup },
-                React.createElement(UiCore.WebFontIcon, { iconName: "icon-add" })));
-        }
-        else {
-            const determineStyleType = () => {
-                switch (props.buttonType) {
-                    case AttachLayerButtonType.Blue:
-                        return "high-visibility";
-                    case AttachLayerButtonType.Primary:
-                    default:
-                        return "cta";
-                }
-            };
-            const styleType = determineStyleType();
-            button = (React.createElement(itwinui_react_1.Button, { disabled: props.disabled, ref: buttonRef, styleType: styleType, title: popupOpen ? hideAttachLayerLabel : showAttachLayerLabel, onClick: togglePopup }, addCustomLayerButtonLabel));
-        }
-        return button;
-    }
-    return (React.createElement(React.Fragment, null,
-        renderButton(),
-        React.createElement(UiCore.Popup, { isOpen: popupOpen, position: appui_abstract_1.RelativePosition.BottomRight, onClose: handleClosePopup, onOutsideClick: onHandleOutsideClick, target: buttonRef.current, closeOnEnter: false, closeOnContextMenu: false },
-            React.createElement("div", { ref: panelRef, className: "map-sources-popup-panel" },
-                React.createElement(AttachLayerPanel, { isOverlay: props.isOverlay, onLayerAttached: handleLayerAttached, onHandleOutsideClick: setHandleOutsideClick })))));
-}
-exports.AttachLayerPopupButton = AttachLayerPopupButton;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttachLayerPopupButton = exports.AttachLayerButtonType = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+const React = require("react");
+const core_frontend_1 = require("@itwin/core-frontend");
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const UiCore = require("@itwin/core-react");
+const appui_react_1 = require("@itwin/appui-react");
+const MapLayerManager_1 = require("./MapLayerManager");
+const MapUrlDialog_1 = require("./MapUrlDialog");
+const ConfirmMessageDialog_1 = require("./ConfirmMessageDialog");
+const itwinui_react_1 = require("@itwin/itwinui-react");
+const MapLayerPreferences_1 = require("../../MapLayerPreferences");
+const mapLayers_1 = require("../../mapLayers");
+// cSpell:ignore droppable Sublayer
+var LayerAction;
+(function (LayerAction) {
+    LayerAction[LayerAction["Attached"] = 0] = "Attached";
+    LayerAction[LayerAction["Edited"] = 1] = "Edited";
+})(LayerAction || (LayerAction = {}));
+// eslint-disable-next-line @typescript-eslint/naming-convention
+function AttachLayerPanel({ isOverlay, onLayerAttached, onHandleOutsideClick }) {
+    const [layerNameToAdd, setLayerNameToAdd] = React.useState();
+    const [sourceFilterString, setSourceFilterString] = React.useState();
+    const { placeholderLabel, addCustomLayerLabel, addCustomLayerToolTip, loadingMapSources, removeLayerDefButtonTitle, editLayerDefButtonTitle, removeLayerDefDialogTitle } = React.useMemo(() => {
+        return {
+            placeholderLabel: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.SearchPlaceholder"),
+            addCustomLayerLabel: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.Custom"),
+            addCustomLayerToolTip: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.AttachCustomLayer"),
+            loadingMapSources: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.LoadingMapSources"),
+            removeLayerDefButtonTitle: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefButtonTitle"),
+            editLayerDefButtonTitle: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.EditLayerDefButtonTitle"),
+            removeLayerDefDialogTitle: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefDialogTitle"),
+        };
+    }, []);
+    const [loading, setLoading] = React.useState(false);
+    const [layerNameUnderCursor, setLayerNameUnderCursor] = React.useState();
+    const resumeOutsideClick = React.useCallback(() => {
+        if (onHandleOutsideClick) {
+            onHandleOutsideClick(true);
+        }
+    }, [onHandleOutsideClick]);
+    // 'isMounted' is used to prevent any async operation once the hook has been
+    // unloaded.  Otherwise we get a 'Can't perform a React state update on an unmounted component.' warning in the console.
+    const isMounted = React.useRef(false);
+    React.useEffect(() => {
+        isMounted.current = true;
+        return () => {
+            isMounted.current = false;
+            // We close any open dialogs that we might have opened
+            // This was added because the modal dialog remained remained displayed after the session expired.
+            appui_react_1.UiFramework.dialogs.modal.close();
+        };
+    }, []);
+    const handleFilterTextChanged = React.useCallback((event) => {
+        setSourceFilterString(event.target.value);
+    }, []);
+    const { loadingSources, sources, activeViewport, backgroundLayers, overlayLayers, mapLayerOptions } = (0, MapLayerManager_1.useSourceMapContext)();
+    const mapTypesOptions = mapLayerOptions?.mapTypeOptions;
+    const iTwinId = activeViewport?.iModel?.iTwinId;
+    const iModelId = activeViewport?.iModel?.iModelId;
+    const styleContainsLayer = React.useCallback((name) => {
+        if (backgroundLayers) {
+            if (-1 !== backgroundLayers.findIndex((layer) => layer.name === name))
+                return true;
+        }
+        if (overlayLayers) {
+            if (-1 !== overlayLayers.findIndex((layer) => layer.name === name))
+                return true;
+        }
+        return false;
+    }, [backgroundLayers, overlayLayers]);
+    const handleModalUrlDialogOk = React.useCallback((action) => {
+        if (LayerAction.Attached === action) {
+            // close popup and refresh UI
+            onLayerAttached();
+        }
+        resumeOutsideClick();
+    }, [onLayerAttached, resumeOutsideClick]);
+    const handleModalUrlDialogCancel = React.useCallback(() => {
+        // close popup and refresh UI
+        setLoading(false);
+        appui_react_1.UiFramework.dialogs.modal.close();
+        resumeOutsideClick();
+    }, [resumeOutsideClick]);
+    React.useEffect(() => {
+        async function attemptToAddLayer(layerName) {
+            if (layerName && activeViewport) {
+                // if the layer is not in the style add it now.
+                if (undefined === backgroundLayers?.find((layer) => layerName === layer.name) && undefined === overlayLayers?.find((layer) => layerName === layer.name)) {
+                    const mapLayerSettings = sources?.find((source) => source.name === layerName);
+                    if (mapLayerSettings === undefined) {
+                        return;
+                    }
+                    try {
+                        if (isMounted.current) {
+                            setLoading(true);
+                        }
+                        const { status, subLayers } = await mapLayerSettings.validateSource();
+                        if (status === core_frontend_1.MapLayerSourceStatus.Valid || status === core_frontend_1.MapLayerSourceStatus.RequireAuth) {
+                            if (status === core_frontend_1.MapLayerSourceStatus.Valid) {
+                                const settings = mapLayerSettings.toLayerSettings(subLayers);
+                                if (settings) {
+                                    activeViewport.displayStyle.attachMapLayer({ settings, isOverlay });
+                                    activeViewport.invalidateRenderPlan();
+                                    const msg = core_frontend_1.IModelApp.localization.getLocalizedString("mapLayers:Messages.MapLayerAttached", { sourceName: settings.name, sourceUrl: settings.url });
+                                    core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, msg));
+                                }
+                                if (isMounted.current) {
+                                    setLoading(false);
+                                }
+                                if (onLayerAttached) {
+                                    onLayerAttached();
+                                }
+                            }
+                            else if (status === core_frontend_1.MapLayerSourceStatus.RequireAuth && isMounted.current) {
+                                appui_react_1.UiFramework.dialogs.modal.open(React.createElement(MapUrlDialog_1.MapUrlDialog, { activeViewport: activeViewport, isOverlay: isOverlay, layerRequiringCredentials: mapLayerSettings.toJSON(), onOkResult: () => handleModalUrlDialogOk(LayerAction.Attached), onCancelResult: handleModalUrlDialogCancel, mapTypesOptions: mapTypesOptions }));
+                                if (onHandleOutsideClick) {
+                                    onHandleOutsideClick(false);
+                                }
+                            }
+                        }
+                        else {
+                            const msg = core_frontend_1.IModelApp.localization.getLocalizedString("mapLayers:Messages.MapLayerValidationFailed", { sourceUrl: mapLayerSettings.url });
+                            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Error, msg));
+                            if (isMounted.current) {
+                                setLoading(false);
+                            }
+                        }
+                    }
+                    catch (err) {
+                        if (isMounted.current) {
+                            setLoading(false);
+                        }
+                        const msg = core_frontend_1.IModelApp.localization.getLocalizedString("mapLayers:Messages.MapLayerAttachError", { error: err, sourceUrl: mapLayerSettings.url });
+                        core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Error, msg));
+                    }
+                }
+            }
+            return;
+        }
+        if (layerNameToAdd) {
+            attemptToAddLayer(layerNameToAdd); // eslint-disable-line @typescript-eslint/no-floating-promises
+            if (isMounted.current) {
+                setLayerNameToAdd(undefined);
+            }
+        }
+    }, [setLayerNameToAdd, layerNameToAdd, activeViewport, sources, backgroundLayers, isOverlay, overlayLayers, onLayerAttached, handleModalUrlDialogOk, mapTypesOptions, handleModalUrlDialogCancel, onHandleOutsideClick]);
+    const options = React.useMemo(() => sources?.filter((source) => !styleContainsLayer(source.name)), [sources, styleContainsLayer]);
+    const filteredOptions = React.useMemo(() => {
+        if (undefined === sourceFilterString || 0 === sourceFilterString.length) {
+            return options;
+        }
+        else {
+            return options?.filter((option) => option.name.toLowerCase().includes(sourceFilterString?.toLowerCase()));
+        }
+    }, [options, sourceFilterString]);
+    const handleAddNewMapSource = React.useCallback(() => {
+        appui_react_1.UiFramework.dialogs.modal.open(React.createElement(MapUrlDialog_1.MapUrlDialog, { activeViewport: activeViewport, isOverlay: isOverlay, onOkResult: () => handleModalUrlDialogOk(LayerAction.Attached), onCancelResult: handleModalUrlDialogCancel, mapTypesOptions: mapTypesOptions }));
+        if (onHandleOutsideClick) {
+            onHandleOutsideClick(false);
+        }
+        return;
+    }, [activeViewport, handleModalUrlDialogCancel, handleModalUrlDialogOk, isOverlay, mapTypesOptions, onHandleOutsideClick]);
+    const handleAttach = React.useCallback((mapName) => {
+        setLayerNameToAdd(mapName);
+    }, []);
+    const handleKeypressOnSourceList = React.useCallback((event) => {
+        const key = event.key;
+        if (key === "Enter") {
+            event.preventDefault();
+            const mapName = event.currentTarget?.dataset?.value;
+            if (mapName && mapName.length) {
+                handleAttach(mapName);
+            }
+        }
+    }, [handleAttach]);
+    const onListboxValueChange = React.useCallback((mapName) => {
+        setLayerNameToAdd(mapName);
+    }, []);
+    const handleNoConfirmation = React.useCallback((_layerName) => {
+        appui_react_1.UiFramework.dialogs.modal.close();
+        resumeOutsideClick();
+    }, [resumeOutsideClick]);
+    const handleYesConfirmation = React.useCallback(async (source) => {
+        const layerName = source.name;
+        if (!!iTwinId) {
+            try {
+                await MapLayerPreferences_1.MapLayerPreferences.deleteByName(source, iTwinId, iModelId);
+                const msg = mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefSuccess", { layerName });
+                core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, msg));
+            }
+            catch (err) {
+                const msg = mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefError", { layerName });
+                core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Error, msg));
+            }
+        }
+        appui_react_1.UiFramework.dialogs.modal.close();
+        resumeOutsideClick();
+    }, [iTwinId, iModelId, resumeOutsideClick]);
+    /*
+     Handle Remove layer button clicked
+     */
+    const onItemRemoveButtonClicked = React.useCallback((source, event) => {
+        event.stopPropagation(); // We don't want the owning ListBox to react on mouse click.
+        const layerName = source.name;
+        const msg = mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefDialogMessage", { layerName });
+        appui_react_1.UiFramework.dialogs.modal.open(React.createElement(ConfirmMessageDialog_1.ConfirmMessageDialog, { className: "map-sources-delete-confirmation", title: removeLayerDefDialogTitle, message: msg, maxWidth: 400, onClose: () => handleNoConfirmation(layerName), onEscape: () => handleNoConfirmation(layerName), onYesResult: async () => handleYesConfirmation(source), onNoResult: () => handleNoConfirmation(layerName) }));
+        if (onHandleOutsideClick) {
+            onHandleOutsideClick(false);
+        }
+    }, [handleNoConfirmation, handleYesConfirmation, onHandleOutsideClick, removeLayerDefDialogTitle]);
+    /*
+   Handle Edit layer button clicked
+   */
+    const onItemEditButtonClicked = React.useCallback((event) => {
+        event.stopPropagation(); // We don't want the owning ListBox to react on mouse click.
+        const targetLayerName = event?.currentTarget?.parentNode?.dataset?.value;
+        const matchingSource = sources.find((layerSource) => layerSource.name === targetLayerName);
+        // we expect a single layer source matching this name
+        if (matchingSource === undefined) {
+            return;
+        }
+        appui_react_1.UiFramework.dialogs.modal.open(React.createElement(MapUrlDialog_1.MapUrlDialog, { activeViewport: activeViewport, isOverlay: isOverlay, mapLayerSourceToEdit: matchingSource, onOkResult: () => handleModalUrlDialogOk(LayerAction.Edited), onCancelResult: handleModalUrlDialogCancel, mapTypesOptions: mapTypesOptions }));
+        if (onHandleOutsideClick) {
+            onHandleOutsideClick(false);
+        }
+    }, [activeViewport, handleModalUrlDialogCancel, handleModalUrlDialogOk, isOverlay, mapTypesOptions, onHandleOutsideClick, sources]);
+    return (React.createElement("div", { className: "map-manager-header" },
+        (loading || loadingSources) && React.createElement(UiCore.LoadingSpinner, { message: loadingMapSources }),
+        React.createElement("div", { className: "map-manager-source-listbox-header" },
+            React.createElement(itwinui_react_1.Input, { type: "text", className: "map-manager-source-list-filter", placeholder: placeholderLabel, value: sourceFilterString, onChange: handleFilterTextChanged, size: "small" }),
+            React.createElement(itwinui_react_1.Button, { className: "map-manager-add-source-button", title: addCustomLayerToolTip, onClick: handleAddNewMapSource }, addCustomLayerLabel)),
+        React.createElement("div", { className: "map-manager-sources" },
+            React.createElement(UiCore.Listbox, { id: "map-sources", selectedValue: layerNameToAdd, className: "map-manager-source-list", onKeyPress: handleKeypressOnSourceList, onListboxValueChange: onListboxValueChange }, filteredOptions?.map((source) => React.createElement(UiCore.ListboxItem, { key: source.name, className: "map-source-list-entry", value: source.name, onMouseEnter: () => setLayerNameUnderCursor(source.name), onMouseLeave: () => setLayerNameUnderCursor(undefined) },
+                React.createElement("span", { className: "map-source-list-entry-name", title: source.name }, source.name),
+                // otherwise list feels cluttered.
+                (!!iTwinId && layerNameUnderCursor && layerNameUnderCursor === source.name) &&
+                    React.createElement(React.Fragment, null,
+                        React.createElement(itwinui_react_1.Button, { size: "small", styleType: "borderless", className: "map-source-list-entry-button", title: editLayerDefButtonTitle, onClick: onItemEditButtonClicked },
+                            React.createElement(UiCore.Icon, { iconSpec: "icon-edit" })),
+                        React.createElement(itwinui_react_1.Button, { size: "small", styleType: "borderless", className: "map-source-list-entry-button", title: removeLayerDefButtonTitle, onClick: (event) => { onItemRemoveButtonClicked(source, event); } },
+                            React.createElement(UiCore.Icon, { iconSpec: "icon-delete" })))))))));
+}
+/** @internal */
+var AttachLayerButtonType;
+(function (AttachLayerButtonType) {
+    AttachLayerButtonType[AttachLayerButtonType["Primary"] = 0] = "Primary";
+    AttachLayerButtonType[AttachLayerButtonType["Blue"] = 1] = "Blue";
+    AttachLayerButtonType[AttachLayerButtonType["Icon"] = 2] = "Icon";
+})(AttachLayerButtonType = exports.AttachLayerButtonType || (exports.AttachLayerButtonType = {}));
+/** @internal */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+function AttachLayerPopupButton(props) {
+    const { showAttachLayerLabel, hideAttachLayerLabel, addCustomLayerButtonLabel } = React.useMemo(() => {
+        return {
+            showAttachLayerLabel: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:AttachLayerPopup.Attach"),
+            hideAttachLayerLabel: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:AttachLayerPopup.Close"),
+            addCustomLayerButtonLabel: mapLayers_1.MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.AddCustomLayerButtonLabel"),
+        };
+    }, []);
+    const [handleOutsideClick, setHandleOutsideClick] = React.useState(true);
+    const [popupOpen, setPopupOpen] = React.useState(false);
+    const buttonRef = React.useRef(null);
+    const panelRef = React.useRef(null);
+    // 'isMounted' is used to prevent any async operation once the hook has been
+    // unloaded.  Otherwise we get a 'Can't perform a React state update on an unmounted component.' warning in the console.
+    const isMounted = React.useRef(false);
+    React.useEffect(() => {
+        isMounted.current = true;
+        return () => {
+            isMounted.current = false;
+        };
+    }, []);
+    const togglePopup = React.useCallback(() => {
+        setPopupOpen(!popupOpen);
+    }, [popupOpen]);
+    const handleClosePopup = React.useCallback(() => {
+        setPopupOpen(false);
+    }, []);
+    const onHandleOutsideClick = React.useCallback((event) => {
+        if (!handleOutsideClick) {
+            return;
+        }
+        // If clicking on button that open panel -  don't trigger outside click processing
+        if (buttonRef?.current && buttonRef?.current.contains(event.target)) {
+            return;
+        }
+        // If clicking the panel, this is not an outside clicked
+        if (panelRef.current && panelRef?.current.contains(event.target)) {
+            return;
+        }
+        // If we reach this point, we got an outside clicked, no close the popup
+        setPopupOpen(false);
+    }, [handleOutsideClick]);
+    const { refreshFromStyle } = (0, MapLayerManager_1.useSourceMapContext)();
+    const handleLayerAttached = React.useCallback(() => {
+        if (!isMounted.current) {
+            return;
+        }
+        setPopupOpen(false);
+        refreshFromStyle();
+    }, [refreshFromStyle]);
+    function renderButton() {
+        let button;
+        if (props.buttonType === undefined || props.buttonType === AttachLayerButtonType.Icon) {
+            button = (React.createElement(itwinui_react_1.Button, { disabled: props.disabled, size: "small", styleType: "borderless", ref: buttonRef, className: "map-manager-attach-layer-button", title: popupOpen ? hideAttachLayerLabel : showAttachLayerLabel, onClick: togglePopup },
+                React.createElement(UiCore.WebFontIcon, { iconName: "icon-add" })));
+        }
+        else {
+            const determineStyleType = () => {
+                switch (props.buttonType) {
+                    case AttachLayerButtonType.Blue:
+                        return "high-visibility";
+                    case AttachLayerButtonType.Primary:
+                    default:
+                        return "cta";
+                }
+            };
+            const styleType = determineStyleType();
+            button = (React.createElement(itwinui_react_1.Button, { disabled: props.disabled, ref: buttonRef, styleType: styleType, title: popupOpen ? hideAttachLayerLabel : showAttachLayerLabel, onClick: togglePopup }, addCustomLayerButtonLabel));
+        }
+        return button;
+    }
+    return (React.createElement(React.Fragment, null,
+        renderButton(),
+        React.createElement(UiCore.Popup, { isOpen: popupOpen, position: appui_abstract_1.RelativePosition.BottomRight, onClose: handleClosePopup, onOutsideClick: onHandleOutsideClick, target: buttonRef.current, closeOnEnter: false, closeOnContextMenu: false },
+            React.createElement("div", { ref: panelRef, className: "map-sources-popup-panel" },
+                React.createElement(AttachLayerPanel, { isOverlay: props.isOverlay, onLayerAttached: handleLayerAttached, onHandleOutsideClick: setHandleOutsideClick })))));
+}
+exports.AttachLayerPopupButton = AttachLayerPopupButton;
 //# sourceMappingURL=AttachLayerPopupButton.js.map