@itwin/core-react 3.4.0-dev.55 → 3.4.0-dev.57

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

@@ -1,123 +1,123 @@
-"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.SettingsManager = exports.ActivateSettingsTabEvent = exports.CloseSettingsContainerEvent = exports.ProcessSettingsContainerCloseEvent = exports.ProcessSettingsTabActivationEvent = exports.SettingsProvidersChangedEvent = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const UiCore_1 = require("../UiCore");
-/** Event class for [[this.onSettingsProvidersChanged]] which is emitted when a new SettingsTabsProvider is added or removed.
- * @public
- */
-class SettingsProvidersChangedEvent extends core_bentley_1.BeUiEvent {
-}
-exports.SettingsProvidersChangedEvent = SettingsProvidersChangedEvent;
-/** 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
- */
-class ProcessSettingsTabActivationEvent extends core_bentley_1.BeUiEvent {
-}
-exports.ProcessSettingsTabActivationEvent = ProcessSettingsTabActivationEvent;
-/** 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
- */
-class ProcessSettingsContainerCloseEvent extends core_bentley_1.BeUiEvent {
-}
-exports.ProcessSettingsContainerCloseEvent = ProcessSettingsContainerCloseEvent;
-/** 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
- */
-class CloseSettingsContainerEvent extends core_bentley_1.BeUiEvent {
-}
-exports.CloseSettingsContainerEvent = CloseSettingsContainerEvent;
-/** Event class for [[this.onActivateSettingsTab]] which is emitted when API call needs to set the active settings tab (ie via Tool key-in).
- * @public
- */
-class ActivateSettingsTabEvent extends core_bentley_1.BeUiEvent {
-}
-exports.ActivateSettingsTabEvent = ActivateSettingsTabEvent;
-/** Settings Manager class. Hold registration of settings providers and supplies events for the provided settings pages to listen.
- * @public
- */
-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 ActivateSettingsTabEvent();
-        /** Event monitored by SettingsContainer to process request to close the settings container.
-         * @internal
-         */
-        this.onCloseSettingsContainer = new CloseSettingsContainerEvent();
-    }
-    /** @public */
-    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 {
-            core_bentley_1.Logger.logInfo(UiCore_1.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;
-    }
-}
-exports.SettingsManager = SettingsManager;
+"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.SettingsManager = exports.ActivateSettingsTabEvent = exports.CloseSettingsContainerEvent = exports.ProcessSettingsContainerCloseEvent = exports.ProcessSettingsTabActivationEvent = exports.SettingsProvidersChangedEvent = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const UiCore_1 = require("../UiCore");
+/** Event class for [[this.onSettingsProvidersChanged]] which is emitted when a new SettingsTabsProvider is added or removed.
+ * @public
+ */
+class SettingsProvidersChangedEvent extends core_bentley_1.BeUiEvent {
+}
+exports.SettingsProvidersChangedEvent = SettingsProvidersChangedEvent;
+/** 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
+ */
+class ProcessSettingsTabActivationEvent extends core_bentley_1.BeUiEvent {
+}
+exports.ProcessSettingsTabActivationEvent = ProcessSettingsTabActivationEvent;
+/** 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
+ */
+class ProcessSettingsContainerCloseEvent extends core_bentley_1.BeUiEvent {
+}
+exports.ProcessSettingsContainerCloseEvent = ProcessSettingsContainerCloseEvent;
+/** 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
+ */
+class CloseSettingsContainerEvent extends core_bentley_1.BeUiEvent {
+}
+exports.CloseSettingsContainerEvent = CloseSettingsContainerEvent;
+/** Event class for [[this.onActivateSettingsTab]] which is emitted when API call needs to set the active settings tab (ie via Tool key-in).
+ * @public
+ */
+class ActivateSettingsTabEvent extends core_bentley_1.BeUiEvent {
+}
+exports.ActivateSettingsTabEvent = ActivateSettingsTabEvent;
+/** Settings Manager class. Hold registration of settings providers and supplies events for the provided settings pages to listen.
+ * @public
+ */
+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 ActivateSettingsTabEvent();
+        /** Event monitored by SettingsContainer to process request to close the settings container.
+         * @internal
+         */
+        this.onCloseSettingsContainer = new CloseSettingsContainerEvent();
+    }
+    /** @public */
+    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 {
+            core_bentley_1.Logger.logInfo(UiCore_1.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;
+    }
+}
+exports.SettingsManager = SettingsManager;
 //# sourceMappingURL=SettingsManager.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"SettingsManager.js","sourceRoot":"","sources":["../../../../src/core-react/settings/SettingsManager.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAwD;AAExD,sCAAmC;AA2BnC;;GAEG;AACH,MAAa,6BAA8B,SAAQ,wBAA4C;CAAI;AAAnG,sEAAmG;AASnG;;;GAGG;AACH,MAAa,iCAAkC,SAAQ,wBAAgD;CAAI;AAA3G,8EAA2G;AAU3G;;;GAGG;AACH,MAAa,kCAAmC,SAAQ,wBAAiD;CAAI;AAA7G,gFAA6G;AAE7G;;GAEG;AACH,MAAa,2BAA4B,SAAQ,wBAAiD;CAAI;AAAtG,kEAAsG;AAUtG;;GAEG;AACH,MAAa,wBAAyB,SAAQ,wBAAuC;CAAI;AAAzF,4DAAyF;AAmBzF;;GAEG;AACH,MAAa,eAAe;IAA5B;QACU,eAAU,GAAwC,EAAE,CAAC;QAE7D;WACG;QACa,+BAA0B,GAAG,IAAI,6BAA6B,EAAE,CAAC;QAEjF;;WAEG;QACa,mCAA8B,GAAG,IAAI,iCAAiC,EAAE,CAAC;QAEzF;;WAEG;QACa,oCAA+B,GAAG,IAAI,kCAAkC,EAAE,CAAC;QAE3F;;WAEG;QACa,0BAAqB,GAAG,IAAI,wBAAwB,EAAE,CAAC;QAEvE;;WAEG;QACa,6BAAwB,GAAG,IAAI,2BAA2B,EAAE,CAAC;IA0D/E,CAAC;IAxDC,cAAc;IACd,IAAW,SAAS,KAA0C,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACvF,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,CAAC,SAA8B,EAAE,aAAmB;QAC/E,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,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAChF,IAAI,CAAC,aAAa,EAAE;YAClB,MAAM,gBAAgB,GAAG;gBACvB,GAAG,IAAI,CAAC,SAAS;gBACjB,gBAAgB;aACjB,CAAC;YACF,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC;SACnC;aAAM;YACL,qBAAM,CAAC,OAAO,CAAC,eAAM,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,gCAAgC,gBAAgB,CAAC,EAAE,8BAA8B,CAAC,CAAC;SAChI;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;YACtD,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC;YAClC,MAAM,GAAG,IAAI,CAAC;SACf;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,mFAAmF;IAC5E,iBAAiB,CAAC,OAAe,EAAE,UAAkB;QAC1D,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;AAnFD,0CAmFC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Settings\r\n */\r\n\r\nimport { BeUiEvent, Logger } from \"@itwin/core-bentley\";\r\nimport { ConditionalBooleanValue } from \"@itwin/appui-abstract\";\r\nimport { UiCore } from \"../UiCore\";\r\n\r\n/** Interface used to populate a tab entry in the SettingContainer control\r\n * @public\r\n */\r\nexport interface SettingsTabEntry {\r\n  /** unique id for entry */\r\n  readonly tabId: string;\r\n  /** localized display label */\r\n  readonly label: string;\r\n  /** Setting page content to display when tab item is selected. */\r\n  readonly page: JSX.Element;\r\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:\r\n   * `settingsManager.onProcessSettingsTabActivation` and `settingsManager.onProcessSettingsContainerClose` */\r\n  readonly pageWillHandleCloseRequest?: boolean;\r\n  /** used to determine position in tablist */\r\n  readonly itemPriority: number;\r\n  /** Optional Subtitle to show below label. */\r\n  readonly subLabel?: string;\r\n  /** Icon specification */\r\n  readonly icon?: string | JSX.Element;\r\n  /** Tooltip. Allows JSX|Element to support react-tooltip component */\r\n  readonly tooltip?: string | JSX.Element;\r\n  /** Allows Settings entry to be disabled */\r\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\r\n}\r\n\r\n/** Event class for [[this.onSettingsProvidersChanged]] which is emitted when a new SettingsTabsProvider is added or removed.\r\n * @public\r\n */\r\nexport class SettingsProvidersChangedEvent extends BeUiEvent<SettingsProvidersChangedEventArgs> { }\r\n\r\n/** Arguments of [[this.onSettingsProvidersChanged]] event.\r\n * @public\r\n */\r\nexport interface SettingsProvidersChangedEventArgs {\r\n  readonly providers: ReadonlyArray<SettingsTabsProvider>;\r\n}\r\n\r\n/** Event class for [[this.onProcessSettingsTabActivation]] which is emitted when a new Tab needs to be activated. This allows the current\r\n * settings page to save its settings before activating the new SettingTab.\r\n * @public\r\n */\r\nexport class ProcessSettingsTabActivationEvent extends BeUiEvent<ProcessSettingsTabActivationEventArgs> { }\r\n\r\n/** Arguments of [[this.onProcessSettingsTabActivation]] event.\r\n * @public\r\n */\r\nexport interface ProcessSettingsTabActivationEventArgs {\r\n  readonly tabSelectionFunc: (tabId: string) => void;\r\n  readonly requestedSettingsTabId: string;\r\n}\r\n\r\n/** Event class for [[this.onProcessSettingsContainerClose]] which is emitted when the settings container will be closed. This allows the current\r\n * settings page to save its settings before calling the function to close the container.\r\n * @public\r\n */\r\nexport class ProcessSettingsContainerCloseEvent extends BeUiEvent<ProcessSettingsContainerCloseEventArgs> { }\r\n\r\n/** Event class for [[this.onCloseSettingsContainer]] which is monitored by the settings container and indicates that some out process want to close the settings container.\r\n * @internal\r\n */\r\nexport class CloseSettingsContainerEvent extends BeUiEvent<ProcessSettingsContainerCloseEventArgs> { }\r\n\r\n/** Arguments of [[this.onProcessSettingsContainerClose]] event.\r\n * @public\r\n */\r\nexport interface ProcessSettingsContainerCloseEventArgs {\r\n  readonly closeFunc: (args: any) => void;\r\n  readonly closeFuncArgs?: any;\r\n}\r\n\r\n/** Event class for [[this.onActivateSettingsTab]] which is emitted when API call needs to set the active settings tab (ie via Tool key-in).\r\n * @public\r\n */\r\nexport class ActivateSettingsTabEvent extends BeUiEvent<ActivateSettingsTabEventArgs> { }\r\n\r\n/** Arguments of [[this.onActivateSettingsTab]] event.\r\n * @public\r\n */\r\nexport interface ActivateSettingsTabEventArgs {\r\n  readonly settingsTabId: string;\r\n}\r\n\r\n/** Setting Provider interface. Implemented by classes that want to supply settings pages for display in the SettingContainer. The\r\n * classes that implement this interface need to be registered with the [[SettingsManager]].\r\n * @public\r\n */\r\nexport interface SettingsTabsProvider {\r\n  /** Id of provider, used to remove registration. */\r\n  readonly id: string;\r\n  getSettingEntries(stageId: string, stageUsage: string): ReadonlyArray<SettingsTabEntry> | undefined;\r\n}\r\n\r\n/** Settings Manager class. Hold registration of settings providers and supplies events for the provided settings pages to listen.\r\n * @public\r\n */\r\nexport class SettingsManager {\r\n  private _providers: ReadonlyArray<SettingsTabsProvider> = [];\r\n\r\n  /** Event raised when SettingsProviders are changed.\r\n   */\r\n  public readonly onSettingsProvidersChanged = new SettingsProvidersChangedEvent();\r\n\r\n  /** Event raised solely for a settings page to monitor so it can save its settings before continuing tab activation.\r\n   * See React hook function `useSaveBeforeActivatingNewSettingsTab`.\r\n   */\r\n  public readonly onProcessSettingsTabActivation = new ProcessSettingsTabActivationEvent();\r\n\r\n  /** Event raised when the settings container will be closed. Any setting page component that is 'modal' should register to\r\n   * listen to this event so that it can save its state before closing. See React hook function `useSaveBeforeClosingSettingsContainer`.\r\n   */\r\n  public readonly onProcessSettingsContainerClose = new ProcessSettingsContainerCloseEvent();\r\n\r\n  /** Event raised to change the active settings tab shown in UI. Monitored by the SettingsContainer.\r\n   * @internal\r\n   */\r\n  public readonly onActivateSettingsTab = new ActivateSettingsTabEvent();\r\n\r\n  /** Event monitored by SettingsContainer to process request to close the settings container.\r\n   * @internal\r\n   */\r\n  public readonly onCloseSettingsContainer = new CloseSettingsContainerEvent();\r\n\r\n  /** @public */\r\n  public get providers(): ReadonlyArray<SettingsTabsProvider> { return this._providers; }\r\n  public set providers(p: ReadonlyArray<SettingsTabsProvider>) {\r\n    this._providers = p;\r\n    this.onSettingsProvidersChanged.emit({ providers: p });\r\n  }\r\n\r\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\r\n   * to save its state.\r\n   */\r\n  public activateSettingsTab(settingsTabId: string) {\r\n    this.onActivateSettingsTab.emit({ settingsTabId });\r\n  }\r\n\r\n  /** Called by application when the Settings Container is to be closed. The function to invoke to actually close the Settings Container is\r\n   * passed in and executed once the active settings tab/page has a chance to save its settings.\r\n   */\r\n  public closeSettingsContainer(closeFunc: (args: any) => void, closeFuncArgs?: any) {\r\n    this.onCloseSettingsContainer.emit({ closeFunc, closeFuncArgs });\r\n  }\r\n\r\n  public addSettingsProvider(settingsProvider: SettingsTabsProvider): void {\r\n    const foundProvider = this._providers.find((p) => p.id === settingsProvider.id);\r\n    if (!foundProvider) {\r\n      const updatedProviders = [\r\n        ...this.providers,\r\n        settingsProvider,\r\n      ];\r\n      this.providers = updatedProviders;\r\n    } else {\r\n      Logger.logInfo(UiCore.loggerCategory(this), `Settings Provider with id of ${settingsProvider.id} has already been registered`);\r\n    }\r\n  }\r\n\r\n  public removeSettingsProvider(providerId: string): boolean {\r\n    let result = false;\r\n    const updatedProviders = this._providers.filter((p) => p.id !== providerId);\r\n    if (updatedProviders.length !== this._providers.length) {\r\n      this.providers = updatedProviders;\r\n      result = true;\r\n    }\r\n\r\n    return result;\r\n  }\r\n\r\n  /** Get an array of SettingsTabEntry objects to populate the settings container. */\r\n  public getSettingEntries(stageId: string, stageUsage: string): Array<SettingsTabEntry> {\r\n    const allSettingEntries: SettingsTabEntry[] = [];\r\n    // Consult the registered SettingsProviders\r\n    this._providers.forEach((p) => {\r\n      const entries = p.getSettingEntries(stageId, stageUsage);\r\n      entries && allSettingEntries.push(...entries);\r\n    });\r\n\r\n    return allSettingEntries;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SettingsManager.js","sourceRoot":"","sources":["../../../../src/core-react/settings/SettingsManager.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAwD;AAExD,sCAAmC;AA2BnC;;GAEG;AACH,MAAa,6BAA8B,SAAQ,wBAA4C;CAAI;AAAnG,sEAAmG;AASnG;;;GAGG;AACH,MAAa,iCAAkC,SAAQ,wBAAgD;CAAI;AAA3G,8EAA2G;AAU3G;;;GAGG;AACH,MAAa,kCAAmC,SAAQ,wBAAiD;CAAI;AAA7G,gFAA6G;AAE7G;;GAEG;AACH,MAAa,2BAA4B,SAAQ,wBAAiD;CAAI;AAAtG,kEAAsG;AAUtG;;GAEG;AACH,MAAa,wBAAyB,SAAQ,wBAAuC;CAAI;AAAzF,4DAAyF;AAmBzF;;GAEG;AACH,MAAa,eAAe;IAA5B;QACU,eAAU,GAAwC,EAAE,CAAC;QAE7D;WACG;QACa,+BAA0B,GAAG,IAAI,6BAA6B,EAAE,CAAC;QAEjF;;WAEG;QACa,mCAA8B,GAAG,IAAI,iCAAiC,EAAE,CAAC;QAEzF;;WAEG;QACa,oCAA+B,GAAG,IAAI,kCAAkC,EAAE,CAAC;QAE3F;;WAEG;QACa,0BAAqB,GAAG,IAAI,wBAAwB,EAAE,CAAC;QAEvE;;WAEG;QACa,6BAAwB,GAAG,IAAI,2BAA2B,EAAE,CAAC;IA0D/E,CAAC;IAxDC,cAAc;IACd,IAAW,SAAS,KAA0C,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACvF,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,CAAC,SAA8B,EAAE,aAAmB;QAC/E,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,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAChF,IAAI,CAAC,aAAa,EAAE;YAClB,MAAM,gBAAgB,GAAG;gBACvB,GAAG,IAAI,CAAC,SAAS;gBACjB,gBAAgB;aACjB,CAAC;YACF,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC;SACnC;aAAM;YACL,qBAAM,CAAC,OAAO,CAAC,eAAM,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,gCAAgC,gBAAgB,CAAC,EAAE,8BAA8B,CAAC,CAAC;SAChI;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;YACtD,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC;YAClC,MAAM,GAAG,IAAI,CAAC;SACf;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,mFAAmF;IAC5E,iBAAiB,CAAC,OAAe,EAAE,UAAkB;QAC1D,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;AAnFD,0CAmFC","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 { ConditionalBooleanValue } from \"@itwin/appui-abstract\";\nimport { UiCore } from \"../UiCore\";\n\n/** Interface used to populate a tab entry in the SettingContainer control\n * @public\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: JSX.Element;\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 | JSX.Element;\n  /** Tooltip. Allows JSX|Element to support react-tooltip component */\n  readonly tooltip?: string | JSX.Element;\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 */\nexport class SettingsProvidersChangedEvent extends BeUiEvent<SettingsProvidersChangedEventArgs> { }\n\n/** Arguments of [[this.onSettingsProvidersChanged]] event.\n * @public\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 */\nexport class ProcessSettingsTabActivationEvent extends BeUiEvent<ProcessSettingsTabActivationEventArgs> { }\n\n/** Arguments of [[this.onProcessSettingsTabActivation]] event.\n * @public\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 */\nexport class ProcessSettingsContainerCloseEvent extends BeUiEvent<ProcessSettingsContainerCloseEventArgs> { }\n\n/** Event class for [[this.onCloseSettingsContainer]] which is monitored by the settings container and indicates that some out process want to close the settings container.\n * @internal\n */\nexport class CloseSettingsContainerEvent extends BeUiEvent<ProcessSettingsContainerCloseEventArgs> { }\n\n/** Arguments of [[this.onProcessSettingsContainerClose]] event.\n * @public\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 */\nexport class ActivateSettingsTabEvent extends BeUiEvent<ActivateSettingsTabEventArgs> { }\n\n/** Arguments of [[this.onActivateSettingsTab]] event.\n * @public\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 */\nexport interface SettingsTabsProvider {\n  /** Id of provider, used to remove registration. */\n  readonly id: string;\n  getSettingEntries(stageId: string, stageUsage: string): 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 */\nexport class SettingsManager {\n  private _providers: ReadonlyArray<SettingsTabsProvider> = [];\n\n  /** Event raised when SettingsProviders are changed.\n   */\n  public readonly onSettingsProvidersChanged = 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 = 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 = 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 = new ActivateSettingsTabEvent();\n\n  /** Event monitored by SettingsContainer to process request to close the settings container.\n   * @internal\n   */\n  public readonly onCloseSettingsContainer = new CloseSettingsContainerEvent();\n\n  /** @public */\n  public get providers(): ReadonlyArray<SettingsTabsProvider> { return this._providers; }\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(closeFunc: (args: any) => void, closeFuncArgs?: any) {\n    this.onCloseSettingsContainer.emit({ closeFunc, closeFuncArgs });\n  }\n\n  public addSettingsProvider(settingsProvider: SettingsTabsProvider): void {\n    const foundProvider = this._providers.find((p) => p.id === settingsProvider.id);\n    if (!foundProvider) {\n      const updatedProviders = [\n        ...this.providers,\n        settingsProvider,\n      ];\n      this.providers = updatedProviders;\n    } else {\n      Logger.logInfo(UiCore.loggerCategory(this), `Settings Provider with id of ${settingsProvider.id} has already been registered`);\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(stageId: string, stageUsage: string): 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/cjs/core-react/slider/Slider.d.ts

@@ -1,80 +1,80 @@
-/** @packageDocumentation
- * @module Slider
- */
-import "./Slider.scss";
-import * as React from "react";
-import { CommonProps } from "../utils/Props";
-/** Properties for [[Slider]] component
-  * @public
-  */
-export interface SliderProps extends CommonProps {
-    /** Values to set Slider to initially */
-    values: number[];
-    /** Minimum value */
-    min: number;
-    /** Maximum value */
-    max: number;
-    /** Format the min display value */
-    formatMin?: (value: number) => string;
-    /** Format the max display value */
-    formatMax?: (value: number) => string;
-    /** Step value. Default is 0.1. */
-    step?: number;
-    /** The interaction mode. Default is 1. Possible values:
-      * 1 - allows handles to cross each other.
-      * 2 - keeps the sliders from crossing and separated by a step.
-      */
-    mode?: number | (() => number);
-    /** Indicates whether the display of the Slider values is reversed. */
-    reversed?: boolean;
-    /** Indicates whether the Slider is disabled. */
-    disabled?: boolean;
-    /** Indicates whether to compensate for the tick marks when determining the width. */
-    includeTicksInWidth?: boolean;
-    /** Indicates whether to show tooltip with the value. The tooltip will be positioned above the Slider, by default. */
-    showTooltip?: boolean;
-    /** Indicates whether the tooltip should show below the Slider instead of above. */
-    tooltipBelow?: boolean;
-    /** Format a value for the tooltip */
-    formatTooltip?: (value: number) => string;
-    /** Indicates whether to show min & max values to the left & right of the Slider. */
-    showMinMax?: boolean;
-    /** Image to show for min. */
-    minImage?: React.ReactNode;
-    /** Image to show for max. */
-    maxImage?: React.ReactNode;
-    /** Indicates whether to show tick marks under the Slider. */
-    showTicks?: boolean;
-    /** Indicates whether to show tick labels under the tick marks. */
-    showTickLabels?: boolean;
-    /** Format a tick mark value */
-    formatTick?: (tick: number) => string;
-    /** Function to get the tick count. The default tick count is 10. */
-    getTickCount?: () => number;
-    /** Function to get the tick values. This overrides the tick count from getTickCount.
-      * Use this prop if you want to specify your own tick values instead of ticks generated by the slider.
-      * The numbers should be valid numbers in the domain and correspond to the step value.
-      * Invalid values will be coerced to the closet matching value in the domain.
-      */
-    getTickValues?: () => number[];
-    /** Listens for value changes.
-      * Triggered when the value of the slider has changed. This will receive changes at
-      * the end of a slide as well as changes from clicks on rails and tracks.
-      */
-    onChange?: (values: ReadonlyArray<number>) => void;
-    /** Listens for value updates.
-      *  Called with the values at each update (caution: high-volume updates when dragging).
-      */
-    onUpdate?: (values: ReadonlyArray<number>) => void;
-    /** No longer available use onUpdate. */
-    onSlideStart?: (values: ReadonlyArray<number>) => void;
-    /** No longer available use onChange. */
-    onSlideEnd?: (values: ReadonlyArray<number>) => void;
-}
-/**
-  * Slider React component displays a range slider.
-  * @public
-  * @deprecated Use Slider in itwinui-react instead
-  */
-export declare function Slider(props: SliderProps): JSX.Element;
+/** @packageDocumentation
+ * @module Slider
+ */
+import "./Slider.scss";
+import * as React from "react";
+import { CommonProps } from "../utils/Props";
+/** Properties for [[Slider]] component
+  * @public
+  */
+export interface SliderProps extends CommonProps {
+    /** Values to set Slider to initially */
+    values: number[];
+    /** Minimum value */
+    min: number;
+    /** Maximum value */
+    max: number;
+    /** Format the min display value */
+    formatMin?: (value: number) => string;
+    /** Format the max display value */
+    formatMax?: (value: number) => string;
+    /** Step value. Default is 0.1. */
+    step?: number;
+    /** The interaction mode. Default is 1. Possible values:
+      * 1 - allows handles to cross each other.
+      * 2 - keeps the sliders from crossing and separated by a step.
+      */
+    mode?: number | (() => number);
+    /** Indicates whether the display of the Slider values is reversed. */
+    reversed?: boolean;
+    /** Indicates whether the Slider is disabled. */
+    disabled?: boolean;
+    /** Indicates whether to compensate for the tick marks when determining the width. */
+    includeTicksInWidth?: boolean;
+    /** Indicates whether to show tooltip with the value. The tooltip will be positioned above the Slider, by default. */
+    showTooltip?: boolean;
+    /** Indicates whether the tooltip should show below the Slider instead of above. */
+    tooltipBelow?: boolean;
+    /** Format a value for the tooltip */
+    formatTooltip?: (value: number) => string;
+    /** Indicates whether to show min & max values to the left & right of the Slider. */
+    showMinMax?: boolean;
+    /** Image to show for min. */
+    minImage?: React.ReactNode;
+    /** Image to show for max. */
+    maxImage?: React.ReactNode;
+    /** Indicates whether to show tick marks under the Slider. */
+    showTicks?: boolean;
+    /** Indicates whether to show tick labels under the tick marks. */
+    showTickLabels?: boolean;
+    /** Format a tick mark value */
+    formatTick?: (tick: number) => string;
+    /** Function to get the tick count. The default tick count is 10. */
+    getTickCount?: () => number;
+    /** Function to get the tick values. This overrides the tick count from getTickCount.
+      * Use this prop if you want to specify your own tick values instead of ticks generated by the slider.
+      * The numbers should be valid numbers in the domain and correspond to the step value.
+      * Invalid values will be coerced to the closet matching value in the domain.
+      */
+    getTickValues?: () => number[];
+    /** Listens for value changes.
+      * Triggered when the value of the slider has changed. This will receive changes at
+      * the end of a slide as well as changes from clicks on rails and tracks.
+      */
+    onChange?: (values: ReadonlyArray<number>) => void;
+    /** Listens for value updates.
+      *  Called with the values at each update (caution: high-volume updates when dragging).
+      */
+    onUpdate?: (values: ReadonlyArray<number>) => void;
+    /** No longer available use onUpdate. */
+    onSlideStart?: (values: ReadonlyArray<number>) => void;
+    /** No longer available use onChange. */
+    onSlideEnd?: (values: ReadonlyArray<number>) => void;
+}
+/**
+  * Slider React component displays a range slider.
+  * @public
+  * @deprecated Use Slider in itwinui-react instead
+  */
+export declare function Slider(props: SliderProps): JSX.Element;
 //# sourceMappingURL=Slider.d.ts.map