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

package/lib/cjs/appui-react/configurableui/ConfigurableUiControl.js

@@ -1,96 +1,96 @@
-"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 ConfigurableUi
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigurableUiControl = exports.ConfigurableUiControlType = exports.ConfigurableBase = exports.ConfigurableCreateInfo = void 0;
-/** Information for creating a ConfigurableUi element
- * @public
- */
-class ConfigurableCreateInfo {
-    constructor(classId, uniqueId, id) {
-        this.classId = classId;
-        this.uniqueId = uniqueId;
-        this.id = id;
-    }
-}
-exports.ConfigurableCreateInfo = ConfigurableCreateInfo;
-/** The base class for all ConfigurableUi elements
- * @public
- */
-class ConfigurableBase {
-    constructor(info, options) {
-        this._uniqueId = info.uniqueId;
-        this._classId = info.classId;
-        this._name = (options && options.hasOwnProperty("name")) ? options.name : info.uniqueId;
-        this._appDataOptions = options;
-    }
-    /** @internal */
-    get uniqueId() { return this._uniqueId; }
-    /** allow options set via appData to be seen by API calls */
-    get applicationData() { return this._appDataOptions; }
-    /** Gets the class Id of configurable element */
-    get classId() { return this._classId; }
-    /** Get internal name of configurable element. If no name is defined in configuration
-     * then the name will match the UniqueId.
-     */
-    get name() { return this._name; }
-}
-exports.ConfigurableBase = ConfigurableBase;
-/** The type of the ConfigurableUiControl.
- * @public
- */
-var ConfigurableUiControlType;
-(function (ConfigurableUiControlType) {
-    ConfigurableUiControlType["Content"] = "ContentControl";
-    ConfigurableUiControlType["NavigationAid"] = "NavigationAidControl";
-    ConfigurableUiControlType["StatusBarWidget"] = "StatusBarWidgetControl";
-    ConfigurableUiControlType["ToolUiProvider"] = "ToolUiProvider";
-    ConfigurableUiControlType["Viewport"] = "ViewportContentControl";
-    ConfigurableUiControlType["Widget"] = "WidgetControl";
-})(ConfigurableUiControlType = exports.ConfigurableUiControlType || (exports.ConfigurableUiControlType = {}));
-/** The abstract base class for all Frontstage controls.
- * @public
- *
- * @note This is an abstract class which should not be derived from by the applications.
- * Instead, applications should derive from one of
- * [[ContentControl]],
- * [[ViewportContentControl]],
- * [[WidgetControl]],
- * [[StatusBarWidgetControl]] or
- * [[NavigationAidControl]].
- */
-class ConfigurableUiControl extends ConfigurableBase {
-    /** Creates an instance of ConfigurableUiControl.
-     * @param info         An object that the subclass must pass to this base class.
-     * @param options      Options provided to the control
-     * @note Subclasses must pass all arguments to the base class and not add themselves
-     * to any container - the control is added automatically.
-     * @protected
-     */
-    constructor(info, options) {
-        super(info, options);
-        this._cid = info.id;
-    }
-    /** @internal
-     */
-    initialize() { this.onInitialize(); }
-    /** Called to initialize the ConfigurableUiControl. */
-    onInitialize() { }
-    /** Called when Frontstage is deactivated. */
-    onFrontstageDeactivated() { }
-    /** Called when Frontstage is ready. */
-    onFrontstageReady() { }
-    /** Returns the ID of this ConfigurableUiControl.
-     */
-    get controlId() { return this._cid; }
-    /** Returns a promise that resolves when the control is ready for usage.
-     */
-    get isReady() { return Promise.resolve(); }
-}
-exports.ConfigurableUiControl = ConfigurableUiControl;
+"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 ConfigurableUi
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigurableUiControl = exports.ConfigurableUiControlType = exports.ConfigurableBase = exports.ConfigurableCreateInfo = void 0;
+/** Information for creating a ConfigurableUi element
+ * @public
+ */
+class ConfigurableCreateInfo {
+    constructor(classId, uniqueId, id) {
+        this.classId = classId;
+        this.uniqueId = uniqueId;
+        this.id = id;
+    }
+}
+exports.ConfigurableCreateInfo = ConfigurableCreateInfo;
+/** The base class for all ConfigurableUi elements
+ * @public
+ */
+class ConfigurableBase {
+    constructor(info, options) {
+        this._uniqueId = info.uniqueId;
+        this._classId = info.classId;
+        this._name = (options && options.hasOwnProperty("name")) ? options.name : info.uniqueId;
+        this._appDataOptions = options;
+    }
+    /** @internal */
+    get uniqueId() { return this._uniqueId; }
+    /** allow options set via appData to be seen by API calls */
+    get applicationData() { return this._appDataOptions; }
+    /** Gets the class Id of configurable element */
+    get classId() { return this._classId; }
+    /** Get internal name of configurable element. If no name is defined in configuration
+     * then the name will match the UniqueId.
+     */
+    get name() { return this._name; }
+}
+exports.ConfigurableBase = ConfigurableBase;
+/** The type of the ConfigurableUiControl.
+ * @public
+ */
+var ConfigurableUiControlType;
+(function (ConfigurableUiControlType) {
+    ConfigurableUiControlType["Content"] = "ContentControl";
+    ConfigurableUiControlType["NavigationAid"] = "NavigationAidControl";
+    ConfigurableUiControlType["StatusBarWidget"] = "StatusBarWidgetControl";
+    ConfigurableUiControlType["ToolUiProvider"] = "ToolUiProvider";
+    ConfigurableUiControlType["Viewport"] = "ViewportContentControl";
+    ConfigurableUiControlType["Widget"] = "WidgetControl";
+})(ConfigurableUiControlType = exports.ConfigurableUiControlType || (exports.ConfigurableUiControlType = {}));
+/** The abstract base class for all Frontstage controls.
+ * @public
+ *
+ * @note This is an abstract class which should not be derived from by the applications.
+ * Instead, applications should derive from one of
+ * [[ContentControl]],
+ * [[ViewportContentControl]],
+ * [[WidgetControl]],
+ * [[StatusBarWidgetControl]] or
+ * [[NavigationAidControl]].
+ */
+class ConfigurableUiControl extends ConfigurableBase {
+    /** Creates an instance of ConfigurableUiControl.
+     * @param info         An object that the subclass must pass to this base class.
+     * @param options      Options provided to the control
+     * @note Subclasses must pass all arguments to the base class and not add themselves
+     * to any container - the control is added automatically.
+     * @protected
+     */
+    constructor(info, options) {
+        super(info, options);
+        this._cid = info.id;
+    }
+    /** @internal
+     */
+    initialize() { this.onInitialize(); }
+    /** Called to initialize the ConfigurableUiControl. */
+    onInitialize() { }
+    /** Called when Frontstage is deactivated. */
+    onFrontstageDeactivated() { }
+    /** Called when Frontstage is ready. */
+    onFrontstageReady() { }
+    /** Returns the ID of this ConfigurableUiControl.
+     */
+    get controlId() { return this._cid; }
+    /** Returns a promise that resolves when the control is ready for usage.
+     */
+    get isReady() { return Promise.resolve(); }
+}
+exports.ConfigurableUiControl = ConfigurableUiControl;
 //# sourceMappingURL=ConfigurableUiControl.js.map

package/lib/cjs/appui-react/configurableui/ConfigurableUiManager.d.ts

@@ -1,66 +1,66 @@
-/** @packageDocumentation
- * @module ConfigurableUi
- */
-import { FrontstageProvider } from "../frontstage/FrontstageProvider";
-import { KeyboardShortcutProps } from "../framework/FrameworkKeyboardShortcuts";
-import { ConfigurableUiControlConstructor, ConfigurableUiElement } from "./ConfigurableUiControl";
-/** Configurable Ui Manager maintains controls, Frontstages, Content Groups, Content Layouts, Tasks and Workflows.
- * @public
- * @deprecated in 3.7. Use `UiFramework.controls` property.
- */
-export declare class ConfigurableUiManager {
-    /** Initializes the InternalConfigurableUiManager and registers core controls.
-     * @deprecated in 3.7. This is called internally.
-    */
-    static initialize(): void;
-    /** Registers a control implementing the [[ConfigurableUiElement]] interface.
-     * These controls can be a
-     * [[ContentControl]],
-     * [[NavigationAidControl]],
-     * [[StatusBarWidgetControl]],
-     * [[WidgetControl]] or
-     * [ToolUiProvider]($appui-react).
-     * @param classId the class id of the control to register
-     * @param constructor the constructor of the control to register
-     * @deprecated in 3.7. Use `register` method.
-     */
-    static registerControl(classId: string, constructor: ConfigurableUiControlConstructor): void;
-    /** Determines if a control has been registered based on its classId.
-     * @param classId   the class id of the control to test
-     * @returns  true if the control is registered or false if not
-     */
-    static isControlRegistered(classId: string): boolean;
-    /** Determines if a control has been registered.
-     * @internal
-     */
-    static getConstructorClassId(constructor: ConfigurableUiControlConstructor): string | undefined;
-    /** Unregisters a control that has been registered.
-     * @param classId   the class id of the control to unregister
-     * @deprecated in 3.7. Use `unregister` method.
-     */
-    static unregisterControl(classId: string): void;
-    /** Creates a control registered by calling registerControl.
-     * @param classId   the class id of the control to create
-     * @param uniqueId  a unique id for the control
-     * @param options   options passed to the constructor of the control
-     * @param controlId controlId which may not be unique across all control instances.
-     * @returns  the created control
-     * @deprecated in 3.7. Use `create` method.
-     */
-    static createControl(classId: string, uniqueId: string, options?: any, controlId?: string): ConfigurableUiElement | undefined;
-    /** Add a Frontstage via a provider into the [[FrontstageManager]].
-     * @param frontstageProvider  Provider of the Frontstage to add
-     * @deprecated in 3.7. Use `UiFramework.frontstages.addFrontstageProvider` method.
-     */
-    static addFrontstageProvider(frontstageProvider: FrontstageProvider): void;
-    /** Loads one or more Keyboard Shortcuts into the [[KeyboardShortcutManager]].
-     * @param shortcutList  the properties of the Keyboard Shortcuts to load
-     * @deprecated in 3.7. Use `UiFramework.keyboardShortcuts.loadShortcuts` method.
-     */
-    static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]): void;
-    /** Gets the HTML wrapper element for Configurable UI */
-    static getWrapperElement(): HTMLElement;
-    /** Closes all UI popups currently open */
-    static closeUi(): void;
-}
+/** @packageDocumentation
+ * @module ConfigurableUi
+ */
+import { FrontstageProvider } from "../frontstage/FrontstageProvider";
+import { KeyboardShortcutProps } from "../framework/FrameworkKeyboardShortcuts";
+import { ConfigurableUiControlConstructor, ConfigurableUiElement } from "./ConfigurableUiControl";
+/** Configurable Ui Manager maintains controls, Frontstages, Content Groups, Content Layouts, Tasks and Workflows.
+ * @public
+ * @deprecated in 3.7. Use `UiFramework.controls` property.
+ */
+export declare class ConfigurableUiManager {
+    /** Initializes the InternalConfigurableUiManager and registers core controls.
+     * @deprecated in 3.7. This is called internally.
+    */
+    static initialize(): void;
+    /** Registers a control implementing the [[ConfigurableUiElement]] interface.
+     * These controls can be a
+     * [[ContentControl]],
+     * [[NavigationAidControl]],
+     * [[StatusBarWidgetControl]],
+     * [[WidgetControl]] or
+     * [ToolUiProvider]($appui-react).
+     * @param classId the class id of the control to register
+     * @param constructor the constructor of the control to register
+     * @deprecated in 3.7. Use `register` method.
+     */
+    static registerControl(classId: string, constructor: ConfigurableUiControlConstructor): void;
+    /** Determines if a control has been registered based on its classId.
+     * @param classId   the class id of the control to test
+     * @returns  true if the control is registered or false if not
+     */
+    static isControlRegistered(classId: string): boolean;
+    /** Determines if a control has been registered.
+     * @internal
+     */
+    static getConstructorClassId(constructor: ConfigurableUiControlConstructor): string | undefined;
+    /** Unregisters a control that has been registered.
+     * @param classId   the class id of the control to unregister
+     * @deprecated in 3.7. Use `unregister` method.
+     */
+    static unregisterControl(classId: string): void;
+    /** Creates a control registered by calling registerControl.
+     * @param classId   the class id of the control to create
+     * @param uniqueId  a unique id for the control
+     * @param options   options passed to the constructor of the control
+     * @param controlId controlId which may not be unique across all control instances.
+     * @returns  the created control
+     * @deprecated in 3.7. Use `create` method.
+     */
+    static createControl(classId: string, uniqueId: string, options?: any, controlId?: string): ConfigurableUiElement | undefined;
+    /** Add a Frontstage via a provider into the [[FrontstageManager]].
+     * @param frontstageProvider  Provider of the Frontstage to add
+     * @deprecated in 3.7. Use `UiFramework.frontstages.addFrontstageProvider` method.
+     */
+    static addFrontstageProvider(frontstageProvider: FrontstageProvider): void;
+    /** Loads one or more Keyboard Shortcuts into the [[KeyboardShortcutManager]].
+     * @param shortcutList  the properties of the Keyboard Shortcuts to load
+     * @deprecated in 3.7. Use `UiFramework.keyboardShortcuts.loadShortcuts` method.
+     */
+    static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]): void;
+    /** Gets the HTML wrapper element for Configurable UI */
+    static getWrapperElement(): HTMLElement;
+    /** Closes all UI popups currently open */
+    static closeUi(): void;
+}
 //# sourceMappingURL=ConfigurableUiManager.d.ts.map

package/lib/cjs/appui-react/configurableui/ConfigurableUiManager.js

@@ -1,93 +1,93 @@
-"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 ConfigurableUi
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigurableUiManager = void 0;
-const UiFramework_1 = require("../UiFramework");
-const InternalConfigurableUiManager_1 = require("./InternalConfigurableUiManager");
-/** Configurable Ui Manager maintains controls, Frontstages, Content Groups, Content Layouts, Tasks and Workflows.
- * @public
- * @deprecated in 3.7. Use `UiFramework.controls` property.
- */
-class ConfigurableUiManager {
-    /** Initializes the InternalConfigurableUiManager and registers core controls.
-     * @deprecated in 3.7. This is called internally.
-    */
-    static initialize() {
-        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.initialize();
-    }
-    /** Registers a control implementing the [[ConfigurableUiElement]] interface.
-     * These controls can be a
-     * [[ContentControl]],
-     * [[NavigationAidControl]],
-     * [[StatusBarWidgetControl]],
-     * [[WidgetControl]] or
-     * [ToolUiProvider]($appui-react).
-     * @param classId the class id of the control to register
-     * @param constructor the constructor of the control to register
-     * @deprecated in 3.7. Use `register` method.
-     */
-    static registerControl(classId, constructor) {
-        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.register(classId, constructor);
-    }
-    /** Determines if a control has been registered based on its classId.
-     * @param classId   the class id of the control to test
-     * @returns  true if the control is registered or false if not
-     */
-    static isControlRegistered(classId) {
-        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.isRegistered(classId);
-    }
-    /** Determines if a control has been registered.
-     * @internal
-     */
-    static getConstructorClassId(constructor) {
-        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.getConstructorClassId(constructor);
-    }
-    /** Unregisters a control that has been registered.
-     * @param classId   the class id of the control to unregister
-     * @deprecated in 3.7. Use `unregister` method.
-     */
-    static unregisterControl(classId) {
-        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.unregister(classId);
-    }
-    /** Creates a control registered by calling registerControl.
-     * @param classId   the class id of the control to create
-     * @param uniqueId  a unique id for the control
-     * @param options   options passed to the constructor of the control
-     * @param controlId controlId which may not be unique across all control instances.
-     * @returns  the created control
-     * @deprecated in 3.7. Use `create` method.
-     */
-    static createControl(classId, uniqueId, options, controlId) {
-        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.create(classId, uniqueId, options, controlId);
-    }
-    /** Add a Frontstage via a provider into the [[FrontstageManager]].
-     * @param frontstageProvider  Provider of the Frontstage to add
-     * @deprecated in 3.7. Use `UiFramework.frontstages.addFrontstageProvider` method.
-     */
-    static addFrontstageProvider(frontstageProvider) {
-        UiFramework_1.UiFramework.frontstages.addFrontstageProvider(frontstageProvider);
-    }
-    /** Loads one or more Keyboard Shortcuts into the [[KeyboardShortcutManager]].
-     * @param shortcutList  the properties of the Keyboard Shortcuts to load
-     * @deprecated in 3.7. Use `UiFramework.keyboardShortcuts.loadShortcuts` method.
-     */
-    static loadKeyboardShortcuts(shortcutList) {
-        UiFramework_1.UiFramework.keyboardShortcuts.loadShortcuts(shortcutList);
-    }
-    /** Gets the HTML wrapper element for Configurable UI */
-    static getWrapperElement() {
-        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.getWrapperElement();
-    }
-    /** Closes all UI popups currently open */
-    static closeUi() {
-        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.closeUi();
-    }
-}
-exports.ConfigurableUiManager = ConfigurableUiManager;
+"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 ConfigurableUi
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigurableUiManager = void 0;
+const UiFramework_1 = require("../UiFramework");
+const InternalConfigurableUiManager_1 = require("./InternalConfigurableUiManager");
+/** Configurable Ui Manager maintains controls, Frontstages, Content Groups, Content Layouts, Tasks and Workflows.
+ * @public
+ * @deprecated in 3.7. Use `UiFramework.controls` property.
+ */
+class ConfigurableUiManager {
+    /** Initializes the InternalConfigurableUiManager and registers core controls.
+     * @deprecated in 3.7. This is called internally.
+    */
+    static initialize() {
+        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.initialize();
+    }
+    /** Registers a control implementing the [[ConfigurableUiElement]] interface.
+     * These controls can be a
+     * [[ContentControl]],
+     * [[NavigationAidControl]],
+     * [[StatusBarWidgetControl]],
+     * [[WidgetControl]] or
+     * [ToolUiProvider]($appui-react).
+     * @param classId the class id of the control to register
+     * @param constructor the constructor of the control to register
+     * @deprecated in 3.7. Use `register` method.
+     */
+    static registerControl(classId, constructor) {
+        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.register(classId, constructor);
+    }
+    /** Determines if a control has been registered based on its classId.
+     * @param classId   the class id of the control to test
+     * @returns  true if the control is registered or false if not
+     */
+    static isControlRegistered(classId) {
+        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.isRegistered(classId);
+    }
+    /** Determines if a control has been registered.
+     * @internal
+     */
+    static getConstructorClassId(constructor) {
+        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.getConstructorClassId(constructor);
+    }
+    /** Unregisters a control that has been registered.
+     * @param classId   the class id of the control to unregister
+     * @deprecated in 3.7. Use `unregister` method.
+     */
+    static unregisterControl(classId) {
+        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.unregister(classId);
+    }
+    /** Creates a control registered by calling registerControl.
+     * @param classId   the class id of the control to create
+     * @param uniqueId  a unique id for the control
+     * @param options   options passed to the constructor of the control
+     * @param controlId controlId which may not be unique across all control instances.
+     * @returns  the created control
+     * @deprecated in 3.7. Use `create` method.
+     */
+    static createControl(classId, uniqueId, options, controlId) {
+        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.create(classId, uniqueId, options, controlId);
+    }
+    /** Add a Frontstage via a provider into the [[FrontstageManager]].
+     * @param frontstageProvider  Provider of the Frontstage to add
+     * @deprecated in 3.7. Use `UiFramework.frontstages.addFrontstageProvider` method.
+     */
+    static addFrontstageProvider(frontstageProvider) {
+        UiFramework_1.UiFramework.frontstages.addFrontstageProvider(frontstageProvider);
+    }
+    /** Loads one or more Keyboard Shortcuts into the [[KeyboardShortcutManager]].
+     * @param shortcutList  the properties of the Keyboard Shortcuts to load
+     * @deprecated in 3.7. Use `UiFramework.keyboardShortcuts.loadShortcuts` method.
+     */
+    static loadKeyboardShortcuts(shortcutList) {
+        UiFramework_1.UiFramework.keyboardShortcuts.loadShortcuts(shortcutList);
+    }
+    /** Gets the HTML wrapper element for Configurable UI */
+    static getWrapperElement() {
+        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.getWrapperElement();
+    }
+    /** Closes all UI popups currently open */
+    static closeUi() {
+        return InternalConfigurableUiManager_1.InternalConfigurableUiManager.closeUi();
+    }
+}
+exports.ConfigurableUiManager = ConfigurableUiManager;
 //# sourceMappingURL=ConfigurableUiManager.js.map