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

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

@@ -1,76 +1,76 @@
-/** @packageDocumentation
- * @module ChildWindowManager
- */
-/// <reference types="react" />
-/** @public */
-export interface OpenChildWindowInfo {
-    childWindowId: string;
-    window: Window;
-    parentWindow: Window;
-}
-/** @public */
-export interface ChildWindowLocationProps {
-    width: number;
-    height: number;
-    left: number;
-    top: number;
-}
-/**
- * Basic recreation of the `createRoot` function type, intentionally not exported.
- */
-declare type CreateRoot = (container: Element | DocumentFragment) => {
-    render(children: React.ReactNode): void;
-};
-/**
- * [[UiFramework.childWindows]] interface.
- * @beta
- */
-export interface FrameworkChildWindows {
-    /**
-     * List of currently open child windows;
-     */
-    readonly openChildWindows: OpenChildWindowInfo[];
-    /**
-     * When using React18, the `createRoot` function must be provided in order to render Popout content with React18.
-     * Do not call if using React 17 or before.
-     *
-     * Note: The type of the function is intentionally simplified here.
-     *
-     * @param createRootFn Function imported from `import { createRoot } from "react-dom/client";`
-     * @beta Will be removed once the transition to react 18 is complete.
-     */
-    useCreateRoot(createRootFn: CreateRoot): void;
-    /**
-     * Returns the OpenChildWindowInfo for the related id.
-     * @param childWindowId Id of the window to retrieve.
-     * @returns undefined if not found.
-     */
-    find(childWindowId: string | undefined): OpenChildWindowInfo | undefined;
-    /**
-     * Return the childWindowId of the provided window.
-     * @param contentWindow Window element to identify
-     * @returns undefined if not found
-     */
-    findId(contentWindow: Window | undefined | null): string | undefined;
-    /** Close all child/pop-out windows. This typically is called when the frontstage is changed. */
-    closeAll(): void;
-    /**
-     * Close a specific child window.
-     * @param childWindowId Id of the window to close
-     * @param processWindowClose should the `close` method be called on the closing window. (defaults to true)
-     * @returns false if the window could not be found.
-     */
-    close(childWindowId: string, processWindowClose?: boolean): boolean;
-    /**
-     * Open a new child window.
-     * @param childWindowId Id to assign to the newly created window.
-     * @param title Title to display on the window.
-     * @param content ReactNode to be rendered in the window.
-     * @param location Position and size information
-     * @param useDefaultPopoutUrl use "/iTwinPopup.html" as the window Url, "" otherwise.
-     * @returns true if the window is opened successfully.
-     */
-    open(childWindowId: string, title: string, content: React.ReactNode, location: ChildWindowLocationProps, useDefaultPopoutUrl?: boolean): boolean;
-}
-export {};
+/** @packageDocumentation
+ * @module ChildWindowManager
+ */
+/// <reference types="react" />
+/** @public */
+export interface OpenChildWindowInfo {
+    childWindowId: string;
+    window: Window;
+    parentWindow: Window;
+}
+/** @public */
+export interface ChildWindowLocationProps {
+    width: number;
+    height: number;
+    left: number;
+    top: number;
+}
+/**
+ * Basic recreation of the `createRoot` function type, intentionally not exported.
+ */
+type CreateRoot = (container: Element | DocumentFragment) => {
+    render(children: React.ReactNode): void;
+};
+/**
+ * [[UiFramework.childWindows]] interface.
+ * @beta
+ */
+export interface FrameworkChildWindows {
+    /**
+     * List of currently open child windows;
+     */
+    readonly openChildWindows: OpenChildWindowInfo[];
+    /**
+     * When using React18, the `createRoot` function must be provided in order to render Popout content with React18.
+     * Do not call if using React 17 or before.
+     *
+     * Note: The type of the function is intentionally simplified here.
+     *
+     * @param createRootFn Function imported from `import { createRoot } from "react-dom/client";`
+     * @beta Will be removed once the transition to react 18 is complete.
+     */
+    useCreateRoot(createRootFn: CreateRoot): void;
+    /**
+     * Returns the OpenChildWindowInfo for the related id.
+     * @param childWindowId Id of the window to retrieve.
+     * @returns undefined if not found.
+     */
+    find(childWindowId: string | undefined): OpenChildWindowInfo | undefined;
+    /**
+     * Return the childWindowId of the provided window.
+     * @param contentWindow Window element to identify
+     * @returns undefined if not found
+     */
+    findId(contentWindow: Window | undefined | null): string | undefined;
+    /** Close all child/pop-out windows. This typically is called when the frontstage is changed. */
+    closeAll(): void;
+    /**
+     * Close a specific child window.
+     * @param childWindowId Id of the window to close
+     * @param processWindowClose should the `close` method be called on the closing window. (defaults to true)
+     * @returns false if the window could not be found.
+     */
+    close(childWindowId: string, processWindowClose?: boolean): boolean;
+    /**
+     * Open a new child window.
+     * @param childWindowId Id to assign to the newly created window.
+     * @param title Title to display on the window.
+     * @param content ReactNode to be rendered in the window.
+     * @param location Position and size information
+     * @param useDefaultPopoutUrl use "/iTwinPopup.html" as the window Url, "" otherwise.
+     * @returns true if the window is opened successfully.
+     */
+    open(childWindowId: string, title: string, content: React.ReactNode, location: ChildWindowLocationProps, useDefaultPopoutUrl?: boolean): boolean;
+}
+export {};
 //# sourceMappingURL=FrameworkChildWindows.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"FrameworkChildWindows.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkChildWindows.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,cAAc;AACd,MAAM,WAAW,mBAAmB;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,cAAc;AACd,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,aAAK,UAAU,GAAG,CAAC,SAAS,EAAE,OAAO,GAAG,gBAAgB,KAAK;IAC3D,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC;CACzC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,mBAAmB,EAAE,CAAC;IAEjD;;;;;;;;OAQG;IACH,aAAa,CAAC,YAAY,EAAE,UAAU,GAAG,IAAI,CAAC;IAE9C;;;;OAIG;IACH,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,GAAG,mBAAmB,GAAG,SAAS,CAAC;IAEzE;;;;OAIG;IACH,MAAM,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS,CAAC;IAErE,gGAAgG;IAChG,QAAQ,IAAI,IAAI,CAAC;IAEjB;;;;;OAKG;IACH,KAAK,CAAC,aAAa,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAEpE;;;;;;;;OAQG;IACH,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,SAAS,EAAE,QAAQ,EAAE,wBAAwB,EAAE,mBAAmB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CAClJ"}
+{"version":3,"file":"FrameworkChildWindows.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkChildWindows.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,cAAc;AACd,MAAM,WAAW,mBAAmB;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,cAAc;AACd,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,KAAK,UAAU,GAAG,CAAC,SAAS,EAAE,OAAO,GAAG,gBAAgB,KAAK;IAC3D,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC;CACzC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,mBAAmB,EAAE,CAAC;IAEjD;;;;;;;;OAQG;IACH,aAAa,CAAC,YAAY,EAAE,UAAU,GAAG,IAAI,CAAC;IAE9C;;;;OAIG;IACH,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,GAAG,mBAAmB,GAAG,SAAS,CAAC;IAEzE;;;;OAIG;IACH,MAAM,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS,CAAC;IAErE,gGAAgG;IAChG,QAAQ,IAAI,IAAI,CAAC;IAEjB;;;;;OAKG;IACH,KAAK,CAAC,aAAa,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAEpE;;;;;;;;OAQG;IACH,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,SAAS,EAAE,QAAQ,EAAE,wBAAwB,EAAE,mBAAmB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CAClJ"}

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

@@ -1,10 +1,10 @@
-"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 ChildWindowManager
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"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 ChildWindowManager
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=FrameworkChildWindows.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"FrameworkChildWindows.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkChildWindows.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 ChildWindowManager\r\n */\r\n\r\n/** @public */\r\nexport interface OpenChildWindowInfo {\r\n  childWindowId: string;\r\n  window: Window;\r\n  parentWindow: Window;\r\n}\r\n\r\n/** @public */\r\nexport interface ChildWindowLocationProps {\r\n  width: number;\r\n  height: number;\r\n  left: number;\r\n  top: number;\r\n}\r\n\r\n/**\r\n * Basic recreation of the `createRoot` function type, intentionally not exported.\r\n */\r\ntype CreateRoot = (container: Element | DocumentFragment) => {\r\n  render(children: React.ReactNode): void;\r\n};\r\n\r\n/**\r\n * [[UiFramework.childWindows]] interface.\r\n * @beta\r\n */\r\nexport interface FrameworkChildWindows {\r\n  /**\r\n   * List of currently open child windows;\r\n   */\r\n  readonly openChildWindows: OpenChildWindowInfo[];\r\n\r\n  /**\r\n   * When using React18, the `createRoot` function must be provided in order to render Popout content with React18.\r\n   * Do not call if using React 17 or before.\r\n   *\r\n   * Note: The type of the function is intentionally simplified here.\r\n   *\r\n   * @param createRootFn Function imported from `import { createRoot } from \"react-dom/client\";`\r\n   * @beta Will be removed once the transition to react 18 is complete.\r\n   */\r\n  useCreateRoot(createRootFn: CreateRoot): void;\r\n\r\n  /**\r\n   * Returns the OpenChildWindowInfo for the related id.\r\n   * @param childWindowId Id of the window to retrieve.\r\n   * @returns undefined if not found.\r\n   */\r\n  find(childWindowId: string | undefined): OpenChildWindowInfo | undefined;\r\n\r\n  /**\r\n   * Return the childWindowId of the provided window.\r\n   * @param contentWindow Window element to identify\r\n   * @returns undefined if not found\r\n   */\r\n  findId(contentWindow: Window | undefined | null): string | undefined;\r\n\r\n  /** Close all child/pop-out windows. This typically is called when the frontstage is changed. */\r\n  closeAll(): void;\r\n\r\n  /**\r\n   * Close a specific child window.\r\n   * @param childWindowId Id of the window to close\r\n   * @param processWindowClose should the `close` method be called on the closing window. (defaults to true)\r\n   * @returns false if the window could not be found.\r\n   */\r\n  close(childWindowId: string, processWindowClose?: boolean): boolean;\r\n\r\n  /**\r\n   * Open a new child window.\r\n   * @param childWindowId Id to assign to the newly created window.\r\n   * @param title Title to display on the window.\r\n   * @param content ReactNode to be rendered in the window.\r\n   * @param location Position and size information\r\n   * @param useDefaultPopoutUrl use \"/iTwinPopup.html\" as the window Url, \"\" otherwise.\r\n   * @returns true if the window is opened successfully.\r\n   */\r\n  open(childWindowId: string, title: string, content: React.ReactNode, location: ChildWindowLocationProps, useDefaultPopoutUrl?: boolean): boolean;\r\n}\r\n"]}
+{"version":3,"file":"FrameworkChildWindows.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkChildWindows.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 ChildWindowManager\n */\n\n/** @public */\nexport interface OpenChildWindowInfo {\n  childWindowId: string;\n  window: Window;\n  parentWindow: Window;\n}\n\n/** @public */\nexport interface ChildWindowLocationProps {\n  width: number;\n  height: number;\n  left: number;\n  top: number;\n}\n\n/**\n * Basic recreation of the `createRoot` function type, intentionally not exported.\n */\ntype CreateRoot = (container: Element | DocumentFragment) => {\n  render(children: React.ReactNode): void;\n};\n\n/**\n * [[UiFramework.childWindows]] interface.\n * @beta\n */\nexport interface FrameworkChildWindows {\n  /**\n   * List of currently open child windows;\n   */\n  readonly openChildWindows: OpenChildWindowInfo[];\n\n  /**\n   * When using React18, the `createRoot` function must be provided in order to render Popout content with React18.\n   * Do not call if using React 17 or before.\n   *\n   * Note: The type of the function is intentionally simplified here.\n   *\n   * @param createRootFn Function imported from `import { createRoot } from \"react-dom/client\";`\n   * @beta Will be removed once the transition to react 18 is complete.\n   */\n  useCreateRoot(createRootFn: CreateRoot): void;\n\n  /**\n   * Returns the OpenChildWindowInfo for the related id.\n   * @param childWindowId Id of the window to retrieve.\n   * @returns undefined if not found.\n   */\n  find(childWindowId: string | undefined): OpenChildWindowInfo | undefined;\n\n  /**\n   * Return the childWindowId of the provided window.\n   * @param contentWindow Window element to identify\n   * @returns undefined if not found\n   */\n  findId(contentWindow: Window | undefined | null): string | undefined;\n\n  /** Close all child/pop-out windows. This typically is called when the frontstage is changed. */\n  closeAll(): void;\n\n  /**\n   * Close a specific child window.\n   * @param childWindowId Id of the window to close\n   * @param processWindowClose should the `close` method be called on the closing window. (defaults to true)\n   * @returns false if the window could not be found.\n   */\n  close(childWindowId: string, processWindowClose?: boolean): boolean;\n\n  /**\n   * Open a new child window.\n   * @param childWindowId Id to assign to the newly created window.\n   * @param title Title to display on the window.\n   * @param content ReactNode to be rendered in the window.\n   * @param location Position and size information\n   * @param useDefaultPopoutUrl use \"/iTwinPopup.html\" as the window Url, \"\" otherwise.\n   * @returns true if the window is opened successfully.\n   */\n  open(childWindowId: string, title: string, content: React.ReactNode, location: ChildWindowLocationProps, useDefaultPopoutUrl?: boolean): boolean;\n}\n"]}

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

@@ -1,155 +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;
-    };
-}
+/** @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.js

@@ -1,31 +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;
+"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

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