@itwin/appui-react 4.6.4 → 4.7.0

package/lib/cjs/appui-react/feedback/ValidationTextbox.js

@@ -11,7 +11,7 @@ exports.ValidationTextbox = exports.InputStatus = void 0;
 require("./ValidationTextbox.scss");
 const classnames_1 = require("classnames");
 const React = require("react");
-const appui_abstract_1 = require("@itwin/appui-abstract");
+const ts_key_enum_1 = require("ts-key-enum");
 const MessageManager_1 = require("../messages/MessageManager");
 const itwinui_react_1 = require("@itwin/itwinui-react");
 /** Enum for Input Status used in [[ValidationTextbox]]
@@ -45,12 +45,12 @@ class ValidationTextbox extends React.PureComponent {
         this._handleKeyUp = (event) => {
             this.processValidateText(event.target);
             switch (event.key) {
-                case appui_abstract_1.SpecialKey.Escape:
+                case ts_key_enum_1.Key.Escape:
                     // istanbul ignore else
                     if (this.props.onEscPressed)
                         this.props.onEscPressed();
                     break;
-                case appui_abstract_1.SpecialKey.Enter:
+                case ts_key_enum_1.Key.Enter:
                     // istanbul ignore else
                     if (this.props.onEnterPressed)
                         this.props.onEnterPressed();

package/lib/cjs/appui-react/feedback/ValidationTextbox.js.map

@@ -1 +1 @@
-{"version":3,"file":"ValidationTextbox.js","sourceRoot":"","sources":["../../../../src/appui-react/feedback/ValidationTextbox.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAEH,oCAAkC;AAClC,2CAAoC;AACpC,+BAA+B;AAC/B,0DAAmD;AAEnD,+DAA4D;AAC5D,wDAA6C;AAE7C;;GAEG;AACH,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,+CAAS,CAAA;IACT,mDAAW,CAAA;AACb,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AA8BD;;;;GAIG;AACH,MAAa,iBAAkB,SAAQ,KAAK,CAAC,aAG5C;IACC,YAAY,KAA6B;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;QA4Df;;;;WAIG;QACK,kBAAa,GAAG,CAAC,KAAW,EAAQ,EAAE;YAC5C,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,MAA0B,CAAC,CAAC;QAC7D,CAAC,CAAC;QA+BF;;;WAGG;QACK,iBAAY,GAAG,CAAC,KAA4C,EAAE,EAAE;YACtE,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,MAA0B,CAAC,CAAC;YAE3D,QAAQ,KAAK,CAAC,GAAG,EAAE;gBACjB,KAAK,2BAAU,CAAC,MAAM;oBACpB,uBAAuB;oBACvB,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY;wBAAE,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;oBACvD,MAAM;gBACR,KAAK,2BAAU,CAAC,KAAK;oBACnB,uBAAuB;oBACvB,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc;wBAAE,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;oBAC3D,MAAM;aACT;QACH,CAAC,CAAC;QAjHA,IAAI,CAAC,KAAK,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACjC,CAAC;IAED,gBAAgB;IACA,MAAM;QACpB,MAAM,SAAS,GAAwB;YACrC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM;SACpE,CAAC;QACF,MAAM,QAAQ,GAAwB;YACpC,GAAG,SAAS;YACZ,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK;SACpB,CAAC;QAEF,MAAM,eAAe,GAAG,IAAA,oBAAU,EAAC,yBAAyB,CAAC,CAAC;QAE9D,MAAM,iBAAiB,GAAG,IAAA,oBAAU,EAClC,yBAAyB,EACzB,2BAA2B,CAC5B,CAAC;QAEF,OAAO,CACL,6BACE,SAAS,EAAE,IAAA,oBAAU,EAAC,wBAAwB,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EACrE,KAAK,EAAE,QAAQ;YAEf,oBAAC,qBAAK,IACJ,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,iBAAiB,EACnE,QAAQ,EAAE,IAAI,CAAC,aAAa,EAC5B,OAAO,EAAE,IAAI,CAAC,YAAY,EAC1B,OAAO,EAAE,IAAI,CAAC,aAAa,EAC3B,KAAK,EAAE,IAAI,CAAC,aAAa,EACzB,MAAM,EAAE,IAAI,CAAC,aAAa,EAC1B,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,EACjE,KAAK,EAAE,SAAS,GAChB;YACD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAChB,CACP,CAAC;IACJ,CAAC;IAEO,mBAAmB,CAAC,MAAoC;QAC9D,uBAAuB;QACvB,IAAI,SAAS,KAAK,MAAM;YAAE,OAAO;QAEjC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAE9C,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE;YAC9B,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;gBACtB,IAAI,CAAC,iBAAiB,EAAE,CAAC;aAC1B;iBAAM;gBACL,uBAAuB;gBACvB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO;oBAC7C,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;aAClC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAWD;;;;;OAKG;IACK,iBAAiB,CAAC,KAAa;QACrC,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc;YAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,WAAW,CAAC,KAAK;gBAC3D,CAAC,CAAC,0BAA0B,CAAC,IAAI;gBACjC,CAAC,CAAC,KAAK,CAAC;QACZ,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED,0BAA0B;IAClB,iBAAiB;QACvB,+BAAc,CAAC,qBAAqB,EAAE,CAAC;IACzC,CAAC;IAED,8BAA8B;IACtB,iBAAiB,CAAC,MAAe;QACvC,+BAAc,CAAC,wBAAwB,CACrC,MAAqB,EACrB,IAAI,CAAC,KAAK,CAAC,SAAU,EACrB,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAC7B,CAAC;QACF,OAAO;IACT,CAAC;CAoBF;AAzHD,8CAyHC","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 Notification\n */\n\nimport \"./ValidationTextbox.scss\";\nimport classnames from \"classnames\";\nimport * as React from \"react\";\nimport { SpecialKey } from \"@itwin/appui-abstract\";\nimport type { CommonProps } from \"@itwin/core-react\";\nimport { MessageManager } from \"../messages/MessageManager\";\nimport { Input } from \"@itwin/itwinui-react\";\n\n/** Enum for Input Status used in [[ValidationTextbox]]\n * @alpha\n */\nexport enum InputStatus {\n  Valid = 0,\n  Invalid = 1,\n}\n\n/** Property interface for ValidationTextbox\n * @alpha\n */\ninterface ValidationTextboxProps extends CommonProps {\n  /** value to set ValidationTextbox to initially */\n  initialValue?: string;\n  /** placeholder value to show in gray before anything is entered in */\n  placeholder?: string;\n  /** triggered when the content of ValidationTextbox is changed. Return true if valid */\n  onValueChanged?: (value: string) => InputStatus;\n  /** listens for <Enter> key presses */\n  onEnterPressed?: () => void;\n  /** listens for <Esc> key presses */\n  onEscPressed?: () => void;\n  /** width of ValidationTextbox, measured in em */\n  size?: number;\n  /** Error message to display */\n  errorText?: string;\n  /** Detailed error message to display */\n  detailedErrorText?: string;\n  /** Content */\n  children?: React.ReactNode;\n}\n\ninterface ValidationTextboxState {\n  isValid: boolean;\n}\n\n/**\n * Input box that validates text based on provided criteria. Defaults to checking\n * for empty if no method for onValueChanged is provided.\n * @alpha\n */\nexport class ValidationTextbox extends React.PureComponent<\n  ValidationTextboxProps,\n  ValidationTextboxState\n> {\n  constructor(props: ValidationTextboxProps) {\n    super(props);\n\n    this.state = { isValid: true };\n  }\n\n  /** @internal */\n  public override render(): React.ReactNode {\n    const sizeStyle: React.CSSProperties = {\n      width: this.props.size ? `${this.props.size.toString()}em` : \"12em\",\n    };\n    const divStyle: React.CSSProperties = {\n      ...sizeStyle,\n      ...this.props.style,\n    };\n\n    const validClassNames = classnames(\"ValidationTextbox-input\");\n\n    const invalidClassNames = classnames(\n      \"ValidationTextbox-input\",\n      \"ValidationTextbox-invalid\"\n    );\n\n    return (\n      <div\n        className={classnames(\"uifw-ValidationTextbox\", this.props.className)}\n        style={divStyle}\n      >\n        <Input\n          className={this.state.isValid ? validClassNames : invalidClassNames}\n          onChange={this._validateText}\n          onKeyUp={this._handleKeyUp}\n          onPaste={this._validateText}\n          onCut={this._validateText}\n          onBlur={this._validateText}\n          placeholder={this.props.placeholder ? this.props.placeholder : \"\"}\n          style={sizeStyle}\n        />\n        {this.props.children}\n      </div>\n    );\n  }\n\n  private processValidateText(target: HTMLInputElement | undefined): void {\n    // istanbul ignore next\n    if (undefined === target) return;\n\n    const value = target.value;\n    const isValid = this._calculateIsValid(value);\n\n    this.setState({ isValid }, () => {\n      if (this.state.isValid) {\n        this._hideErrorMessage();\n      } else {\n        // istanbul ignore else\n        if (this.props.errorText && !this.state.isValid)\n          this._showErrorMessage(target);\n      }\n    });\n  }\n\n  /**\n   * Determines if value is valid and resolves any defined functions.\n   * Also will show or hide error message if defined.\n   * @param event   Button press event that triggers validation\n   */\n  private _validateText = (event?: any): void => {\n    this.processValidateText(event.target as HTMLInputElement);\n  };\n\n  /**\n   * Determines if value provided is valid by calling user defined\n   * function. If no function is provided, the default criteria for\n   * validity is if the value has been defined.\n   * @param value   The value provided in textbox\n   */\n  private _calculateIsValid(value: string): boolean {\n    if (this.props.onValueChanged)\n      return this.props.onValueChanged(value) === InputStatus.Valid\n        ? /* istanbul ignore next */ true\n        : false;\n    return value.length > 0;\n  }\n\n  /** Hides error message */\n  private _hideErrorMessage() {\n    MessageManager.hideInputFieldMessage();\n  }\n\n  /** Displays error message. */\n  private _showErrorMessage(target: Element) {\n    MessageManager.displayInputFieldMessage(\n      target as HTMLElement,\n      this.props.errorText!,\n      this.props.detailedErrorText\n    );\n    return;\n  }\n\n  /**\n   * Manages special key codes by calling user defined functions\n   * @param event   Keyup event\n   */\n  private _handleKeyUp = (event: React.KeyboardEvent<HTMLInputElement>) => {\n    this.processValidateText(event.target as HTMLInputElement);\n\n    switch (event.key) {\n      case SpecialKey.Escape:\n        // istanbul ignore else\n        if (this.props.onEscPressed) this.props.onEscPressed();\n        break;\n      case SpecialKey.Enter:\n        // istanbul ignore else\n        if (this.props.onEnterPressed) this.props.onEnterPressed();\n        break;\n    }\n  };\n}\n"]}
+{"version":3,"file":"ValidationTextbox.js","sourceRoot":"","sources":["../../../../src/appui-react/feedback/ValidationTextbox.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAEH,oCAAkC;AAClC,2CAAoC;AACpC,+BAA+B;AAC/B,6CAAkC;AAElC,+DAA4D;AAC5D,wDAA6C;AAE7C;;GAEG;AACH,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,+CAAS,CAAA;IACT,mDAAW,CAAA;AACb,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AA8BD;;;;GAIG;AACH,MAAa,iBAAkB,SAAQ,KAAK,CAAC,aAG5C;IACC,YAAY,KAA6B;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;QA4Df;;;;WAIG;QACK,kBAAa,GAAG,CAAC,KAAW,EAAQ,EAAE;YAC5C,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,MAA0B,CAAC,CAAC;QAC7D,CAAC,CAAC;QA+BF;;;WAGG;QACK,iBAAY,GAAG,CAAC,KAA4C,EAAE,EAAE;YACtE,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,MAA0B,CAAC,CAAC;YAE3D,QAAQ,KAAK,CAAC,GAAG,EAAE;gBACjB,KAAK,iBAAG,CAAC,MAAM;oBACb,uBAAuB;oBACvB,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY;wBAAE,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;oBACvD,MAAM;gBACR,KAAK,iBAAG,CAAC,KAAK;oBACZ,uBAAuB;oBACvB,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc;wBAAE,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;oBAC3D,MAAM;aACT;QACH,CAAC,CAAC;QAjHA,IAAI,CAAC,KAAK,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACjC,CAAC;IAED,gBAAgB;IACA,MAAM;QACpB,MAAM,SAAS,GAAwB;YACrC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM;SACpE,CAAC;QACF,MAAM,QAAQ,GAAwB;YACpC,GAAG,SAAS;YACZ,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK;SACpB,CAAC;QAEF,MAAM,eAAe,GAAG,IAAA,oBAAU,EAAC,yBAAyB,CAAC,CAAC;QAE9D,MAAM,iBAAiB,GAAG,IAAA,oBAAU,EAClC,yBAAyB,EACzB,2BAA2B,CAC5B,CAAC;QAEF,OAAO,CACL,6BACE,SAAS,EAAE,IAAA,oBAAU,EAAC,wBAAwB,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EACrE,KAAK,EAAE,QAAQ;YAEf,oBAAC,qBAAK,IACJ,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,iBAAiB,EACnE,QAAQ,EAAE,IAAI,CAAC,aAAa,EAC5B,OAAO,EAAE,IAAI,CAAC,YAAY,EAC1B,OAAO,EAAE,IAAI,CAAC,aAAa,EAC3B,KAAK,EAAE,IAAI,CAAC,aAAa,EACzB,MAAM,EAAE,IAAI,CAAC,aAAa,EAC1B,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,EACjE,KAAK,EAAE,SAAS,GAChB;YACD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAChB,CACP,CAAC;IACJ,CAAC;IAEO,mBAAmB,CAAC,MAAoC;QAC9D,uBAAuB;QACvB,IAAI,SAAS,KAAK,MAAM;YAAE,OAAO;QAEjC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAE9C,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE;YAC9B,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;gBACtB,IAAI,CAAC,iBAAiB,EAAE,CAAC;aAC1B;iBAAM;gBACL,uBAAuB;gBACvB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO;oBAC7C,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;aAClC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAWD;;;;;OAKG;IACK,iBAAiB,CAAC,KAAa;QACrC,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc;YAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,WAAW,CAAC,KAAK;gBAC3D,CAAC,CAAC,0BAA0B,CAAC,IAAI;gBACjC,CAAC,CAAC,KAAK,CAAC;QACZ,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED,0BAA0B;IAClB,iBAAiB;QACvB,+BAAc,CAAC,qBAAqB,EAAE,CAAC;IACzC,CAAC;IAED,8BAA8B;IACtB,iBAAiB,CAAC,MAAe;QACvC,+BAAc,CAAC,wBAAwB,CACrC,MAAqB,EACrB,IAAI,CAAC,KAAK,CAAC,SAAU,EACrB,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAC7B,CAAC;QACF,OAAO;IACT,CAAC;CAoBF;AAzHD,8CAyHC","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 Notification\n */\n\nimport \"./ValidationTextbox.scss\";\nimport classnames from \"classnames\";\nimport * as React from \"react\";\nimport { Key } from \"ts-key-enum\";\nimport type { CommonProps } from \"@itwin/core-react\";\nimport { MessageManager } from \"../messages/MessageManager\";\nimport { Input } from \"@itwin/itwinui-react\";\n\n/** Enum for Input Status used in [[ValidationTextbox]]\n * @alpha\n */\nexport enum InputStatus {\n  Valid = 0,\n  Invalid = 1,\n}\n\n/** Property interface for ValidationTextbox\n * @alpha\n */\ninterface ValidationTextboxProps extends CommonProps {\n  /** value to set ValidationTextbox to initially */\n  initialValue?: string;\n  /** placeholder value to show in gray before anything is entered in */\n  placeholder?: string;\n  /** triggered when the content of ValidationTextbox is changed. Return true if valid */\n  onValueChanged?: (value: string) => InputStatus;\n  /** listens for <Enter> key presses */\n  onEnterPressed?: () => void;\n  /** listens for <Esc> key presses */\n  onEscPressed?: () => void;\n  /** width of ValidationTextbox, measured in em */\n  size?: number;\n  /** Error message to display */\n  errorText?: string;\n  /** Detailed error message to display */\n  detailedErrorText?: string;\n  /** Content */\n  children?: React.ReactNode;\n}\n\ninterface ValidationTextboxState {\n  isValid: boolean;\n}\n\n/**\n * Input box that validates text based on provided criteria. Defaults to checking\n * for empty if no method for onValueChanged is provided.\n * @alpha\n */\nexport class ValidationTextbox extends React.PureComponent<\n  ValidationTextboxProps,\n  ValidationTextboxState\n> {\n  constructor(props: ValidationTextboxProps) {\n    super(props);\n\n    this.state = { isValid: true };\n  }\n\n  /** @internal */\n  public override render(): React.ReactNode {\n    const sizeStyle: React.CSSProperties = {\n      width: this.props.size ? `${this.props.size.toString()}em` : \"12em\",\n    };\n    const divStyle: React.CSSProperties = {\n      ...sizeStyle,\n      ...this.props.style,\n    };\n\n    const validClassNames = classnames(\"ValidationTextbox-input\");\n\n    const invalidClassNames = classnames(\n      \"ValidationTextbox-input\",\n      \"ValidationTextbox-invalid\"\n    );\n\n    return (\n      <div\n        className={classnames(\"uifw-ValidationTextbox\", this.props.className)}\n        style={divStyle}\n      >\n        <Input\n          className={this.state.isValid ? validClassNames : invalidClassNames}\n          onChange={this._validateText}\n          onKeyUp={this._handleKeyUp}\n          onPaste={this._validateText}\n          onCut={this._validateText}\n          onBlur={this._validateText}\n          placeholder={this.props.placeholder ? this.props.placeholder : \"\"}\n          style={sizeStyle}\n        />\n        {this.props.children}\n      </div>\n    );\n  }\n\n  private processValidateText(target: HTMLInputElement | undefined): void {\n    // istanbul ignore next\n    if (undefined === target) return;\n\n    const value = target.value;\n    const isValid = this._calculateIsValid(value);\n\n    this.setState({ isValid }, () => {\n      if (this.state.isValid) {\n        this._hideErrorMessage();\n      } else {\n        // istanbul ignore else\n        if (this.props.errorText && !this.state.isValid)\n          this._showErrorMessage(target);\n      }\n    });\n  }\n\n  /**\n   * Determines if value is valid and resolves any defined functions.\n   * Also will show or hide error message if defined.\n   * @param event   Button press event that triggers validation\n   */\n  private _validateText = (event?: any): void => {\n    this.processValidateText(event.target as HTMLInputElement);\n  };\n\n  /**\n   * Determines if value provided is valid by calling user defined\n   * function. If no function is provided, the default criteria for\n   * validity is if the value has been defined.\n   * @param value   The value provided in textbox\n   */\n  private _calculateIsValid(value: string): boolean {\n    if (this.props.onValueChanged)\n      return this.props.onValueChanged(value) === InputStatus.Valid\n        ? /* istanbul ignore next */ true\n        : false;\n    return value.length > 0;\n  }\n\n  /** Hides error message */\n  private _hideErrorMessage() {\n    MessageManager.hideInputFieldMessage();\n  }\n\n  /** Displays error message. */\n  private _showErrorMessage(target: Element) {\n    MessageManager.displayInputFieldMessage(\n      target as HTMLElement,\n      this.props.errorText!,\n      this.props.detailedErrorText\n    );\n    return;\n  }\n\n  /**\n   * Manages special key codes by calling user defined functions\n   * @param event   Keyup event\n   */\n  private _handleKeyUp = (event: React.KeyboardEvent<HTMLInputElement>) => {\n    this.processValidateText(event.target as HTMLInputElement);\n\n    switch (event.key) {\n      case Key.Escape:\n        // istanbul ignore else\n        if (this.props.onEscPressed) this.props.onEscPressed();\n        break;\n      case Key.Enter:\n        // istanbul ignore else\n        if (this.props.onEnterPressed) this.props.onEnterPressed();\n        break;\n    }\n  };\n}\n"]}

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

@@ -1,7 +1,7 @@
 /** @packageDocumentation
  * @module KeyboardShortcut
  */
-import type { FunctionKey, SpecialKey } from "@itwin/appui-abstract";
+import type { Key } from "ts-key-enum";
 import type { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
 import type { ItemDefBase } from "../shared/ItemDefBase";
 import type { ItemProps } from "../shared/ItemProps";
@@ -12,7 +12,7 @@ export interface KeyboardShortcutProps extends ItemProps {
     /** The key that invokes the shortcut.
      * This is either an alphanumeric key, a function key or a special key.
      */
-    key: string | FunctionKey | SpecialKey;
+    key: string | Key;
     /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified. */
     item?: ActionButtonItemDef;
     /** Nested array of shortcut props. Either 'item' or 'shortcuts' must be specified. */

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

@@ -1 +1 @@
-{"version":3,"file":"FrameworkKeyboardShortcuts.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkKeyboardShortcuts.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,SAAS;IACtD;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,WAAW,GAAG,UAAU,CAAC;IAEvC,yGAAyG;IACzG,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B,sFAAsF;IACtF,SAAS,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAEpC,8DAA8D;IAC9D,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,+DAA+D;IAC/D,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gEAAgE;IAChE,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,WAAW;IAC5D,uCAAuC;IACvC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,qCAAqC;IACrC,QAAQ,CAAC,iBAAiB,EAAE,kCAAkC,CAAC;IAE/D,oEAAoE;IACpE,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAEnE,wDAAwD;IACxD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,wEAAwE;IACxE,QAAQ,CAAC,IAAI,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAE/C,uFAAuF;IACvF,UAAU,IAAI,IAAI,CAAC;IAEnB,4BAA4B;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,yCAAyC;IACzC,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC,0CAA0C;IAC1C,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACpC,2CAA2C;IAC3C,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAC;IACrC,2CAA2C;IAC3C,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAChC,0CAA0C;IAC1C,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,oFAAoF;IACpF,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,yBAAyB,GACpC,yBAAyB,GAAG,SAAS,CAAC;IAEzC,4DAA4D;IAC5D,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAElE,2EAA2E;IAC3E,6BAA6B,IAAI,OAAO,CAAC;IAEzC,yDAAyD;IACzD,SAAS,IAAI,IAAI,CAAC;IAElB,6BAA6B,IAAI,yBAAyB,EAAE,CAAC;IAE7D,mEAAmE;IACnE,iBAAiB,IAAI,IAAI,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,qDAAqD;IACrD,aAAa,CAAC,YAAY,EAAE,qBAAqB,EAAE,GAAG,IAAI,CAAC;IAE3D,sDAAsD;IACtD,YAAY,CAAC,aAAa,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEzD,qEAAqE;IACrE,UAAU,CACR,WAAW,EAAE,MAAM,EACnB,eAAe,CAAC,EAAE,OAAO,EACzB,gBAAgB,CAAC,EAAE,OAAO,EAC1B,iBAAiB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC;IAEX,qDAAqD;IACrD,QAAQ,CAAC,iBAAiB,EAAE,kCAAkC,CAAC;IAE/D,yDAAyD;IACzD,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAEtE,yCAAyC;IACzC,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAEhC,yBAAyB;IACzB,cAAc,IAAI,IAAI,CAAC;IAEvB,yDAAyD;IACzD,WAAW,IAAI,IAAI,CAAC;IAEpB,yCAAyC;IACzC,SAAS,IAAI,IAAI,CAAC;IAElB,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B"}
+{"version":3,"file":"FrameworkKeyboardShortcuts.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkKeyboardShortcuts.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,SAAS;IACtD;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IAElB,yGAAyG;IACzG,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B,sFAAsF;IACtF,SAAS,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAEpC,8DAA8D;IAC9D,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,+DAA+D;IAC/D,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gEAAgE;IAChE,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,WAAW;IAC5D,uCAAuC;IACvC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,qCAAqC;IACrC,QAAQ,CAAC,iBAAiB,EAAE,kCAAkC,CAAC;IAE/D,oEAAoE;IACpE,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAEnE,wDAAwD;IACxD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,wEAAwE;IACxE,QAAQ,CAAC,IAAI,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAE/C,uFAAuF;IACvF,UAAU,IAAI,IAAI,CAAC;IAEnB,4BAA4B;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,yCAAyC;IACzC,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC,0CAA0C;IAC1C,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACpC,2CAA2C;IAC3C,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAC;IACrC,2CAA2C;IAC3C,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAChC,0CAA0C;IAC1C,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,oFAAoF;IACpF,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,yBAAyB,GACpC,yBAAyB,GAAG,SAAS,CAAC;IAEzC,4DAA4D;IAC5D,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAElE,2EAA2E;IAC3E,6BAA6B,IAAI,OAAO,CAAC;IAEzC,yDAAyD;IACzD,SAAS,IAAI,IAAI,CAAC;IAElB,6BAA6B,IAAI,yBAAyB,EAAE,CAAC;IAE7D,mEAAmE;IACnE,iBAAiB,IAAI,IAAI,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,qDAAqD;IACrD,aAAa,CAAC,YAAY,EAAE,qBAAqB,EAAE,GAAG,IAAI,CAAC;IAE3D,sDAAsD;IACtD,YAAY,CAAC,aAAa,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEzD,qEAAqE;IACrE,UAAU,CACR,WAAW,EAAE,MAAM,EACnB,eAAe,CAAC,EAAE,OAAO,EACzB,gBAAgB,CAAC,EAAE,OAAO,EAC1B,iBAAiB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC;IAEX,qDAAqD;IACrD,QAAQ,CAAC,iBAAiB,EAAE,kCAAkC,CAAC;IAE/D,yDAAyD;IACzD,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAEtE,yCAAyC;IACzC,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAEhC,yBAAyB;IACzB,cAAc,IAAI,IAAI,CAAC;IAEvB,yDAAyD;IACzD,WAAW,IAAI,IAAI,CAAC;IAEpB,yCAAyC;IACzC,SAAS,IAAI,IAAI,CAAC;IAElB,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B"}

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

@@ -1 +1 @@
-{"version":3,"file":"FrameworkKeyboardShortcuts.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkKeyboardShortcuts.ts"],"names":[],"mappings":"","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 KeyboardShortcut\n */\nimport type { FunctionKey, SpecialKey } from \"@itwin/appui-abstract\";\nimport type { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\nimport type { ItemDefBase } from \"../shared/ItemDefBase\";\nimport type { ItemProps } from \"../shared/ItemProps\";\n\n/** Properties for a Keyboard Shortcut\n * @public\n */\nexport interface KeyboardShortcutProps extends ItemProps {\n  /** The key that invokes the shortcut.\n   * This is either an alphanumeric key, a function key or a special key.\n   */\n  key: string | FunctionKey | SpecialKey;\n\n  /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified. */\n  item?: ActionButtonItemDef;\n  /** Nested array of shortcut props. Either 'item' or 'shortcuts' must be specified. */\n  shortcuts?: KeyboardShortcutProps[];\n\n  /** Indicates whether the Alt key required. Default - false */\n  isAltKeyRequired?: boolean;\n  /** Indicates whether the Ctrl key required. Default - false */\n  isCtrlKeyRequired?: boolean;\n  /** Indicates whether the Shift key required. Default - false */\n  isShiftKeyRequired?: boolean;\n}\n\n/** Keyboard Shortcut used to execute an action\n * @public\n */\nexport interface FrameworkKeyboardShortcut extends ItemDefBase {\n  /** Returns the id for this shortcut */\n  readonly id: string;\n\n  /** Returns the shortcut container */\n  readonly shortcutContainer: FrameworkKeyboardShortcutContainer;\n\n  /** Finds a shortcut with a given key in the shortcut's container */\n  getShortcut(mapKey: string): FrameworkKeyboardShortcut | undefined;\n\n  /** Returns the shortcut's key map key used as the id */\n  readonly keyMapKey: string;\n\n  /** Returns the [[ActionButtonItemDef]] associated with this shortcut */\n  readonly item: ActionButtonItemDef | undefined;\n\n  /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */\n  itemPicked(): void;\n\n  /** Gets the keyboard key */\n  readonly key: string;\n  /** Gets whether the Alt key required. */\n  readonly isAltKeyRequired: boolean;\n  /** Gets whether the Ctrl key required. */\n  readonly isCtrlKeyRequired: boolean;\n  /** Gets whether the Shift key required. */\n  readonly isShiftKeyRequired: boolean;\n  /** Gets whether this is a Function key. */\n  readonly isFunctionKey: boolean;\n  /** Gets whether this is a Special key. */\n  readonly isSpecialKey: boolean;\n}\n\n/** Keyboard Shortcut Container\n * @public\n */\nexport interface FrameworkKeyboardShortcutContainer {\n  /** Registers a Keyboard Shortcut associated with a given key in the managed list */\n  registerKey(\n    keyMapKey: string,\n    inShortcut: FrameworkKeyboardShortcut\n  ): FrameworkKeyboardShortcut | undefined;\n\n  /** Finds a Keyboard Shortcut associated with a given key */\n  findKey(keyMapKey: string): FrameworkKeyboardShortcut | undefined;\n\n  /** Determines if any Keyboard Shortcuts are available in this container */\n  areKeyboardShortcutsAvailable(): boolean;\n\n  /** Empties any Keyboard Shortcuts from this container */\n  emptyData(): void;\n\n  getAvailableKeyboardShortcuts(): FrameworkKeyboardShortcut[];\n\n  /** Displays a menu for the Keyboard Shortcuts in this container */\n  showShortcutsMenu(): void;\n}\n\n/**\n * [[UiFramework.keyboardShortcuts]] interface\n * @public\n */\nexport interface FrameworkKeyboardShortcuts {\n  /** Loads Keyboard Shortcuts into the managed list */\n  loadShortcuts(shortcutList: KeyboardShortcutProps[]): void;\n\n  /** Loads a Keyboard Shortcut into the managed list */\n  loadShortcut(shortcutProps: KeyboardShortcutProps): void;\n\n  /** Processes a keystroke and invokes a matching Keyboard Shortcut */\n  processKey(\n    keyboardKey: string,\n    isAltKeyPressed?: boolean,\n    isCtrlKeyPressed?: boolean,\n    isShiftKeyPressed?: boolean\n  ): boolean;\n\n  /** Returns the managed list of Keyboard Shortcuts */\n  readonly shortcutContainer: FrameworkKeyboardShortcutContainer;\n\n  /** Returns a Keyboard Shortcut from the managed lists */\n  getShortcut(keyMapKey: string): FrameworkKeyboardShortcut | undefined;\n\n  /** Determines if focus is set to Home */\n  readonly isFocusOnHome: boolean;\n\n  /** Sets focus to Home */\n  setFocusToHome(): void;\n\n  /** Displays the Keyboard Shortcuts menu at the cursor */\n  displayMenu(): void;\n\n  /** Closes the Keyboard Shortcuts menu */\n  closeMenu(): void;\n\n  /** Returns the cursor X position, which is mouseEvent.pageX. */\n  readonly cursorX: number;\n  /** Returns the cursor Y position, which is mouseEvent.pageY. */\n  readonly cursorY: number;\n}\n"]}
+{"version":3,"file":"FrameworkKeyboardShortcuts.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkKeyboardShortcuts.ts"],"names":[],"mappings":"","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 KeyboardShortcut\n */\nimport type { Key } from \"ts-key-enum\";\nimport type { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\nimport type { ItemDefBase } from \"../shared/ItemDefBase\";\nimport type { ItemProps } from \"../shared/ItemProps\";\n\n/** Properties for a Keyboard Shortcut\n * @public\n */\nexport interface KeyboardShortcutProps extends ItemProps {\n  /** The key that invokes the shortcut.\n   * This is either an alphanumeric key, a function key or a special key.\n   */\n  key: string | Key;\n\n  /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified. */\n  item?: ActionButtonItemDef;\n  /** Nested array of shortcut props. Either 'item' or 'shortcuts' must be specified. */\n  shortcuts?: KeyboardShortcutProps[];\n\n  /** Indicates whether the Alt key required. Default - false */\n  isAltKeyRequired?: boolean;\n  /** Indicates whether the Ctrl key required. Default - false */\n  isCtrlKeyRequired?: boolean;\n  /** Indicates whether the Shift key required. Default - false */\n  isShiftKeyRequired?: boolean;\n}\n\n/** Keyboard Shortcut used to execute an action\n * @public\n */\nexport interface FrameworkKeyboardShortcut extends ItemDefBase {\n  /** Returns the id for this shortcut */\n  readonly id: string;\n\n  /** Returns the shortcut container */\n  readonly shortcutContainer: FrameworkKeyboardShortcutContainer;\n\n  /** Finds a shortcut with a given key in the shortcut's container */\n  getShortcut(mapKey: string): FrameworkKeyboardShortcut | undefined;\n\n  /** Returns the shortcut's key map key used as the id */\n  readonly keyMapKey: string;\n\n  /** Returns the [[ActionButtonItemDef]] associated with this shortcut */\n  readonly item: ActionButtonItemDef | undefined;\n\n  /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */\n  itemPicked(): void;\n\n  /** Gets the keyboard key */\n  readonly key: string;\n  /** Gets whether the Alt key required. */\n  readonly isAltKeyRequired: boolean;\n  /** Gets whether the Ctrl key required. */\n  readonly isCtrlKeyRequired: boolean;\n  /** Gets whether the Shift key required. */\n  readonly isShiftKeyRequired: boolean;\n  /** Gets whether this is a Function key. */\n  readonly isFunctionKey: boolean;\n  /** Gets whether this is a Special key. */\n  readonly isSpecialKey: boolean;\n}\n\n/** Keyboard Shortcut Container\n * @public\n */\nexport interface FrameworkKeyboardShortcutContainer {\n  /** Registers a Keyboard Shortcut associated with a given key in the managed list */\n  registerKey(\n    keyMapKey: string,\n    inShortcut: FrameworkKeyboardShortcut\n  ): FrameworkKeyboardShortcut | undefined;\n\n  /** Finds a Keyboard Shortcut associated with a given key */\n  findKey(keyMapKey: string): FrameworkKeyboardShortcut | undefined;\n\n  /** Determines if any Keyboard Shortcuts are available in this container */\n  areKeyboardShortcutsAvailable(): boolean;\n\n  /** Empties any Keyboard Shortcuts from this container */\n  emptyData(): void;\n\n  getAvailableKeyboardShortcuts(): FrameworkKeyboardShortcut[];\n\n  /** Displays a menu for the Keyboard Shortcuts in this container */\n  showShortcutsMenu(): void;\n}\n\n/**\n * [[UiFramework.keyboardShortcuts]] interface\n * @public\n */\nexport interface FrameworkKeyboardShortcuts {\n  /** Loads Keyboard Shortcuts into the managed list */\n  loadShortcuts(shortcutList: KeyboardShortcutProps[]): void;\n\n  /** Loads a Keyboard Shortcut into the managed list */\n  loadShortcut(shortcutProps: KeyboardShortcutProps): void;\n\n  /** Processes a keystroke and invokes a matching Keyboard Shortcut */\n  processKey(\n    keyboardKey: string,\n    isAltKeyPressed?: boolean,\n    isCtrlKeyPressed?: boolean,\n    isShiftKeyPressed?: boolean\n  ): boolean;\n\n  /** Returns the managed list of Keyboard Shortcuts */\n  readonly shortcutContainer: FrameworkKeyboardShortcutContainer;\n\n  /** Returns a Keyboard Shortcut from the managed lists */\n  getShortcut(keyMapKey: string): FrameworkKeyboardShortcut | undefined;\n\n  /** Determines if focus is set to Home */\n  readonly isFocusOnHome: boolean;\n\n  /** Sets focus to Home */\n  setFocusToHome(): void;\n\n  /** Displays the Keyboard Shortcuts menu at the cursor */\n  displayMenu(): void;\n\n  /** Closes the Keyboard Shortcuts menu */\n  closeMenu(): void;\n\n  /** Returns the cursor X position, which is mouseEvent.pageX. */\n  readonly cursorX: number;\n  /** Returns the cursor Y position, which is mouseEvent.pageY. */\n  readonly cursorY: number;\n}\n"]}

package/lib/cjs/appui-react/frontstage/FrontstageDef.d.ts

@@ -2,7 +2,6 @@
  * @module Frontstage
  */
 import type { ScreenViewport } from "@itwin/core-frontend";
-import type { XAndY } from "@itwin/core-geometry";
 import type { RectangleProps, SizeProps } from "@itwin/core-react";
 import type { NineZoneDispatch, NineZoneState } from "@itwin/appui-layout-react";
 import type { ContentControl } from "../content/ContentControl";
@@ -16,6 +15,7 @@ import { TimeTracker } from "../configurableui/TimeTracker";
 import type { FrontstageConfig } from "./FrontstageConfig";
 import { StagePanelLocation } from "../stagepanels/StagePanelLocation";
 import { WidgetState } from "../widgets/WidgetState";
+import type { XAndY } from "@itwin/core-geometry";
 /** @internal */
 export interface FrontstageEventArgs {
     frontstageDef: FrontstageDef;
@@ -131,14 +131,13 @@ export declare class FrontstageDef {
      * @beta
      */
     restoreLayout(): void;
-    /** Used only in UI 2.0 to determine WidgetState from NinezoneState
+    /** Used to determine WidgetState from NinezoneState
      *  @internal
      */
     getWidgetCurrentState(widgetDef: WidgetDef): WidgetState | undefined;
     isPopoutWidget(widgetId: string): boolean;
     isFloatingWidget(widgetId: string): boolean;
-    /** Create a new floating panel that contains the widget specified by its Id. Supported only when in
-     *  UI 2.0 or higher.
+    /** Create a new floating panel that contains the widget specified by its Id.
      * @param widgetId case sensitive Widget Id
      * @param position Position of top left corner of floating panel in pixels. If undefined {x:50, y:100} is used.
      * @param size defines the width and height of the floating panel. If undefined and widget has been floated before
@@ -154,9 +153,8 @@ export declare class FrontstageDef {
     /** Opens window for specified PopoutWidget container. Used to reopen popout when running in Electron.
      * @internal
      */
-    openPopoutWidgetContainer(widgetContainerId: string): void;
-    /** Create a new popout/child window that contains the widget specified by its Id. Supported only when in
-     *  UI 2.0 or higher.
+    openPopoutWidgetContainer(widgetContainerId: string, oldState: NineZoneState | undefined): boolean;
+    /** Create a new popout/child window that contains the widget specified by its Id.
      * @param widgetId case sensitive Widget Id
      * @param position Position of top left corner of floating panel in pixels. If undefined {x:0, y:0} is used.
      * @param size defines the width and height of the floating panel. If undefined and widget has been floated before
@@ -173,7 +171,7 @@ export declare class FrontstageDef {
     dockWidgetContainerByContainerId(widgetContainerId: string): void;
     /** Finds the container with the specified widget and re-docks all widgets
      * back to the panel zone location that was used when the floating container
-     * was generated. Supported only when in UI 2.0 or higher.
+     * was generated.
      * @param widgetId  case sensitive Widget Id.
      * @beta
      */

package/lib/cjs/appui-react/frontstage/FrontstageDef.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FrontstageDef.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/FrontstageDef.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAE3D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAElD,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAEnE,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EAEd,MAAM,2BAA2B,CAAC;AAYnC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,aAAa,EAAmB,MAAM,8BAA8B,CAAC;AAG9E,OAAO,EAAE,SAAS,EAAc,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAI5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAI3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,gBAAgB;AAChB,MAAM,WAAW,mBAAmB;IAClC,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED,gBAAgB;AAChB,MAAM,WAAW,uCACf,SAAQ,mBAAmB;IAC3B,KAAK,EAAE,aAAa,GAAG,SAAS,CAAC;CAClC;AAED;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,GAAG,CAAc;IACzB,OAAO,CAAC,cAAc,CAAC,CAAmB;IAC1C,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAa;IAC7B,OAAO,CAAC,aAAa,CAAC,CAAY;IAClC,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,OAAO,CAAC,oBAAoB,CAAC,CAAY;IACzC,OAAO,CAAC,eAAe,CAAC,CAAY;IACpC,OAAO,CAAC,SAAS,CAAC,CAAgB;IAClC,OAAO,CAAC,UAAU,CAAC,CAAgB;IACnC,OAAO,CAAC,WAAW,CAAC,CAAgB;IACpC,OAAO,CAAC,YAAY,CAAC,CAAgB;IACrC,OAAO,CAAC,iBAAiB,CAAC,CAAmB;IAC7C,OAAO,CAAC,aAAa,CAAC,CAAe;IACrC,OAAO,CAAC,mBAAmB,CAAC,CAAqB;IACjD,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,OAAO,CAAC,qBAAqB,CAAC,CAAuB;IACrD,OAAO,CAAC,wBAAwB,CAAC,CAAmB;IACpD,OAAO,CAAC,uBAAuB,CAAC,CAAS;IACzC,OAAO,CAAC,SAAS,CAAC,CAAmB;IAErC,IAAW,EAAE,IAAI,MAAM,CAEtB;IACD,IAAW,KAAK,IAAI,MAAM,CAEzB;IACD,IAAW,OAAO,IAAI,MAAM,CAE3B;IACD,IAAW,oBAAoB,IAAI,oBAAoB,GAAG,SAAS,CAElE;IACD,IAAW,uBAAuB,iCAEjC;IAED,IAAW,YAAY,IAAI,SAAS,GAAG,SAAS,CAE/C;IACD,IAAW,SAAS,IAAI,SAAS,GAAG,SAAS,CAE5C;IACD,IAAW,mBAAmB,IAAI,SAAS,GAAG,SAAS,CAEtD;IACD,IAAW,cAAc,IAAI,SAAS,GAAG,SAAS,CAEjD;IAED,IAAW,QAAQ,IAAI,aAAa,GAAG,SAAS,CAE/C;IACD,IAAW,SAAS,IAAI,aAAa,GAAG,SAAS,CAEhD;IACD,IAAW,UAAU,IAAI,aAAa,GAAG,SAAS,CAEjD;IACD,IAAW,WAAW,IAAI,aAAa,GAAG,SAAS,CAElD;IAED,IAAW,gBAAgB,IAAI,gBAAgB,GAAG,SAAS,CAE1D;IACD,IAAW,YAAY,IAAI,YAAY,GAAG,SAAS,CAElD;IACD,IAAW,kBAAkB,IAAI,kBAAkB,GAAG,SAAS,CAE9D;IAED,OAAO,CAAC,oBAAoB;IAa5B,OAAO,CAAC,iBAAiB;IA+CzB,OAAO,CAAC,wBAAwB;IA8ChC,OAAO,CAAC,aAAa;IAiBrB,gBAAgB;IAChB,IAAW,aAAa,IAAI,aAAa,GAAG,SAAS,CAEpD;IACD,IAAW,aAAa,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,EAgBxD;IAED,gBAAgB;IAChB,IAAW,QAAQ,IAAI,gBAAgB,CAUtC;IAED,gBAAgB;IAChB,IAAW,WAAW,IAAI,WAAW,CAEpC;IAED,oDAAoD;WAChC,MAAM,CAAC,QAAQ,EAAE,kBAAkB;IAUvD,oDAAoD;cACpC,YAAY;IAE5B,oDAAoD;IACvC,WAAW;IA2BxB,mDAAmD;cACnC,cAAc;IAE9B,mDAAmD;IACtC,aAAa;IAkC1B,gBAAgB;IACT,uBAAuB,CAAC,KAAK,EAAE,OAAO;IAI7C,+EAA+E;IAClE,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAuB5C,iDAAiD;IACjD,SAAS,CAAC,kBAAkB,IAAI,IAAI;IAEpC,iDAAiD;IAC1C,iBAAiB,IAAI,IAAI;IA0BhC,gDAAgD;IACzC,wBAAwB,CAC7B,gBAAgB,EAAE,gBAAgB,EAClC,YAAY,EAAE,YAAY,GACzB,IAAI;IAKP,mEAAmE;IACtD,gBAAgB,IAAI,OAAO,CAAC,OAAO,CAAC;IAsBjD,2CAA2C;IACpC,aAAa,CAClB,UAAU,EAAE,cAAc,EAC1B,UAAU,CAAC,EAAE,cAAc,GAC1B,IAAI;IASP,2EAA2E;IACpE,yBAAyB,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO;IAcnE;;OAEG;IACI,gBAAgB,CACrB,QAAQ,EAAE,kBAAkB,GAC3B,aAAa,GAAG,SAAS;IAsB5B;;OAEG;IACH,IAAW,SAAS,IAAI,aAAa,EAAE,CAetC;IAED,gDAAgD;IACzC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAOvD,0CAA0C;IAC1C,OAAO,KAAK,eAAe,GAY1B;IAEM,yBAAyB,CAAC,cAAc,CAAC,EAAE,cAAc;IAYzD,0BAA0B,CAAC,cAAc,CAAC,EAAE,cAAc;IAcjE,2CAA2C;IAC3C,IAAW,eAAe,IAAI,cAAc,EAAE,CAU7C;IAED;;OAEG;IACU,oBAAoB,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgC1E,gBAAgB;IACT,gBAAgB,IAAI,IAAI;IAoB/B;;OAEG;IACI,aAAa;IAapB;;OAEG;IACI,qBAAqB,CAAC,SAAS,EAAE,SAAS,GAAG,WAAW,GAAG,SAAS;IAqCpE,cAAc,CAAC,QAAQ,EAAE,MAAM;IAW/B,gBAAgB,CAAC,QAAQ,EAAE,MAAM;IAWxC;;;;;;;OAOG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS;IAcvE;;;OAGG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAiBnD;;OAEG;IACI,yBAAyB,CAAC,iBAAiB,EAAE,MAAM;IAwC1D;;;;;;;OAOG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS;IAcxE,IAAW,cAAc,YAExB;IAED,IAAW,oBAAoB,YAE9B;IAED,IAAW,OAAO,YAEjB;IAED,gBAAgB;IACT,8BAA8B,CACnC,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,MAAM;IA8BrB,gBAAgB;IACT,gCAAgC,CAAC,iBAAiB,EAAE,MAAM;IAuBjE;;;;;OAKG;IACI,mBAAmB,CAAC,QAAQ,EAAE,MAAM;IAUpC,gCAAgC,CACrC,gBAAgB,EAAE,MAAM,EACxB,MAAM,EAAE,cAAc;IAqBjB,6BAA6B,IAAI,MAAM,EAAE;IAMzC,sCAAsC,CAC3C,QAAQ,EAAE,MAAM,GACf,MAAM,GAAG,SAAS;IAYd,gCAAgC,CACrC,gBAAgB,EAAE,MAAM,GAAG,SAAS;IA2BtC,OAAO,CAAE,WAAW;IAWpB;;OAEG;IACH,IAAW,UAAU;;MAOpB;CACF;AAuCD;;GAEG;AACH,eAAO,MAAM,qBAAqB,cAOjC,CAAC;AAEF;;GAEG;AACH,wBAAgB,sBAAsB,8BAYrC;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,yBAepD"}
+{"version":3,"file":"FrontstageDef.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/FrontstageDef.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAQ3D,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAEnE,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EAEd,MAAM,2BAA2B,CAAC;AAYnC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,aAAa,EAAmB,MAAM,8BAA8B,CAAC;AAG9E,OAAO,EAAE,SAAS,EAAc,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAI5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAI3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAGrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAElD,gBAAgB;AAChB,MAAM,WAAW,mBAAmB;IAClC,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED,gBAAgB;AAChB,MAAM,WAAW,uCACf,SAAQ,mBAAmB;IAC3B,KAAK,EAAE,aAAa,GAAG,SAAS,CAAC;CAClC;AAED;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,GAAG,CAAc;IACzB,OAAO,CAAC,cAAc,CAAC,CAAmB;IAC1C,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAa;IAC7B,OAAO,CAAC,aAAa,CAAC,CAAY;IAClC,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,OAAO,CAAC,oBAAoB,CAAC,CAAY;IACzC,OAAO,CAAC,eAAe,CAAC,CAAY;IACpC,OAAO,CAAC,SAAS,CAAC,CAAgB;IAClC,OAAO,CAAC,UAAU,CAAC,CAAgB;IACnC,OAAO,CAAC,WAAW,CAAC,CAAgB;IACpC,OAAO,CAAC,YAAY,CAAC,CAAgB;IACrC,OAAO,CAAC,iBAAiB,CAAC,CAAmB;IAC7C,OAAO,CAAC,aAAa,CAAC,CAAe;IACrC,OAAO,CAAC,mBAAmB,CAAC,CAAqB;IACjD,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,OAAO,CAAC,qBAAqB,CAAC,CAAuB;IACrD,OAAO,CAAC,wBAAwB,CAAC,CAAmB;IACpD,OAAO,CAAC,uBAAuB,CAAC,CAAS;IACzC,OAAO,CAAC,SAAS,CAAC,CAAmB;IAErC,IAAW,EAAE,IAAI,MAAM,CAEtB;IACD,IAAW,KAAK,IAAI,MAAM,CAEzB;IACD,IAAW,OAAO,IAAI,MAAM,CAE3B;IACD,IAAW,oBAAoB,IAAI,oBAAoB,GAAG,SAAS,CAElE;IACD,IAAW,uBAAuB,iCAEjC;IAED,IAAW,YAAY,IAAI,SAAS,GAAG,SAAS,CAE/C;IACD,IAAW,SAAS,IAAI,SAAS,GAAG,SAAS,CAE5C;IACD,IAAW,mBAAmB,IAAI,SAAS,GAAG,SAAS,CAEtD;IACD,IAAW,cAAc,IAAI,SAAS,GAAG,SAAS,CAEjD;IAED,IAAW,QAAQ,IAAI,aAAa,GAAG,SAAS,CAE/C;IACD,IAAW,SAAS,IAAI,aAAa,GAAG,SAAS,CAEhD;IACD,IAAW,UAAU,IAAI,aAAa,GAAG,SAAS,CAEjD;IACD,IAAW,WAAW,IAAI,aAAa,GAAG,SAAS,CAElD;IAED,IAAW,gBAAgB,IAAI,gBAAgB,GAAG,SAAS,CAE1D;IACD,IAAW,YAAY,IAAI,YAAY,GAAG,SAAS,CAElD;IACD,IAAW,kBAAkB,IAAI,kBAAkB,GAAG,SAAS,CAE9D;IAED,OAAO,CAAC,oBAAoB;IAa5B,OAAO,CAAC,iBAAiB;IA+CzB,OAAO,CAAC,wBAAwB;IA8ChC,OAAO,CAAC,aAAa;IAoBrB,gBAAgB;IAChB,IAAW,aAAa,IAAI,aAAa,GAAG,SAAS,CAEpD;IACD,IAAW,aAAa,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,EA2BxD;IAED,gBAAgB;IAChB,IAAW,QAAQ,IAAI,gBAAgB,CAUtC;IAED,gBAAgB;IAChB,IAAW,WAAW,IAAI,WAAW,CAEpC;IAED,oDAAoD;WAChC,MAAM,CAAC,QAAQ,EAAE,kBAAkB;IAUvD,oDAAoD;cACpC,YAAY;IAE5B,oDAAoD;IACvC,WAAW;IA2BxB,mDAAmD;cACnC,cAAc;IAE9B,mDAAmD;IACtC,aAAa;IAkC1B,gBAAgB;IACT,uBAAuB,CAAC,KAAK,EAAE,OAAO;IAI7C,+EAA+E;IAClE,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAuB5C,iDAAiD;IACjD,SAAS,CAAC,kBAAkB,IAAI,IAAI;IAEpC,iDAAiD;IAC1C,iBAAiB,IAAI,IAAI;IA0BhC,gDAAgD;IACzC,wBAAwB,CAC7B,gBAAgB,EAAE,gBAAgB,EAClC,YAAY,EAAE,YAAY,GACzB,IAAI;IAKP,mEAAmE;IACtD,gBAAgB,IAAI,OAAO,CAAC,OAAO,CAAC;IAsBjD,2CAA2C;IACpC,aAAa,CAClB,UAAU,EAAE,cAAc,EAC1B,UAAU,CAAC,EAAE,cAAc,GAC1B,IAAI;IASP,2EAA2E;IACpE,yBAAyB,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO;IAcnE;;OAEG;IACI,gBAAgB,CACrB,QAAQ,EAAE,kBAAkB,GAC3B,aAAa,GAAG,SAAS;IAsB5B;;OAEG;IACH,IAAW,SAAS,IAAI,aAAa,EAAE,CAetC;IAED,gDAAgD;IACzC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAOvD,0CAA0C;IAC1C,OAAO,KAAK,eAAe,GAY1B;IAEM,yBAAyB,CAAC,cAAc,CAAC,EAAE,cAAc;IAYzD,0BAA0B,CAAC,cAAc,CAAC,EAAE,cAAc;IAcjE,2CAA2C;IAC3C,IAAW,eAAe,IAAI,cAAc,EAAE,CAU7C;IAED;;OAEG;IACU,oBAAoB,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgC1E,gBAAgB;IACT,gBAAgB,IAAI,IAAI;IAoB/B;;OAEG;IACI,aAAa;IAapB;;OAEG;IACI,qBAAqB,CAAC,SAAS,EAAE,SAAS,GAAG,WAAW,GAAG,SAAS;IAqCpE,cAAc,CAAC,QAAQ,EAAE,MAAM;IAW/B,gBAAgB,CAAC,QAAQ,EAAE,MAAM;IAWxC;;;;;;OAMG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS;IAcvE;;;OAGG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAiBnD;;OAEG;IACI,yBAAyB,CAC9B,iBAAiB,EAAE,MAAM,EACzB,QAAQ,EAAE,aAAa,GAAG,SAAS,GAClC,OAAO;IA6CV;;;;;;OAMG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS;IAcxE,IAAW,cAAc,YAExB;IAED,IAAW,oBAAoB,YAE9B;IAED,IAAW,OAAO,YAEjB;IAED,gBAAgB;IACT,8BAA8B,CACnC,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,MAAM;IA8BrB,gBAAgB;IACT,gCAAgC,CAAC,iBAAiB,EAAE,MAAM;IAuBjE;;;;;OAKG;IACI,mBAAmB,CAAC,QAAQ,EAAE,MAAM;IAUpC,gCAAgC,CACrC,gBAAgB,EAAE,MAAM,EACxB,MAAM,EAAE,cAAc;IAqBjB,6BAA6B,IAAI,MAAM,EAAE;IAMzC,sCAAsC,CAC3C,QAAQ,EAAE,MAAM,GACf,MAAM,GAAG,SAAS;IAYd,gCAAgC,CACrC,gBAAgB,EAAE,MAAM,GAAG,SAAS;IA2BtC,OAAO,CAAE,WAAW;IAWpB;;OAEG;IACH,IAAW,UAAU;;MAOpB;CACF;AAuCD;;GAEG;AACH,eAAO,MAAM,qBAAqB,cAOjC,CAAC;AAEF;;GAEG;AACH,wBAAgB,sBAAsB,8BAYrC;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,yBAepD"}

package/lib/cjs/appui-react/frontstage/FrontstageDef.js

@@ -188,8 +188,11 @@ class FrontstageDef {
             UiFramework_1.UiFramework.childWindows.close(popoutId, true);
         }
         for (const popoutId of popoutsToOpen) {
-            this.openPopoutWidgetContainer(popoutId);
+            const result = this.openPopoutWidgetContainer(popoutId, oldState);
+            if (!result)
+                return result;
         }
+        return true;
     }
     /** @internal */
     get nineZoneState() {
@@ -200,13 +203,17 @@ class FrontstageDef {
             return;
         const oldState = this._nineZoneState;
         this._nineZoneState = state;
-        this.handlePopouts(oldState);
+        const popoutResult = this.handlePopouts(oldState);
         if (oldState) {
             this.triggerStateChangeEvents(oldState);
         }
         const isClosing = this._isStageClosing || this._isApplicationClosing;
         if (isClosing && !this.isReady)
             return;
+        if (popoutResult === false) {
+            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Error, "Widget Failed To Popout", undefined, core_frontend_1.OutputMessageType.Toast));
+            return;
+        }
         InternalFrontstageManager_1.InternalFrontstageManager.onFrontstageNineZoneStateChangedEvent.emit({
             frontstageDef: this,
             state,
@@ -527,7 +534,7 @@ class FrontstageDef {
             frontstageDef: this,
         });
     }
-    /** Used only in UI 2.0 to determine WidgetState from NinezoneState
+    /** Used to determine WidgetState from NinezoneState
      *  @internal
      */
     getWidgetCurrentState(widgetDef) {
@@ -581,8 +588,7 @@ class FrontstageDef {
         }
         return false;
     }
-    /** Create a new floating panel that contains the widget specified by its Id. Supported only when in
-     *  UI 2.0 or higher.
+    /** Create a new floating panel that contains the widget specified by its Id.
      * @param widgetId case sensitive Widget Id
      * @param position Position of top left corner of floating panel in pixels. If undefined {x:50, y:100} is used.
      * @param size defines the width and height of the floating panel. If undefined and widget has been floated before
@@ -624,24 +630,24 @@ class FrontstageDef {
     /** Opens window for specified PopoutWidget container. Used to reopen popout when running in Electron.
      * @internal
      */
-    openPopoutWidgetContainer(widgetContainerId) {
+    openPopoutWidgetContainer(widgetContainerId, oldState) {
         const state = this.nineZoneState;
         if (!state)
-            return;
+            return false;
         const location = (0, appui_layout_react_1.getWidgetLocation)(state, widgetContainerId);
         if (!location)
-            return;
+            return false;
         if (!(0, appui_layout_react_1.isPopoutWidgetLocation)(location))
-            return;
+            return false;
         const widget = state.widgets[widgetContainerId];
         // Popout widget should only contain a single tab.
         if (widget.tabs.length !== 1)
-            return;
+            return false;
         const tabId = widget.tabs[0];
         const widgetDef = this.findWidgetDef(tabId);
         if (!widgetDef)
-            return;
-        const popoutContent = (React.createElement(PopoutWidget_1.PopoutWidget, { widgetContainerId: widgetContainerId, widgetDef: widgetDef }));
+            return false;
+        const popoutContent = (React.createElement(PopoutWidget_1.PopoutWidget, { widgetContainerId: widgetContainerId }));
         const popoutWidget = state.popoutWidgets.byId[location.popoutWidgetId];
         const bounds = core_react_1.Rectangle.create(popoutWidget.bounds);
         const position = {
@@ -650,10 +656,14 @@ class FrontstageDef {
             left: bounds.left,
             top: bounds.top,
         };
-        UiFramework_1.UiFramework.childWindows.open(widgetContainerId, widgetDef.label, popoutContent, position, UiFramework_1.UiFramework.useDefaultPopoutUrl);
+        const result = UiFramework_1.UiFramework.childWindows.open(widgetContainerId, widgetDef.label, popoutContent, position, UiFramework_1.UiFramework.useDefaultPopoutUrl);
+        if (!result && oldState) {
+            this.nineZoneState = oldState;
+            return false;
+        }
+        return true;
     }
-    /** Create a new popout/child window that contains the widget specified by its Id. Supported only when in
-     *  UI 2.0 or higher.
+    /** Create a new popout/child window that contains the widget specified by its Id.
      * @param widgetId case sensitive Widget Id
      * @param position Position of top left corner of floating panel in pixels. If undefined {x:0, y:0} is used.
      * @param size defines the width and height of the floating panel. If undefined and widget has been floated before
@@ -735,7 +745,7 @@ class FrontstageDef {
     }
     /** Finds the container with the specified widget and re-docks all widgets
      * back to the panel zone location that was used when the floating container
-     * was generated. Supported only when in UI 2.0 or higher.
+     * was generated.
      * @param widgetId  case sensitive Widget Id.
      * @beta
      */