@itwin/core-react 4.17.6 → 5.0.0-dev.3

package/lib/esm/core-react/settings/SettingsContainer.d.ts

@@ -1,35 +0,0 @@
-/** @packageDocumentation
- * @module Settings
- */
-import "./SettingsContainer.scss";
-import * as React from "react";
-import type { SettingsManager, SettingsTabEntry } from "./SettingsManager";
-/** Hook to use within Settings Page component to allow saving the current page's data before the Setting Container is closed.
- * @public
- * @deprecated in 4.16.0. Use {@link SettingsManager} instead.
- */
-export declare function useSaveBeforeClosingSettingsContainer(settingsManager: SettingsManager, saveFunction: (closeFunc: (args: any) => void, closeFuncArgs?: any) => void): void;
-/** Hook to use within Settings Page component to allow saving the current page's data before loading to the requested Setting Tab's page.
- * @public
- * @deprecated in 4.16.0. Use {@link SettingsManager} instead.
- */
-export declare function useSaveBeforeActivatingNewSettingsTab(settingsManager: SettingsManager, saveFunction: (tabSelectionFunc: (args: any) => void, requestedSettingsTabId?: string) => void): void;
-/**
- * Properties of {@link SettingsContainer} component.
- * @public
- * @deprecated in 4.16.0. Props of deprecated component {@link SettingsContainer}.
- */
-export interface SettingsContainerProps {
-    tabs: SettingsTabEntry[];
-    currentSettingsTab?: SettingsTabEntry;
-    onSettingsTabSelected?: (tab: SettingsTabEntry) => void;
-    settingsManager: SettingsManager;
-    showHeader?: boolean;
-}
-/** Component that displays setting tabs on the left and the setting page on the right.
- * Note: that SettingsContainer is not rendered if tabs array is empty.
- * @public
- * @deprecated in 4.16.0. Used internally by {@link @itwin/appui-react#SettingsModalFrontstage}.
- */
-export declare const SettingsContainer: ({ tabs, onSettingsTabSelected, currentSettingsTab, settingsManager, showHeader, }: SettingsContainerProps) => React.JSX.Element;
-//# sourceMappingURL=SettingsContainer.d.ts.map

package/lib/esm/core-react/settings/SettingsContainer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SettingsContainer.d.ts","sourceRoot":"","sources":["../../../../src/core-react/settings/SettingsContainer.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,0BAA0B,CAAC;AAClC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAmB3E;;;GAGG;AACH,wBAAgB,qCAAqC,CACnD,eAAe,EAAE,eAAe,EAChC,YAAY,EAAE,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,EAAE,aAAa,CAAC,EAAE,GAAG,KAAK,IAAI,QAS5E;AAED;;;GAGG;AACH,wBAAgB,qCAAqC,CACnD,eAAe,EAAE,eAAe,EAChC,YAAY,EAAE,CACZ,gBAAgB,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,EACrC,sBAAsB,CAAC,EAAE,MAAM,KAC5B,IAAI,QASV;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAEzB,kBAAkB,CAAC,EAAE,gBAAgB,CAAC;IAEtC,qBAAqB,CAAC,EAAE,CAAC,GAAG,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAExD,eAAe,EAAE,eAAe,CAAC;IAEjC,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,sFAM3B,sBAAsB,sBAyIxB,CAAC"}

package/lib/esm/core-react/settings/SettingsContainer.js

@@ -1,149 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Settings
- */
-import "./SettingsContainer.scss";
-import * as React from "react";
-import { VerticalTabs } from "../tabs/VerticalTabs";
-import { ConditionalBooleanValue } from "@itwin/appui-abstract";
-/* eslint-disable deprecation/deprecation */
-/*  ---------------------------------------------------------------------------------------------------
-// A typical implementation of a saveFunction callback
-const saveChanges = React.useCallback((afterSaveFunction: (args: any) => void, args?: any) => {
-  if (dataIsDirty) {
-    // prompt user to save changes passing in function and arguments to call after saving changes.
-    UiFramework.dialogs.modal.openDialog(<CustomSavePromptModalDialog customProps={customProps}
-      onDialogCloseArgs={args} onDialogClose={afterSaveFunction} />);
-    return;
-  }
-  afterSaveFunction(args);
-}, []);
----------------------------------------------------------------------------------------------------------- */
-/** Hook to use within Settings Page component to allow saving the current page's data before the Setting Container is closed.
- * @public
- * @deprecated in 4.16.0. Use {@link SettingsManager} instead.
- */
-export function useSaveBeforeClosingSettingsContainer(settingsManager, saveFunction) {
-    React.useEffect(() => {
-        return settingsManager.onProcessSettingsContainerClose.addListener(({ closeFunc, closeFuncArgs }) => {
-            saveFunction(closeFunc, closeFuncArgs);
-        });
-    }, [saveFunction, settingsManager]);
-}
-/** Hook to use within Settings Page component to allow saving the current page's data before loading to the requested Setting Tab's page.
- * @public
- * @deprecated in 4.16.0. Use {@link SettingsManager} instead.
- */
-export function useSaveBeforeActivatingNewSettingsTab(settingsManager, saveFunction) {
-    React.useEffect(() => {
-        return settingsManager.onProcessSettingsTabActivation.addListener(({ tabSelectionFunc, requestedSettingsTabId }) => {
-            saveFunction(tabSelectionFunc, requestedSettingsTabId);
-        });
-    }, [saveFunction, settingsManager]);
-}
-/** Component that displays setting tabs on the left and the setting page on the right.
- * Note: that SettingsContainer is not rendered if tabs array is empty.
- * @public
- * @deprecated in 4.16.0. Used internally by {@link @itwin/appui-react#SettingsModalFrontstage}.
- */
-export const SettingsContainer = ({ tabs, onSettingsTabSelected, currentSettingsTab, settingsManager, showHeader, }) => {
-    // sort the tabs based on itemPriority
-    tabs = tabs.sort((a, b) => a.itemPriority - b.itemPriority);
-    const [openTab, setOpenTab] = React.useState(() => {
-        if (currentSettingsTab &&
-            !ConditionalBooleanValue.getValue(currentSettingsTab.isDisabled))
-            return currentSettingsTab;
-        else
-            return tabs[0];
-    });
-    const processTabSelection = React.useCallback((tab) => {
-        if (ConditionalBooleanValue.getValue(tab.isDisabled))
-            return;
-        onSettingsTabSelected && onSettingsTabSelected(tab);
-        setOpenTab(tab);
-    }, [onSettingsTabSelected]);
-    const processTabSelectionById = React.useCallback((tabId) => {
-        const tabToActivate = tabs.find((tab) => tab.tabId === tabId);
-        tabToActivate && processTabSelection(tabToActivate);
-    }, [processTabSelection, tabs]);
-    const onActivateTab = React.useCallback((tabIndex) => {
-        const selectedTab = tabs[tabIndex];
-        if (openTab && openTab.pageWillHandleCloseRequest)
-            settingsManager.onProcessSettingsTabActivation.emit({
-                requestedSettingsTabId: selectedTab.tabId,
-                tabSelectionFunc: processTabSelectionById,
-            });
-        else
-            processTabSelection(selectedTab);
-    }, [
-        openTab,
-        processTabSelection,
-        processTabSelectionById,
-        settingsManager,
-        tabs,
-    ]);
-    React.useEffect(() => {
-        return settingsManager.onActivateSettingsTab.addListener(({ settingsTabId }) => {
-            const idToFind = settingsTabId.toLowerCase();
-            let tabToActivate = tabs.find((tab) => tab.tabId.toLowerCase() === idToFind);
-            if (!tabToActivate)
-                tabToActivate = tabs.find((tab) => tab.label.toLowerCase() === idToFind);
-            if (tabToActivate) {
-                if (openTab && openTab.pageWillHandleCloseRequest)
-                    settingsManager.onProcessSettingsTabActivation.emit({
-                        requestedSettingsTabId: tabToActivate.tabId,
-                        tabSelectionFunc: processTabSelectionById,
-                    });
-                else
-                    processTabSelection(tabToActivate);
-            }
-        });
-    }, [
-        openTab,
-        processTabSelection,
-        processTabSelectionById,
-        settingsManager,
-        settingsManager.onActivateSettingsTab,
-        tabs,
-    ]);
-    React.useEffect(() => {
-        return settingsManager.onCloseSettingsContainer.addListener(({ closeFunc, closeFuncArgs }) => {
-            if (openTab && openTab.pageWillHandleCloseRequest)
-                settingsManager.onProcessSettingsContainerClose.emit({
-                    closeFunc,
-                    closeFuncArgs,
-                });
-            else
-                closeFunc(closeFuncArgs);
-        });
-    }, [
-        openTab,
-        processTabSelection,
-        settingsManager,
-        settingsManager.onActivateSettingsTab,
-        tabs,
-    ]);
-    const labels = tabs.map((tab) => {
-        return {
-            label: tab.label,
-            subLabel: tab.subLabel,
-            icon: tab.icon,
-            tooltip: tab.tooltip,
-            tabId: tab.tabId,
-            disabled: ConditionalBooleanValue.getValue(tab.isDisabled),
-        };
-    });
-    const activeIndex = tabs.findIndex((tab) => tab.tabId === openTab.tabId);
-    return (React.createElement("div", { className: "core-settings-container" },
-        React.createElement("div", { className: "core-settings-container-left" },
-            React.createElement(VerticalTabs, { labels: labels, activeIndex: activeIndex, onActivateTab: onActivateTab })),
-        React.createElement("div", { className: "core-settings-container-right" },
-            showHeader && (React.createElement("div", { className: "core-settings-container-right-header" },
-                React.createElement("span", { className: "core-settings-container-main-header" }, openTab.label),
-                openTab.subLabel && (React.createElement("span", { className: "core-settings-container-main-sub-header" }, openTab.subLabel)))),
-            React.createElement("div", { className: "core-settings-container-right-contents" }, openTab.page))));
-};
-//# sourceMappingURL=SettingsContainer.js.map

package/lib/esm/core-react/settings/SettingsContainer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SettingsContainer.js","sourceRoot":"","sources":["../../../../src/core-react/settings/SettingsContainer.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,0BAA0B,CAAC;AAClC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAEhE,4CAA4C;AAE5C;;;;;;;;;;;6GAW6G;AAE7G;;;GAGG;AACH,MAAM,UAAU,qCAAqC,CACnD,eAAgC,EAChC,YAA2E;IAE3E,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,eAAe,CAAC,+BAA+B,CAAC,WAAW,CAChE,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,EAAE,EAAE;YAC/B,YAAY,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QACzC,CAAC,CACF,CAAC;IACJ,CAAC,EAAE,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,CAAC;AACtC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qCAAqC,CACnD,eAAgC,EAChC,YAGS;IAET,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,eAAe,CAAC,8BAA8B,CAAC,WAAW,CAC/D,CAAC,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,EAAE,EAAE;YAC/C,YAAY,CAAC,gBAAgB,EAAE,sBAAsB,CAAC,CAAC;QACzD,CAAC,CACF,CAAC;IACJ,CAAC,EAAE,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,CAAC;AACtC,CAAC;AAmBD;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,EAChC,IAAI,EACJ,qBAAqB,EACrB,kBAAkB,EAClB,eAAe,EACf,UAAU,GACa,EAAE,EAAE;IAC3B,sCAAsC;IACtC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC;IAE5D,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE;QAChD,IACE,kBAAkB;YAClB,CAAC,uBAAuB,CAAC,QAAQ,CAAC,kBAAkB,CAAC,UAAU,CAAC;YAEhE,OAAO,kBAAkB,CAAC;;YACvB,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,KAAK,CAAC,WAAW,CAC3C,CAAC,GAAqB,EAAE,EAAE;QACxB,IAAI,uBAAuB,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC;YAAE,OAAO;QAC7D,qBAAqB,IAAI,qBAAqB,CAAC,GAAG,CAAC,CAAC;QACpD,UAAU,CAAC,GAAG,CAAC,CAAC;IAClB,CAAC,EACD,CAAC,qBAAqB,CAAC,CACxB,CAAC;IAEF,MAAM,uBAAuB,GAAG,KAAK,CAAC,WAAW,CAC/C,CAAC,KAAa,EAAE,EAAE;QAChB,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;QAC9D,aAAa,IAAI,mBAAmB,CAAC,aAAa,CAAC,CAAC;IACtD,CAAC,EACD,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAC5B,CAAC;IAEF,MAAM,aAAa,GAAG,KAAK,CAAC,WAAW,CACrC,CAAC,QAAgB,EAAE,EAAE;QACnB,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAI,OAAO,IAAI,OAAO,CAAC,0BAA0B;YAC/C,eAAe,CAAC,8BAA8B,CAAC,IAAI,CAAC;gBAClD,sBAAsB,EAAE,WAAW,CAAC,KAAK;gBACzC,gBAAgB,EAAE,uBAAuB;aAC1C,CAAC,CAAC;;YACA,mBAAmB,CAAC,WAAW,CAAC,CAAC;IACxC,CAAC,EACD;QACE,OAAO;QACP,mBAAmB;QACnB,uBAAuB;QACvB,eAAe;QACf,IAAI;KACL,CACF,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,eAAe,CAAC,qBAAqB,CAAC,WAAW,CACtD,CAAC,EAAE,aAAa,EAAE,EAAE,EAAE;YACpB,MAAM,QAAQ,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;YAC7C,IAAI,aAAa,GAAG,IAAI,CAAC,IAAI,CAC3B,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,QAAQ,CAC9C,CAAC;YACF,IAAI,CAAC,aAAa;gBAChB,aAAa,GAAG,IAAI,CAAC,IAAI,CACvB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,QAAQ,CAC9C,CAAC;YACJ,IAAI,aAAa,EAAE,CAAC;gBAClB,IAAI,OAAO,IAAI,OAAO,CAAC,0BAA0B;oBAC/C,eAAe,CAAC,8BAA8B,CAAC,IAAI,CAAC;wBAClD,sBAAsB,EAAE,aAAa,CAAC,KAAK;wBAC3C,gBAAgB,EAAE,uBAAuB;qBAC1C,CAAC,CAAC;;oBACA,mBAAmB,CAAC,aAAa,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC,EAAE;QACD,OAAO;QACP,mBAAmB;QACnB,uBAAuB;QACvB,eAAe;QACf,eAAe,CAAC,qBAAqB;QACrC,IAAI;KACL,CAAC,CAAC;IAEH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,eAAe,CAAC,wBAAwB,CAAC,WAAW,CACzD,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,EAAE,EAAE;YAC/B,IAAI,OAAO,IAAI,OAAO,CAAC,0BAA0B;gBAC/C,eAAe,CAAC,+BAA+B,CAAC,IAAI,CAAC;oBACnD,SAAS;oBACT,aAAa;iBACd,CAAC,CAAC;;gBACA,SAAS,CAAC,aAAa,CAAC,CAAC;QAChC,CAAC,CACF,CAAC;IACJ,CAAC,EAAE;QACD,OAAO;QACP,mBAAmB;QACnB,eAAe;QACf,eAAe,CAAC,qBAAqB;QACrC,IAAI;KACL,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAC9B,OAAO;YACL,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC;SAC3D,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,OAAO,CAAC,KAAK,CAAC,CAAC;IACzE,OAAO,CACL,6BAAK,SAAS,EAAC,yBAAyB;QACtC,6BAAK,SAAS,EAAC,8BAA8B;YAC3C,oBAAC,YAAY,IACX,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,aAAa,GAC5B,CACE;QACN,6BAAK,SAAS,EAAC,+BAA+B;YAC3C,UAAU,IAAI,CACb,6BAAK,SAAS,EAAC,sCAAsC;gBACnD,8BAAM,SAAS,EAAC,qCAAqC,IAClD,OAAO,CAAC,KAAK,CACT;gBACN,OAAO,CAAC,QAAQ,IAAI,CACnB,8BAAM,SAAS,EAAC,yCAAyC,IACtD,OAAO,CAAC,QAAQ,CACZ,CACR,CACG,CACP;YACD,6BAAK,SAAS,EAAC,wCAAwC,IACpD,OAAO,CAAC,IAAI,CACT,CACF,CACF,CACP,CAAC;AACJ,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Settings\n */\n\nimport \"./SettingsContainer.scss\";\nimport * as React from \"react\";\nimport type { SettingsManager, SettingsTabEntry } from \"./SettingsManager\";\nimport { VerticalTabs } from \"../tabs/VerticalTabs\";\nimport { ConditionalBooleanValue } from \"@itwin/appui-abstract\";\n\n/* eslint-disable deprecation/deprecation */\n\n/*  ---------------------------------------------------------------------------------------------------\n// A typical implementation of a saveFunction callback\nconst saveChanges = React.useCallback((afterSaveFunction: (args: any) => void, args?: any) => {\n  if (dataIsDirty) {\n    // prompt user to save changes passing in function and arguments to call after saving changes.\n    UiFramework.dialogs.modal.openDialog(<CustomSavePromptModalDialog customProps={customProps}\n      onDialogCloseArgs={args} onDialogClose={afterSaveFunction} />);\n    return;\n  }\n  afterSaveFunction(args);\n}, []);\n---------------------------------------------------------------------------------------------------------- */\n\n/** Hook to use within Settings Page component to allow saving the current page's data before the Setting Container is closed.\n * @public\n * @deprecated in 4.16.0. Use {@link SettingsManager} instead.\n */\nexport function useSaveBeforeClosingSettingsContainer(\n  settingsManager: SettingsManager,\n  saveFunction: (closeFunc: (args: any) => void, closeFuncArgs?: any) => void\n) {\n  React.useEffect(() => {\n    return settingsManager.onProcessSettingsContainerClose.addListener(\n      ({ closeFunc, closeFuncArgs }) => {\n        saveFunction(closeFunc, closeFuncArgs);\n      }\n    );\n  }, [saveFunction, settingsManager]);\n}\n\n/** Hook to use within Settings Page component to allow saving the current page's data before loading to the requested Setting Tab's page.\n * @public\n * @deprecated in 4.16.0. Use {@link SettingsManager} instead.\n */\nexport function useSaveBeforeActivatingNewSettingsTab(\n  settingsManager: SettingsManager,\n  saveFunction: (\n    tabSelectionFunc: (args: any) => void,\n    requestedSettingsTabId?: string\n  ) => void\n) {\n  React.useEffect(() => {\n    return settingsManager.onProcessSettingsTabActivation.addListener(\n      ({ tabSelectionFunc, requestedSettingsTabId }) => {\n        saveFunction(tabSelectionFunc, requestedSettingsTabId);\n      }\n    );\n  }, [saveFunction, settingsManager]);\n}\n\n/**\n * Properties of {@link SettingsContainer} component.\n * @public\n * @deprecated in 4.16.0. Props of deprecated component {@link SettingsContainer}.\n */\nexport interface SettingsContainerProps {\n  tabs: SettingsTabEntry[];\n  // sets tab to set as active tab\n  currentSettingsTab?: SettingsTabEntry;\n  // If plugging into a SPA and you need to modify the route, you can pass in additional logic here\n  onSettingsTabSelected?: (tab: SettingsTabEntry) => void;\n  // The SettingsManager that can have event handlers registered against it so pages can save its settings before the page is closed.\n  settingsManager: SettingsManager;\n  // if true show tab label as header above page contents.\n  showHeader?: boolean;\n}\n\n/** Component that displays setting tabs on the left and the setting page on the right.\n * Note: that SettingsContainer is not rendered if tabs array is empty.\n * @public\n * @deprecated in 4.16.0. Used internally by {@link @itwin/appui-react#SettingsModalFrontstage}.\n */\nexport const SettingsContainer = ({\n  tabs,\n  onSettingsTabSelected,\n  currentSettingsTab,\n  settingsManager,\n  showHeader,\n}: SettingsContainerProps) => {\n  // sort the tabs based on itemPriority\n  tabs = tabs.sort((a, b) => a.itemPriority - b.itemPriority);\n\n  const [openTab, setOpenTab] = React.useState(() => {\n    if (\n      currentSettingsTab &&\n      !ConditionalBooleanValue.getValue(currentSettingsTab.isDisabled)\n    )\n      return currentSettingsTab;\n    else return tabs[0];\n  });\n\n  const processTabSelection = React.useCallback(\n    (tab: SettingsTabEntry) => {\n      if (ConditionalBooleanValue.getValue(tab.isDisabled)) return;\n      onSettingsTabSelected && onSettingsTabSelected(tab);\n      setOpenTab(tab);\n    },\n    [onSettingsTabSelected]\n  );\n\n  const processTabSelectionById = React.useCallback(\n    (tabId: string) => {\n      const tabToActivate = tabs.find((tab) => tab.tabId === tabId);\n      tabToActivate && processTabSelection(tabToActivate);\n    },\n    [processTabSelection, tabs]\n  );\n\n  const onActivateTab = React.useCallback(\n    (tabIndex: number) => {\n      const selectedTab = tabs[tabIndex];\n      if (openTab && openTab.pageWillHandleCloseRequest)\n        settingsManager.onProcessSettingsTabActivation.emit({\n          requestedSettingsTabId: selectedTab.tabId,\n          tabSelectionFunc: processTabSelectionById,\n        });\n      else processTabSelection(selectedTab);\n    },\n    [\n      openTab,\n      processTabSelection,\n      processTabSelectionById,\n      settingsManager,\n      tabs,\n    ]\n  );\n\n  React.useEffect(() => {\n    return settingsManager.onActivateSettingsTab.addListener(\n      ({ settingsTabId }) => {\n        const idToFind = settingsTabId.toLowerCase();\n        let tabToActivate = tabs.find(\n          (tab) => tab.tabId.toLowerCase() === idToFind\n        );\n        if (!tabToActivate)\n          tabToActivate = tabs.find(\n            (tab) => tab.label.toLowerCase() === idToFind\n          );\n        if (tabToActivate) {\n          if (openTab && openTab.pageWillHandleCloseRequest)\n            settingsManager.onProcessSettingsTabActivation.emit({\n              requestedSettingsTabId: tabToActivate.tabId,\n              tabSelectionFunc: processTabSelectionById,\n            });\n          else processTabSelection(tabToActivate);\n        }\n      }\n    );\n  }, [\n    openTab,\n    processTabSelection,\n    processTabSelectionById,\n    settingsManager,\n    settingsManager.onActivateSettingsTab,\n    tabs,\n  ]);\n\n  React.useEffect(() => {\n    return settingsManager.onCloseSettingsContainer.addListener(\n      ({ closeFunc, closeFuncArgs }) => {\n        if (openTab && openTab.pageWillHandleCloseRequest)\n          settingsManager.onProcessSettingsContainerClose.emit({\n            closeFunc,\n            closeFuncArgs,\n          });\n        else closeFunc(closeFuncArgs);\n      }\n    );\n  }, [\n    openTab,\n    processTabSelection,\n    settingsManager,\n    settingsManager.onActivateSettingsTab,\n    tabs,\n  ]);\n\n  const labels = tabs.map((tab) => {\n    return {\n      label: tab.label,\n      subLabel: tab.subLabel,\n      icon: tab.icon,\n      tooltip: tab.tooltip,\n      tabId: tab.tabId,\n      disabled: ConditionalBooleanValue.getValue(tab.isDisabled),\n    };\n  });\n  const activeIndex = tabs.findIndex((tab) => tab.tabId === openTab.tabId);\n  return (\n    <div className=\"core-settings-container\">\n      <div className=\"core-settings-container-left\">\n        <VerticalTabs\n          labels={labels}\n          activeIndex={activeIndex}\n          onActivateTab={onActivateTab}\n        />\n      </div>\n      <div className=\"core-settings-container-right\">\n        {showHeader && (\n          <div className=\"core-settings-container-right-header\">\n            <span className=\"core-settings-container-main-header\">\n              {openTab.label}\n            </span>\n            {openTab.subLabel && (\n              <span className=\"core-settings-container-main-sub-header\">\n                {openTab.subLabel}\n              </span>\n            )}\n          </div>\n        )}\n        <div className=\"core-settings-container-right-contents\">\n          {openTab.page}\n        </div>\n      </div>\n    </div>\n  );\n};\n"]}

package/lib/esm/core-react/settings/SettingsManager.d.ts

@@ -1,137 +0,0 @@
-/** @packageDocumentation
- * @module Settings
- */
-import { BeUiEvent } from "@itwin/core-bentley";
-import type { ConditionalBooleanValue } from "@itwin/appui-abstract";
-/** Interface used to populate a tab entry in the SettingContainer control
- * @public
- * @deprecated in 4.16.0. Use {@link @itwin/appui-react#SettingsTabEntry} instead.
- */
-export interface SettingsTabEntry {
-    /** unique id for entry */
-    readonly tabId: string;
-    /** localized display label */
-    readonly label: string;
-    /** Setting page content to display when tab item is selected. */
-    readonly page: React.ReactElement;
-    /** Setting to true if page will register to watch for stage closing event so it can save any dirty settings. Page component should register and handle the events:
-     * `settingsManager.onProcessSettingsTabActivation` and `settingsManager.onProcessSettingsContainerClose` */
-    readonly pageWillHandleCloseRequest?: boolean;
-    /** used to determine position in tablist */
-    readonly itemPriority: number;
-    /** Optional Subtitle to show below label. */
-    readonly subLabel?: string;
-    /** Icon specification */
-    readonly icon?: string | React.ReactElement;
-    /** Tooltip. Allows JSX|Element to support react-tooltip component */
-    readonly tooltip?: string | React.ReactElement;
-    /** Allows Settings entry to be disabled */
-    readonly isDisabled?: boolean | ConditionalBooleanValue;
-}
-/** Event class for [[this.onSettingsProvidersChanged]] which is emitted when a new SettingsTabsProvider is added or removed.
- * @public
- * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
- */
-export declare class SettingsProvidersChangedEvent extends BeUiEvent<SettingsProvidersChangedEventArgs> {
-}
-/** Arguments of [[this.onSettingsProvidersChanged]] event.
- * @public
- * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
- */
-export interface SettingsProvidersChangedEventArgs {
-    readonly providers: ReadonlyArray<SettingsTabsProvider>;
-}
-/** Event class for [[this.onProcessSettingsTabActivation]] which is emitted when a new Tab needs to be activated. This allows the current
- * settings page to save its settings before activating the new SettingTab.
- * @public
- * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
- */
-export declare class ProcessSettingsTabActivationEvent extends BeUiEvent<ProcessSettingsTabActivationEventArgs> {
-}
-/** Arguments of [[this.onProcessSettingsTabActivation]] event.
- * @public
- * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
- */
-export interface ProcessSettingsTabActivationEventArgs {
-    readonly tabSelectionFunc: (tabId: string) => void;
-    readonly requestedSettingsTabId: string;
-}
-/** Event class for [[this.onProcessSettingsContainerClose]] which is emitted when the settings container will be closed. This allows the current
- * settings page to save its settings before calling the function to close the container.
- * @public
- * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
- */
-export declare class ProcessSettingsContainerCloseEvent extends BeUiEvent<ProcessSettingsContainerCloseEventArgs> {
-}
-/** Arguments of [[this.onProcessSettingsContainerClose]] event.
- * @public
- * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
- */
-export interface ProcessSettingsContainerCloseEventArgs {
-    readonly closeFunc: (args: any) => void;
-    readonly closeFuncArgs?: any;
-}
-/** Event class for [[this.onActivateSettingsTab]] which is emitted when API call needs to set the active settings tab (ie via Tool key-in).
- * @public
- * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
- */
-export declare class ActivateSettingsTabEvent extends BeUiEvent<ActivateSettingsTabEventArgs> {
-}
-/** Arguments of [[this.onActivateSettingsTab]] event.
- * @public
- * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
- */
-export interface ActivateSettingsTabEventArgs {
-    readonly settingsTabId: string;
-}
-/** Setting Provider interface. Implemented by classes that want to supply settings pages for display in the SettingContainer. The
- * classes that implement this interface need to be registered with the [[SettingsManager]].
- * @public
- * @deprecated in 4.16.0. Use {@link @itwin/appui-react#SettingsTabsProvider} instead.
- */
-export interface SettingsTabsProvider {
-    /** Id of provider, used to remove registration. */
-    readonly id: string;
-    getSettingEntries(stageId: string, stageUsage: string): ReadonlyArray<SettingsTabEntry> | undefined;
-}
-/** Settings Manager class. Hold registration of settings providers and supplies events for the provided settings pages to listen.
- * @public
- * @deprecated in 4.16.0. Use {@link @itwin/appui-react#SettingsManager} instead.
- */
-export declare class SettingsManager {
-    private _providers;
-    /** Event raised when SettingsProviders are changed.
-     */
-    readonly onSettingsProvidersChanged: SettingsProvidersChangedEvent;
-    /** Event raised solely for a settings page to monitor so it can save its settings before continuing tab activation.
-     * See React hook function `useSaveBeforeActivatingNewSettingsTab`.
-     */
-    readonly onProcessSettingsTabActivation: ProcessSettingsTabActivationEvent;
-    /** Event raised when the settings container will be closed. Any setting page component that is 'modal' should register to
-     * listen to this event so that it can save its state before closing. See React hook function `useSaveBeforeClosingSettingsContainer`.
-     */
-    readonly onProcessSettingsContainerClose: ProcessSettingsContainerCloseEvent;
-    /** Event raised to change the active settings tab shown in UI. Monitored by the SettingsContainer.
-     * @internal
-     */
-    readonly onActivateSettingsTab: BeUiEvent<ActivateSettingsTabEventArgs>;
-    /** Event monitored by SettingsContainer to process request to close the settings container.
-     * @internal
-     */
-    readonly onCloseSettingsContainer: BeUiEvent<ProcessSettingsContainerCloseEventArgs>;
-    get providers(): ReadonlyArray<SettingsTabsProvider>;
-    set providers(p: ReadonlyArray<SettingsTabsProvider>);
-    /** Called by application when an tool, keyin, or other process want to change the active settings tab/page giving the current tab/page and opportunity
-     * to save its state.
-     */
-    activateSettingsTab(settingsTabId: string): void;
-    /** Called by application when the Settings Container is to be closed. The function to invoke to actually close the Settings Container is
-     * passed in and executed once the active settings tab/page has a chance to save its settings.
-     */
-    closeSettingsContainer(closeFunc: (args: any) => void, closeFuncArgs?: any): void;
-    addSettingsProvider(settingsProvider: SettingsTabsProvider): void;
-    removeSettingsProvider(providerId: string): boolean;
-    /** Get an array of SettingsTabEntry objects to populate the settings container. */
-    getSettingEntries(stageId: string, stageUsage: string): Array<SettingsTabEntry>;
-}
-//# sourceMappingURL=SettingsManager.d.ts.map

package/lib/esm/core-react/settings/SettingsManager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SettingsManager.d.ts","sourceRoot":"","sources":["../../../../src/core-react/settings/SettingsManager.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAU,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAKrE;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0BAA0B;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,8BAA8B;IAC9B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,iEAAiE;IACjE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC;IAClC;gHAC4G;IAC5G,QAAQ,CAAC,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAC9C,4CAA4C;IAC5C,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,6CAA6C;IAC7C,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,yBAAyB;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC;IAC5C,qEAAqE;IACrE,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC;IAC/C,2CAA2C;IAC3C,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;CACzD;AAED;;;GAGG;AACH,qBAAa,6BAA8B,SAAQ,SAAS,CAAC,iCAAiC,CAAC;CAAG;AAElG;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;CACzD;AAED;;;;GAIG;AACH,qBAAa,iCAAkC,SAAQ,SAAS,CAAC,qCAAqC,CAAC;CAAG;AAE1G;;;GAGG;AACH,MAAM,WAAW,qCAAqC;IACpD,QAAQ,CAAC,gBAAgB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACnD,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;CACzC;AAED;;;;GAIG;AACH,qBAAa,kCAAmC,SAAQ,SAAS,CAAC,sCAAsC,CAAC;CAAG;AAE5G;;;GAGG;AACH,MAAM,WAAW,sCAAsC;IACrD,QAAQ,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC;IACxC,QAAQ,CAAC,aAAa,CAAC,EAAE,GAAG,CAAC;CAC9B;AAED;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,SAAS,CAAC,4BAA4B,CAAC;CAAG;AAExF;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,mDAAmD;IACnD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,iBAAiB,CACf,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,GACjB,aAAa,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC;CAChD;AAED;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,UAAU,CAA2C;IAE7D;OACG;IACH,SAAgB,0BAA0B,gCACJ;IAEtC;;OAEG;IACH,SAAgB,8BAA8B,oCACJ;IAE1C;;OAEG;IACH,SAAgB,+BAA+B,qCACJ;IAE3C;;OAEG;IACH,SAAgB,qBAAqB,0CACW;IAEhD;;OAEG;IACH,SAAgB,wBAAwB,oDACkB;IAE1D,IAAW,SAAS,IAAI,aAAa,CAAC,oBAAoB,CAAC,CAE1D;IACD,IAAW,SAAS,CAAC,CAAC,EAAE,aAAa,CAAC,oBAAoB,CAAC,EAG1D;IAED;;OAEG;IACI,mBAAmB,CAAC,aAAa,EAAE,MAAM;IAIhD;;OAEG;IACI,sBAAsB,CAC3B,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,EAC9B,aAAa,CAAC,EAAE,GAAG;IAKd,mBAAmB,CAAC,gBAAgB,EAAE,oBAAoB,GAAG,IAAI;IAejE,sBAAsB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAW1D,mFAAmF;IAC5E,iBAAiB,CACtB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,GACjB,KAAK,CAAC,gBAAgB,CAAC;CAU3B"}

package/lib/esm/core-react/settings/SettingsManager.js

@@ -1,112 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Settings
- */
-import { BeUiEvent, Logger } from "@itwin/core-bentley";
-import { UiCore } from "../UiCore";
-/** Event class for [[this.onSettingsProvidersChanged]] which is emitted when a new SettingsTabsProvider is added or removed.
- * @public
- * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
- */
-export class SettingsProvidersChangedEvent extends BeUiEvent {
-}
-/** Event class for [[this.onProcessSettingsTabActivation]] which is emitted when a new Tab needs to be activated. This allows the current
- * settings page to save its settings before activating the new SettingTab.
- * @public
- * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
- */
-export class ProcessSettingsTabActivationEvent extends BeUiEvent {
-}
-/** Event class for [[this.onProcessSettingsContainerClose]] which is emitted when the settings container will be closed. This allows the current
- * settings page to save its settings before calling the function to close the container.
- * @public
- * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
- */
-export class ProcessSettingsContainerCloseEvent extends BeUiEvent {
-}
-/** Event class for [[this.onActivateSettingsTab]] which is emitted when API call needs to set the active settings tab (ie via Tool key-in).
- * @public
- * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
- */
-export class ActivateSettingsTabEvent extends BeUiEvent {
-}
-/** Settings Manager class. Hold registration of settings providers and supplies events for the provided settings pages to listen.
- * @public
- * @deprecated in 4.16.0. Use {@link @itwin/appui-react#SettingsManager} instead.
- */
-export class SettingsManager {
-    constructor() {
-        this._providers = [];
-        /** Event raised when SettingsProviders are changed.
-         */
-        this.onSettingsProvidersChanged = new SettingsProvidersChangedEvent();
-        /** Event raised solely for a settings page to monitor so it can save its settings before continuing tab activation.
-         * See React hook function `useSaveBeforeActivatingNewSettingsTab`.
-         */
-        this.onProcessSettingsTabActivation = new ProcessSettingsTabActivationEvent();
-        /** Event raised when the settings container will be closed. Any setting page component that is 'modal' should register to
-         * listen to this event so that it can save its state before closing. See React hook function `useSaveBeforeClosingSettingsContainer`.
-         */
-        this.onProcessSettingsContainerClose = new ProcessSettingsContainerCloseEvent();
-        /** Event raised to change the active settings tab shown in UI. Monitored by the SettingsContainer.
-         * @internal
-         */
-        this.onActivateSettingsTab = new BeUiEvent();
-        /** Event monitored by SettingsContainer to process request to close the settings container.
-         * @internal
-         */
-        this.onCloseSettingsContainer = new BeUiEvent();
-    }
-    get providers() {
-        return this._providers;
-    }
-    set providers(p) {
-        this._providers = p;
-        this.onSettingsProvidersChanged.emit({ providers: p });
-    }
-    /** Called by application when an tool, keyin, or other process want to change the active settings tab/page giving the current tab/page and opportunity
-     * to save its state.
-     */
-    activateSettingsTab(settingsTabId) {
-        this.onActivateSettingsTab.emit({ settingsTabId });
-    }
-    /** Called by application when the Settings Container is to be closed. The function to invoke to actually close the Settings Container is
-     * passed in and executed once the active settings tab/page has a chance to save its settings.
-     */
-    closeSettingsContainer(closeFunc, closeFuncArgs) {
-        this.onCloseSettingsContainer.emit({ closeFunc, closeFuncArgs });
-    }
-    addSettingsProvider(settingsProvider) {
-        const foundProvider = this._providers.find((p) => p.id === settingsProvider.id);
-        if (!foundProvider) {
-            const updatedProviders = [...this.providers, settingsProvider];
-            this.providers = updatedProviders;
-        }
-        else {
-            Logger.logInfo(UiCore.loggerCategory(this), `Settings Provider with id of ${settingsProvider.id} has already been registered`);
-        }
-    }
-    removeSettingsProvider(providerId) {
-        let result = false;
-        const updatedProviders = this._providers.filter((p) => p.id !== providerId);
-        if (updatedProviders.length !== this._providers.length) {
-            this.providers = updatedProviders;
-            result = true;
-        }
-        return result;
-    }
-    /** Get an array of SettingsTabEntry objects to populate the settings container. */
-    getSettingEntries(stageId, stageUsage) {
-        const allSettingEntries = [];
-        // Consult the registered SettingsProviders
-        this._providers.forEach((p) => {
-            const entries = p.getSettingEntries(stageId, stageUsage);
-            entries && allSettingEntries.push(...entries);
-        });
-        return allSettingEntries;
-    }
-}
-//# sourceMappingURL=SettingsManager.js.map

package/lib/esm/core-react/settings/SettingsManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SettingsManager.js","sourceRoot":"","sources":["../../../../src/core-react/settings/SettingsManager.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AA8BnC;;;GAGG;AACH,MAAM,OAAO,6BAA8B,SAAQ,SAA4C;CAAG;AAUlG;;;;GAIG;AACH,MAAM,OAAO,iCAAkC,SAAQ,SAAgD;CAAG;AAW1G;;;;GAIG;AACH,MAAM,OAAO,kCAAmC,SAAQ,SAAiD;CAAG;AAW5G;;;GAGG;AACH,MAAM,OAAO,wBAAyB,SAAQ,SAAuC;CAAG;AAwBxF;;;GAGG;AACH,MAAM,OAAO,eAAe;IAA5B;QACU,eAAU,GAAwC,EAAE,CAAC;QAE7D;WACG;QACa,+BAA0B,GACxC,IAAI,6BAA6B,EAAE,CAAC;QAEtC;;WAEG;QACa,mCAA8B,GAC5C,IAAI,iCAAiC,EAAE,CAAC;QAE1C;;WAEG;QACa,oCAA+B,GAC7C,IAAI,kCAAkC,EAAE,CAAC;QAE3C;;WAEG;QACa,0BAAqB,GACnC,IAAI,SAAS,EAAgC,CAAC;QAEhD;;WAEG;QACa,6BAAwB,GACtC,IAAI,SAAS,EAA0C,CAAC;IAmE5D,CAAC;IAjEC,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IACD,IAAW,SAAS,CAAC,CAAsC;QACzD,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,mBAAmB,CAAC,aAAqB;QAC9C,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACI,sBAAsB,CAC3B,SAA8B,EAC9B,aAAmB;QAEnB,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC;IACnE,CAAC;IAEM,mBAAmB,CAAC,gBAAsC;QAC/D,MAAM,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CACxC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,gBAAgB,CAAC,EAAE,CACpC,CAAC;QACF,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,gBAAgB,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YAC/D,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,OAAO,CACZ,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,EAC3B,gCAAgC,gBAAgB,CAAC,EAAE,8BAA8B,CAClF,CAAC;QACJ,CAAC;IACH,CAAC;IAEM,sBAAsB,CAAC,UAAkB;QAC9C,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,UAAU,CAAC,CAAC;QAC5E,IAAI,gBAAgB,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACvD,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC;YAClC,MAAM,GAAG,IAAI,CAAC;QAChB,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,mFAAmF;IAC5E,iBAAiB,CACtB,OAAe,EACf,UAAkB;QAElB,MAAM,iBAAiB,GAAuB,EAAE,CAAC;QACjD,2CAA2C;QAC3C,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAC5B,MAAM,OAAO,GAAG,CAAC,CAAC,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YACzD,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,OAAO,iBAAiB,CAAC;IAC3B,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Settings\n */\n\nimport { BeUiEvent, Logger } from \"@itwin/core-bentley\";\nimport type { ConditionalBooleanValue } from \"@itwin/appui-abstract\";\nimport { UiCore } from \"../UiCore\";\n\n/* eslint-disable deprecation/deprecation */\n\n/** Interface used to populate a tab entry in the SettingContainer control\n * @public\n * @deprecated in 4.16.0. Use {@link @itwin/appui-react#SettingsTabEntry} instead.\n */\nexport interface SettingsTabEntry {\n  /** unique id for entry */\n  readonly tabId: string;\n  /** localized display label */\n  readonly label: string;\n  /** Setting page content to display when tab item is selected. */\n  readonly page: React.ReactElement;\n  /** Setting to true if page will register to watch for stage closing event so it can save any dirty settings. Page component should register and handle the events:\n   * `settingsManager.onProcessSettingsTabActivation` and `settingsManager.onProcessSettingsContainerClose` */\n  readonly pageWillHandleCloseRequest?: boolean;\n  /** used to determine position in tablist */\n  readonly itemPriority: number;\n  /** Optional Subtitle to show below label. */\n  readonly subLabel?: string;\n  /** Icon specification */\n  readonly icon?: string | React.ReactElement;\n  /** Tooltip. Allows JSX|Element to support react-tooltip component */\n  readonly tooltip?: string | React.ReactElement;\n  /** Allows Settings entry to be disabled */\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\n}\n\n/** Event class for [[this.onSettingsProvidersChanged]] which is emitted when a new SettingsTabsProvider is added or removed.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\nexport class SettingsProvidersChangedEvent extends BeUiEvent<SettingsProvidersChangedEventArgs> {}\n\n/** Arguments of [[this.onSettingsProvidersChanged]] event.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface SettingsProvidersChangedEventArgs {\n  readonly providers: ReadonlyArray<SettingsTabsProvider>;\n}\n\n/** Event class for [[this.onProcessSettingsTabActivation]] which is emitted when a new Tab needs to be activated. This allows the current\n * settings page to save its settings before activating the new SettingTab.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\nexport class ProcessSettingsTabActivationEvent extends BeUiEvent<ProcessSettingsTabActivationEventArgs> {}\n\n/** Arguments of [[this.onProcessSettingsTabActivation]] event.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface ProcessSettingsTabActivationEventArgs {\n  readonly tabSelectionFunc: (tabId: string) => void;\n  readonly requestedSettingsTabId: string;\n}\n\n/** Event class for [[this.onProcessSettingsContainerClose]] which is emitted when the settings container will be closed. This allows the current\n * settings page to save its settings before calling the function to close the container.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\nexport class ProcessSettingsContainerCloseEvent extends BeUiEvent<ProcessSettingsContainerCloseEventArgs> {}\n\n/** Arguments of [[this.onProcessSettingsContainerClose]] event.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface ProcessSettingsContainerCloseEventArgs {\n  readonly closeFunc: (args: any) => void;\n  readonly closeFuncArgs?: any;\n}\n\n/** Event class for [[this.onActivateSettingsTab]] which is emitted when API call needs to set the active settings tab (ie via Tool key-in).\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\nexport class ActivateSettingsTabEvent extends BeUiEvent<ActivateSettingsTabEventArgs> {}\n\n/** Arguments of [[this.onActivateSettingsTab]] event.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface ActivateSettingsTabEventArgs {\n  readonly settingsTabId: string;\n}\n\n/** Setting Provider interface. Implemented by classes that want to supply settings pages for display in the SettingContainer. The\n * classes that implement this interface need to be registered with the [[SettingsManager]].\n * @public\n * @deprecated in 4.16.0. Use {@link @itwin/appui-react#SettingsTabsProvider} instead.\n */\nexport interface SettingsTabsProvider {\n  /** Id of provider, used to remove registration. */\n  readonly id: string;\n  getSettingEntries(\n    stageId: string,\n    stageUsage: string\n  ): ReadonlyArray<SettingsTabEntry> | undefined;\n}\n\n/** Settings Manager class. Hold registration of settings providers and supplies events for the provided settings pages to listen.\n * @public\n * @deprecated in 4.16.0. Use {@link @itwin/appui-react#SettingsManager} instead.\n */\nexport class SettingsManager {\n  private _providers: ReadonlyArray<SettingsTabsProvider> = [];\n\n  /** Event raised when SettingsProviders are changed.\n   */\n  public readonly onSettingsProvidersChanged =\n    new SettingsProvidersChangedEvent();\n\n  /** Event raised solely for a settings page to monitor so it can save its settings before continuing tab activation.\n   * See React hook function `useSaveBeforeActivatingNewSettingsTab`.\n   */\n  public readonly onProcessSettingsTabActivation =\n    new ProcessSettingsTabActivationEvent();\n\n  /** Event raised when the settings container will be closed. Any setting page component that is 'modal' should register to\n   * listen to this event so that it can save its state before closing. See React hook function `useSaveBeforeClosingSettingsContainer`.\n   */\n  public readonly onProcessSettingsContainerClose =\n    new ProcessSettingsContainerCloseEvent();\n\n  /** Event raised to change the active settings tab shown in UI. Monitored by the SettingsContainer.\n   * @internal\n   */\n  public readonly onActivateSettingsTab =\n    new BeUiEvent<ActivateSettingsTabEventArgs>();\n\n  /** Event monitored by SettingsContainer to process request to close the settings container.\n   * @internal\n   */\n  public readonly onCloseSettingsContainer =\n    new BeUiEvent<ProcessSettingsContainerCloseEventArgs>();\n\n  public get providers(): ReadonlyArray<SettingsTabsProvider> {\n    return this._providers;\n  }\n  public set providers(p: ReadonlyArray<SettingsTabsProvider>) {\n    this._providers = p;\n    this.onSettingsProvidersChanged.emit({ providers: p });\n  }\n\n  /** Called by application when an tool, keyin, or other process want to change the active settings tab/page giving the current tab/page and opportunity\n   * to save its state.\n   */\n  public activateSettingsTab(settingsTabId: string) {\n    this.onActivateSettingsTab.emit({ settingsTabId });\n  }\n\n  /** Called by application when the Settings Container is to be closed. The function to invoke to actually close the Settings Container is\n   * passed in and executed once the active settings tab/page has a chance to save its settings.\n   */\n  public closeSettingsContainer(\n    closeFunc: (args: any) => void,\n    closeFuncArgs?: any\n  ) {\n    this.onCloseSettingsContainer.emit({ closeFunc, closeFuncArgs });\n  }\n\n  public addSettingsProvider(settingsProvider: SettingsTabsProvider): void {\n    const foundProvider = this._providers.find(\n      (p) => p.id === settingsProvider.id\n    );\n    if (!foundProvider) {\n      const updatedProviders = [...this.providers, settingsProvider];\n      this.providers = updatedProviders;\n    } else {\n      Logger.logInfo(\n        UiCore.loggerCategory(this),\n        `Settings Provider with id of ${settingsProvider.id} has already been registered`\n      );\n    }\n  }\n\n  public removeSettingsProvider(providerId: string): boolean {\n    let result = false;\n    const updatedProviders = this._providers.filter((p) => p.id !== providerId);\n    if (updatedProviders.length !== this._providers.length) {\n      this.providers = updatedProviders;\n      result = true;\n    }\n\n    return result;\n  }\n\n  /** Get an array of SettingsTabEntry objects to populate the settings container. */\n  public getSettingEntries(\n    stageId: string,\n    stageUsage: string\n  ): Array<SettingsTabEntry> {\n    const allSettingEntries: SettingsTabEntry[] = [];\n    // Consult the registered SettingsProviders\n    this._providers.forEach((p) => {\n      const entries = p.getSettingEntries(stageId, stageUsage);\n      entries && allSettingEntries.push(...entries);\n    });\n\n    return allSettingEntries;\n  }\n}\n"]}

package/lib/esm/core-react/tabs/Tabs.d.ts

@@ -1,69 +0,0 @@
-/** @packageDocumentation
- * @module Tabs
- */
-import * as React from "react";
-import type { CommonProps } from "../utils/Props";
-import { Orientation } from "../enums/Orientation";
-/** TabLabel provides ability to define label, icon, and tooltip for a tab entry. The tooltip can be defined as JSX|Element
- *  to support react-tooltip component or a string that will be use to set the title property.
- * @public
- * @deprecated in 4.12.0. Interface used in a deprecated component {@link Tabs}.
- */
-export interface TabLabel {
-    label: string;
-    subLabel?: string;
-    icon?: string | React.ReactElement;
-    tabId: string;
-    /** tooltip allows React.ReactElement to support styled tooltips like react-tooltip. */
-    tooltip?: string | React.ReactElement;
-    disabled?: boolean;
-}
-/** Properties for the [[VerticalTabs]] component
- * @public
- * @deprecated in 4.12.0. Props of deprecated component {@link Tabs}.
- */
-export interface TabsProps extends React.AllHTMLAttributes<HTMLUListElement>, CommonProps {
-    /** Text shown for each tab */
-    labels: Array<string | TabLabel>;
-    /** Handler for activating a tab */
-    onActivateTab?: (index: number) => any;
-    /** Index of the initial active tab */
-    activeIndex?: number;
-    /** Indicates whether the bar on the active tab is green instead of the default blue */
-    green?: boolean;
-}
-interface TabsState {
-    activeIndex: number;
-}
-/** Properties for the base [[Tabs]] component
- * @public
- * @deprecated in 4.12.0. Props of deprecated component {@link Tabs}.
- */
-export interface MainTabsProps extends TabsProps {
-    /** Main CSS class name */
-    mainClassName: string;
-    /** Orientation of the Tabs list */
-    orientation: Orientation;
-}
-/** Tabs meant to represent the current position in a page/section
- * @public
- * @deprecated in 4.12.0. Use {@link https://itwinui.bentley.com/docs/tabs iTwinUI Tabs} instead.
- */
-export declare class Tabs extends React.PureComponent<MainTabsProps, TabsState> {
-    private _anchorRefs;
-    private _itemKeyboardNavigator;
-    constructor(props: MainTabsProps);
-    private validateActiveIndex;
-    componentDidMount(): void;
-    componentDidUpdate(prevProps: MainTabsProps): void;
-    private _handleFocusItem;
-    private _handleTabClick;
-    /** Handle keydown on tabs */
-    private _handleKeyDownEvent;
-    /** Handle keyup on tabs */
-    private _handleKeyUpEvent;
-    private _activateTab;
-    render(): React.ReactElement;
-}
-export {};
-//# sourceMappingURL=Tabs.d.ts.map

package/lib/esm/core-react/tabs/Tabs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Tabs.d.ts","sourceRoot":"","sources":["../../../../src/core-react/tabs/Tabs.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAMnD;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC;IACnC,KAAK,EAAE,MAAM,CAAoE;IACjF,uFAAuF;IACvF,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC;IACtC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAUD;;;GAGG;AACH,MAAM,WAAW,SACf,SAAQ,KAAK,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,EAC/C,WAAW;IACb,8BAA8B;IAC9B,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,CAAC;IACjC,mCAAmC;IACnC,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,GAAG,CAAC;IACvC,sCAAsC;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uFAAuF;IACvF,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,UAAU,SAAS;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,SAAS;IAC9C,0BAA0B;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,mCAAmC;IACnC,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;;GAGG;AACH,qBAAa,IAAK,SAAQ,KAAK,CAAC,aAAa,CAAC,aAAa,EAAE,SAAS,CAAC;IACrE,OAAO,CAAC,WAAW,CAAiD;IACpE,OAAO,CAAC,sBAAsB,CAAwB;gBAE1C,KAAK,EAAE,aAAa;IAiBhC,OAAO,CAAC,mBAAmB;IAMX,iBAAiB;IAKjB,kBAAkB,CAAC,SAAS,EAAE,aAAa;IAyB3D,OAAO,CAAC,gBAAgB,CAGtB;IAEF,OAAO,CAAC,eAAe,CAErB;IAEF,6BAA6B;IAC7B,OAAO,CAAC,mBAAmB;IAI3B,2BAA2B;IAC3B,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,YAAY,CAGlB;IAEc,MAAM,IAAI,KAAK,CAAC,YAAY;CAwF7C"}