@itwin/appui-react 4.0.0-dev.9 → 4.0.0

package/lib/cjs/appui-react/framework/FrameworkControls.d.ts

@@ -1,43 +1,43 @@
-/** @packageDocumentation
- * @module ConfigurableUi
- */
-import { ConfigurableUiControlConstructor, ConfigurableUiElement } from "../configurableui/ConfigurableUiControl";
-/**
- * [[UiFramework.controls]] interface
- * @beta
- */
-export interface FrameworkControls {
-    /** 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
-     */
-    register(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
-     */
-    isRegistered(classId: string): boolean;
-    /** Unregisters a control that has been registered.
-     * @param classId   the class id of the control to unregister
-     */
-    unregister(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
-     */
-    create(classId: string, uniqueId: string, options?: any, controlId?: string): ConfigurableUiElement | undefined;
-    /** Gets the HTML wrapper element for Configurable UI */
-    getWrapperElement(): HTMLElement;
-    /** Closes all UI popups currently open */
-    closeUi(): void;
-}
+/** @packageDocumentation
+ * @module ConfigurableUi
+ */
+import { ConfigurableUiControlConstructor, ConfigurableUiElement } from "../configurableui/ConfigurableUiControl";
+/**
+ * [[UiFramework.controls]] interface
+ * @public
+ */
+export interface FrameworkControls {
+    /** 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
+     */
+    register(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
+     */
+    isRegistered(classId: string): boolean;
+    /** Unregisters a control that has been registered.
+     * @param classId   the class id of the control to unregister
+     */
+    unregister(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
+     */
+    create(classId: string, uniqueId: string, options?: any, controlId?: string): ConfigurableUiElement | undefined;
+    /** Gets the HTML wrapper element for Configurable UI */
+    getWrapperElement(): HTMLElement;
+    /** Closes all UI popups currently open */
+    closeUi(): void;
+}
 //# sourceMappingURL=FrameworkControls.d.ts.map

package/lib/cjs/appui-react/framework/FrameworkControls.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=FrameworkControls.js.map

package/lib/cjs/appui-react/framework/FrameworkControls.js.map

@@ -1 +1 @@
-{"version":3,"file":"FrameworkControls.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkControls.ts"],"names":[],"mappings":"","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\nimport { ConfigurableUiControlConstructor, ConfigurableUiElement } from \"../configurableui/ConfigurableUiControl\";\r\n\r\n/**\r\n * [[UiFramework.controls]] interface\r\n * @beta\r\n */\r\nexport interface FrameworkControls {\r\n\r\n  /** Registers a control implementing the [[ConfigurableUiElement]] interface.\r\n   * These controls can be a\r\n   * [[ContentControl]],\r\n   * [[NavigationAidControl]],\r\n   * [[StatusBarWidgetControl]],\r\n   * [[WidgetControl]] or\r\n   * [[ToolUiProvider]].\r\n   * @param classId the class id of the control to register\r\n   * @param constructor the constructor of the control to register\r\n   */\r\n  register(classId: string, constructor: ConfigurableUiControlConstructor): void;\r\n\r\n  /** Determines if a control has been registered based on its classId.\r\n   * @param classId   the class id of the control to test\r\n   * @returns  true if the control is registered or false if not\r\n   */\r\n  isRegistered(classId: string): boolean;\r\n\r\n  /** Unregisters a control that has been registered.\r\n   * @param classId   the class id of the control to unregister\r\n   */\r\n  unregister(classId: string): void;\r\n\r\n  /** Creates a control registered by calling registerControl.\r\n   * @param classId   the class id of the control to create\r\n   * @param uniqueId  a unique id for the control\r\n   * @param options   options passed to the constructor of the control\r\n   * @param controlId controlId which may not be unique across all control instances.\r\n   * @returns  the created control\r\n   */\r\n  create(classId: string, uniqueId: string, options?: any, controlId?: string): ConfigurableUiElement | undefined;\r\n\r\n  /** Gets the HTML wrapper element for Configurable UI */\r\n  getWrapperElement(): HTMLElement;\r\n\r\n  /** Closes all UI popups currently open */\r\n  closeUi(): void;\r\n\r\n}\r\n"]}
+{"version":3,"file":"FrameworkControls.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkControls.ts"],"names":[],"mappings":"","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\nimport { ConfigurableUiControlConstructor, ConfigurableUiElement } from \"../configurableui/ConfigurableUiControl\";\r\n\r\n/**\r\n * [[UiFramework.controls]] interface\r\n * @public\r\n */\r\nexport interface FrameworkControls {\r\n\r\n  /** Registers a control implementing the [[ConfigurableUiElement]] interface.\r\n   * These controls can be a\r\n   * [[ContentControl]],\r\n   * [[NavigationAidControl]],\r\n   * [[StatusBarWidgetControl]],\r\n   * [[WidgetControl]] or\r\n   * [[ToolUiProvider]].\r\n   * @param classId the class id of the control to register\r\n   * @param constructor the constructor of the control to register\r\n   */\r\n  register(classId: string, constructor: ConfigurableUiControlConstructor): void;\r\n\r\n  /** Determines if a control has been registered based on its classId.\r\n   * @param classId   the class id of the control to test\r\n   * @returns  true if the control is registered or false if not\r\n   */\r\n  isRegistered(classId: string): boolean;\r\n\r\n  /** Unregisters a control that has been registered.\r\n   * @param classId   the class id of the control to unregister\r\n   */\r\n  unregister(classId: string): void;\r\n\r\n  /** Creates a control registered by calling registerControl.\r\n   * @param classId   the class id of the control to create\r\n   * @param uniqueId  a unique id for the control\r\n   * @param options   options passed to the constructor of the control\r\n   * @param controlId controlId which may not be unique across all control instances.\r\n   * @returns  the created control\r\n   */\r\n  create(classId: string, uniqueId: string, options?: any, controlId?: string): ConfigurableUiElement | undefined;\r\n\r\n  /** Gets the HTML wrapper element for Configurable UI */\r\n  getWrapperElement(): HTMLElement;\r\n\r\n  /** Closes all UI popups currently open */\r\n  closeUi(): void;\r\n\r\n}\r\n"]}

package/lib/cjs/appui-react/framework/FrameworkDialogs.d.ts

@@ -1,79 +1,79 @@
-/// <reference types="react" />
-/** @packageDocumentation
- * @module Dialog
- */
-import { DialogChangedEvent, DialogInfo } from "../dialog/DialogManagerBase";
-/** Modal Dialog Changed Event class.
- * @public
- */
-export declare class ModalDialogChangedEvent extends DialogChangedEvent {
-}
-/** Modeless Dialog Changed Event class.
- * @public
- */
-export declare class ModelessDialogChangedEvent extends DialogChangedEvent {
-}
-/** @public */
-export interface ModelessDialogInfo {
-    reactNode: React.ReactNode;
-    zIndex: number;
-    parentDocument: Document;
-}
-/**
- * Manages dialog access
- * @beta
- */
-export interface FrameworkDialog {
-    /** Get the array of modal dialogs */
-    readonly dialogs: DialogInfo[];
-    /** Open a modal dialog
-     * @param dialog The Dialog to open
-     * @param id The id of the Dialog. If one is not provided, an id is generated.
-     * @param parentDocument The Document used to determine the owning window.
-     */
-    open(dialog: React.ReactNode, id?: string, parentDocument?: Document): void;
-    /** Close a modal dialog
-     * @param dialog The Dialog to open. If one is not specified, the active dialog will be closed.
-     */
-    close(dialog?: React.ReactNode): void;
-    /** Update the dialogs */
-    update(): void;
-    /** Get the active modal dialog */
-    readonly active: React.ReactNode | undefined;
-    /** Get the count of modal dialogs */
-    readonly count: number;
-}
-/**
- * FrameworkDialog that manages the top most content.
- * @beta
- */
-export interface FrameworkStackedDialog<DialogInfoType> extends FrameworkDialog {
-    /** Handle a pointer down event on a modeless dialog */
-    handlePointerDownEvent(_event: React.PointerEvent, id: string, updateFunc: () => void): void;
-    /** Get the z-index for a modeless dialog */
-    getZIndex(id: string): number;
-    getInfo(id: string): DialogInfoType | undefined;
-}
-/**
- * [[UiFramework.dialogs]] interface.
- * @beta
- */
-export interface FrameworkDialogs {
-    /**
-     * Manage modal dialogs.
-     * @beta
-     */
-    readonly modal: FrameworkDialog & {
-        /** Modal Dialog Changed Event */
-        readonly onModalDialogChangedEvent: ModalDialogChangedEvent;
-    };
-    /**
-     * Manage modeless dialogs.
-     * @beta
-     */
-    readonly modeless: FrameworkStackedDialog<ModelessDialogInfo> & {
-        /** Modeless Dialog Changed Event */
-        readonly onModelessDialogChangedEvent: ModelessDialogChangedEvent;
-    };
-}
+/// <reference types="react" />
+/** @packageDocumentation
+ * @module Dialog
+ */
+import { DialogChangedEvent, DialogInfo } from "../dialog/DialogManagerBase";
+/** Modal Dialog Changed Event class.
+ * @public
+ */
+export declare class ModalDialogChangedEvent extends DialogChangedEvent {
+}
+/** Modeless Dialog Changed Event class.
+ * @public
+ */
+export declare class ModelessDialogChangedEvent extends DialogChangedEvent {
+}
+/** @public */
+export interface ModelessDialogInfo {
+    reactNode: React.ReactNode;
+    zIndex: number;
+    parentDocument: Document;
+}
+/**
+ * Manages dialog access
+ * @beta
+ */
+export interface FrameworkDialog {
+    /** Get the array of modal dialogs */
+    readonly dialogs: DialogInfo[];
+    /** Open a modal dialog
+     * @param dialog The Dialog to open
+     * @param id The id of the Dialog. If one is not provided, an id is generated.
+     * @param parentDocument The Document used to determine the owning window.
+     */
+    open(dialog: React.ReactNode, id?: string, parentDocument?: Document): void;
+    /** Close a modal dialog
+     * @param dialog The Dialog to open. If one is not specified, the active dialog will be closed.
+     */
+    close(dialog?: React.ReactNode): void;
+    /** Update the dialogs */
+    update(): void;
+    /** Get the active modal dialog */
+    readonly active: React.ReactNode | undefined;
+    /** Get the count of modal dialogs */
+    readonly count: number;
+}
+/**
+ * FrameworkDialog that manages the top most content.
+ * @beta
+ */
+export interface FrameworkStackedDialog<DialogInfoType> extends FrameworkDialog {
+    /** Handle a pointer down event on a modeless dialog */
+    handlePointerDownEvent(_event: React.PointerEvent, id: string, updateFunc: () => void): void;
+    /** Get the z-index for a modeless dialog */
+    getZIndex(id: string): number;
+    getInfo(id: string): DialogInfoType | undefined;
+}
+/**
+ * [[UiFramework.dialogs]] interface.
+ * @public
+ */
+export interface FrameworkDialogs {
+    /**
+     * Manage modal dialogs.
+     * @beta
+     */
+    readonly modal: FrameworkDialog & {
+        /** Modal Dialog Changed Event */
+        readonly onModalDialogChangedEvent: ModalDialogChangedEvent;
+    };
+    /**
+     * Manage modeless dialogs.
+     * @beta
+     */
+    readonly modeless: FrameworkStackedDialog<ModelessDialogInfo> & {
+        /** Modeless Dialog Changed Event */
+        readonly onModelessDialogChangedEvent: ModelessDialogChangedEvent;
+    };
+}
 //# sourceMappingURL=FrameworkDialogs.d.ts.map

package/lib/cjs/appui-react/framework/FrameworkDialogs.js

@@ -1,24 +1,24 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModelessDialogChangedEvent = exports.ModalDialogChangedEvent = void 0;
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Dialog
- */
-const DialogManagerBase_1 = require("../dialog/DialogManagerBase");
-/** Modal Dialog Changed Event class.
- * @public
- */
-class ModalDialogChangedEvent extends DialogManagerBase_1.DialogChangedEvent {
-}
-exports.ModalDialogChangedEvent = ModalDialogChangedEvent;
-/** Modeless Dialog Changed Event class.
- * @public
- */
-class ModelessDialogChangedEvent extends DialogManagerBase_1.DialogChangedEvent {
-}
-exports.ModelessDialogChangedEvent = ModelessDialogChangedEvent;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelessDialogChangedEvent = exports.ModalDialogChangedEvent = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Dialog
+ */
+const DialogManagerBase_1 = require("../dialog/DialogManagerBase");
+/** Modal Dialog Changed Event class.
+ * @public
+ */
+class ModalDialogChangedEvent extends DialogManagerBase_1.DialogChangedEvent {
+}
+exports.ModalDialogChangedEvent = ModalDialogChangedEvent;
+/** Modeless Dialog Changed Event class.
+ * @public
+ */
+class ModelessDialogChangedEvent extends DialogManagerBase_1.DialogChangedEvent {
+}
+exports.ModelessDialogChangedEvent = ModelessDialogChangedEvent;
 //# sourceMappingURL=FrameworkDialogs.js.map

package/lib/cjs/appui-react/framework/FrameworkDialogs.js.map

@@ -1 +1 @@
-{"version":3,"file":"FrameworkDialogs.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkDialogs.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,mEAA6E;AAE7E;;GAEG;AACH,MAAa,uBAAwB,SAAQ,sCAAkB;CAAI;AAAnE,0DAAmE;AAEnE;;GAEG;AACH,MAAa,0BAA2B,SAAQ,sCAAkB;CAAI;AAAtE,gEAAsE","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 Dialog\r\n */\r\nimport { DialogChangedEvent, DialogInfo } from \"../dialog/DialogManagerBase\";\r\n\r\n/** Modal Dialog Changed Event class.\r\n * @public\r\n */\r\nexport class ModalDialogChangedEvent extends DialogChangedEvent { }\r\n\r\n/** Modeless Dialog Changed Event class.\r\n * @public\r\n */\r\nexport class ModelessDialogChangedEvent extends DialogChangedEvent { }\r\n\r\n/** @public */\r\nexport interface ModelessDialogInfo {\r\n  reactNode: React.ReactNode;\r\n  zIndex: number;\r\n  parentDocument: Document;\r\n}\r\n\r\n/**\r\n * Manages dialog access\r\n * @beta\r\n */\r\nexport interface FrameworkDialog {\r\n  /** Get the array of modal dialogs */\r\n  readonly dialogs: DialogInfo[];\r\n\r\n  /** Open a modal dialog\r\n   * @param dialog The Dialog to open\r\n   * @param id The id of the Dialog. If one is not provided, an id is generated.\r\n   * @param parentDocument The Document used to determine the owning window.\r\n   */\r\n  open(dialog: React.ReactNode, id?: string, parentDocument?: Document): void;\r\n\r\n  /** Close a modal dialog\r\n   * @param dialog The Dialog to open. If one is not specified, the active dialog will be closed.\r\n   */\r\n  close(dialog?: React.ReactNode): void;\r\n\r\n  /** Update the dialogs */\r\n  update(): void;\r\n\r\n  /** Get the active modal dialog */\r\n  readonly active: React.ReactNode | undefined;\r\n\r\n  /** Get the count of modal dialogs */\r\n  readonly count: number;\r\n}\r\n\r\n/**\r\n * FrameworkDialog that manages the top most content.\r\n * @beta\r\n */\r\nexport interface FrameworkStackedDialog<DialogInfoType> extends FrameworkDialog {\r\n  /** Handle a pointer down event on a modeless dialog */\r\n  handlePointerDownEvent(_event: React.PointerEvent, id: string, updateFunc: () => void): void;\r\n\r\n  /** Get the z-index for a modeless dialog */\r\n  getZIndex(id: string): number;\r\n\r\n  getInfo(id: string): DialogInfoType | undefined;\r\n}\r\n\r\n/**\r\n * [[UiFramework.dialogs]] interface.\r\n * @beta\r\n */\r\nexport interface FrameworkDialogs {\r\n  /**\r\n   * Manage modal dialogs.\r\n   * @beta\r\n   */\r\n  readonly modal: FrameworkDialog & {\r\n    /** Modal Dialog Changed Event */\r\n    readonly onModalDialogChangedEvent: ModalDialogChangedEvent;\r\n  };\r\n\r\n  /**\r\n   * Manage modeless dialogs.\r\n   * @beta\r\n   */\r\n  readonly modeless: FrameworkStackedDialog<ModelessDialogInfo> & {\r\n    /** Modeless Dialog Changed Event */\r\n    readonly onModelessDialogChangedEvent: ModelessDialogChangedEvent;\r\n  };\r\n}\r\n"]}
+{"version":3,"file":"FrameworkDialogs.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkDialogs.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,mEAA6E;AAE7E;;GAEG;AACH,MAAa,uBAAwB,SAAQ,sCAAkB;CAAI;AAAnE,0DAAmE;AAEnE;;GAEG;AACH,MAAa,0BAA2B,SAAQ,sCAAkB;CAAI;AAAtE,gEAAsE","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 Dialog\r\n */\r\nimport { DialogChangedEvent, DialogInfo } from \"../dialog/DialogManagerBase\";\r\n\r\n/** Modal Dialog Changed Event class.\r\n * @public\r\n */\r\nexport class ModalDialogChangedEvent extends DialogChangedEvent { }\r\n\r\n/** Modeless Dialog Changed Event class.\r\n * @public\r\n */\r\nexport class ModelessDialogChangedEvent extends DialogChangedEvent { }\r\n\r\n/** @public */\r\nexport interface ModelessDialogInfo {\r\n  reactNode: React.ReactNode;\r\n  zIndex: number;\r\n  parentDocument: Document;\r\n}\r\n\r\n/**\r\n * Manages dialog access\r\n * @beta\r\n */\r\nexport interface FrameworkDialog {\r\n  /** Get the array of modal dialogs */\r\n  readonly dialogs: DialogInfo[];\r\n\r\n  /** Open a modal dialog\r\n   * @param dialog The Dialog to open\r\n   * @param id The id of the Dialog. If one is not provided, an id is generated.\r\n   * @param parentDocument The Document used to determine the owning window.\r\n   */\r\n  open(dialog: React.ReactNode, id?: string, parentDocument?: Document): void;\r\n\r\n  /** Close a modal dialog\r\n   * @param dialog The Dialog to open. If one is not specified, the active dialog will be closed.\r\n   */\r\n  close(dialog?: React.ReactNode): void;\r\n\r\n  /** Update the dialogs */\r\n  update(): void;\r\n\r\n  /** Get the active modal dialog */\r\n  readonly active: React.ReactNode | undefined;\r\n\r\n  /** Get the count of modal dialogs */\r\n  readonly count: number;\r\n}\r\n\r\n/**\r\n * FrameworkDialog that manages the top most content.\r\n * @beta\r\n */\r\nexport interface FrameworkStackedDialog<DialogInfoType> extends FrameworkDialog {\r\n  /** Handle a pointer down event on a modeless dialog */\r\n  handlePointerDownEvent(_event: React.PointerEvent, id: string, updateFunc: () => void): void;\r\n\r\n  /** Get the z-index for a modeless dialog */\r\n  getZIndex(id: string): number;\r\n\r\n  getInfo(id: string): DialogInfoType | undefined;\r\n}\r\n\r\n/**\r\n * [[UiFramework.dialogs]] interface.\r\n * @public\r\n */\r\nexport interface FrameworkDialogs {\r\n  /**\r\n   * Manage modal dialogs.\r\n   * @beta\r\n   */\r\n  readonly modal: FrameworkDialog & {\r\n    /** Modal Dialog Changed Event */\r\n    readonly onModalDialogChangedEvent: ModalDialogChangedEvent;\r\n  };\r\n\r\n  /**\r\n   * Manage modeless dialogs.\r\n   * @beta\r\n   */\r\n  readonly modeless: FrameworkStackedDialog<ModelessDialogInfo> & {\r\n    /** Modeless Dialog Changed Event */\r\n    readonly onModelessDialogChangedEvent: ModelessDialogChangedEvent;\r\n  };\r\n}\r\n"]}