@itwin/appui-react 3.6.0-dev.8 → 3.7.0-dev.1

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

@@ -0,0 +1,155 @@
+/** @packageDocumentation
+ * @module ContentView
+ */
+/// <reference types="react" />
+import { ContentLayoutProps, UiEvent } from "@itwin/appui-abstract";
+import { ContentControl } from "../content/ContentControl";
+import { ContentGroup, ContentGroupProps } from "../content/ContentGroup";
+import { ContentLayoutDef } from "../content/ContentLayout";
+import { DialogChangedEvent } from "../dialog/DialogManagerBase";
+import { FrameworkStackedDialog } from "./FrameworkDialogs";
+/** [[MouseDownChangedEvent]] Args interface.
+ * @public
+ */
+export interface MouseDownChangedEventArgs {
+    /** Indicates whether the mouse is down */
+    mouseDown: boolean;
+}
+/** Mouse Down Changed Event class.
+ * @public
+ */
+export declare class MouseDownChangedEvent extends UiEvent<MouseDownChangedEventArgs> {
+}
+/** [[ActiveContentChangedEvent]] Args interface.
+ * @public
+ */
+export interface ActiveContentChangedEventArgs {
+    /** React node of the old content */
+    oldContent?: React.ReactNode;
+    /** React node of the newly active content */
+    activeContent?: React.ReactNode;
+}
+/** Active Content Changed Event class.
+ * @public
+ */
+export declare class ActiveContentChangedEvent extends UiEvent<ActiveContentChangedEventArgs> {
+}
+/** Content Dialog Changed Event class.
+ * @public
+ */
+export declare class ContentDialogChangedEvent extends DialogChangedEvent {
+}
+/** @public */
+export interface ContentDialogInfo {
+    reactNode: React.ReactNode;
+    zIndex: number;
+    parentDocument: Document;
+}
+/**
+ * [[UiFramework.content]] interface
+ * @beta
+ */
+export interface FrameworkContent {
+    /** Gets the [[MouseDownChangedEvent]] */
+    readonly onMouseDownChangedEvent: MouseDownChangedEvent;
+    /** Determines if the mouse is down in a content view */
+    readonly isMouseDown: boolean;
+    /** Sets the mouse down status for a content view */
+    setMouseDown(mouseDown: boolean): void;
+    /** Gets the [[ActiveContentChangedEvent]] */
+    readonly onActiveContentChangedEvent: ActiveContentChangedEvent;
+    /** Fires when floating contents are added or removed */
+    readonly onAvailableContentChangedEvent: UiEvent<{
+        contentId: string;
+    }>;
+    /** Gets the active content as a React.ReactNode. */
+    getActive(): React.ReactNode | undefined;
+    /** Return the active ContentControl. */
+    getActiveContentControl(): ContentControl | undefined;
+    addFloatingContentControl(contentControl?: ContentControl): void;
+    dropFloatingContentControl(contentControl?: ContentControl): void;
+    /** Sets the active [[ContentControl]] */
+    setActive(activeContent?: React.ReactNode, forceEventProcessing?: boolean): void;
+    /** Refreshes the active [[ContentControl]] */
+    refreshActive(activeContent: React.ReactNode): void;
+    /**
+     * Determines if content displays a Sheet view.
+     * @param content ContentControl to check
+     */
+    isContentSheetView(content: ContentControl | undefined): boolean;
+    /**
+     * Determines if content displays a Drawing view.
+     * @param content ContentControl to check
+     */
+    isContentDrawingView(content: ContentControl | undefined): boolean;
+    /**
+     * Determines if content displays a Spatial view.
+     * @param content ContentControl to check
+     */
+    isContentSpatialView(content: ContentControl | undefined): boolean;
+    /**
+     * Determines if content displays a Orthographic view.
+     * @param content ContentControl to check
+     */
+    isContentOrthographicView(content: ContentControl | undefined): boolean;
+    /**
+     * Determines if content displays a 3d view.
+     * @param content ContentControl to check
+     */
+    isContent3dView(content: ContentControl | undefined): boolean;
+    /**
+     * Determines if viewport supports use of a camera.
+     * @param content ContentControl to check
+     */
+    contentSupportsCamera(content: ContentControl | undefined): boolean;
+    /**
+     * Manage content layouts.
+     * @beta
+     */
+    readonly layouts: {
+        /** build a layout key that is unique for group layout combination */
+        getKey(props: {
+            contentGroupId: string;
+            layoutId: string;
+        }): string;
+        /** Return a LayoutDef that is specific to a content group.
+         * @returns the [[ContentLayoutDef]] if found, or undefined otherwise
+         */
+        getForGroup(contentGroupProps: ContentGroupProps | ContentGroup, overrideContentLayout?: ContentLayoutProps): ContentLayoutDef;
+        /** Finds a Content Layout with a given id.
+         * @param layoutKey  group specific layout id, see `getLayoutKey`
+         * @returns the [[ContentLayoutDef]] if found, or undefined otherwise
+         */
+        find(layoutKey: string): ContentLayoutDef | undefined;
+        /** Adds a Content Layout.
+         * @param layoutId  the id of the Content Layout to add
+         * @param layoutDef  the Content Layout definition to add
+         */
+        add(layoutId: string, layoutDef: ContentLayoutDef): void;
+        /** Gets the active Content Layout */
+        readonly activeLayout: ContentLayoutDef | undefined;
+        /** Gets the active Content Group */
+        readonly activeContentGroup: ContentGroup | undefined;
+        /** Sets the active Content Layout, Content Group and Content Control.
+         * @param contentLayoutDef  Content layout to make active
+         * @param contentGroup  Content Group to make active
+         */
+        setActive(contentLayoutDef: ContentLayoutDef, contentGroup: ContentGroup): Promise<void>;
+        /** Sets the active Content Group.
+         * @param contentGroup  Content Group to make active
+         */
+        setActiveContentGroup(contentGroup: ContentGroup): Promise<void>;
+        /** Refreshes the active layout and content group.
+         */
+        refreshActive(): void;
+    };
+    /**
+     * Manage dialogs displaying managed content.
+     * @beta
+     */
+    readonly dialogs: FrameworkStackedDialog<ContentDialogInfo> & {
+        /** Content Dialog Changed Event */
+        readonly onContentDialogChangedEvent: ContentDialogChangedEvent;
+    };
+}
+//# sourceMappingURL=FrameworkContent.d.ts.map

package/lib/cjs/appui-react/framework/FrameworkContent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkContent.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkContent.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,OAAO,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0CAA0C;IAC1C,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,OAAO,CAAC,yBAAyB,CAAC;CAAI;AAEjF;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,oCAAoC;IACpC,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC7B,6CAA6C;IAC7C,aAAa,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CACjC;AAED;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,OAAO,CAAC,6BAA6B,CAAC;CAAI;AAEzF;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,kBAAkB;CAAI;AAErE,cAAc;AACd,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,QAAQ,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yCAAyC;IACzC,QAAQ,CAAC,uBAAuB,EAAE,qBAAqB,CAAC;IAExD,wDAAwD;IACxD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAE9B,oDAAoD;IACpD,YAAY,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAEvC,6CAA6C;IAC7C,QAAQ,CAAC,2BAA2B,EAAE,yBAAyB,CAAC;IAEhE,wDAAwD;IAExD,QAAQ,CAAC,8BAA8B,EAAE,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAExE,oDAAoD;IACpD,SAAS,IAAI,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;IAEzC,wCAAwC;IACxC,uBAAuB,IAAI,cAAc,GAAG,SAAS,CAAC;IAEtD,yBAAyB,CAAC,cAAc,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAEjE,0BAA0B,CAAC,cAAc,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAElE,yCAAyC;IACzC,SAAS,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjF,8CAA8C;IAC9C,aAAa,CAAC,aAAa,EAAE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpD;;;OAGG;IACH,kBAAkB,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,GAAG,OAAO,CAAC;IAEjE;;;OAGG;IACH,oBAAoB,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,GAAG,OAAO,CAAC;IAEnE;;;OAGG;IACH,oBAAoB,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,GAAG,OAAO,CAAC;IAEnE;;;OAGG;IACH,yBAAyB,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,GAAG,OAAO,CAAC;IAExE;;;OAGG;IACH,eAAe,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,GAAG,OAAO,CAAC;IAE9D;;;OAGG;IACH,qBAAqB,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,GAAG,OAAO,CAAC;IAEpE;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE;QAChB,qEAAqE;QACrE,MAAM,CAAC,KAAK,EAAE;YAAE,cAAc,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,GAAG,MAAM,CAAC;QAEpE;;WAEG;QACH,WAAW,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,YAAY,EAAE,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,gBAAgB,CAAC;QAE/H;;;WAGG;QACH,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAC;QAEtD;;;WAGG;QACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,gBAAgB,GAAG,IAAI,CAAC;QAEzD,qCAAqC;QACrC,QAAQ,CAAC,YAAY,EAAE,gBAAgB,GAAG,SAAS,CAAC;QAEpD,oCAAoC;QACpC,QAAQ,CAAC,kBAAkB,EAAE,YAAY,GAAG,SAAS,CAAC;QAEtD;;;WAGG;QACH,SAAS,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEzF;;WAEG;QACH,qBAAqB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEjE;WACG;QACH,aAAa,IAAI,IAAI,CAAC;KACvB,CAAC;IACF;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC,iBAAiB,CAAC,GAAG;QAC5D,mCAAmC;QACnC,QAAQ,CAAC,2BAA2B,EAAE,yBAAyB,CAAC;KACjE,CAAC;CACH"}

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

@@ -0,0 +1,31 @@
+"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 ContentView
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentDialogChangedEvent = exports.ActiveContentChangedEvent = exports.MouseDownChangedEvent = void 0;
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const DialogManagerBase_1 = require("../dialog/DialogManagerBase");
+/** Mouse Down Changed Event class.
+ * @public
+ */
+class MouseDownChangedEvent extends appui_abstract_1.UiEvent {
+}
+exports.MouseDownChangedEvent = MouseDownChangedEvent;
+/** Active Content Changed Event class.
+ * @public
+ */
+class ActiveContentChangedEvent extends appui_abstract_1.UiEvent {
+}
+exports.ActiveContentChangedEvent = ActiveContentChangedEvent;
+/** Content Dialog Changed Event class.
+ * @public
+ */
+class ContentDialogChangedEvent extends DialogManagerBase_1.DialogChangedEvent {
+}
+exports.ContentDialogChangedEvent = ContentDialogChangedEvent;
+//# sourceMappingURL=FrameworkContent.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkContent.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkContent.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,0DAAoE;AAIpE,mEAAiE;AAWjE;;GAEG;AACH,MAAa,qBAAsB,SAAQ,wBAAkC;CAAI;AAAjF,sDAAiF;AAYjF;;GAEG;AACH,MAAa,yBAA0B,SAAQ,wBAAsC;CAAI;AAAzF,8DAAyF;AAEzF;;GAEG;AACH,MAAa,yBAA0B,SAAQ,sCAAkB;CAAI;AAArE,8DAAqE","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 ContentView\r\n */\r\n\r\nimport { ContentLayoutProps, UiEvent } from \"@itwin/appui-abstract\";\r\nimport { ContentControl } from \"../content/ContentControl\";\r\nimport { ContentGroup, ContentGroupProps } from \"../content/ContentGroup\";\r\nimport { ContentLayoutDef } from \"../content/ContentLayout\";\r\nimport { DialogChangedEvent } from \"../dialog/DialogManagerBase\";\r\nimport { FrameworkStackedDialog } from \"./FrameworkDialogs\";\r\n\r\n/** [[MouseDownChangedEvent]] Args interface.\r\n * @public\r\n */\r\nexport interface MouseDownChangedEventArgs {\r\n  /** Indicates whether the mouse is down */\r\n  mouseDown: boolean;\r\n}\r\n\r\n/** Mouse Down Changed Event class.\r\n * @public\r\n */\r\nexport class MouseDownChangedEvent extends UiEvent<MouseDownChangedEventArgs> { }\r\n\r\n/** [[ActiveContentChangedEvent]] Args interface.\r\n * @public\r\n */\r\nexport interface ActiveContentChangedEventArgs {\r\n  /** React node of the old content */\r\n  oldContent?: React.ReactNode;\r\n  /** React node of the newly active content */\r\n  activeContent?: React.ReactNode;\r\n}\r\n\r\n/** Active Content Changed Event class.\r\n * @public\r\n */\r\nexport class ActiveContentChangedEvent extends UiEvent<ActiveContentChangedEventArgs> { }\r\n\r\n/** Content Dialog Changed Event class.\r\n * @public\r\n */\r\nexport class ContentDialogChangedEvent extends DialogChangedEvent { }\r\n\r\n/** @public */\r\nexport interface ContentDialogInfo {\r\n  reactNode: React.ReactNode;\r\n  zIndex: number;\r\n  parentDocument: Document;\r\n}\r\n\r\n/**\r\n * [[UiFramework.content]] interface\r\n * @beta\r\n */\r\nexport interface FrameworkContent {\r\n  /** Gets the [[MouseDownChangedEvent]] */\r\n  readonly onMouseDownChangedEvent: MouseDownChangedEvent;\r\n\r\n  /** Determines if the mouse is down in a content view */\r\n  readonly isMouseDown: boolean;\r\n\r\n  /** Sets the mouse down status for a content view */\r\n  setMouseDown(mouseDown: boolean): void;\r\n\r\n  /** Gets the [[ActiveContentChangedEvent]] */\r\n  readonly onActiveContentChangedEvent: ActiveContentChangedEvent;\r\n\r\n  /** Fires when floating contents are added or removed */\r\n\r\n  readonly onAvailableContentChangedEvent: UiEvent<{ contentId: string }>;\r\n\r\n  /** Gets the active content as a React.ReactNode. */\r\n  getActive(): React.ReactNode | undefined;\r\n\r\n  /** Return the active ContentControl. */\r\n  getActiveContentControl(): ContentControl | undefined;\r\n\r\n  addFloatingContentControl(contentControl?: ContentControl): void;\r\n\r\n  dropFloatingContentControl(contentControl?: ContentControl): void;\r\n\r\n  /** Sets the active [[ContentControl]] */\r\n  setActive(activeContent?: React.ReactNode, forceEventProcessing?: boolean): void;\r\n\r\n  /** Refreshes the active [[ContentControl]] */\r\n  refreshActive(activeContent: React.ReactNode): void;\r\n\r\n  /**\r\n   * Determines if content displays a Sheet view.\r\n   * @param content ContentControl to check\r\n   */\r\n  isContentSheetView(content: ContentControl | undefined): boolean;\r\n\r\n  /**\r\n   * Determines if content displays a Drawing view.\r\n   * @param content ContentControl to check\r\n   */\r\n  isContentDrawingView(content: ContentControl | undefined): boolean;\r\n\r\n  /**\r\n   * Determines if content displays a Spatial view.\r\n   * @param content ContentControl to check\r\n   */\r\n  isContentSpatialView(content: ContentControl | undefined): boolean;\r\n\r\n  /**\r\n   * Determines if content displays a Orthographic view.\r\n   * @param content ContentControl to check\r\n   */\r\n  isContentOrthographicView(content: ContentControl | undefined): boolean;\r\n\r\n  /**\r\n   * Determines if content displays a 3d view.\r\n   * @param content ContentControl to check\r\n   */\r\n  isContent3dView(content: ContentControl | undefined): boolean;\r\n\r\n  /**\r\n   * Determines if viewport supports use of a camera.\r\n   * @param content ContentControl to check\r\n   */\r\n  contentSupportsCamera(content: ContentControl | undefined): boolean;\r\n\r\n  /**\r\n   * Manage content layouts.\r\n   * @beta\r\n   */\r\n  readonly layouts: {\r\n    /** build a layout key that is unique for group layout combination */\r\n    getKey(props: { contentGroupId: string, layoutId: string }): string;\r\n\r\n    /** Return a LayoutDef that is specific to a content group.\r\n     * @returns the [[ContentLayoutDef]] if found, or undefined otherwise\r\n     */\r\n    getForGroup(contentGroupProps: ContentGroupProps | ContentGroup, overrideContentLayout?: ContentLayoutProps): ContentLayoutDef;\r\n\r\n    /** Finds a Content Layout with a given id.\r\n     * @param layoutKey  group specific layout id, see `getLayoutKey`\r\n     * @returns the [[ContentLayoutDef]] if found, or undefined otherwise\r\n     */\r\n    find(layoutKey: string): ContentLayoutDef | undefined;\r\n\r\n    /** Adds a Content Layout.\r\n     * @param layoutId  the id of the Content Layout to add\r\n     * @param layoutDef  the Content Layout definition to add\r\n     */\r\n    add(layoutId: string, layoutDef: ContentLayoutDef): void;\r\n\r\n    /** Gets the active Content Layout */\r\n    readonly activeLayout: ContentLayoutDef | undefined;\r\n\r\n    /** Gets the active Content Group */\r\n    readonly activeContentGroup: ContentGroup | undefined;\r\n\r\n    /** Sets the active Content Layout, Content Group and Content Control.\r\n     * @param contentLayoutDef  Content layout to make active\r\n     * @param contentGroup  Content Group to make active\r\n     */\r\n    setActive(contentLayoutDef: ContentLayoutDef, contentGroup: ContentGroup): Promise<void>;\r\n\r\n    /** Sets the active Content Group.\r\n     * @param contentGroup  Content Group to make active\r\n     */\r\n    setActiveContentGroup(contentGroup: ContentGroup): Promise<void>;\r\n\r\n    /** Refreshes the active layout and content group.\r\n     */\r\n    refreshActive(): void;\r\n  };\r\n  /**\r\n   * Manage dialogs displaying managed content.\r\n   * @beta\r\n   */\r\n  readonly dialogs: FrameworkStackedDialog<ContentDialogInfo> & {\r\n    /** Content Dialog Changed Event */\r\n    readonly onContentDialogChangedEvent: ContentDialogChangedEvent;\r\n  };\r\n}\r\n"]}

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

@@ -0,0 +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;
+}
+//# sourceMappingURL=FrameworkControls.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkControls.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkControls.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,gCAAgC,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AAElH;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAEhC;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,gCAAgC,GAAG,IAAI,CAAC;IAE/E;;;OAGG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;IAEvC;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAAC;IAEhH,wDAAwD;IACxD,iBAAiB,IAAI,WAAW,CAAC;IAEjC,0CAA0C;IAC1C,OAAO,IAAI,IAAI,CAAC;CAEjB"}

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

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

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

@@ -0,0 +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"]}

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

@@ -0,0 +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;
+    };
+}
+//# sourceMappingURL=FrameworkDialogs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkDialogs.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkDialogs.ts"],"names":[],"mappings":";AAIA;;GAEG;AACH,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAE7E;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,kBAAkB;CAAI;AAEnE;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,kBAAkB;CAAI;AAEtE,cAAc;AACd,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,QAAQ,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,qCAAqC;IACrC,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,CAAC;IAE/B;;;;OAIG;IACH,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IAE5E;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC;IAEtC,yBAAyB;IACzB,MAAM,IAAI,IAAI,CAAC;IAEf,kCAAkC;IAClC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;IAE7C,qCAAqC;IACrC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB,CAAC,cAAc,CAAE,SAAQ,eAAe;IAC7E,uDAAuD;IACvD,sBAAsB,CAAC,MAAM,EAAE,KAAK,CAAC,YAAY,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAE7F,4CAA4C;IAC5C,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;IAE9B,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,GAAG;QAChC,iCAAiC;QACjC,QAAQ,CAAC,yBAAyB,EAAE,uBAAuB,CAAC;KAC7D,CAAC;IAEF;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,CAAC,kBAAkB,CAAC,GAAG;QAC9D,oCAAoC;QACpC,QAAQ,CAAC,4BAA4B,EAAE,0BAA0B,CAAC;KACnE,CAAC;CACH"}

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

@@ -0,0 +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;
+//# sourceMappingURL=FrameworkDialogs.js.map

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

@@ -0,0 +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"]}