@itwin/appui-react 4.17.1 → 5.0.0-dev.2

package/lib/cjs/appui-react/content/ContentGroup.js

@@ -1,199 +0,0 @@
-"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.ContentGroup = exports.ContentGroupProvider = void 0;
-const appui_abstract_1 = require("@itwin/appui-abstract");
-const ConfigurableUiControl_1 = require("../configurableui/ConfigurableUiControl");
-const UiFramework_1 = require("../UiFramework");
-const InternalConfigurableUiManager_1 = require("../configurableui/InternalConfigurableUiManager");
-/** Abstract class that can be implemented and specified by frontstage to dynamically construct
- * content group just prior to activating the frontstage.
- * @public
- */
-class ContentGroupProvider {
-    /** Allow provider to update any data stored in ContentGroupProps. Typically this may
-     * be to remove applicationData entries.
-     */
-    prepareToSaveProps(contentGroupProps) {
-        return contentGroupProps;
-    }
-    /** Allow provider to update any stored ContentGroupProps be it is to be used to create ContentGroup and layouts.
-     * Typically this may be to add applicationData to content entries.
-     */
-    applyUpdatesToSavedProps(contentGroupProps) {
-        return contentGroupProps;
-    }
-    /** Allow provider to save any content group data before the stage deactivated. */
-    async onFrontstageDeactivated() { }
-}
-exports.ContentGroupProvider = ContentGroupProvider;
-/** ContentGroup class. Content Groups define content displayed in content views that are laid out using a [[ContentLayout]].
- * @public
- */
-class ContentGroup {
-    get id() {
-        return this.groupId;
-    }
-    constructor(contentGroupProps) {
-        /* eslint-disable deprecation/deprecation */
-        this._contentControls = new Map();
-        this._contentSetMap = new Map();
-        this.layout = { ...contentGroupProps.layout };
-        this.propsId = contentGroupProps.id;
-        // ensure we have a unique groupId for each instance of a content group - this will be used to generate a key in the React controls
-        this.groupId = `[${contentGroupProps.id}-${ContentGroup._sId++}]`;
-        this.contentPropsList = contentGroupProps.contents;
-    }
-    /** Gets the React nodes representing the content views in this content group.
-     * @deprecated in 4.16.0. Use {@link ContentGroup.contentPropsList} instead.
-     */
-    getContentNodes() {
-        const contentNodes = new Array();
-        this._contentSetMap.clear();
-        this.contentPropsList.forEach((contentProps, index) => {
-            if (contentProps.content) {
-                contentNodes.push(contentProps.content);
-                return;
-            }
-            // eslint-disable-next-line deprecation/deprecation
-            const control = this.getContentControl(contentProps, index);
-            if (!control)
-                return;
-            contentNodes.push(control.reactNode);
-            this._contentSetMap.set(control.controlId, control);
-        });
-        return contentNodes;
-    }
-    /** Refreshes the React nodes representing the Content Views in this Content Group. */
-    refreshContentNodes() {
-        this._contentSetMap.clear();
-    }
-    /** Called when Frontstage is deactivated. */
-    onFrontstageDeactivated() {
-        this.clearContentControls();
-    }
-    /** Called when Frontstage is ready. */
-    onFrontstageReady() { }
-    /** Clears the map of content controls. */
-    clearContentControls() {
-        this._contentControls.clear();
-    }
-    /** Creates [[ContentGroupProps]] for JSON purposes.
-     * @public
-     */
-    toJSON(contentCallback) {
-        const contentGroupProps = {
-            id: this.propsId,
-            layout: this.layout,
-            contents: this.contentPropsList,
-        };
-        contentGroupProps.contents.forEach((content, index) => {
-            // eslint-disable-next-line deprecation/deprecation
-            if (typeof content.classId !== "string") {
-                const classId = InternalConfigurableUiManager_1.InternalConfigurableUiManager.getConstructorClassId(
-                // eslint-disable-next-line deprecation/deprecation
-                content.classId);
-                // eslint-disable-next-line deprecation/deprecation
-                if (classId !== undefined)
-                    content.classId = classId;
-                else
-                    throw new appui_abstract_1.UiError(// eslint-disable-line deprecation/deprecation
-                    UiFramework_1.UiFramework.loggerCategory(this), `toJSON: ContentControl at index ${index} is NOT registered with a string id`);
-                if (typeof contentCallback === "function")
-                    contentCallback(content);
-            }
-        });
-        return contentGroupProps;
-    }
-    /** Gets Viewports from Viewport Content Controls.
-     * @internal
-     */
-    getViewports() {
-        // eslint-disable-next-line deprecation/deprecation
-        const contentControls = this.getContentControls();
-        const viewports = new Array();
-        contentControls.forEach((control) => {
-            if (control.isViewport && control.viewport) {
-                viewports.push(control.viewport);
-            }
-            else {
-                viewports.push(undefined);
-            }
-        });
-        return viewports;
-    }
-    /** Gets a [[ContentControl]] from the Content Group based on its [[ContentProps]].
-     * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.
-     */
-    getContentControl(contentProps, _index) {
-        // ensure we have a unique control Id for each instance of a content control - this will be used as a key for the React control - see `ContentControl.getKeyedReactNode`
-        const id = `${contentProps.id}::${this.groupId}`;
-        let contentControl;
-        if (!this._contentControls.get(contentProps.id)) {
-            let usedClassId = "";
-            if (typeof contentProps.classId === "string") {
-                if (!this._contentControls.get(contentProps.id) &&
-                    UiFramework_1.UiFramework.controls.isRegistered(contentProps.classId)) {
-                    contentControl = UiFramework_1.UiFramework.controls.create(contentProps.classId, id, contentProps.applicationData, contentProps.id);
-                    usedClassId = contentProps.classId;
-                }
-            }
-            else {
-                const info = new ConfigurableUiControl_1.ConfigurableCreateInfo(contentProps.classId.name, id, contentProps.id);
-                contentControl = new contentProps.classId(info, contentProps.applicationData);
-                usedClassId = contentProps.classId.name;
-            }
-            if (contentControl) {
-                if (contentControl.getType() !== ConfigurableUiControl_1.ConfigurableUiControlType.Content &&
-                    contentControl.getType() !== ConfigurableUiControl_1.ConfigurableUiControlType.Viewport) {
-                    throw new appui_abstract_1.UiError(UiFramework_1.UiFramework.loggerCategory(this), `getContentControl error: '${usedClassId}' is NOT a ContentControl or ViewportContentControl`);
-                }
-                contentControl.initialize();
-                this._contentControls.set(contentProps.id, contentControl);
-            }
-        }
-        return this._contentControls.get(contentProps.id);
-    }
-    /** Gets a [[ContentControl]] from the Content Group with a given ID.
-     * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.
-     */
-    getContentControlById(id) {
-        return this._contentControls.get(id);
-    }
-    /** Gets the [[ContentControl]] associated with a given React node representing a Content View.
-     * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.
-     */
-    getControlFromElement(node) {
-        if (this._contentSetMap.size === 0)
-            this.getContentNodes();
-        if (node && node.key) {
-            const key = node.key;
-            // key has format `${contentProps.id}::${this.groupId}` which is stored as unique id
-            const controlId = key.split("::", 1)[0];
-            return this._contentSetMap.get(controlId);
-        }
-        return undefined;
-    }
-    /** Gets an array of the content controls representing the Content Views.
-     * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.
-     */
-    getContentControls() {
-        const contentControls = new Array();
-        this.contentPropsList.forEach((contentProps, index) => {
-            const control = this.getContentControl(contentProps, index);
-            if (!control)
-                return;
-            contentControls.push(control);
-        });
-        return contentControls;
-    }
-}
-exports.ContentGroup = ContentGroup;
-ContentGroup._sId = 0;
-//# sourceMappingURL=ContentGroup.js.map

package/lib/cjs/appui-react/content/ContentGroup.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ContentGroup.js","sourceRoot":"","sources":["../../../../src/appui-react/content/ContentGroup.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAIH,0DAAgD;AAEhD,mFAGiD;AACjD,gDAA6C;AAE7C,mGAAgG;AAyChG;;;GAGG;AACH,MAAsB,oBAAoB;IAIxC;;OAEG;IACI,kBAAkB,CAAC,iBAAoC;QAC5D,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,wBAAwB,CAAC,iBAAoC;QAClE,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,kFAAkF;IAC3E,KAAK,CAAC,uBAAuB,KAAI,CAAC;CAC1C;AApBD,oDAoBC;AAOD;;GAEG;AACH,MAAa,YAAY;IAOvB,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,YAAY,iBAAoC;QAsGhD,4CAA4C;QAEpC,qBAAgB,GAAG,IAAI,GAAG,EAA0B,CAAC;QACrD,mBAAc,GAAG,IAAI,GAAG,EAA0B,CAAC;QAxGzD,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC,EAAE,CAAC;QACpC,mIAAmI;QACnI,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAiB,CAAC,EAAE,IAAI,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC;QAClE,IAAI,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,QAAQ,CAAC;IACrD,CAAC;IAED;;OAEG;IACI,eAAe;QACpB,MAAM,YAAY,GAAsB,IAAI,KAAK,EAAmB,CAAC;QAErE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAE5B,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE;YACpD,IAAI,YAAY,CAAC,OAAO,EAAE,CAAC;gBACzB,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBACxC,OAAO;YACT,CAAC;YAED,mDAAmD;YACnD,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;YAC5D,IAAI,CAAC,OAAO;gBAAE,OAAO;YAErB,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACrC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,sFAAsF;IAC/E,mBAAmB;QACxB,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IAED,6CAA6C;IACtC,uBAAuB;QAC5B,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAED,uCAAuC;IAChC,iBAAiB,KAAU,CAAC;IAEnC,0CAA0C;IACnC,oBAAoB;QACzB,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,eAAiC;QAC7C,MAAM,iBAAiB,GAAsB;YAC3C,EAAE,EAAE,IAAI,CAAC,OAAO;YAChB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ,EAAE,IAAI,CAAC,gBAAgB;SAChC,CAAC;QAEF,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;YACpD,mDAAmD;YACnD,IAAI,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACxC,MAAM,OAAO,GAAG,6DAA6B,CAAC,qBAAqB;gBACjE,mDAAmD;gBACnD,OAAO,CAAC,OAAO,CAChB,CAAC;gBACF,mDAAmD;gBACnD,IAAI,OAAO,KAAK,SAAS;oBAAE,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;;oBAEnD,MAAM,IAAI,wBAAO,CAAE,8CAA8C;oBAC/D,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,mCAAmC,KAAK,qCAAqC,CAC9E,CAAC;gBAEJ,IAAI,OAAO,eAAe,KAAK,UAAU;oBAAE,eAAe,CAAC,OAAO,CAAC,CAAC;YACtE,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,mDAAmD;QACnD,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAClD,MAAM,SAAS,GAAG,IAAI,KAAK,EAA8B,CAAC;QAE1D,eAAe,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAClC,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBAC3C,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACnC,CAAC;iBAAM,CAAC;gBACN,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IACnB,CAAC;IAOD;;OAEG;IACI,iBAAiB,CACtB,YAA0B,EAC1B,MAAc;QAEd,wKAAwK;QACxK,MAAM,EAAE,GAAG,GAAG,YAAY,CAAC,EAAE,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;QACjD,IAAI,cAA0C,CAAC;QAE/C,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC;YAChD,IAAI,WAAW,GAAW,EAAE,CAAC;YAE7B,IAAI,OAAO,YAAY,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAC7C,IACE,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;oBAC3C,yBAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,EACvD,CAAC;oBACD,cAAc,GAAG,yBAAW,CAAC,QAAQ,CAAC,MAAM,CAC1C,YAAY,CAAC,OAAO,EACpB,EAAE,EACF,YAAY,CAAC,eAAe,EAC5B,YAAY,CAAC,EAAE,CACE,CAAC;oBACpB,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC;gBACrC,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,GAAG,IAAI,8CAAsB,CACrC,YAAY,CAAC,OAAO,CAAC,IAAI,EACzB,EAAE,EACF,YAAY,CAAC,EAAE,CAChB,CAAC;gBACF,cAAc,GAAG,IAAI,YAAY,CAAC,OAAO,CACvC,IAAI,EACJ,YAAY,CAAC,eAAe,CACX,CAAC;gBACpB,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC;YAC1C,CAAC;YAED,IAAI,cAAc,EAAE,CAAC;gBACnB,IACE,cAAc,CAAC,OAAO,EAAE,KAAK,iDAAyB,CAAC,OAAO;oBAC9D,cAAc,CAAC,OAAO,EAAE,KAAK,iDAAyB,CAAC,QAAQ,EAC/D,CAAC;oBACD,MAAM,IAAI,wBAAO,CACf,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,6BAA6B,WAAW,qDAAqD,CAC9F,CAAC;gBACJ,CAAC;gBACD,cAAc,CAAC,UAAU,EAAE,CAAC;gBAC5B,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,qBAAqB,CAAC,EAAU;QACrC,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACI,qBAAqB,CAC1B,IAAqB;QAErB,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,KAAK,CAAC;YAAE,IAAI,CAAC,eAAe,EAAE,CAAC;QAE3D,IAAI,IAAI,IAAK,IAAgC,CAAC,GAAG,EAAE,CAAC;YAClD,MAAM,GAAG,GAAI,IAAgC,CAAC,GAAa,CAAC;YAC5D,oFAAoF;YACpF,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,kBAAkB;QACvB,MAAM,eAAe,GAAqB,IAAI,KAAK,EAAkB,CAAC;QAEtE,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE;YACpD,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;YAC5D,IAAI,CAAC,OAAO;gBAAE,OAAO;YAErB,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,OAAO,eAAe,CAAC;IACzB,CAAC;;AAvNH,oCA0NC;AAzNgB,iBAAI,GAAG,CAAC,AAAJ,CAAK","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 type * as React from \"react\";\nimport type { ScreenViewport } from \"@itwin/core-frontend\";\nimport { UiError } from \"@itwin/appui-abstract\";\nimport type { ConfigurableUiControlConstructor } from \"../configurableui/ConfigurableUiControl\";\nimport {\n  ConfigurableCreateInfo,\n  ConfigurableUiControlType,\n} from \"../configurableui/ConfigurableUiControl\";\nimport { UiFramework } from \"../UiFramework\";\nimport type { ContentControl } from \"./ContentControl\";\nimport { InternalConfigurableUiManager } from \"../configurableui/InternalConfigurableUiManager\";\nimport type { Frontstage } from \"../frontstage/Frontstage\";\nimport type { ContentLayoutProps } from \"./ContentLayoutProps\";\nimport type { ConditionalValue } from \"../shared/ConditionalValue\";\n\n/** Properties for content displayed in a content view\n * @public\n */\nexport interface ContentProps {\n  /** A unique id for the Content View within the group. */\n  id: string;\n  /** The class name or [[ConfigurableUiControlConstructor]] of the content control.\n   * @deprecated in 4.16.0. Use {@link ContentProps.content} instead and specify an empty string for this property. This will be made optional in 5.0.0.\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  classId: string | ConfigurableUiControlConstructor;\n  /** Optional application data passed down to the content view.\n   * @deprecated in 4.16.0. Use {@link ContentProps.content} instead.\n   */\n  applicationData?: any;\n  /** Content to be displayed in the content view. */\n  content?: React.ReactNode;\n  /** Describes if the content should display the active strip.\n   * If `undefined` the strip will be displayed only if this content is active and multiple contents are available.\n   * Floating content controls (deprecated API) and `ContentOverlay` components are considered as content nodes.\n   */\n  renderActiveStrip?: boolean | ConditionalValue<boolean | undefined>;\n}\n\n/** Properties for a [[ContentGroup]]\n * @public\n */\nexport interface ContentGroupProps {\n  /** An id for the [[ContentGroup]]. This id is used to locate a ContentGroup and it also can be used by an ContentGroupProvider to save/restore content settings */\n  id: string;\n  /** Content Layout Id or complete set of [[ContentLayoutProps]]  */\n  layout: ContentLayoutProps;\n  /** A collection of [[ContentProps]], one for each content view */\n  contents: ContentProps[];\n}\n\n/** Abstract class that can be implemented and specified by frontstage to dynamically construct\n * content group just prior to activating the frontstage.\n * @public\n */\nexport abstract class ContentGroupProvider {\n  /** Return the contentGroup based on the `Frontstage`. */\n  public abstract contentGroup(frontstage: Frontstage): Promise<ContentGroup>;\n\n  /** Allow provider to update any data stored in ContentGroupProps. Typically this may\n   * be to remove applicationData entries.\n   */\n  public prepareToSaveProps(contentGroupProps: ContentGroupProps) {\n    return contentGroupProps;\n  }\n\n  /** Allow provider to update any stored ContentGroupProps be it is to be used to create ContentGroup and layouts.\n   * Typically this may be to add applicationData to content entries.\n   */\n  public applyUpdatesToSavedProps(contentGroupProps: ContentGroupProps) {\n    return contentGroupProps;\n  }\n\n  /** Allow provider to save any content group data before the stage deactivated. */\n  public async onFrontstageDeactivated() {}\n}\n\n/** Callback to process content properties during toJSON method\n * @public\n */\nexport type ContentCallback = (content: ContentProps) => void;\n\n/** ContentGroup class. Content Groups define content displayed in content views that are laid out using a [[ContentLayout]].\n * @public\n */\nexport class ContentGroup {\n  private static _sId = 0;\n  public groupId: string;\n  public propsId: string;\n  public layout: ContentLayoutProps;\n  public contentPropsList: ContentProps[];\n\n  public get id() {\n    return this.groupId;\n  }\n\n  constructor(contentGroupProps: ContentGroupProps) {\n    this.layout = { ...contentGroupProps.layout };\n    this.propsId = contentGroupProps.id;\n    // ensure we have a unique groupId for each instance of a content group - this will be used to generate a key in the React controls\n    this.groupId = `[${contentGroupProps.id}-${ContentGroup._sId++}]`;\n    this.contentPropsList = contentGroupProps.contents;\n  }\n\n  /** Gets the React nodes representing the content views in this content group.\n   * @deprecated in 4.16.0. Use {@link ContentGroup.contentPropsList} instead.\n   */\n  public getContentNodes(): React.ReactNode[] {\n    const contentNodes: React.ReactNode[] = new Array<React.ReactNode>();\n\n    this._contentSetMap.clear();\n\n    this.contentPropsList.forEach((contentProps, index) => {\n      if (contentProps.content) {\n        contentNodes.push(contentProps.content);\n        return;\n      }\n\n      // eslint-disable-next-line deprecation/deprecation\n      const control = this.getContentControl(contentProps, index);\n      if (!control) return;\n\n      contentNodes.push(control.reactNode);\n      this._contentSetMap.set(control.controlId, control);\n    });\n\n    return contentNodes;\n  }\n\n  /** Refreshes the React nodes representing the Content Views in this Content Group. */\n  public refreshContentNodes() {\n    this._contentSetMap.clear();\n  }\n\n  /** Called when Frontstage is deactivated. */\n  public onFrontstageDeactivated(): void {\n    this.clearContentControls();\n  }\n\n  /** Called when Frontstage is ready. */\n  public onFrontstageReady(): void {}\n\n  /** Clears the map of content controls. */\n  public clearContentControls(): void {\n    this._contentControls.clear();\n  }\n\n  /** Creates [[ContentGroupProps]] for JSON purposes.\n   * @public\n   */\n  public toJSON(contentCallback?: ContentCallback): ContentGroupProps {\n    const contentGroupProps: ContentGroupProps = {\n      id: this.propsId,\n      layout: this.layout,\n      contents: this.contentPropsList,\n    };\n\n    contentGroupProps.contents.forEach((content, index) => {\n      // eslint-disable-next-line deprecation/deprecation\n      if (typeof content.classId !== \"string\") {\n        const classId = InternalConfigurableUiManager.getConstructorClassId(\n          // eslint-disable-next-line deprecation/deprecation\n          content.classId\n        );\n        // eslint-disable-next-line deprecation/deprecation\n        if (classId !== undefined) content.classId = classId;\n        else\n          throw new UiError( // eslint-disable-line deprecation/deprecation\n            UiFramework.loggerCategory(this),\n            `toJSON: ContentControl at index ${index} is NOT registered with a string id`\n          );\n\n        if (typeof contentCallback === \"function\") contentCallback(content);\n      }\n    });\n\n    return contentGroupProps;\n  }\n\n  /** Gets Viewports from Viewport Content Controls.\n   * @internal\n   */\n  public getViewports(): Array<ScreenViewport | undefined> {\n    // eslint-disable-next-line deprecation/deprecation\n    const contentControls = this.getContentControls();\n    const viewports = new Array<ScreenViewport | undefined>();\n\n    contentControls.forEach((control) => {\n      if (control.isViewport && control.viewport) {\n        viewports.push(control.viewport);\n      } else {\n        viewports.push(undefined);\n      }\n    });\n\n    return viewports;\n  }\n\n  /* eslint-disable deprecation/deprecation */\n\n  private _contentControls = new Map<string, ContentControl>();\n  private _contentSetMap = new Map<string, ContentControl>();\n\n  /** Gets a [[ContentControl]] from the Content Group based on its [[ContentProps]].\n   * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.\n   */\n  public getContentControl(\n    contentProps: ContentProps,\n    _index: number\n  ): ContentControl | undefined {\n    // ensure we have a unique control Id for each instance of a content control - this will be used as a key for the React control - see `ContentControl.getKeyedReactNode`\n    const id = `${contentProps.id}::${this.groupId}`;\n    let contentControl: ContentControl | undefined;\n\n    if (!this._contentControls.get(contentProps.id)) {\n      let usedClassId: string = \"\";\n\n      if (typeof contentProps.classId === \"string\") {\n        if (\n          !this._contentControls.get(contentProps.id) &&\n          UiFramework.controls.isRegistered(contentProps.classId)\n        ) {\n          contentControl = UiFramework.controls.create(\n            contentProps.classId,\n            id,\n            contentProps.applicationData,\n            contentProps.id\n          ) as ContentControl;\n          usedClassId = contentProps.classId;\n        }\n      } else {\n        const info = new ConfigurableCreateInfo(\n          contentProps.classId.name,\n          id,\n          contentProps.id\n        );\n        contentControl = new contentProps.classId(\n          info,\n          contentProps.applicationData\n        ) as ContentControl;\n        usedClassId = contentProps.classId.name;\n      }\n\n      if (contentControl) {\n        if (\n          contentControl.getType() !== ConfigurableUiControlType.Content &&\n          contentControl.getType() !== ConfigurableUiControlType.Viewport\n        ) {\n          throw new UiError(\n            UiFramework.loggerCategory(this),\n            `getContentControl error: '${usedClassId}' is NOT a ContentControl or ViewportContentControl`\n          );\n        }\n        contentControl.initialize();\n        this._contentControls.set(contentProps.id, contentControl);\n      }\n    }\n\n    return this._contentControls.get(contentProps.id);\n  }\n\n  /** Gets a [[ContentControl]] from the Content Group with a given ID.\n   * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.\n   */\n  public getContentControlById(id: string): ContentControl | undefined {\n    return this._contentControls.get(id);\n  }\n\n  /** Gets the [[ContentControl]] associated with a given React node representing a Content View.\n   * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.\n   */\n  public getControlFromElement(\n    node: React.ReactNode\n  ): ContentControl | undefined {\n    if (this._contentSetMap.size === 0) this.getContentNodes();\n\n    if (node && (node as React.ReactElement<any>).key) {\n      const key = (node as React.ReactElement<any>).key as string;\n      // key has format `${contentProps.id}::${this.groupId}` which is stored as unique id\n      const controlId = key.split(\"::\", 1)[0];\n      return this._contentSetMap.get(controlId);\n    }\n\n    return undefined;\n  }\n\n  /** Gets an array of the content controls representing the Content Views.\n   * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.\n   */\n  public getContentControls(): ContentControl[] {\n    const contentControls: ContentControl[] = new Array<ContentControl>();\n\n    this.contentPropsList.forEach((contentProps, index) => {\n      const control = this.getContentControl(contentProps, index);\n      if (!control) return;\n\n      contentControls.push(control);\n    });\n\n    return contentControls;\n  }\n\n  /* eslint-enable deprecation/deprecation */\n}\n"]}

package/lib/cjs/appui-react/content/ContentLayout.d.ts

@@ -1,78 +0,0 @@
-/** @packageDocumentation
- * @module ContentView
- */
-import "./ContentLayout.scss";
-import * as React from "react";
-import { UiEvent } from "@itwin/appui-abstract";
-import type { CommonProps } from "@itwin/core-react";
-import type { ContentGroup } from "./ContentGroup";
-import type { ContentLayoutProps, LayoutFragmentProps } from "./ContentLayoutProps";
-/** Properties for [[ContentWrapper]] */
-interface ContentWrapperProps extends CommonProps {
-    content: React.ReactNode;
-    contentIndex: number | undefined;
-}
-/** ContentWrapper React component.
- * @internal
- */
-export declare function ContentWrapper(props: ContentWrapperProps): React.JSX.Element;
-/** Common interface for HorizontalSplit and VerticalSplit. */
-interface LayoutSplit {
-    createContentContainer(contentNodes: React.ReactNode[], resizable: boolean): React.ReactNode;
-    isLocked: boolean;
-}
-/** Content Layout Definition class.
- * @public
- */
-export declare class ContentLayoutDef {
-    private _layoutProps;
-    private _rootSplit?;
-    /** ID for this Content Layout */
-    id: string;
-    /** Description of the layout. */
-    description: string;
-    constructor(layoutProps: ContentLayoutProps);
-    /** @deprecated in 4.16.0. Used internally. */
-    get rootSplit(): LayoutSplit | undefined;
-    /** Creates [[ContentLayoutProps]] for JSON purposes
-     * @public
-     */
-    toJSON(): ContentLayoutProps;
-    /** Fill a layout container with React nodes for each content view.
-     * @deprecated in 4.16.0. Used internally.
-     */
-    fillLayoutContainer(contentNodes: React.ReactNode[], resizable: boolean): React.ReactNode | undefined;
-    /** Gets the indexes of content views used in this Content Layout. */
-    getUsedContentIndexes(): number[];
-    private getHorizontalSplitContentIndexes;
-    private getVerticalSplitContentIndexes;
-    /** @internal */
-    static createSplit(fragmentDef: LayoutFragmentProps): LayoutSplit | undefined;
-}
-/** Content Layout Activated Event Args class.
- * @public
- * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
- */
-export interface ContentLayoutActivatedEventArgs {
-    contentLayout: ContentLayoutDef;
-    contentGroup: ContentGroup;
-}
-/** Content Layout Activated Event class.
- * @public
- * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
- */
-export declare class ContentLayoutActivatedEvent extends UiEvent<ContentLayoutActivatedEventArgs> {
-}
-/** Properties for the [[ContentLayout]] React component.
- * @public
- */
-export interface ContentLayoutComponentProps extends CommonProps {
-    contentLayout: ContentLayoutDef;
-    contentGroup: ContentGroup;
-}
-/** Content Layout React component.
- * @public
- */
-export declare function ContentLayout(props: ContentLayoutComponentProps): React.JSX.Element | null;
-export {};
-//# sourceMappingURL=ContentLayout.d.ts.map

package/lib/cjs/appui-react/content/ContentLayout.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ContentLayout.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/content/ContentLayout.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,sBAAsB,CAAC;AAE9B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAGhD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EACV,kBAAkB,EAClB,mBAAmB,EAIpB,MAAM,sBAAsB,CAAC;AAM9B,wCAAwC;AAExC,UAAU,mBAAoB,SAAQ,WAAW;IAC/C,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC;IACzB,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,mBAAmB,qBAmGxD;AAkID,8DAA8D;AAC9D,UAAU,WAAW;IACnB,sBAAsB,CACpB,YAAY,EAAE,KAAK,CAAC,SAAS,EAAE,EAC/B,SAAS,EAAE,OAAO,GACjB,KAAK,CAAC,SAAS,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAiLD;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,UAAU,CAAC,CAAc;IAEjC,iCAAiC;IAC1B,EAAE,EAAE,MAAM,CAAM;IACvB,iCAAiC;IAC1B,WAAW,EAAE,MAAM,CAAM;gBACpB,WAAW,EAAE,kBAAkB;IAO3C,8CAA8C;IAC9C,IAAW,SAAS,IAAI,WAAW,GAAG,SAAS,CAE9C;IAED;;OAEG;IACI,MAAM,IAAI,kBAAkB;IAInC;;OAEG;IACI,mBAAmB,CACxB,YAAY,EAAE,KAAK,CAAC,SAAS,EAAE,EAC/B,SAAS,EAAE,OAAO,GACjB,KAAK,CAAC,SAAS,GAAG,SAAS;IAiB9B,qEAAqE;IAC9D,qBAAqB,IAAI,MAAM,EAAE;IAmBxC,OAAO,CAAC,gCAAgC;IA+BxC,OAAO,CAAC,8BAA8B;IAgCtC,gBAAgB;WACF,WAAW,CACvB,WAAW,EAAE,mBAAmB,GAC/B,WAAW,GAAG,SAAS;CAS3B;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,aAAa,EAAE,gBAAgB,CAAC;IAChC,YAAY,EAAE,YAAY,CAAC;CAC5B;AAED;;;GAGG;AAEH,qBAAa,2BAA4B,SAAQ,OAAO,CAAC,+BAA+B,CAAC;CAAG;AAE5F;;GAEG;AAEH,MAAM,WAAW,2BAA4B,SAAQ,WAAW;IAC9D,aAAa,EAAE,gBAAgB,CAAC;IAChC,YAAY,EAAE,YAAY,CAAC;CAC5B;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,2BAA2B,4BAwD/D"}