@itwin/core-react 4.0.0-dev.12 → 4.0.0-dev.14

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

@@ -1,122 +1,122 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SettingsContainer = exports.useSaveBeforeActivatingNewSettingsTab = exports.useSaveBeforeClosingSettingsContainer = void 0;
-require("./SettingsContainer.scss");
-const React = require("react");
-const VerticalTabs_1 = require("../tabs/VerticalTabs");
-const appui_abstract_1 = require("@itwin/appui-abstract");
-/*  ---------------------------------------------------------------------------------------------------
-// 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
- */
-function useSaveBeforeClosingSettingsContainer(settingsManager, saveFunction) {
-    React.useEffect(() => {
-        const handleProcessSettingsContainerClose = ({ closeFunc, closeFuncArgs }) => {
-            saveFunction(closeFunc, closeFuncArgs);
-        };
-        return settingsManager.onProcessSettingsContainerClose.addListener(handleProcessSettingsContainerClose);
-    }, [saveFunction, settingsManager]);
-}
-exports.useSaveBeforeClosingSettingsContainer = useSaveBeforeClosingSettingsContainer;
-/** 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
- */
-function useSaveBeforeActivatingNewSettingsTab(settingsManager, saveFunction) {
-    React.useEffect(() => {
-        const handleProcessSettingsTabActivation = ({ tabSelectionFunc, requestedSettingsTabId }) => {
-            saveFunction(tabSelectionFunc, requestedSettingsTabId);
-        };
-        return settingsManager.onProcessSettingsTabActivation.addListener(handleProcessSettingsTabActivation);
-    }, [saveFunction, settingsManager]);
-}
-exports.useSaveBeforeActivatingNewSettingsTab = useSaveBeforeActivatingNewSettingsTab;
-/**
- * SettingsContainer component that displays Setting Tabs on Left and the P
- * Note: that SettingsContainer is not rendered if tabs array is empty
- * @public
- */
-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 && !appui_abstract_1.ConditionalBooleanValue.getValue(currentSettingsTab.isDisabled))
-            return currentSettingsTab;
-        else
-            return tabs[0];
-    });
-    const processTabSelection = React.useCallback((tab) => {
-        if (appui_abstract_1.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(() => {
-        const handleActivateSettingsTab = ({ settingsTabId }) => {
-            const idToFind = settingsTabId.toLowerCase();
-            let tabToActivate = tabs.find((tab) => tab.tabId.toLowerCase() === idToFind);
-            if (!tabToActivate)
-                tabToActivate = tabs.find((tab) => tab.label.toLowerCase() === idToFind);
-            // istanbul ignore else
-            if (tabToActivate) {
-                if (openTab && openTab.pageWillHandleCloseRequest)
-                    settingsManager.onProcessSettingsTabActivation.emit({ requestedSettingsTabId: tabToActivate.tabId, tabSelectionFunc: processTabSelectionById });
-                else
-                    processTabSelection(tabToActivate);
-            }
-        };
-        return settingsManager.onActivateSettingsTab.addListener(handleActivateSettingsTab);
-    }, [openTab, processTabSelection, processTabSelectionById, settingsManager, settingsManager.onActivateSettingsTab, tabs]);
-    React.useEffect(() => {
-        const handleSettingsContainerClose = ({ closeFunc, closeFuncArgs }) => {
-            if (openTab && openTab.pageWillHandleCloseRequest)
-                settingsManager.onProcessSettingsContainerClose.emit({ closeFunc, closeFuncArgs });
-            else
-                closeFunc(closeFuncArgs);
-        };
-        return settingsManager.onCloseSettingsContainer.addListener(handleSettingsContainerClose);
-    }, [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: appui_abstract_1.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_1.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))));
-};
-exports.SettingsContainer = SettingsContainer;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SettingsContainer = exports.useSaveBeforeActivatingNewSettingsTab = exports.useSaveBeforeClosingSettingsContainer = void 0;
+require("./SettingsContainer.scss");
+const React = require("react");
+const VerticalTabs_1 = require("../tabs/VerticalTabs");
+const appui_abstract_1 = require("@itwin/appui-abstract");
+/*  ---------------------------------------------------------------------------------------------------
+// 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
+ */
+function useSaveBeforeClosingSettingsContainer(settingsManager, saveFunction) {
+    React.useEffect(() => {
+        const handleProcessSettingsContainerClose = ({ closeFunc, closeFuncArgs }) => {
+            saveFunction(closeFunc, closeFuncArgs);
+        };
+        return settingsManager.onProcessSettingsContainerClose.addListener(handleProcessSettingsContainerClose);
+    }, [saveFunction, settingsManager]);
+}
+exports.useSaveBeforeClosingSettingsContainer = useSaveBeforeClosingSettingsContainer;
+/** 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
+ */
+function useSaveBeforeActivatingNewSettingsTab(settingsManager, saveFunction) {
+    React.useEffect(() => {
+        const handleProcessSettingsTabActivation = ({ tabSelectionFunc, requestedSettingsTabId }) => {
+            saveFunction(tabSelectionFunc, requestedSettingsTabId);
+        };
+        return settingsManager.onProcessSettingsTabActivation.addListener(handleProcessSettingsTabActivation);
+    }, [saveFunction, settingsManager]);
+}
+exports.useSaveBeforeActivatingNewSettingsTab = useSaveBeforeActivatingNewSettingsTab;
+/**
+ * SettingsContainer component that displays Setting Tabs on Left and the P
+ * Note: that SettingsContainer is not rendered if tabs array is empty
+ * @public
+ */
+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 && !appui_abstract_1.ConditionalBooleanValue.getValue(currentSettingsTab.isDisabled))
+            return currentSettingsTab;
+        else
+            return tabs[0];
+    });
+    const processTabSelection = React.useCallback((tab) => {
+        if (appui_abstract_1.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(() => {
+        const handleActivateSettingsTab = ({ settingsTabId }) => {
+            const idToFind = settingsTabId.toLowerCase();
+            let tabToActivate = tabs.find((tab) => tab.tabId.toLowerCase() === idToFind);
+            if (!tabToActivate)
+                tabToActivate = tabs.find((tab) => tab.label.toLowerCase() === idToFind);
+            // istanbul ignore else
+            if (tabToActivate) {
+                if (openTab && openTab.pageWillHandleCloseRequest)
+                    settingsManager.onProcessSettingsTabActivation.emit({ requestedSettingsTabId: tabToActivate.tabId, tabSelectionFunc: processTabSelectionById });
+                else
+                    processTabSelection(tabToActivate);
+            }
+        };
+        return settingsManager.onActivateSettingsTab.addListener(handleActivateSettingsTab);
+    }, [openTab, processTabSelection, processTabSelectionById, settingsManager, settingsManager.onActivateSettingsTab, tabs]);
+    React.useEffect(() => {
+        const handleSettingsContainerClose = ({ closeFunc, closeFuncArgs }) => {
+            if (openTab && openTab.pageWillHandleCloseRequest)
+                settingsManager.onProcessSettingsContainerClose.emit({ closeFunc, closeFuncArgs });
+            else
+                closeFunc(closeFuncArgs);
+        };
+        return settingsManager.onCloseSettingsContainer.addListener(handleSettingsContainerClose);
+    }, [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: appui_abstract_1.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_1.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))));
+};
+exports.SettingsContainer = SettingsContainer;
 //# sourceMappingURL=SettingsContainer.js.map

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

@@ -1,133 +1,133 @@
-/** @packageDocumentation
- * @module Settings
- */
-/// <reference types="react" />
-import { BeUiEvent } from "@itwin/core-bentley";
-import { ConditionalBooleanValue } from "@itwin/appui-abstract";
-/** Interface used to populate a tab entry in the SettingContainer control
- * @public
- */
-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: JSX.Element;
-    /** 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 | JSX.Element;
-    /** Tooltip. Allows JSX|Element to support react-tooltip component */
-    readonly tooltip?: string | JSX.Element;
-    /** 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
- */
-export declare class SettingsProvidersChangedEvent extends BeUiEvent<SettingsProvidersChangedEventArgs> {
-}
-/** Arguments of [[this.onSettingsProvidersChanged]] event.
- * @public
- */
-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
- */
-export declare class ProcessSettingsTabActivationEvent extends BeUiEvent<ProcessSettingsTabActivationEventArgs> {
-}
-/** Arguments of [[this.onProcessSettingsTabActivation]] event.
- * @public
- */
-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
- */
-export declare class ProcessSettingsContainerCloseEvent extends BeUiEvent<ProcessSettingsContainerCloseEventArgs> {
-}
-/** Event class for [[this.onCloseSettingsContainer]] which is monitored by the settings container and indicates that some out process want to close the settings container.
- * @internal
- */
-export declare class CloseSettingsContainerEvent extends BeUiEvent<ProcessSettingsContainerCloseEventArgs> {
-}
-/** Arguments of [[this.onProcessSettingsContainerClose]] event.
- * @public
- */
-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
- */
-export declare class ActivateSettingsTabEvent extends BeUiEvent<ActivateSettingsTabEventArgs> {
-}
-/** Arguments of [[this.onActivateSettingsTab]] event.
- * @public
- */
-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
- */
-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
- */
-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: ActivateSettingsTabEvent;
-    /** Event monitored by SettingsContainer to process request to close the settings container.
-     * @internal
-     */
-    readonly onCloseSettingsContainer: CloseSettingsContainerEvent;
-    /** @public */
-    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>;
-}
+/** @packageDocumentation
+ * @module Settings
+ */
+/// <reference types="react" />
+import { BeUiEvent } from "@itwin/core-bentley";
+import { ConditionalBooleanValue } from "@itwin/appui-abstract";
+/** Interface used to populate a tab entry in the SettingContainer control
+ * @public
+ */
+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: JSX.Element;
+    /** 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 | JSX.Element;
+    /** Tooltip. Allows JSX|Element to support react-tooltip component */
+    readonly tooltip?: string | JSX.Element;
+    /** 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
+ */
+export declare class SettingsProvidersChangedEvent extends BeUiEvent<SettingsProvidersChangedEventArgs> {
+}
+/** Arguments of [[this.onSettingsProvidersChanged]] event.
+ * @public
+ */
+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
+ */
+export declare class ProcessSettingsTabActivationEvent extends BeUiEvent<ProcessSettingsTabActivationEventArgs> {
+}
+/** Arguments of [[this.onProcessSettingsTabActivation]] event.
+ * @public
+ */
+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
+ */
+export declare class ProcessSettingsContainerCloseEvent extends BeUiEvent<ProcessSettingsContainerCloseEventArgs> {
+}
+/** Event class for [[this.onCloseSettingsContainer]] which is monitored by the settings container and indicates that some out process want to close the settings container.
+ * @internal
+ */
+export declare class CloseSettingsContainerEvent extends BeUiEvent<ProcessSettingsContainerCloseEventArgs> {
+}
+/** Arguments of [[this.onProcessSettingsContainerClose]] event.
+ * @public
+ */
+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
+ */
+export declare class ActivateSettingsTabEvent extends BeUiEvent<ActivateSettingsTabEventArgs> {
+}
+/** Arguments of [[this.onActivateSettingsTab]] event.
+ * @public
+ */
+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
+ */
+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
+ */
+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: ActivateSettingsTabEvent;
+    /** Event monitored by SettingsContainer to process request to close the settings container.
+     * @internal
+     */
+    readonly onCloseSettingsContainer: CloseSettingsContainerEvent;
+    /** @public */
+    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