@itwin/appui-react 3.4.4 → 3.4.6

package/lib/cjs/appui-react/backstage/Backstage.d.ts

@@ -1,59 +1,59 @@
-/** @packageDocumentation
- * @module Backstage
- */
-import * as React from "react";
-import { CommonProps, IconSpec, UiEvent } from "@itwin/core-react";
-/** [[BackstageEvent]] arguments.
- * @public
- * @deprecated use [BackstageComposer]($appui-react) instead.
- */
-export interface BackstageEventArgs {
-    isVisible: boolean;
-}
-/** Backstage Event class.
- * @public
- */
-export declare class BackstageEvent extends UiEvent<BackstageEventArgs> {
-}
-/** Properties for the [[Backstage]] React component.
- * @public
- */
-export interface BackstageProps extends CommonProps {
-    isVisible?: boolean;
-    showOverlay?: boolean;
-    onClose?: () => void;
-    header?: React.ReactNode;
-}
-/** State for the [[Backstage]] React component.
- * @internal
- */
-interface BackstageState {
-    isVisible: boolean;
-}
-/** Backstage React component.
- * @public
- */
-export declare class Backstage extends React.Component<BackstageProps, BackstageState> {
-    static readonly onBackstageEvent: BackstageEvent;
-    static isBackstageVisible: boolean;
-    /** Shows the Backstage */
-    static show(): void;
-    /** Hides the Backstage */
-    static hide(): void;
-    /** Get CommandItemDef that will toggle display of Backstage and allow iconSpec to be overridden */
-    static getBackstageToggleCommand(overrideIconSpec?: IconSpec): import("../shared/CommandItemDef").CommandItemDef;
-    /** Command that toggles the Backstage */
-    static get backstageToggleCommand(): import("../shared/CommandItemDef").CommandItemDef;
-    /** @internal */
-    readonly state: BackstageState;
-    constructor(props: BackstageProps);
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    private _handleBackstageEvent;
-    componentDidUpdate(prevProps: BackstageProps): void;
-    private setIsOpen;
-    private _onClose;
-    render(): React.ReactNode;
-}
-export {};
+/** @packageDocumentation
+ * @module Backstage
+ */
+import * as React from "react";
+import { CommonProps, IconSpec, UiEvent } from "@itwin/core-react";
+/** [[BackstageEvent]] arguments.
+ * @public
+ * @deprecated use [BackstageComposer]($appui-react) instead.
+ */
+export interface BackstageEventArgs {
+    isVisible: boolean;
+}
+/** Backstage Event class.
+ * @public
+ */
+export declare class BackstageEvent extends UiEvent<BackstageEventArgs> {
+}
+/** Properties for the [[Backstage]] React component.
+ * @public
+ */
+export interface BackstageProps extends CommonProps {
+    isVisible?: boolean;
+    showOverlay?: boolean;
+    onClose?: () => void;
+    header?: React.ReactNode;
+}
+/** State for the [[Backstage]] React component.
+ * @internal
+ */
+interface BackstageState {
+    isVisible: boolean;
+}
+/** Backstage React component.
+ * @public
+ */
+export declare class Backstage extends React.Component<BackstageProps, BackstageState> {
+    static readonly onBackstageEvent: BackstageEvent;
+    static isBackstageVisible: boolean;
+    /** Shows the Backstage */
+    static show(): void;
+    /** Hides the Backstage */
+    static hide(): void;
+    /** Get CommandItemDef that will toggle display of Backstage and allow iconSpec to be overridden */
+    static getBackstageToggleCommand(overrideIconSpec?: IconSpec): import("../shared/CommandItemDef").CommandItemDef;
+    /** Command that toggles the Backstage */
+    static get backstageToggleCommand(): import("../shared/CommandItemDef").CommandItemDef;
+    /** @internal */
+    readonly state: BackstageState;
+    constructor(props: BackstageProps);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private _handleBackstageEvent;
+    componentDidUpdate(prevProps: BackstageProps): void;
+    private setIsOpen;
+    private _onClose;
+    render(): React.ReactNode;
+}
+export {};
 //# sourceMappingURL=Backstage.d.ts.map

package/lib/cjs/appui-react/backstage/Backstage.js

@@ -1,87 +1,87 @@
-"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 Backstage
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Backstage = exports.BackstageEvent = void 0;
-const React = require("react");
-const core_react_1 = require("@itwin/core-react");
-const appui_layout_react_1 = require("@itwin/appui-layout-react");
-const SafeAreaContext_1 = require("../safearea/SafeAreaContext");
-const UiFramework_1 = require("../UiFramework");
-const BackstageManager_1 = require("./BackstageManager");
-/** Backstage Event class.
- * @public
- */
-class BackstageEvent extends core_react_1.UiEvent {
-} // eslint-disable-line deprecation/deprecation
-exports.BackstageEvent = BackstageEvent;
-/** Backstage React component.
- * @public
- */
-class Backstage extends React.Component {
-    constructor(props) {
-        super(props);
-        this._handleBackstageEvent = (args) => {
-            this.setState({ isVisible: args.isVisible });
-        };
-        this._onClose = () => {
-            Backstage.hide(); // eslint-disable-line deprecation/deprecation
-            /* istanbul ignore else */
-            if (this.props.onClose)
-                this.props.onClose();
-        };
-        this.setIsOpen(!!this.props.isVisible);
-        this.state = {
-            isVisible: UiFramework_1.UiFramework.backstageManager.isOpen,
-        };
-    }
-    /** Shows the Backstage */
-    static show() {
-        UiFramework_1.UiFramework.backstageManager.open();
-    }
-    /** Hides the Backstage */
-    static hide() {
-        UiFramework_1.UiFramework.backstageManager.close();
-    }
-    /** Get CommandItemDef that will toggle display of Backstage and allow iconSpec to be overridden */
-    static getBackstageToggleCommand(overrideIconSpec) {
-        return BackstageManager_1.BackstageManager.getBackstageToggleCommand(overrideIconSpec);
-    }
-    /** Command that toggles the Backstage */
-    static get backstageToggleCommand() {
-        return this.getBackstageToggleCommand();
-    }
-    componentDidMount() {
-        Backstage.onBackstageEvent.addListener(this._handleBackstageEvent); // eslint-disable-line deprecation/deprecation
-    }
-    componentWillUnmount() {
-        Backstage.onBackstageEvent.removeListener(this._handleBackstageEvent); // eslint-disable-line deprecation/deprecation
-    }
-    componentDidUpdate(prevProps) {
-        if (this.props.isVisible !== prevProps.isVisible)
-            this.setIsOpen(!!this.props.isVisible);
-    }
-    setIsOpen(isOpen) {
-        if (isOpen) {
-            UiFramework_1.UiFramework.backstageManager.open();
-        }
-        else {
-            UiFramework_1.UiFramework.backstageManager.close();
-        }
-    }
-    render() {
-        Backstage.isBackstageVisible = this.state.isVisible; // eslint-disable-line deprecation/deprecation
-        let header = null;
-        if (this.props.header)
-            header = this.props.header;
-        return (React.createElement(SafeAreaContext_1.SafeAreaContext.Consumer, null, (safeAreaInsets) => (React.createElement(appui_layout_react_1.Backstage, { className: this.props.className, header: header, isOpen: this.state.isVisible, onClose: this._onClose, safeAreaInsets: safeAreaInsets, showOverlay: this.props.showOverlay, style: this.props.style }, this.props.children))));
-    }
-}
-exports.Backstage = Backstage;
-Backstage.onBackstageEvent = new BackstageEvent();
+"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 Backstage
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Backstage = exports.BackstageEvent = void 0;
+const React = require("react");
+const core_react_1 = require("@itwin/core-react");
+const appui_layout_react_1 = require("@itwin/appui-layout-react");
+const SafeAreaContext_1 = require("../safearea/SafeAreaContext");
+const UiFramework_1 = require("../UiFramework");
+const BackstageManager_1 = require("./BackstageManager");
+/** Backstage Event class.
+ * @public
+ */
+class BackstageEvent extends core_react_1.UiEvent {
+} // eslint-disable-line deprecation/deprecation
+exports.BackstageEvent = BackstageEvent;
+/** Backstage React component.
+ * @public
+ */
+class Backstage extends React.Component {
+    constructor(props) {
+        super(props);
+        this._handleBackstageEvent = (args) => {
+            this.setState({ isVisible: args.isVisible });
+        };
+        this._onClose = () => {
+            Backstage.hide(); // eslint-disable-line deprecation/deprecation
+            /* istanbul ignore else */
+            if (this.props.onClose)
+                this.props.onClose();
+        };
+        this.setIsOpen(!!this.props.isVisible);
+        this.state = {
+            isVisible: UiFramework_1.UiFramework.backstageManager.isOpen,
+        };
+    }
+    /** Shows the Backstage */
+    static show() {
+        UiFramework_1.UiFramework.backstageManager.open();
+    }
+    /** Hides the Backstage */
+    static hide() {
+        UiFramework_1.UiFramework.backstageManager.close();
+    }
+    /** Get CommandItemDef that will toggle display of Backstage and allow iconSpec to be overridden */
+    static getBackstageToggleCommand(overrideIconSpec) {
+        return BackstageManager_1.BackstageManager.getBackstageToggleCommand(overrideIconSpec);
+    }
+    /** Command that toggles the Backstage */
+    static get backstageToggleCommand() {
+        return this.getBackstageToggleCommand();
+    }
+    componentDidMount() {
+        Backstage.onBackstageEvent.addListener(this._handleBackstageEvent); // eslint-disable-line deprecation/deprecation
+    }
+    componentWillUnmount() {
+        Backstage.onBackstageEvent.removeListener(this._handleBackstageEvent); // eslint-disable-line deprecation/deprecation
+    }
+    componentDidUpdate(prevProps) {
+        if (this.props.isVisible !== prevProps.isVisible)
+            this.setIsOpen(!!this.props.isVisible);
+    }
+    setIsOpen(isOpen) {
+        if (isOpen) {
+            UiFramework_1.UiFramework.backstageManager.open();
+        }
+        else {
+            UiFramework_1.UiFramework.backstageManager.close();
+        }
+    }
+    render() {
+        Backstage.isBackstageVisible = this.state.isVisible; // eslint-disable-line deprecation/deprecation
+        let header = null;
+        if (this.props.header)
+            header = this.props.header;
+        return (React.createElement(SafeAreaContext_1.SafeAreaContext.Consumer, null, (safeAreaInsets) => (React.createElement(appui_layout_react_1.Backstage, { className: this.props.className, header: header, isOpen: this.state.isVisible, onClose: this._onClose, safeAreaInsets: safeAreaInsets, showOverlay: this.props.showOverlay, style: this.props.style }, this.props.children))));
+    }
+}
+exports.Backstage = Backstage;
+Backstage.onBackstageEvent = new BackstageEvent();
 //# sourceMappingURL=Backstage.js.map

package/lib/cjs/appui-react/backstage/Backstage.js.map

@@ -1 +1 @@
-{"version":3,"file":"Backstage.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/Backstage.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,kDAAmE;AACnE,kEAAsE;AACtE,iEAA8D;AAC9D,gDAA6C;AAC7C,yDAAsD;AAYtD;;GAEG;AACH,MAAa,cAAe,SAAQ,oBAA2B;CAAI,CAAC,8CAA8C;AAAlH,wCAAmE;AAmBnE;;GAEG;AACH,MAAa,SAAU,SAAQ,KAAK,CAAC,SAAyC;IA4B5E,YAAY,KAAqB;QAC/B,KAAK,CAAC,KAAK,CAAC,CAAC;QAgBP,0BAAqB,GAAG,CAAC,IAAwB,EAAE,EAAE;YAC3D,IAAI,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAC/C,CAAC,CAAC;QAeM,aAAQ,GAAG,GAAG,EAAE;YACtB,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,8CAA8C;YAEhE,0BAA0B;YAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO;gBACpB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACzB,CAAC,CAAC;QArCA,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,CAAC,KAAK,GAAG;YACX,SAAS,EAAE,yBAAW,CAAC,gBAAgB,CAAC,MAAM;SAC/C,CAAC;IACJ,CAAC;IA9BD,0BAA0B;IACnB,MAAM,CAAC,IAAI;QAChB,yBAAW,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC;IACtC,CAAC;IAED,0BAA0B;IACnB,MAAM,CAAC,IAAI;QAChB,yBAAW,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;IACvC,CAAC;IAED,mGAAmG;IAC5F,MAAM,CAAC,yBAAyB,CAAC,gBAA2B;QACjE,OAAO,mCAAgB,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,CAAC;IACtE,CAAC;IAED,yCAAyC;IAClC,MAAM,KAAK,sBAAsB;QACtC,OAAO,IAAI,CAAC,yBAAyB,EAAE,CAAC;IAC1C,CAAC;IAce,iBAAiB;QAC/B,SAAS,CAAC,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,8CAA8C;IACpH,CAAC;IAEe,oBAAoB;QAClC,SAAS,CAAC,gBAAgB,CAAC,cAAc,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,8CAA8C;IACvH,CAAC;IAMe,kBAAkB,CAAC,SAAyB;QAC1D,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC,SAAS;YAC9C,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC3C,CAAC;IAEO,SAAS,CAAC,MAAe;QAC/B,IAAI,MAAM,EAAE;YACV,yBAAW,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC;SACrC;aAAM;YACL,yBAAW,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;SACtC;IACH,CAAC;IAUe,MAAM;QACpB,SAAS,CAAC,kBAAkB,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,8CAA8C;QAEnG,IAAI,MAAM,GAAoB,IAAI,CAAC;QAEnC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM;YACnB,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;QAE7B,OAAO,CACL,oBAAC,iCAAe,CAAC,QAAQ,QACtB,CAAC,cAAc,EAAE,EAAE,CAAC,CACnB,oBAAC,8BAAY,IACX,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAC/B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAC5B,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,cAAc,EAAE,cAAc,EAC9B,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,EACnC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,IAEtB,IAAI,CAAC,KAAK,CAAC,QAAQ,CACP,CAChB,CACwB,CAC5B,CAAC;IACJ,CAAC;;AA/FH,8BAgGC;AA9FwB,0BAAgB,GAAG,IAAI,cAAc,EAAE,CAAC","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 Backstage\n */\n\nimport * as React from \"react\";\nimport { CommonProps, IconSpec, UiEvent } from \"@itwin/core-react\";\nimport { Backstage as NZ_Backstage } from \"@itwin/appui-layout-react\";\nimport { SafeAreaContext } from \"../safearea/SafeAreaContext\";\nimport { UiFramework } from \"../UiFramework\";\nimport { BackstageManager } from \"./BackstageManager\";\n\n// cSpell:ignore safearea\n\n/** [[BackstageEvent]] arguments.\n * @public\n * @deprecated use [BackstageComposer]($appui-react) instead.\n */\nexport interface BackstageEventArgs {\n  isVisible: boolean;\n}\n\n/** Backstage Event class.\n * @public\n */\nexport class BackstageEvent extends UiEvent<BackstageEventArgs> { } // eslint-disable-line deprecation/deprecation\n\n/** Properties for the [[Backstage]] React component.\n * @public\n */\nexport interface BackstageProps extends CommonProps {\n  isVisible?: boolean;\n  showOverlay?: boolean;\n  onClose?: () => void;\n  header?: React.ReactNode;\n}\n\n/** State for the [[Backstage]] React component.\n * @internal\n */\ninterface BackstageState {\n  isVisible: boolean;\n}\n\n/** Backstage React component.\n * @public\n */\nexport class Backstage extends React.Component<BackstageProps, BackstageState> { // eslint-disable-line deprecation/deprecation\n\n  public static readonly onBackstageEvent = new BackstageEvent();\n  public static isBackstageVisible: boolean;\n\n  /** Shows the Backstage */\n  public static show(): void {\n    UiFramework.backstageManager.open();\n  }\n\n  /** Hides the Backstage */\n  public static hide(): void {\n    UiFramework.backstageManager.close();\n  }\n\n  /** Get CommandItemDef that will toggle display of Backstage and allow iconSpec to be overridden */\n  public static getBackstageToggleCommand(overrideIconSpec?: IconSpec) {\n    return BackstageManager.getBackstageToggleCommand(overrideIconSpec);\n  }\n\n  /** Command that toggles the Backstage */\n  public static get backstageToggleCommand() {\n    return this.getBackstageToggleCommand();\n  }\n\n  /** @internal */\n  public override readonly state: BackstageState;\n\n  constructor(props: BackstageProps) { // eslint-disable-line deprecation/deprecation\n    super(props);\n\n    this.setIsOpen(!!this.props.isVisible);\n    this.state = {\n      isVisible: UiFramework.backstageManager.isOpen,\n    };\n  }\n\n  public override componentDidMount() {\n    Backstage.onBackstageEvent.addListener(this._handleBackstageEvent); // eslint-disable-line deprecation/deprecation\n  }\n\n  public override componentWillUnmount() {\n    Backstage.onBackstageEvent.removeListener(this._handleBackstageEvent); // eslint-disable-line deprecation/deprecation\n  }\n\n  private _handleBackstageEvent = (args: BackstageEventArgs) => { // eslint-disable-line deprecation/deprecation\n    this.setState({ isVisible: args.isVisible });\n  };\n\n  public override componentDidUpdate(prevProps: BackstageProps) { // eslint-disable-line deprecation/deprecation\n    if (this.props.isVisible !== prevProps.isVisible)\n      this.setIsOpen(!!this.props.isVisible);\n  }\n\n  private setIsOpen(isOpen: boolean) {\n    if (isOpen) {\n      UiFramework.backstageManager.open();\n    } else {\n      UiFramework.backstageManager.close();\n    }\n  }\n\n  private _onClose = () => {\n    Backstage.hide(); // eslint-disable-line deprecation/deprecation\n\n    /* istanbul ignore else */\n    if (this.props.onClose)\n      this.props.onClose();\n  };\n\n  public override render(): React.ReactNode {\n    Backstage.isBackstageVisible = this.state.isVisible; // eslint-disable-line deprecation/deprecation\n\n    let header: React.ReactNode = null;\n\n    if (this.props.header)\n      header = this.props.header;\n\n    return (\n      <SafeAreaContext.Consumer>\n        {(safeAreaInsets) => (\n          <NZ_Backstage\n            className={this.props.className}\n            header={header}\n            isOpen={this.state.isVisible}\n            onClose={this._onClose}\n            safeAreaInsets={safeAreaInsets}\n            showOverlay={this.props.showOverlay}\n            style={this.props.style}\n          >\n            {this.props.children}\n          </NZ_Backstage>\n        )}\n      </SafeAreaContext.Consumer>\n    );\n  }\n}\n"]}
+{"version":3,"file":"Backstage.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/Backstage.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,kDAAmE;AACnE,kEAAsE;AACtE,iEAA8D;AAC9D,gDAA6C;AAC7C,yDAAsD;AAYtD;;GAEG;AACH,MAAa,cAAe,SAAQ,oBAA2B;CAAI,CAAC,8CAA8C;AAAlH,wCAAmE;AAmBnE;;GAEG;AACH,MAAa,SAAU,SAAQ,KAAK,CAAC,SAAyC;IA4B5E,YAAY,KAAqB;QAC/B,KAAK,CAAC,KAAK,CAAC,CAAC;QAgBP,0BAAqB,GAAG,CAAC,IAAwB,EAAE,EAAE;YAC3D,IAAI,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAC/C,CAAC,CAAC;QAeM,aAAQ,GAAG,GAAG,EAAE;YACtB,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,8CAA8C;YAEhE,0BAA0B;YAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO;gBACpB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACzB,CAAC,CAAC;QArCA,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,CAAC,KAAK,GAAG;YACX,SAAS,EAAE,yBAAW,CAAC,gBAAgB,CAAC,MAAM;SAC/C,CAAC;IACJ,CAAC;IA9BD,0BAA0B;IACnB,MAAM,CAAC,IAAI;QAChB,yBAAW,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC;IACtC,CAAC;IAED,0BAA0B;IACnB,MAAM,CAAC,IAAI;QAChB,yBAAW,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;IACvC,CAAC;IAED,mGAAmG;IAC5F,MAAM,CAAC,yBAAyB,CAAC,gBAA2B;QACjE,OAAO,mCAAgB,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,CAAC;IACtE,CAAC;IAED,yCAAyC;IAClC,MAAM,KAAK,sBAAsB;QACtC,OAAO,IAAI,CAAC,yBAAyB,EAAE,CAAC;IAC1C,CAAC;IAce,iBAAiB;QAC/B,SAAS,CAAC,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,8CAA8C;IACpH,CAAC;IAEe,oBAAoB;QAClC,SAAS,CAAC,gBAAgB,CAAC,cAAc,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,8CAA8C;IACvH,CAAC;IAMe,kBAAkB,CAAC,SAAyB;QAC1D,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC,SAAS;YAC9C,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC3C,CAAC;IAEO,SAAS,CAAC,MAAe;QAC/B,IAAI,MAAM,EAAE;YACV,yBAAW,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC;SACrC;aAAM;YACL,yBAAW,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;SACtC;IACH,CAAC;IAUe,MAAM;QACpB,SAAS,CAAC,kBAAkB,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,8CAA8C;QAEnG,IAAI,MAAM,GAAoB,IAAI,CAAC;QAEnC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM;YACnB,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;QAE7B,OAAO,CACL,oBAAC,iCAAe,CAAC,QAAQ,QACtB,CAAC,cAAc,EAAE,EAAE,CAAC,CACnB,oBAAC,8BAAY,IACX,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAC/B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAC5B,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,cAAc,EAAE,cAAc,EAC9B,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,EACnC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,IAEtB,IAAI,CAAC,KAAK,CAAC,QAAQ,CACP,CAChB,CACwB,CAC5B,CAAC;IACJ,CAAC;;AA/FH,8BAgGC;AA9FwB,0BAAgB,GAAG,IAAI,cAAc,EAAE,CAAC","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 Backstage\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { CommonProps, IconSpec, UiEvent } from \"@itwin/core-react\";\r\nimport { Backstage as NZ_Backstage } from \"@itwin/appui-layout-react\";\r\nimport { SafeAreaContext } from \"../safearea/SafeAreaContext\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { BackstageManager } from \"./BackstageManager\";\r\n\r\n// cSpell:ignore safearea\r\n\r\n/** [[BackstageEvent]] arguments.\r\n * @public\r\n * @deprecated use [BackstageComposer]($appui-react) instead.\r\n */\r\nexport interface BackstageEventArgs {\r\n  isVisible: boolean;\r\n}\r\n\r\n/** Backstage Event class.\r\n * @public\r\n */\r\nexport class BackstageEvent extends UiEvent<BackstageEventArgs> { } // eslint-disable-line deprecation/deprecation\r\n\r\n/** Properties for the [[Backstage]] React component.\r\n * @public\r\n */\r\nexport interface BackstageProps extends CommonProps {\r\n  isVisible?: boolean;\r\n  showOverlay?: boolean;\r\n  onClose?: () => void;\r\n  header?: React.ReactNode;\r\n}\r\n\r\n/** State for the [[Backstage]] React component.\r\n * @internal\r\n */\r\ninterface BackstageState {\r\n  isVisible: boolean;\r\n}\r\n\r\n/** Backstage React component.\r\n * @public\r\n */\r\nexport class Backstage extends React.Component<BackstageProps, BackstageState> { // eslint-disable-line deprecation/deprecation\r\n\r\n  public static readonly onBackstageEvent = new BackstageEvent();\r\n  public static isBackstageVisible: boolean;\r\n\r\n  /** Shows the Backstage */\r\n  public static show(): void {\r\n    UiFramework.backstageManager.open();\r\n  }\r\n\r\n  /** Hides the Backstage */\r\n  public static hide(): void {\r\n    UiFramework.backstageManager.close();\r\n  }\r\n\r\n  /** Get CommandItemDef that will toggle display of Backstage and allow iconSpec to be overridden */\r\n  public static getBackstageToggleCommand(overrideIconSpec?: IconSpec) {\r\n    return BackstageManager.getBackstageToggleCommand(overrideIconSpec);\r\n  }\r\n\r\n  /** Command that toggles the Backstage */\r\n  public static get backstageToggleCommand() {\r\n    return this.getBackstageToggleCommand();\r\n  }\r\n\r\n  /** @internal */\r\n  public override readonly state: BackstageState;\r\n\r\n  constructor(props: BackstageProps) { // eslint-disable-line deprecation/deprecation\r\n    super(props);\r\n\r\n    this.setIsOpen(!!this.props.isVisible);\r\n    this.state = {\r\n      isVisible: UiFramework.backstageManager.isOpen,\r\n    };\r\n  }\r\n\r\n  public override componentDidMount() {\r\n    Backstage.onBackstageEvent.addListener(this._handleBackstageEvent); // eslint-disable-line deprecation/deprecation\r\n  }\r\n\r\n  public override componentWillUnmount() {\r\n    Backstage.onBackstageEvent.removeListener(this._handleBackstageEvent); // eslint-disable-line deprecation/deprecation\r\n  }\r\n\r\n  private _handleBackstageEvent = (args: BackstageEventArgs) => { // eslint-disable-line deprecation/deprecation\r\n    this.setState({ isVisible: args.isVisible });\r\n  };\r\n\r\n  public override componentDidUpdate(prevProps: BackstageProps) { // eslint-disable-line deprecation/deprecation\r\n    if (this.props.isVisible !== prevProps.isVisible)\r\n      this.setIsOpen(!!this.props.isVisible);\r\n  }\r\n\r\n  private setIsOpen(isOpen: boolean) {\r\n    if (isOpen) {\r\n      UiFramework.backstageManager.open();\r\n    } else {\r\n      UiFramework.backstageManager.close();\r\n    }\r\n  }\r\n\r\n  private _onClose = () => {\r\n    Backstage.hide(); // eslint-disable-line deprecation/deprecation\r\n\r\n    /* istanbul ignore else */\r\n    if (this.props.onClose)\r\n      this.props.onClose();\r\n  };\r\n\r\n  public override render(): React.ReactNode {\r\n    Backstage.isBackstageVisible = this.state.isVisible; // eslint-disable-line deprecation/deprecation\r\n\r\n    let header: React.ReactNode = null;\r\n\r\n    if (this.props.header)\r\n      header = this.props.header;\r\n\r\n    return (\r\n      <SafeAreaContext.Consumer>\r\n        {(safeAreaInsets) => (\r\n          <NZ_Backstage\r\n            className={this.props.className}\r\n            header={header}\r\n            isOpen={this.state.isVisible}\r\n            onClose={this._onClose}\r\n            safeAreaInsets={safeAreaInsets}\r\n            showOverlay={this.props.showOverlay}\r\n            style={this.props.style}\r\n          >\r\n            {this.props.children}\r\n          </NZ_Backstage>\r\n        )}\r\n      </SafeAreaContext.Consumer>\r\n    );\r\n  }\r\n}\r\n"]}

package/lib/cjs/appui-react/backstage/BackstageComposer.d.ts

@@ -1,28 +1,28 @@
-/** @packageDocumentation
- * @module Backstage
- */
-import * as React from "react";
-import { BackstageItem } from "@itwin/appui-abstract";
-import { CommonProps } from "@itwin/core-react";
-/** @internal */
-export declare type GroupedItems = ReadonlyArray<ReadonlyArray<BackstageItem>>;
-/** @internal */
-export declare const useGroupedItems: (items: ReadonlyArray<BackstageItem>) => GroupedItems;
-/** Props of [[BackstageComposer]] component.
- * @public
- */
-export interface BackstageComposerProps extends CommonProps {
-    /** React node for an optional header item */
-    readonly header?: React.ReactNode;
-    /** Indicates whether to place an overlay over the frontstage when the backstage is displayed */
-    readonly showOverlay?: boolean;
-    /** List of static backstage items to show. Can be undefined in UiItemsProviders are used to populate backstage. */
-    readonly items?: BackstageItem[];
-    /** If true and only one stage launcher item is found, do not show entry in backstage */
-    readonly hideSoloStageEntry?: boolean;
-}
-/** Backstage component composed from [[BackstageManager]] items.
- * @public
- */
-export declare function BackstageComposer(props: BackstageComposerProps): JSX.Element;
+/** @packageDocumentation
+ * @module Backstage
+ */
+import * as React from "react";
+import { BackstageItem } from "@itwin/appui-abstract";
+import { CommonProps } from "@itwin/core-react";
+/** @internal */
+export declare type GroupedItems = ReadonlyArray<ReadonlyArray<BackstageItem>>;
+/** @internal */
+export declare const useGroupedItems: (items: ReadonlyArray<BackstageItem>) => GroupedItems;
+/** Props of [[BackstageComposer]] component.
+ * @public
+ */
+export interface BackstageComposerProps extends CommonProps {
+    /** React node for an optional header item */
+    readonly header?: React.ReactNode;
+    /** Indicates whether to place an overlay over the frontstage when the backstage is displayed */
+    readonly showOverlay?: boolean;
+    /** List of static backstage items to show. Can be undefined in UiItemsProviders are used to populate backstage. */
+    readonly items?: BackstageItem[];
+    /** If true and only one stage launcher item is found, do not show entry in backstage */
+    readonly hideSoloStageEntry?: boolean;
+}
+/** Backstage component composed from [[BackstageManager]] items.
+ * @public
+ */
+export declare function BackstageComposer(props: BackstageComposerProps): JSX.Element;
 //# sourceMappingURL=BackstageComposer.d.ts.map