@itwin/appui-react 3.6.0 → 3.6.2

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

@@ -1,96 +1,96 @@
-/** @packageDocumentation
- * @module ConfigurableUi
- */
-/** Interface for a ConfigurableUi element
- * @public
- */
-export interface ConfigurableUiElement {
-    uniqueId: string;
-    classId: string;
-    name: string;
-}
-/** Information for creating a ConfigurableUi element
- * @public
- */
-export declare class ConfigurableCreateInfo {
-    readonly classId: string;
-    readonly uniqueId: string;
-    readonly id: string;
-    constructor(classId: string, uniqueId: string, id: string);
-}
-/** The base class for all ConfigurableUi elements
- * @public
- */
-export declare class ConfigurableBase implements ConfigurableUiElement {
-    private _uniqueId;
-    private _classId;
-    private _name;
-    protected _appDataOptions: any;
-    constructor(info: ConfigurableCreateInfo, options: any);
-    /** @internal */
-    get uniqueId(): string;
-    /** allow options set via appData to be seen by API calls */
-    get applicationData(): any;
-    /** Gets the class Id of configurable element */
-    get classId(): string;
-    /** Get internal name of configurable element. If no name is defined in configuration
-     * then the name will match the UniqueId.
-     */
-    get name(): string;
-}
-/** The type of the ConfigurableUiControl.
- * @public
- */
-export declare enum ConfigurableUiControlType {
-    Content = "ContentControl",
-    NavigationAid = "NavigationAidControl",
-    StatusBarWidget = "StatusBarWidgetControl",
-    ToolUiProvider = "ToolUiProvider",
-    Viewport = "ViewportContentControl",
-    Widget = "WidgetControl"
-}
-/** Prototype for ConfigurableUiControl constructor
- * @public
- */
-export declare type ConfigurableUiControlConstructor = new (info: ConfigurableCreateInfo, options: any) => ConfigurableUiElement;
-/** 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]].
- */
-export declare abstract class ConfigurableUiControl extends ConfigurableBase {
-    private _cid;
-    /** 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 by the [[FrontstageComposer]].
-     * @protected
-     */
-    constructor(info: ConfigurableCreateInfo, options: any);
-    /** @internal
-     */
-    initialize(): void;
-    /** Called to initialize the ConfigurableUiControl. */
-    onInitialize(): void;
-    /** Called when Frontstage is deactivated. */
-    onFrontstageDeactivated(): void;
-    /** Called when Frontstage is ready. */
-    onFrontstageReady(): void;
-    /** Returns the ID of this ConfigurableUiControl.
-     */
-    get controlId(): string;
-    /** Get the type of this control.
-     */
-    abstract getType(): ConfigurableUiControlType;
-    /** Returns a promise that resolves when the control is ready for usage.
-     */
-    get isReady(): Promise<void>;
-}
+/** @packageDocumentation
+ * @module ConfigurableUi
+ */
+/** Interface for a ConfigurableUi element
+ * @public
+ */
+export interface ConfigurableUiElement {
+    uniqueId: string;
+    classId: string;
+    name: string;
+}
+/** Information for creating a ConfigurableUi element
+ * @public
+ */
+export declare class ConfigurableCreateInfo {
+    readonly classId: string;
+    readonly uniqueId: string;
+    readonly id: string;
+    constructor(classId: string, uniqueId: string, id: string);
+}
+/** The base class for all ConfigurableUi elements
+ * @public
+ */
+export declare class ConfigurableBase implements ConfigurableUiElement {
+    private _uniqueId;
+    private _classId;
+    private _name;
+    protected _appDataOptions: any;
+    constructor(info: ConfigurableCreateInfo, options: any);
+    /** @internal */
+    get uniqueId(): string;
+    /** allow options set via appData to be seen by API calls */
+    get applicationData(): any;
+    /** Gets the class Id of configurable element */
+    get classId(): string;
+    /** Get internal name of configurable element. If no name is defined in configuration
+     * then the name will match the UniqueId.
+     */
+    get name(): string;
+}
+/** The type of the ConfigurableUiControl.
+ * @public
+ */
+export declare enum ConfigurableUiControlType {
+    Content = "ContentControl",
+    NavigationAid = "NavigationAidControl",
+    StatusBarWidget = "StatusBarWidgetControl",
+    ToolUiProvider = "ToolUiProvider",
+    Viewport = "ViewportContentControl",
+    Widget = "WidgetControl"
+}
+/** Prototype for ConfigurableUiControl constructor
+ * @public
+ */
+export declare type ConfigurableUiControlConstructor = new (info: ConfigurableCreateInfo, options: any) => ConfigurableUiElement;
+/** 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]].
+ */
+export declare abstract class ConfigurableUiControl extends ConfigurableBase {
+    private _cid;
+    /** 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 by the [[FrontstageComposer]].
+     * @protected
+     */
+    constructor(info: ConfigurableCreateInfo, options: any);
+    /** @internal
+     */
+    initialize(): void;
+    /** Called to initialize the ConfigurableUiControl. */
+    onInitialize(): void;
+    /** Called when Frontstage is deactivated. */
+    onFrontstageDeactivated(): void;
+    /** Called when Frontstage is ready. */
+    onFrontstageReady(): void;
+    /** Returns the ID of this ConfigurableUiControl.
+     */
+    get controlId(): string;
+    /** Get the type of this control.
+     */
+    abstract getType(): ConfigurableUiControlType;
+    /** Returns a promise that resolves when the control is ready for usage.
+     */
+    get isReady(): Promise<void>;
+}
 //# sourceMappingURL=ConfigurableUiControl.d.ts.map

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 by the [[FrontstageComposer]].
-     * @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 by the [[FrontstageComposer]].
+     * @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/ConfigurableUiControl.js.map

@@ -1 +1 @@
-{"version":3,"file":"ConfigurableUiControl.js","sourceRoot":"","sources":["../../../../src/appui-react/configurableui/ConfigurableUiControl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAWH;;GAEG;AACH,MAAa,sBAAsB;IACjC,YAA4B,OAAe,EACzB,QAAgB,EAChB,EAAU;QAFA,YAAO,GAAP,OAAO,CAAQ;QACzB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,OAAE,GAAF,EAAE,CAAQ;IAC5B,CAAC;CACF;AALD,wDAKC;AAED;;GAEG;AACH,MAAa,gBAAgB;IAM3B,YAAY,IAA4B,EAAE,OAAY;QACpD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;QACxF,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC;IACjC,CAAC;IAED,gBAAgB;IAChB,IAAW,QAAQ,KAAa,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAExD,4DAA4D;IAC5D,IAAW,eAAe,KAAU,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAElE,gDAAgD;IAChD,IAAW,OAAO,KAAa,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEtD;;OAEG;IACH,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;CACjD;AA1BD,4CA0BC;AAED;;GAEG;AACH,IAAY,yBAOX;AAPD,WAAY,yBAAyB;IACnC,uDAA0B,CAAA;IAC1B,mEAAsC,CAAA;IACtC,uEAA0C,CAAA;IAC1C,8DAAiC,CAAA;IACjC,gEAAmC,CAAA;IACnC,qDAAwB,CAAA;AAC1B,CAAC,EAPW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAOpC;AAOD;;;;;;;;;;GAUG;AACH,MAAsB,qBAAsB,SAAQ,gBAAgB;IAGlE;;;;;;OAMG;IACH,YAAY,IAA4B,EAAE,OAAY;QACpD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;IACtB,CAAC;IAED;OACG;IACI,UAAU,KAAW,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IAElD,sDAAsD;IAC/C,YAAY,KAAW,CAAC;IAE/B,6CAA6C;IACtC,uBAAuB,KAAW,CAAC;IAE1C,uCAAuC;IAChC,iBAAiB,KAAW,CAAC;IAEpC;OACG;IACH,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAMpD;OACG;IACH,IAAW,OAAO,KAAoB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;CAClE;AAvCD,sDAuCC","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 ConfigurableUi\n */\n\n/** Interface for a ConfigurableUi element\n * @public\n */\nexport interface ConfigurableUiElement {\n  uniqueId: string;\n  classId: string;\n  name: string;\n}\n\n/** Information for creating a ConfigurableUi element\n * @public\n */\nexport class ConfigurableCreateInfo {\n  constructor(public readonly classId: string,\n    public readonly uniqueId: string,\n    public readonly id: string) {\n  }\n}\n\n/** The base class for all ConfigurableUi elements\n * @public\n */\nexport class ConfigurableBase implements ConfigurableUiElement {\n  private _uniqueId: string;\n  private _classId: string;\n  private _name: string;\n  protected _appDataOptions: any;\n\n  constructor(info: ConfigurableCreateInfo, options: any) {\n    this._uniqueId = info.uniqueId;\n    this._classId = info.classId;\n    this._name = (options && options.hasOwnProperty(\"name\")) ? options.name : info.uniqueId;\n    this._appDataOptions = options;\n  }\n\n  /** @internal */\n  public get uniqueId(): string { return this._uniqueId; }\n\n  /** allow options set via appData to be seen by API calls */\n  public get applicationData(): any { return this._appDataOptions; }\n\n  /** Gets the class Id of configurable element */\n  public get classId(): string { return this._classId; }\n\n  /** Get internal name of configurable element. If no name is defined in configuration\n   * then the name will match the UniqueId.\n   */\n  public get name(): string { return this._name; }\n}\n\n/** The type of the ConfigurableUiControl.\n * @public\n */\nexport enum ConfigurableUiControlType {\n  Content = \"ContentControl\",\n  NavigationAid = \"NavigationAidControl\",\n  StatusBarWidget = \"StatusBarWidgetControl\",\n  ToolUiProvider = \"ToolUiProvider\",\n  Viewport = \"ViewportContentControl\",\n  Widget = \"WidgetControl\",\n}\n\n/** Prototype for ConfigurableUiControl constructor\n * @public\n */\nexport type ConfigurableUiControlConstructor = new (info: ConfigurableCreateInfo, options: any) => ConfigurableUiElement;\n\n/** The abstract base class for all Frontstage controls.\n * @public\n *\n * @note This is an abstract class which should not be derived from by the applications.\n * Instead, applications should derive from one of\n * [[ContentControl]],\n * [[ViewportContentControl]],\n * [[WidgetControl]],\n * [[StatusBarWidgetControl]] or\n * [[NavigationAidControl]].\n */\nexport abstract class ConfigurableUiControl extends ConfigurableBase {\n  private _cid: string;\n\n  /** Creates an instance of ConfigurableUiControl.\n   * @param info         An object that the subclass must pass to this base class.\n   * @param options      Options provided to the control\n   * @note Subclasses must pass all arguments to the base class and not add themselves\n   * to any container - the control is added automatically by the [[FrontstageComposer]].\n   * @protected\n   */\n  constructor(info: ConfigurableCreateInfo, options: any) {\n    super(info, options);\n    this._cid = info.id;\n  }\n\n  /** @internal\n   */\n  public initialize(): void { this.onInitialize(); }\n\n  /** Called to initialize the ConfigurableUiControl. */\n  public onInitialize(): void { }\n\n  /** Called when Frontstage is deactivated. */\n  public onFrontstageDeactivated(): void { }\n\n  /** Called when Frontstage is ready. */\n  public onFrontstageReady(): void { }\n\n  /** Returns the ID of this ConfigurableUiControl.\n   */\n  public get controlId(): string { return this._cid; }\n\n  /** Get the type of this control.\n   */\n  public abstract getType(): ConfigurableUiControlType;\n\n  /** Returns a promise that resolves when the control is ready for usage.\n   */\n  public get isReady(): Promise<void> { return Promise.resolve(); }\n}\n"]}
+{"version":3,"file":"ConfigurableUiControl.js","sourceRoot":"","sources":["../../../../src/appui-react/configurableui/ConfigurableUiControl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAWH;;GAEG;AACH,MAAa,sBAAsB;IACjC,YAA4B,OAAe,EACzB,QAAgB,EAChB,EAAU;QAFA,YAAO,GAAP,OAAO,CAAQ;QACzB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,OAAE,GAAF,EAAE,CAAQ;IAC5B,CAAC;CACF;AALD,wDAKC;AAED;;GAEG;AACH,MAAa,gBAAgB;IAM3B,YAAY,IAA4B,EAAE,OAAY;QACpD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;QACxF,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC;IACjC,CAAC;IAED,gBAAgB;IAChB,IAAW,QAAQ,KAAa,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAExD,4DAA4D;IAC5D,IAAW,eAAe,KAAU,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAElE,gDAAgD;IAChD,IAAW,OAAO,KAAa,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEtD;;OAEG;IACH,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;CACjD;AA1BD,4CA0BC;AAED;;GAEG;AACH,IAAY,yBAOX;AAPD,WAAY,yBAAyB;IACnC,uDAA0B,CAAA;IAC1B,mEAAsC,CAAA;IACtC,uEAA0C,CAAA;IAC1C,8DAAiC,CAAA;IACjC,gEAAmC,CAAA;IACnC,qDAAwB,CAAA;AAC1B,CAAC,EAPW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAOpC;AAOD;;;;;;;;;;GAUG;AACH,MAAsB,qBAAsB,SAAQ,gBAAgB;IAGlE;;;;;;OAMG;IACH,YAAY,IAA4B,EAAE,OAAY;QACpD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;IACtB,CAAC;IAED;OACG;IACI,UAAU,KAAW,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IAElD,sDAAsD;IAC/C,YAAY,KAAW,CAAC;IAE/B,6CAA6C;IACtC,uBAAuB,KAAW,CAAC;IAE1C,uCAAuC;IAChC,iBAAiB,KAAW,CAAC;IAEpC;OACG;IACH,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAMpD;OACG;IACH,IAAW,OAAO,KAAoB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;CAClE;AAvCD,sDAuCC","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 ConfigurableUi\r\n */\r\n\r\n/** Interface for a ConfigurableUi element\r\n * @public\r\n */\r\nexport interface ConfigurableUiElement {\r\n  uniqueId: string;\r\n  classId: string;\r\n  name: string;\r\n}\r\n\r\n/** Information for creating a ConfigurableUi element\r\n * @public\r\n */\r\nexport class ConfigurableCreateInfo {\r\n  constructor(public readonly classId: string,\r\n    public readonly uniqueId: string,\r\n    public readonly id: string) {\r\n  }\r\n}\r\n\r\n/** The base class for all ConfigurableUi elements\r\n * @public\r\n */\r\nexport class ConfigurableBase implements ConfigurableUiElement {\r\n  private _uniqueId: string;\r\n  private _classId: string;\r\n  private _name: string;\r\n  protected _appDataOptions: any;\r\n\r\n  constructor(info: ConfigurableCreateInfo, options: any) {\r\n    this._uniqueId = info.uniqueId;\r\n    this._classId = info.classId;\r\n    this._name = (options && options.hasOwnProperty(\"name\")) ? options.name : info.uniqueId;\r\n    this._appDataOptions = options;\r\n  }\r\n\r\n  /** @internal */\r\n  public get uniqueId(): string { return this._uniqueId; }\r\n\r\n  /** allow options set via appData to be seen by API calls */\r\n  public get applicationData(): any { return this._appDataOptions; }\r\n\r\n  /** Gets the class Id of configurable element */\r\n  public get classId(): string { return this._classId; }\r\n\r\n  /** Get internal name of configurable element. If no name is defined in configuration\r\n   * then the name will match the UniqueId.\r\n   */\r\n  public get name(): string { return this._name; }\r\n}\r\n\r\n/** The type of the ConfigurableUiControl.\r\n * @public\r\n */\r\nexport enum ConfigurableUiControlType {\r\n  Content = \"ContentControl\",\r\n  NavigationAid = \"NavigationAidControl\",\r\n  StatusBarWidget = \"StatusBarWidgetControl\",\r\n  ToolUiProvider = \"ToolUiProvider\",\r\n  Viewport = \"ViewportContentControl\",\r\n  Widget = \"WidgetControl\",\r\n}\r\n\r\n/** Prototype for ConfigurableUiControl constructor\r\n * @public\r\n */\r\nexport type ConfigurableUiControlConstructor = new (info: ConfigurableCreateInfo, options: any) => ConfigurableUiElement;\r\n\r\n/** The abstract base class for all Frontstage controls.\r\n * @public\r\n *\r\n * @note This is an abstract class which should not be derived from by the applications.\r\n * Instead, applications should derive from one of\r\n * [[ContentControl]],\r\n * [[ViewportContentControl]],\r\n * [[WidgetControl]],\r\n * [[StatusBarWidgetControl]] or\r\n * [[NavigationAidControl]].\r\n */\r\nexport abstract class ConfigurableUiControl extends ConfigurableBase {\r\n  private _cid: string;\r\n\r\n  /** Creates an instance of ConfigurableUiControl.\r\n   * @param info         An object that the subclass must pass to this base class.\r\n   * @param options      Options provided to the control\r\n   * @note Subclasses must pass all arguments to the base class and not add themselves\r\n   * to any container - the control is added automatically by the [[FrontstageComposer]].\r\n   * @protected\r\n   */\r\n  constructor(info: ConfigurableCreateInfo, options: any) {\r\n    super(info, options);\r\n    this._cid = info.id;\r\n  }\r\n\r\n  /** @internal\r\n   */\r\n  public initialize(): void { this.onInitialize(); }\r\n\r\n  /** Called to initialize the ConfigurableUiControl. */\r\n  public onInitialize(): void { }\r\n\r\n  /** Called when Frontstage is deactivated. */\r\n  public onFrontstageDeactivated(): void { }\r\n\r\n  /** Called when Frontstage is ready. */\r\n  public onFrontstageReady(): void { }\r\n\r\n  /** Returns the ID of this ConfigurableUiControl.\r\n   */\r\n  public get controlId(): string { return this._cid; }\r\n\r\n  /** Get the type of this control.\r\n   */\r\n  public abstract getType(): ConfigurableUiControlType;\r\n\r\n  /** Returns a promise that resolves when the control is ready for usage.\r\n   */\r\n  public get isReady(): Promise<void> { return Promise.resolve(); }\r\n}\r\n"]}

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

@@ -1,110 +1,110 @@
-/** @packageDocumentation
- * @module ConfigurableUi
- */
-import { BeUiEvent } from "@itwin/core-bentley";
-import { FrontstageProvider } from "../frontstage/FrontstageProvider";
-import { KeyboardShortcutProps } from "../keyboardshortcut/KeyboardShortcut";
-import { TaskPropsList } from "../workflow/Task";
-import { WorkflowProps, WorkflowPropsList } from "../workflow/Workflow";
-import { ConfigurableUiControlConstructor, ConfigurableUiElement } from "./ConfigurableUiControl";
-import { ActivityTracker } from "./ActivityTracker";
-/** Ui Activity Event Args interface.
- * @internal
- */
-export interface UiActivityEventArgs {
-    event: Event;
-}
-/** Ui Activity Event class.
- * @internal
- */
-export declare class UiActivityEvent extends BeUiEvent<UiActivityEventArgs> {
-}
-/** Ui Interval Event Args interface
- * @internal
- */
-export interface UiIntervalEventArgs {
-    idleTimeout?: number;
-}
-/** Ui Interval Event class.
- * @internal
- */
-export declare class UiIntervalEvent extends BeUiEvent<UiIntervalEventArgs> {
-}
-/** Configurable Ui Manager maintains controls, Frontstages, Content Groups, Content Layouts, Tasks and Workflows.
- * @public
- */
-export declare class ConfigurableUiManager {
-    private static _registeredControls;
-    private static _initialized;
-    /** @internal */
-    static readonly activityTracker: ActivityTracker;
-    /** @internal */
-    static readonly onUiActivityEvent: UiActivityEvent;
-    /** @internal */
-    static readonly onUiIntervalEvent: UiIntervalEvent;
-    /** Initializes the ConfigurableUiManager and registers core controls. */
-    static initialize(): void;
-    /** Registers a control implementing the [[ConfigurableUiElement]] interface.
-     * These controls can be a
-     * [[ContentControl]],
-     * [[NavigationAidControl]],
-     * [[StatusBarWidgetControl]],
-     * [[WidgetControl]] or
-     * [[ToolUiProvider]].
-     * @param classId the class id of the control to register
-     * @param constructor the constructor of the control to register
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    static addFrontstageProvider(frontstageProvider: FrontstageProvider): void;
-    /** Loads one or more Tasks into the [[TaskManager]].
-     * @param taskPropsList  the list of Tasks to load
-     * @internal
-     * @deprecated in 3.0.
-     */
-    static loadTasks(taskPropsList: TaskPropsList): void;
-    /** Loads a Workflow into the [[WorkflowManager]].
-     * @param workflowProps  the Workflow to load
-     * @internal
-     * @deprecated in 3.0.
-     */
-    static loadWorkflow(workflowProps: WorkflowProps): void;
-    /** Loads one or more Workflows into the [[WorkflowManager]].
-     * @param workflowPropsList  the list of Workflows to load
-     * @internal
-     * @deprecated in 3.0.
-     */
-    static loadWorkflows(workflowPropsList: WorkflowPropsList): void;
-    /** Loads one or more Keyboard Shortcuts into the [[KeyboardShortcutManager]].
-     * @param shortcutList  the properties of the Keyboard Shortcuts to load
-     */
-    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 { BeUiEvent } from "@itwin/core-bentley";
+import { FrontstageProvider } from "../frontstage/FrontstageProvider";
+import { KeyboardShortcutProps } from "../keyboardshortcut/KeyboardShortcut";
+import { TaskPropsList } from "../workflow/Task";
+import { WorkflowProps, WorkflowPropsList } from "../workflow/Workflow";
+import { ConfigurableUiControlConstructor, ConfigurableUiElement } from "./ConfigurableUiControl";
+import { ActivityTracker } from "./ActivityTracker";
+/** Ui Activity Event Args interface.
+ * @internal
+ */
+export interface UiActivityEventArgs {
+    event: Event;
+}
+/** Ui Activity Event class.
+ * @internal
+ */
+export declare class UiActivityEvent extends BeUiEvent<UiActivityEventArgs> {
+}
+/** Ui Interval Event Args interface
+ * @internal
+ */
+export interface UiIntervalEventArgs {
+    idleTimeout?: number;
+}
+/** Ui Interval Event class.
+ * @internal
+ */
+export declare class UiIntervalEvent extends BeUiEvent<UiIntervalEventArgs> {
+}
+/** Configurable Ui Manager maintains controls, Frontstages, Content Groups, Content Layouts, Tasks and Workflows.
+ * @public
+ */
+export declare class ConfigurableUiManager {
+    private static _registeredControls;
+    private static _initialized;
+    /** @internal */
+    static readonly activityTracker: ActivityTracker;
+    /** @internal */
+    static readonly onUiActivityEvent: UiActivityEvent;
+    /** @internal */
+    static readonly onUiIntervalEvent: UiIntervalEvent;
+    /** Initializes the ConfigurableUiManager and registers core controls. */
+    static initialize(): void;
+    /** Registers a control implementing the [[ConfigurableUiElement]] interface.
+     * These controls can be a
+     * [[ContentControl]],
+     * [[NavigationAidControl]],
+     * [[StatusBarWidgetControl]],
+     * [[WidgetControl]] or
+     * [[ToolUiProvider]].
+     * @param classId the class id of the control to register
+     * @param constructor the constructor of the control to register
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    static addFrontstageProvider(frontstageProvider: FrontstageProvider): void;
+    /** Loads one or more Tasks into the [[TaskManager]].
+     * @param taskPropsList  the list of Tasks to load
+     * @internal
+     * @deprecated in 3.0.
+     */
+    static loadTasks(taskPropsList: TaskPropsList): void;
+    /** Loads a Workflow into the [[WorkflowManager]].
+     * @param workflowProps  the Workflow to load
+     * @internal
+     * @deprecated in 3.0.
+     */
+    static loadWorkflow(workflowProps: WorkflowProps): void;
+    /** Loads one or more Workflows into the [[WorkflowManager]].
+     * @param workflowPropsList  the list of Workflows to load
+     * @internal
+     * @deprecated in 3.0.
+     */
+    static loadWorkflows(workflowPropsList: WorkflowPropsList): void;
+    /** Loads one or more Keyboard Shortcuts into the [[KeyboardShortcutManager]].
+     * @param shortcutList  the properties of the Keyboard Shortcuts to load
+     */
+    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