@itwin/appui-react 3.5.0-dev.14 → 3.5.0-dev.16

package/lib/cjs/appui-react/stagepanels/StagePanel.js.map

@@ -1 +1 @@
-{"version":3,"file":"StagePanel.js","sourceRoot":"","sources":["../../../../src/appui-react/stagepanels/StagePanel.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;;;AAEH,+BAA+B;AAC/B,0DAA2D;AAC3D,kEAGmC;AAEnC,uEAAoE;AAIpE,+DAA4D;AAC5D,mDAAgH;AAoHhH;;GAEG;AACH,MAAa,UAAW,SAAQ,KAAK,CAAC,SAAoD;IAKxF,YAAmB,KAAsB;;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;QAoDP,sBAAiB,GAAG,CAAC,WAA4B,EAAmB,EAAE;YAC5E,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YAC7C,IAAI,CAAC,YAAY;gBACf,OAAO,IAAI,CAAC;YACd,MAAM,SAAS,GAAG,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YACnE,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,SAAS;gBACpC,OAAO,IAAI,CAAC;YACd,OAAO,CACL,6BACE,KAAK,EAAE;oBACL,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO;iBAC3D,IAEA,SAAS,CAAC,SAAS,CAChB,CACP,CAAC;QACJ,CAAC,CAAC;QAEM,kCAA6B,GAAG,CAAC,EAAE,QAAQ,EAAE,UAAU,EAA8B,EAAE,EAAE;;YAC/F,uBAAuB;YACvB,IAAI,QAAQ,MAAK,MAAA,IAAI,CAAC,KAAK,CAAC,YAAY,0CAAE,QAAQ,CAAA;gBAChD,OAAO;YACT,uBAAuB;YACvB,IAAI,CAAC,QAAQ,CAAC;gBACZ,UAAU;aACX,CAAC,CAAC;QACL,CAAC,CAAC;QAEM,mCAA8B,GAAG,CAAC,EAAE,SAAS,EAA+B,EAAE,EAAE;YACtF,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YAC7C,IAAI,CAAC,YAAY;gBACf,OAAO;YACT,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;gBACpD,OAAO;YACT,IAAI,CAAC,QAAQ,CAAC;gBACZ,iBAAiB,EAAE,IAAI,CAAC,4BAA4B,EAAE;aACvD,CAAC,CAAC;QACL,CAAC,CAAC;QAxFA,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,KAAK,CAAC,YAAY,0CAAE,QAAQ,CAAC,UAAU,CAAC;QAChE,IAAI,CAAC,KAAK,GAAG;YACX,UAAU,EAAE,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,+BAAe,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU;YACxE,iBAAiB,EAAE,IAAI,CAAC,4BAA4B,EAAE;SACvD,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,uBAAuB,CAAC,QAAuB,EAAE,KAAsB,EAAE,aAAiC;QACtH,QAAQ,CAAC,mBAAmB,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;IACrD,CAAC;IAEe,iBAAiB;QAC/B,qCAAiB,CAAC,wBAAwB,CAAC,WAAW,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QAC3F,qCAAiB,CAAC,yBAAyB,CAAC,WAAW,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;IAC/F,CAAC;IAEe,kBAAkB,CAAC,SAA0B;;QAC3D,IAAI,CAAA,MAAA,SAAS,CAAC,YAAY,0CAAE,QAAQ,OAAK,MAAA,IAAI,CAAC,KAAK,CAAC,YAAY,0CAAE,QAAQ,CAAA,EAAE;YAC1E,IAAI,CAAC,QAAQ,CAAC;gBACZ,iBAAiB,EAAE,IAAI,CAAC,4BAA4B,EAAE;aACvD,CAAC,CAAC;SACJ;IACH,CAAC;IAEe,oBAAoB;QAClC,qCAAiB,CAAC,wBAAwB,CAAC,cAAc,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QAC9F,qCAAiB,CAAC,yBAAyB,CAAC,cAAc,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;IAClG,CAAC;IAEe,MAAM;QACpB,MAAM,EAAE,eAAe,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,wDAAwD;QACrJ,IAAI,CAAC,YAAY;YACf,OAAO,IAAI,CAAC;QAEd,MAAM,EAAE,uBAAuB,EAAE,QAAQ,EAAE,GAAG,iBAAiB,EAAE,GAAG,YAAY,CAAC;QACjF,OAAO,CACL,oBAAC,yCAAmB,IAClB,aAAa,EAAE,uBAAuB,EACtC,WAAW,EAAE,IAAI,EACjB,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAC3B,UAAU,EAAE,IAAI,CAAC,iBAAiB,EAClC,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAC/C,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EACjC,OAAO,EAAE,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,KACtD,KAAK,KACL,iBAAiB,GACrB,CACH,CAAC;IACJ,CAAC;IA0CO,4BAA4B;;QAClC,MAAM,QAAQ,GAAG,MAAA,IAAI,CAAC,KAAK,CAAC,YAAY,0CAAE,QAAQ,CAAC;QACnD,IAAI,CAAC,QAAQ;YACX,OAAO,EAAE,CAAC;QACZ,MAAM,cAAc,GAAG,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;QACxE,OAAO,cAAc,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACzD,CAAC;;AAxGH,gCAyGC;AAxGwB,uBAAY,GAA2B;IAC5D,SAAS,EAAE,IAAI;CAChB,CAAC;AAwGJ,gBAAgB;AACT,MAAM,iBAAiB,GAAG,CAAC,QAA4B,EAAqB,EAAE;IACnF,QAAQ,QAAQ,EAAE;QAChB,KAAK,mCAAkB,CAAC,MAAM,CAAC;QAC/B,KAAK,mCAAkB,CAAC,UAAU;YAChC,OAAO,mCAAiB,CAAC,MAAM,CAAC;QAClC,KAAK,mCAAkB,CAAC,IAAI;YAC1B,OAAO,mCAAiB,CAAC,IAAI,CAAC;QAChC,KAAK,mCAAkB,CAAC,KAAK;YAC3B,OAAO,mCAAiB,CAAC,KAAK,CAAC;QACjC,KAAK,mCAAkB,CAAC,GAAG,CAAC;QAC5B,KAAK,mCAAkB,CAAC,OAAO;YAC7B,OAAO,mCAAiB,CAAC,GAAG,CAAC;KAChC;AACH,CAAC,CAAC;AAbW,QAAA,iBAAiB,qBAa5B;AAEF,gBAAgB;AACT,MAAM,sBAAsB,GAAG,CAAC,QAA4B,EAAsD,EAAE;IACzH,QAAQ,QAAQ,EAAE;QAChB,KAAK,mCAAkB,CAAC,MAAM;YAC5B,OAAO;gBACL,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE,mCAAiB,CAAC,MAAM;aAC/B,CAAC;QACJ,KAAK,mCAAkB,CAAC,UAAU;YAChC,OAAO;gBACL,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE,mCAAiB,CAAC,MAAM;aAC/B,CAAC;QACJ,KAAK,mCAAkB,CAAC,IAAI;YAC1B,OAAO;gBACL,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE,mCAAiB,CAAC,IAAI;aAC7B,CAAC;QACJ,KAAK,mCAAkB,CAAC,KAAK;YAC3B,OAAO;gBACL,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE,mCAAiB,CAAC,KAAK;aAC9B,CAAC;QACJ,KAAK,mCAAkB,CAAC,GAAG;YACzB,OAAO;gBACL,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE,mCAAiB,CAAC,GAAG;aAC5B,CAAC;QACJ,KAAK,mCAAkB,CAAC,OAAO;YAC7B,OAAO;gBACL,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE,mCAAiB,CAAC,GAAG;aAC5B,CAAC;KACL;AACH,CAAC,CAAC;AAjCW,QAAA,sBAAsB,0BAiCjC","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/* eslint-disable deprecation/deprecation */\n/** @packageDocumentation\n * @module Frontstage\n */\n\nimport * as React from \"react\";\nimport { StagePanelLocation } from \"@itwin/appui-abstract\";\nimport {\n  NestedStagePanelKey, NestedStagePanelsManagerProps, NineZoneStagePanelManagerProps, StagePanelType as NZ_StagePanelType, WidgetZoneId,\n  ZonesManagerWidgetsProps,\n} from \"@itwin/appui-layout-react\";\nimport { StagePanelChangeHandler, WidgetChangeHandler, ZoneDefProvider } from \"../frontstage/FrontstageComposer\";\nimport { FrontstageManager } from \"../frontstage/FrontstageManager\";\nimport { WidgetProps } from \"../widgets/WidgetProps\";\nimport { WidgetTabs } from \"../widgets/WidgetStack\";\nimport { ZoneLocation } from \"../zones/Zone\";\nimport { FrameworkStagePanel } from \"./FrameworkStagePanel\";\nimport { PanelStateChangedEventArgs, StagePanelDef, StagePanelState as StagePanelState } from \"./StagePanelDef\";\nimport { WidgetDef, WidgetStateChangedEventArgs } from \"../widgets/WidgetDef\";\n\n/** Available StagePanel locations.\n * ------------------------------------------------------------------------------------\n * TopMost\n * ------------------------------------------------------------------------------------\n * Left     | Top                                                           | Right\n *          |---------------------------------------------------------------|\n *          | Nine-zone                                                     |\n *          |                                                               |\n *          |                                                               |\n *          |                                                               |\n *          |                                                               |\n *          |                                                               |\n *          |---------------------------------------------------------------|\n *          | Bottom                                                        |\n * ------------------------------------------------------------------------------------\n * BottomMost\n * ------------------------------------------------------------------------------------\n */\n\n/** Properties of a Stage Panel Zone\n * @public @deprecated\n */\nexport interface StagePanelZoneProps {\n  /** Properties for the Widgets in this Zone.\n   * @note Stable `WidgetProps[\"id\"]` is generated if id is not provided to correctly save and restore App layout.\n   * [[Frontstage]] version must be increased when Widget location is changed or new widgets are added/removed.\n   */\n  widgets: Array<React.ReactElement<WidgetProps>>;\n  /** Any application data to attach to this Zone. */\n  applicationData?: any;\n}\n\n/** Properties of the Stage Panel Zones\n * @public @deprecated\n */\nexport interface StagePanelZonesProps {\n  /** Properties for the Widgets in the Start section. */\n  start?: StagePanelZoneProps;\n  /** Properties for the Widgets in the Middle section. Deprecated - all widgets originally targeted for \"middle\" will now go to \"end\". */\n  middle?: StagePanelZoneProps;\n  /** Properties for the Widgets in the End section. */\n  end?: StagePanelZoneProps;\n}\n\n/** Available units of panel maximum size. Pixels or percentage of 9-Zone App size.\n * @note Percentage of 9-Zone `height` is used for top/bottom panel and percentage of 9-Zone `width` is used for left/right panel.\n * @public\n */\nexport type StagePanelMaxSizeSpec = number | { percentage: number };\n\n/** Properties of a [[StagePanel]] component\n * @public\n */\nexport interface StagePanelProps {\n  /** Describes which zones are allowed in this stage panel. */\n  allowedZones?: ZoneLocation[];\n  /** Any application data to attach to this Panel. */\n  applicationData?: any;\n  /** Default Panel state. Controls how the panel is initially displayed. Defaults to StagePanelState.Open. */\n  defaultState?: StagePanelState;\n  /** Stage panel header. */\n  header?: React.ReactNode;\n  /** Maximum size of the panel. */\n  maxSize?: StagePanelMaxSizeSpec;\n  /** Minimum size of the panel. */\n  minSize?: number;\n  /** Indicates whether the panel is pinned. Defaults to true. */\n  pinned?: boolean;\n  /** Indicates whether the panel is resizable. Defaults to true. */\n  resizable: boolean;\n  /** Default size of the panel. */\n  size?: number;\n  /** Properties for the Widgets in this Panel.\n   * @note Stable `WidgetProps[\"id\"]` is generated if id is not provided to correctly save and restore App layout.\n   * [[Frontstage]] version must be increased when Widget location is changed or new widgets are added/removed.\n   */\n  widgets?: Array<React.ReactElement<WidgetProps>>;\n\n  /** Properties for the Panel Zones in this Panel.\n   * @beta */\n  panelZones?: StagePanelZonesProps;\n\n  /** @internal */\n  runtimeProps?: StagePanelRuntimeProps;\n}\n\n/** Default properties of [[StagePanel]] component.\n * @public\n */\nexport type StagePanelDefaultProps = Pick<StagePanelProps, \"resizable\">;\n\n/** Runtime Properties for the [[StagePanel]] component.\n * @internal\n */\nexport interface StagePanelRuntimeProps {\n  draggedWidgetId: WidgetZoneId | undefined; // eslint-disable-line deprecation/deprecation\n  getWidgetContentRef: (id: WidgetZoneId) => React.Ref<HTMLDivElement>; // eslint-disable-line deprecation/deprecation\n  isInFooterMode: boolean;\n  isTargeted: boolean;\n  panel: NineZoneStagePanelManagerProps;\n  panelDef: StagePanelDef;\n  stagePanelChangeHandler: StagePanelChangeHandler;\n  widgetChangeHandler: WidgetChangeHandler; // eslint-disable-line deprecation/deprecation\n  widgets: ZonesManagerWidgetsProps;\n  widgetTabs: WidgetTabs;\n  zoneDefProvider: ZoneDefProvider;\n}\n\ninterface StagePanelComponentState {\n  panelState: StagePanelState;\n  stagePanelWidgets: ReadonlyArray<WidgetDef[\"id\"]>;\n}\n\n/** Frontstage Panel React component.\n * @public\n */\nexport class StagePanel extends React.Component<StagePanelProps, StagePanelComponentState> {\n  public static readonly defaultProps: StagePanelDefaultProps = {\n    resizable: true,\n  };\n\n  public constructor(props: StagePanelProps) {\n    super(props);\n\n    const panelState = this.props.runtimeProps?.panelDef.panelState;\n    this.state = {\n      panelState: panelState === undefined ? StagePanelState.Open : panelState,\n      stagePanelWidgets: this._getVisibleStagePanelWidgets(),\n    };\n  }\n\n  public static initializeStagePanelDef(panelDef: StagePanelDef, props: StagePanelProps, panelLocation: StagePanelLocation): void {\n    panelDef.initializeFromProps(props, panelLocation);\n  }\n\n  public override componentDidMount() {\n    FrontstageManager.onPanelStateChangedEvent.addListener(this._handlePanelStateChangedEvent);\n    FrontstageManager.onWidgetStateChangedEvent.addListener(this._handleWidgetStateChangedEvent);\n  }\n\n  public override componentDidUpdate(prevProps: StagePanelProps) {\n    if (prevProps.runtimeProps?.panelDef !== this.props.runtimeProps?.panelDef) {\n      this.setState({\n        stagePanelWidgets: this._getVisibleStagePanelWidgets(),\n      });\n    }\n  }\n\n  public override componentWillUnmount() {\n    FrontstageManager.onPanelStateChangedEvent.removeListener(this._handlePanelStateChangedEvent);\n    FrontstageManager.onWidgetStateChangedEvent.removeListener(this._handleWidgetStateChangedEvent);\n  }\n\n  public override render(): React.ReactNode {\n    const { applicationData, defaultState, runtimeProps, maxSize, size, ...props } = this.props; // eslint-disable-line @typescript-eslint/no-unused-vars\n    if (!runtimeProps)\n      return null;\n\n    const { stagePanelChangeHandler, panelDef, ...otherRuntimeProps } = runtimeProps;\n    return (\n      <FrameworkStagePanel\n        changeHandler={stagePanelChangeHandler}\n        initialSize={size}\n        location={panelDef.location}\n        renderPane={this._handleRenderPane}\n        stagePanelWidgets={this.state.stagePanelWidgets}\n        panelState={this.state.panelState}\n        maxSize={typeof maxSize === \"number\" ? maxSize : undefined}\n        {...props}\n        {...otherRuntimeProps}\n      />\n    );\n  }\n\n  private _handleRenderPane = (widgetDefId: WidgetDef[\"id\"]): React.ReactNode => {\n    const runtimeProps = this.props.runtimeProps;\n    if (!runtimeProps)\n      return null;\n    const widgetDef = runtimeProps.panelDef.findWidgetDef(widgetDefId);\n    if (!widgetDef || !widgetDef.isVisible)\n      return null;\n    return (\n      <div\n        style={{\n          height: \"100%\",\n          display: runtimeProps.panel.isCollapsed ? \"none\" : \"block\",\n        }}\n      >\n        {widgetDef.reactNode}\n      </div>\n    );\n  };\n\n  private _handlePanelStateChangedEvent = ({ panelDef, panelState }: PanelStateChangedEventArgs) => {\n    // istanbul ignore else\n    if (panelDef !== this.props.runtimeProps?.panelDef)\n      return;\n    // istanbul ignore next\n    this.setState({\n      panelState,\n    });\n  };\n\n  private _handleWidgetStateChangedEvent = ({ widgetDef }: WidgetStateChangedEventArgs) => {\n    const runtimeProps = this.props.runtimeProps;\n    if (!runtimeProps)\n      return;\n    if (!runtimeProps.panelDef.findWidgetDef(widgetDef.id))\n      return;\n    this.setState({\n      stagePanelWidgets: this._getVisibleStagePanelWidgets(),\n    });\n  };\n\n  private _getVisibleStagePanelWidgets() {\n    const panelDef = this.props.runtimeProps?.panelDef;\n    if (!panelDef)\n      return [];\n    const visibleWidgets = panelDef.widgetDefs.filter((wd) => wd.isVisible);\n    return visibleWidgets.map((widgetDef) => widgetDef.id);\n  }\n}\n\n/** @internal */\nexport const getStagePanelType = (location: StagePanelLocation): NZ_StagePanelType => {\n  switch (location) {\n    case StagePanelLocation.Bottom:\n    case StagePanelLocation.BottomMost:\n      return NZ_StagePanelType.Bottom;\n    case StagePanelLocation.Left:\n      return NZ_StagePanelType.Left;\n    case StagePanelLocation.Right:\n      return NZ_StagePanelType.Right;\n    case StagePanelLocation.Top:\n    case StagePanelLocation.TopMost:\n      return NZ_StagePanelType.Top;\n  }\n};\n\n/** @internal */\nexport const getNestedStagePanelKey = (location: StagePanelLocation): NestedStagePanelKey<NestedStagePanelsManagerProps> => {\n  switch (location) {\n    case StagePanelLocation.Bottom:\n      return {\n        id: \"inner\",\n        type: NZ_StagePanelType.Bottom,\n      };\n    case StagePanelLocation.BottomMost:\n      return {\n        id: \"outer\",\n        type: NZ_StagePanelType.Bottom,\n      };\n    case StagePanelLocation.Left:\n      return {\n        id: \"inner\",\n        type: NZ_StagePanelType.Left,\n      };\n    case StagePanelLocation.Right:\n      return {\n        id: \"inner\",\n        type: NZ_StagePanelType.Right,\n      };\n    case StagePanelLocation.Top:\n      return {\n        id: \"inner\",\n        type: NZ_StagePanelType.Top,\n      };\n    case StagePanelLocation.TopMost:\n      return {\n        id: \"outer\",\n        type: NZ_StagePanelType.Top,\n      };\n  }\n};\n"]}
+{"version":3,"file":"StagePanel.js","sourceRoot":"","sources":["../../../../src/appui-react/stagepanels/StagePanel.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;;;AAEH,+BAA+B;AAC/B,0DAA2D;AAC3D,kEAGmC;AAEnC,uEAAoE;AAIpE,+DAA4D;AAC5D,mDAAgH;AAoHhH;;GAEG;AACH,MAAa,UAAW,SAAQ,KAAK,CAAC,SAAoD;IAKxF,YAAmB,KAAsB;;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;QAoDP,sBAAiB,GAAG,CAAC,WAA4B,EAAmB,EAAE;YAC5E,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YAC7C,IAAI,CAAC,YAAY;gBACf,OAAO,IAAI,CAAC;YACd,MAAM,SAAS,GAAG,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YACnE,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,SAAS;gBACpC,OAAO,IAAI,CAAC;YACd,OAAO,CACL,6BACE,KAAK,EAAE;oBACL,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO;iBAC3D,IAEA,SAAS,CAAC,SAAS,CAChB,CACP,CAAC;QACJ,CAAC,CAAC;QAEM,kCAA6B,GAAG,CAAC,EAAE,QAAQ,EAAE,UAAU,EAA8B,EAAE,EAAE;;YAC/F,uBAAuB;YACvB,IAAI,QAAQ,MAAK,MAAA,IAAI,CAAC,KAAK,CAAC,YAAY,0CAAE,QAAQ,CAAA;gBAChD,OAAO;YACT,uBAAuB;YACvB,IAAI,CAAC,QAAQ,CAAC;gBACZ,UAAU;aACX,CAAC,CAAC;QACL,CAAC,CAAC;QAEM,mCAA8B,GAAG,CAAC,EAAE,SAAS,EAA+B,EAAE,EAAE;YACtF,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YAC7C,IAAI,CAAC,YAAY;gBACf,OAAO;YACT,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;gBACpD,OAAO;YACT,IAAI,CAAC,QAAQ,CAAC;gBACZ,iBAAiB,EAAE,IAAI,CAAC,4BAA4B,EAAE;aACvD,CAAC,CAAC;QACL,CAAC,CAAC;QAxFA,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,KAAK,CAAC,YAAY,0CAAE,QAAQ,CAAC,UAAU,CAAC;QAChE,IAAI,CAAC,KAAK,GAAG;YACX,UAAU,EAAE,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,+BAAe,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU;YACxE,iBAAiB,EAAE,IAAI,CAAC,4BAA4B,EAAE;SACvD,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,uBAAuB,CAAC,QAAuB,EAAE,KAAsB,EAAE,aAAiC;QACtH,QAAQ,CAAC,mBAAmB,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;IACrD,CAAC;IAEe,iBAAiB;QAC/B,qCAAiB,CAAC,wBAAwB,CAAC,WAAW,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QAC3F,qCAAiB,CAAC,yBAAyB,CAAC,WAAW,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;IAC/F,CAAC;IAEe,kBAAkB,CAAC,SAA0B;;QAC3D,IAAI,CAAA,MAAA,SAAS,CAAC,YAAY,0CAAE,QAAQ,OAAK,MAAA,IAAI,CAAC,KAAK,CAAC,YAAY,0CAAE,QAAQ,CAAA,EAAE;YAC1E,IAAI,CAAC,QAAQ,CAAC;gBACZ,iBAAiB,EAAE,IAAI,CAAC,4BAA4B,EAAE;aACvD,CAAC,CAAC;SACJ;IACH,CAAC;IAEe,oBAAoB;QAClC,qCAAiB,CAAC,wBAAwB,CAAC,cAAc,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QAC9F,qCAAiB,CAAC,yBAAyB,CAAC,cAAc,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;IAClG,CAAC;IAEe,MAAM;QACpB,MAAM,EAAE,eAAe,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,wDAAwD;QACrJ,IAAI,CAAC,YAAY;YACf,OAAO,IAAI,CAAC;QAEd,MAAM,EAAE,uBAAuB,EAAE,QAAQ,EAAE,GAAG,iBAAiB,EAAE,GAAG,YAAY,CAAC;QACjF,OAAO,CACL,oBAAC,yCAAmB,IAClB,aAAa,EAAE,uBAAuB,EACtC,WAAW,EAAE,IAAI,EACjB,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAC3B,UAAU,EAAE,IAAI,CAAC,iBAAiB,EAClC,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAC/C,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EACjC,OAAO,EAAE,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,KACtD,KAAK,KACL,iBAAiB,GACrB,CACH,CAAC;IACJ,CAAC;IA0CO,4BAA4B;;QAClC,MAAM,QAAQ,GAAG,MAAA,IAAI,CAAC,KAAK,CAAC,YAAY,0CAAE,QAAQ,CAAC;QACnD,IAAI,CAAC,QAAQ;YACX,OAAO,EAAE,CAAC;QACZ,MAAM,cAAc,GAAG,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;QACxE,OAAO,cAAc,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACzD,CAAC;;AAxGH,gCAyGC;AAxGwB,uBAAY,GAA2B;IAC5D,SAAS,EAAE,IAAI;CAChB,CAAC;AAwGJ,gBAAgB;AACT,MAAM,iBAAiB,GAAG,CAAC,QAA4B,EAAqB,EAAE;IACnF,QAAQ,QAAQ,EAAE;QAChB,KAAK,mCAAkB,CAAC,MAAM,CAAC;QAC/B,KAAK,mCAAkB,CAAC,UAAU;YAChC,OAAO,mCAAiB,CAAC,MAAM,CAAC;QAClC,KAAK,mCAAkB,CAAC,IAAI;YAC1B,OAAO,mCAAiB,CAAC,IAAI,CAAC;QAChC,KAAK,mCAAkB,CAAC,KAAK;YAC3B,OAAO,mCAAiB,CAAC,KAAK,CAAC;QACjC,KAAK,mCAAkB,CAAC,GAAG,CAAC;QAC5B,KAAK,mCAAkB,CAAC,OAAO;YAC7B,OAAO,mCAAiB,CAAC,GAAG,CAAC;KAChC;AACH,CAAC,CAAC;AAbW,QAAA,iBAAiB,qBAa5B;AAEF,gBAAgB;AACT,MAAM,sBAAsB,GAAG,CAAC,QAA4B,EAAsD,EAAE;IACzH,QAAQ,QAAQ,EAAE;QAChB,KAAK,mCAAkB,CAAC,MAAM;YAC5B,OAAO;gBACL,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE,mCAAiB,CAAC,MAAM;aAC/B,CAAC;QACJ,KAAK,mCAAkB,CAAC,UAAU;YAChC,OAAO;gBACL,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE,mCAAiB,CAAC,MAAM;aAC/B,CAAC;QACJ,KAAK,mCAAkB,CAAC,IAAI;YAC1B,OAAO;gBACL,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE,mCAAiB,CAAC,IAAI;aAC7B,CAAC;QACJ,KAAK,mCAAkB,CAAC,KAAK;YAC3B,OAAO;gBACL,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE,mCAAiB,CAAC,KAAK;aAC9B,CAAC;QACJ,KAAK,mCAAkB,CAAC,GAAG;YACzB,OAAO;gBACL,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE,mCAAiB,CAAC,GAAG;aAC5B,CAAC;QACJ,KAAK,mCAAkB,CAAC,OAAO;YAC7B,OAAO;gBACL,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE,mCAAiB,CAAC,GAAG;aAC5B,CAAC;KACL;AACH,CAAC,CAAC;AAjCW,QAAA,sBAAsB,0BAiCjC","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/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module Frontstage\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { StagePanelLocation } from \"@itwin/appui-abstract\";\r\nimport {\r\n  NestedStagePanelKey, NestedStagePanelsManagerProps, NineZoneStagePanelManagerProps, StagePanelType as NZ_StagePanelType, WidgetZoneId,\r\n  ZonesManagerWidgetsProps,\r\n} from \"@itwin/appui-layout-react\";\r\nimport { StagePanelChangeHandler, WidgetChangeHandler, ZoneDefProvider } from \"../frontstage/FrontstageComposer\";\r\nimport { FrontstageManager } from \"../frontstage/FrontstageManager\";\r\nimport { WidgetProps } from \"../widgets/WidgetProps\";\r\nimport { WidgetTabs } from \"../widgets/WidgetStack\";\r\nimport { ZoneLocation } from \"../zones/Zone\";\r\nimport { FrameworkStagePanel } from \"./FrameworkStagePanel\";\r\nimport { PanelStateChangedEventArgs, StagePanelDef, StagePanelState as StagePanelState } from \"./StagePanelDef\";\r\nimport { WidgetDef, WidgetStateChangedEventArgs } from \"../widgets/WidgetDef\";\r\n\r\n/** Available StagePanel locations.\r\n * ------------------------------------------------------------------------------------\r\n * TopMost\r\n * ------------------------------------------------------------------------------------\r\n * Left     | Top                                                           | Right\r\n *          |---------------------------------------------------------------|\r\n *          | Nine-zone                                                     |\r\n *          |                                                               |\r\n *          |                                                               |\r\n *          |                                                               |\r\n *          |                                                               |\r\n *          |                                                               |\r\n *          |---------------------------------------------------------------|\r\n *          | Bottom                                                        |\r\n * ------------------------------------------------------------------------------------\r\n * BottomMost\r\n * ------------------------------------------------------------------------------------\r\n */\r\n\r\n/** Properties of a Stage Panel Zone\r\n * @public @deprecated\r\n */\r\nexport interface StagePanelZoneProps {\r\n  /** Properties for the Widgets in this Zone.\r\n   * @note Stable `WidgetProps[\"id\"]` is generated if id is not provided to correctly save and restore App layout.\r\n   * [[Frontstage]] version must be increased when Widget location is changed or new widgets are added/removed.\r\n   */\r\n  widgets: Array<React.ReactElement<WidgetProps>>;\r\n  /** Any application data to attach to this Zone. */\r\n  applicationData?: any;\r\n}\r\n\r\n/** Properties of the Stage Panel Zones\r\n * @public @deprecated\r\n */\r\nexport interface StagePanelZonesProps {\r\n  /** Properties for the Widgets in the Start section. */\r\n  start?: StagePanelZoneProps;\r\n  /** Properties for the Widgets in the Middle section. Deprecated - all widgets originally targeted for \"middle\" will now go to \"end\". */\r\n  middle?: StagePanelZoneProps;\r\n  /** Properties for the Widgets in the End section. */\r\n  end?: StagePanelZoneProps;\r\n}\r\n\r\n/** Available units of panel maximum size. Pixels or percentage of 9-Zone App size.\r\n * @note Percentage of 9-Zone `height` is used for top/bottom panel and percentage of 9-Zone `width` is used for left/right panel.\r\n * @public\r\n */\r\nexport type StagePanelMaxSizeSpec = number | { percentage: number };\r\n\r\n/** Properties of a [[StagePanel]] component\r\n * @public\r\n */\r\nexport interface StagePanelProps {\r\n  /** Describes which zones are allowed in this stage panel. */\r\n  allowedZones?: ZoneLocation[];\r\n  /** Any application data to attach to this Panel. */\r\n  applicationData?: any;\r\n  /** Default Panel state. Controls how the panel is initially displayed. Defaults to StagePanelState.Open. */\r\n  defaultState?: StagePanelState;\r\n  /** Stage panel header. */\r\n  header?: React.ReactNode;\r\n  /** Maximum size of the panel. */\r\n  maxSize?: StagePanelMaxSizeSpec;\r\n  /** Minimum size of the panel. */\r\n  minSize?: number;\r\n  /** Indicates whether the panel is pinned. Defaults to true. */\r\n  pinned?: boolean;\r\n  /** Indicates whether the panel is resizable. Defaults to true. */\r\n  resizable: boolean;\r\n  /** Default size of the panel. */\r\n  size?: number;\r\n  /** Properties for the Widgets in this Panel.\r\n   * @note Stable `WidgetProps[\"id\"]` is generated if id is not provided to correctly save and restore App layout.\r\n   * [[Frontstage]] version must be increased when Widget location is changed or new widgets are added/removed.\r\n   */\r\n  widgets?: Array<React.ReactElement<WidgetProps>>;\r\n\r\n  /** Properties for the Panel Zones in this Panel.\r\n   * @beta */\r\n  panelZones?: StagePanelZonesProps;\r\n\r\n  /** @internal */\r\n  runtimeProps?: StagePanelRuntimeProps;\r\n}\r\n\r\n/** Default properties of [[StagePanel]] component.\r\n * @public\r\n */\r\nexport type StagePanelDefaultProps = Pick<StagePanelProps, \"resizable\">;\r\n\r\n/** Runtime Properties for the [[StagePanel]] component.\r\n * @internal\r\n */\r\nexport interface StagePanelRuntimeProps {\r\n  draggedWidgetId: WidgetZoneId | undefined; // eslint-disable-line deprecation/deprecation\r\n  getWidgetContentRef: (id: WidgetZoneId) => React.Ref<HTMLDivElement>; // eslint-disable-line deprecation/deprecation\r\n  isInFooterMode: boolean;\r\n  isTargeted: boolean;\r\n  panel: NineZoneStagePanelManagerProps;\r\n  panelDef: StagePanelDef;\r\n  stagePanelChangeHandler: StagePanelChangeHandler;\r\n  widgetChangeHandler: WidgetChangeHandler; // eslint-disable-line deprecation/deprecation\r\n  widgets: ZonesManagerWidgetsProps;\r\n  widgetTabs: WidgetTabs;\r\n  zoneDefProvider: ZoneDefProvider;\r\n}\r\n\r\ninterface StagePanelComponentState {\r\n  panelState: StagePanelState;\r\n  stagePanelWidgets: ReadonlyArray<WidgetDef[\"id\"]>;\r\n}\r\n\r\n/** Frontstage Panel React component.\r\n * @public\r\n */\r\nexport class StagePanel extends React.Component<StagePanelProps, StagePanelComponentState> {\r\n  public static readonly defaultProps: StagePanelDefaultProps = {\r\n    resizable: true,\r\n  };\r\n\r\n  public constructor(props: StagePanelProps) {\r\n    super(props);\r\n\r\n    const panelState = this.props.runtimeProps?.panelDef.panelState;\r\n    this.state = {\r\n      panelState: panelState === undefined ? StagePanelState.Open : panelState,\r\n      stagePanelWidgets: this._getVisibleStagePanelWidgets(),\r\n    };\r\n  }\r\n\r\n  public static initializeStagePanelDef(panelDef: StagePanelDef, props: StagePanelProps, panelLocation: StagePanelLocation): void {\r\n    panelDef.initializeFromProps(props, panelLocation);\r\n  }\r\n\r\n  public override componentDidMount() {\r\n    FrontstageManager.onPanelStateChangedEvent.addListener(this._handlePanelStateChangedEvent);\r\n    FrontstageManager.onWidgetStateChangedEvent.addListener(this._handleWidgetStateChangedEvent);\r\n  }\r\n\r\n  public override componentDidUpdate(prevProps: StagePanelProps) {\r\n    if (prevProps.runtimeProps?.panelDef !== this.props.runtimeProps?.panelDef) {\r\n      this.setState({\r\n        stagePanelWidgets: this._getVisibleStagePanelWidgets(),\r\n      });\r\n    }\r\n  }\r\n\r\n  public override componentWillUnmount() {\r\n    FrontstageManager.onPanelStateChangedEvent.removeListener(this._handlePanelStateChangedEvent);\r\n    FrontstageManager.onWidgetStateChangedEvent.removeListener(this._handleWidgetStateChangedEvent);\r\n  }\r\n\r\n  public override render(): React.ReactNode {\r\n    const { applicationData, defaultState, runtimeProps, maxSize, size, ...props } = this.props; // eslint-disable-line @typescript-eslint/no-unused-vars\r\n    if (!runtimeProps)\r\n      return null;\r\n\r\n    const { stagePanelChangeHandler, panelDef, ...otherRuntimeProps } = runtimeProps;\r\n    return (\r\n      <FrameworkStagePanel\r\n        changeHandler={stagePanelChangeHandler}\r\n        initialSize={size}\r\n        location={panelDef.location}\r\n        renderPane={this._handleRenderPane}\r\n        stagePanelWidgets={this.state.stagePanelWidgets}\r\n        panelState={this.state.panelState}\r\n        maxSize={typeof maxSize === \"number\" ? maxSize : undefined}\r\n        {...props}\r\n        {...otherRuntimeProps}\r\n      />\r\n    );\r\n  }\r\n\r\n  private _handleRenderPane = (widgetDefId: WidgetDef[\"id\"]): React.ReactNode => {\r\n    const runtimeProps = this.props.runtimeProps;\r\n    if (!runtimeProps)\r\n      return null;\r\n    const widgetDef = runtimeProps.panelDef.findWidgetDef(widgetDefId);\r\n    if (!widgetDef || !widgetDef.isVisible)\r\n      return null;\r\n    return (\r\n      <div\r\n        style={{\r\n          height: \"100%\",\r\n          display: runtimeProps.panel.isCollapsed ? \"none\" : \"block\",\r\n        }}\r\n      >\r\n        {widgetDef.reactNode}\r\n      </div>\r\n    );\r\n  };\r\n\r\n  private _handlePanelStateChangedEvent = ({ panelDef, panelState }: PanelStateChangedEventArgs) => {\r\n    // istanbul ignore else\r\n    if (panelDef !== this.props.runtimeProps?.panelDef)\r\n      return;\r\n    // istanbul ignore next\r\n    this.setState({\r\n      panelState,\r\n    });\r\n  };\r\n\r\n  private _handleWidgetStateChangedEvent = ({ widgetDef }: WidgetStateChangedEventArgs) => {\r\n    const runtimeProps = this.props.runtimeProps;\r\n    if (!runtimeProps)\r\n      return;\r\n    if (!runtimeProps.panelDef.findWidgetDef(widgetDef.id))\r\n      return;\r\n    this.setState({\r\n      stagePanelWidgets: this._getVisibleStagePanelWidgets(),\r\n    });\r\n  };\r\n\r\n  private _getVisibleStagePanelWidgets() {\r\n    const panelDef = this.props.runtimeProps?.panelDef;\r\n    if (!panelDef)\r\n      return [];\r\n    const visibleWidgets = panelDef.widgetDefs.filter((wd) => wd.isVisible);\r\n    return visibleWidgets.map((widgetDef) => widgetDef.id);\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport const getStagePanelType = (location: StagePanelLocation): NZ_StagePanelType => {\r\n  switch (location) {\r\n    case StagePanelLocation.Bottom:\r\n    case StagePanelLocation.BottomMost:\r\n      return NZ_StagePanelType.Bottom;\r\n    case StagePanelLocation.Left:\r\n      return NZ_StagePanelType.Left;\r\n    case StagePanelLocation.Right:\r\n      return NZ_StagePanelType.Right;\r\n    case StagePanelLocation.Top:\r\n    case StagePanelLocation.TopMost:\r\n      return NZ_StagePanelType.Top;\r\n  }\r\n};\r\n\r\n/** @internal */\r\nexport const getNestedStagePanelKey = (location: StagePanelLocation): NestedStagePanelKey<NestedStagePanelsManagerProps> => {\r\n  switch (location) {\r\n    case StagePanelLocation.Bottom:\r\n      return {\r\n        id: \"inner\",\r\n        type: NZ_StagePanelType.Bottom,\r\n      };\r\n    case StagePanelLocation.BottomMost:\r\n      return {\r\n        id: \"outer\",\r\n        type: NZ_StagePanelType.Bottom,\r\n      };\r\n    case StagePanelLocation.Left:\r\n      return {\r\n        id: \"inner\",\r\n        type: NZ_StagePanelType.Left,\r\n      };\r\n    case StagePanelLocation.Right:\r\n      return {\r\n        id: \"inner\",\r\n        type: NZ_StagePanelType.Right,\r\n      };\r\n    case StagePanelLocation.Top:\r\n      return {\r\n        id: \"inner\",\r\n        type: NZ_StagePanelType.Top,\r\n      };\r\n    case StagePanelLocation.TopMost:\r\n      return {\r\n        id: \"outer\",\r\n        type: NZ_StagePanelType.Top,\r\n      };\r\n  }\r\n};\r\n"]}

package/lib/cjs/appui-react/stagepanels/StagePanelDef.d.ts

@@ -1,284 +1,284 @@
-/** @packageDocumentation
- * @module Frontstage
- */
-/// <reference types="react" />
-import { StagePanelLocation, StagePanelSection, UiEvent } from "@itwin/appui-abstract";
-import { NineZoneState, PanelSide } from "@itwin/appui-layout-react";
-import { WidgetDef } from "../widgets/WidgetDef";
-import { WidgetHost } from "../widgets/WidgetHost";
-import { StagePanelMaxSizeSpec, StagePanelProps, StagePanelZoneProps, StagePanelZonesProps } from "./StagePanel";
-import { ZoneLocation } from "../zones/Zone";
-/** Enum for StagePanel state.
- * @public
- */
-export declare enum StagePanelState {
-    Off = 0,
-    Minimized = 1,
-    Open = 2,
-    Popup = 3
-}
-/** Panel State Changed Event Args interface.
- * @public
- */
-export interface PanelStateChangedEventArgs {
-    panelDef: StagePanelDef;
-    panelState: StagePanelState;
-}
-/** Panel State Changed Event class.
- * @beta
- */
-export declare class PanelStateChangedEvent extends UiEvent<PanelStateChangedEventArgs> {
-}
-/** @internal */
-export interface PanelSizeChangedEventArgs {
-    panelDef: StagePanelDef;
-    size: number | undefined;
-}
-/** @internal */
-export declare class PanelSizeChangedEvent extends UiEvent<PanelSizeChangedEventArgs> {
-}
-/**
- * A StagePanelDef represents each Stage Panel within a Frontstage.
- * @public
- */
-export declare class StagePanelDef extends WidgetHost {
-    private _panelState;
-    private _defaultState;
-    private _maxSizeSpec;
-    private _minSize;
-    private _size;
-    private _defaultSize;
-    private _resizable;
-    private _pinned;
-    private _applicationData?;
-    private _location;
-    private _panelZones;
-    /** Constructor for PanelDef.
-     */
-    constructor();
-    /** @internal */
-    get maxSizeSpec(): StagePanelMaxSizeSpec | undefined;
-    /** @internal */
-    get minSize(): number | undefined;
-    /** Default size of the panel */
-    get size(): number | undefined;
-    set size(size: number | undefined);
-    /** Indicates whether the panel is resizable. */
-    get resizable(): boolean;
-    /** Indicates whether the panel is pinned. */
-    get pinned(): boolean;
-    /** Any application data to attach to this Panel. */
-    get applicationData(): any | undefined;
-    /** Location of panel. */
-    get location(): StagePanelLocation;
-    /** Panel state. Defaults to PanelState.Open. */
-    get panelState(): StagePanelState;
-    set panelState(panelState: StagePanelState);
-    /** @internal */
-    get defaultState(): StagePanelState;
-    /** @internal */
-    get defaultSize(): number | undefined;
-    /** Panel zones.
-     * @internal
-     */
-    get panelZones(): StagePanelZonesDef;
-    /** @internal */
-    initializeFromProps(props?: StagePanelProps, panelLocation?: StagePanelLocation): void;
-    /** Gets the list of Widgets. */
-    get widgetDefs(): ReadonlyArray<WidgetDef>;
-    /** Gets the list of Widgets (w/o StagePanelZone widgets).
-     * @internal
-     */
-    get panelWidgetDefs(): readonly WidgetDef[];
-    /** @internal */
-    updateDynamicWidgetDefs(stageId: string, stageUsage: string, location: ZoneLocation | StagePanelLocation, _section: StagePanelSection | undefined, allStageWidgetDefs: WidgetDef[], frontstageApplicationData?: any): void;
-}
-/** @internal */
-export declare type StagePanelZoneDefKeys = keyof Pick<StagePanelZonesDef, "start" | "end">;
-/** @internal */
-export declare class StagePanelZonesDef {
-    private _start;
-    private _end;
-    get start(): StagePanelZoneDef;
-    get end(): StagePanelZoneDef;
-    /** @internal */
-    initializeFromProps(props: StagePanelZonesProps, panelLocation: StagePanelLocation): void;
-    /** @internal */
-    [Symbol.iterator](): Iterator<[StagePanelZoneDefKeys, StagePanelZoneDef]>;
-}
-/** @internal */
-export declare class StagePanelZoneDef extends WidgetHost {
-    /** @internal */
-    initializeFromProps(props: StagePanelZoneProps, panelLocation: StagePanelLocation, panelZone: StagePanelZoneDefKeys): void;
-}
-/** @internal */
-export declare function toPanelSide(location: StagePanelLocation): PanelSide;
-/** @internal */
-export declare const setPanelSize: (base: {
-    readonly draggedTab: {
-        readonly tabId: string;
-        readonly position: {
-            readonly x: number;
-            readonly y: number;
-        };
-        readonly home: {
-            readonly widgetIndex: number;
-            readonly widgetId: string | undefined;
-            readonly side: PanelSide;
-        };
-    } | undefined;
-    readonly floatingWidgets: {
-        readonly byId: {
-            readonly [x: string]: {
-                readonly bounds: {
-                    readonly left: number;
-                    readonly top: number;
-                    readonly right: number;
-                    readonly bottom: number;
-                };
-                readonly id: string;
-                readonly home: {
-                    readonly widgetIndex: number;
-                    readonly widgetId: string | undefined;
-                    readonly side: PanelSide;
-                };
-                readonly userSized?: boolean | undefined;
-                readonly hidden?: boolean | undefined;
-            };
-        };
-        readonly allIds: readonly string[];
-    };
-    readonly popoutWidgets: {
-        readonly byId: {
-            readonly [x: string]: {
-                readonly bounds: {
-                    readonly left: number;
-                    readonly top: number;
-                    readonly right: number;
-                    readonly bottom: number;
-                };
-                readonly id: string;
-                readonly home: {
-                    readonly widgetIndex: number;
-                    readonly widgetId: string | undefined;
-                    readonly side: PanelSide;
-                };
-            };
-        };
-        readonly allIds: readonly string[];
-    };
-    readonly panels: {
-        readonly bottom: {
-            readonly span: boolean;
-            readonly side: import("@itwin/appui-layout-react").HorizontalPanelSide;
-            readonly collapseOffset: number;
-            readonly collapsed: boolean;
-            readonly maxSize: number;
-            readonly minSize: number;
-            readonly pinned: boolean;
-            readonly resizable: boolean;
-            readonly size: number | undefined;
-            readonly widgets: readonly string[];
-            readonly maxWidgetCount: number;
-            readonly splitterPercent: number | undefined;
-        };
-        readonly left: {
-            readonly side: import("@itwin/appui-layout-react").VerticalPanelSide;
-            readonly collapseOffset: number;
-            readonly collapsed: boolean;
-            readonly maxSize: number;
-            readonly minSize: number;
-            readonly pinned: boolean;
-            readonly resizable: boolean;
-            readonly size: number | undefined;
-            readonly widgets: readonly string[];
-            readonly maxWidgetCount: number;
-            readonly splitterPercent: number | undefined;
-        };
-        readonly right: {
-            readonly side: import("@itwin/appui-layout-react").VerticalPanelSide;
-            readonly collapseOffset: number;
-            readonly collapsed: boolean;
-            readonly maxSize: number;
-            readonly minSize: number;
-            readonly pinned: boolean;
-            readonly resizable: boolean;
-            readonly size: number | undefined;
-            readonly widgets: readonly string[];
-            readonly maxWidgetCount: number;
-            readonly splitterPercent: number | undefined;
-        };
-        readonly top: {
-            readonly span: boolean;
-            readonly side: import("@itwin/appui-layout-react").HorizontalPanelSide;
-            readonly collapseOffset: number;
-            readonly collapsed: boolean;
-            readonly maxSize: number;
-            readonly minSize: number;
-            readonly pinned: boolean;
-            readonly resizable: boolean;
-            readonly size: number | undefined;
-            readonly widgets: readonly string[];
-            readonly maxWidgetCount: number;
-            readonly splitterPercent: number | undefined;
-        };
-    };
-    readonly tabs: {
-        readonly [x: string]: {
-            readonly id: string;
-            readonly label: string;
-            readonly iconSpec?: boolean | import("react").ReactText | {
-                readonly type: string | import("react").JSXElementConstructor<any>;
-                readonly props: any;
-                readonly key: import("react").Key | null;
-            } | {} | {
-                readonly [Symbol.iterator]: () => Iterator<import("react").ReactNode, any, undefined>;
-            } | {
-                readonly key: import("react").Key | null;
-                readonly children: boolean | import("react").ReactText | {
-                    readonly type: string | import("react").JSXElementConstructor<any>;
-                    readonly props: any;
-                    readonly key: import("react").Key | null;
-                } | {} | {
-                    readonly [Symbol.iterator]: () => Iterator<import("react").ReactNode, any, undefined>;
-                } | any | null | undefined;
-                readonly type: string | import("react").JSXElementConstructor<any>;
-                readonly props: any;
-            } | {
-                readonly stringGetter: () => string;
-                readonly syncEventIds: readonly string[];
-                readonly value: string;
-                readonly refresh: () => boolean;
-            } | null | undefined;
-            readonly preferredFloatingWidgetSize?: {
-                readonly width: number;
-                readonly height: number;
-            } | undefined;
-            readonly preferredPanelWidgetSize?: "fit-content" | undefined;
-            readonly allowedPanelTargets?: readonly PanelSide[] | undefined;
-            readonly canPopout?: boolean | undefined;
-            readonly userSized?: boolean | undefined;
-            readonly isFloatingStateWindowResizable?: boolean | undefined;
-            readonly hideWithUiWhenFloating?: boolean | undefined;
-        };
-    };
-    readonly toolSettings: {
-        readonly type: "docked";
-    } | {
-        readonly type: "widget";
-    };
-    readonly widgets: {
-        readonly [x: string]: {
-            readonly activeTabId: string;
-            readonly id: string;
-            readonly minimized: boolean;
-            readonly tabs: readonly string[];
-            readonly isFloatingStateWindowResizable?: boolean | undefined;
-        };
-    };
-    readonly size: {
-        readonly width: number;
-        readonly height: number;
-    };
-}, side: PanelSide, size: number | undefined) => import("immer/dist/internal").WritableDraft<NineZoneState>;
+/** @packageDocumentation
+ * @module Frontstage
+ */
+/// <reference types="react" />
+import { StagePanelLocation, StagePanelSection, UiEvent } from "@itwin/appui-abstract";
+import { NineZoneState, PanelSide } from "@itwin/appui-layout-react";
+import { WidgetDef } from "../widgets/WidgetDef";
+import { WidgetHost } from "../widgets/WidgetHost";
+import { StagePanelMaxSizeSpec, StagePanelProps, StagePanelZoneProps, StagePanelZonesProps } from "./StagePanel";
+import { ZoneLocation } from "../zones/Zone";
+/** Enum for StagePanel state.
+ * @public
+ */
+export declare enum StagePanelState {
+    Off = 0,
+    Minimized = 1,
+    Open = 2,
+    Popup = 3
+}
+/** Panel State Changed Event Args interface.
+ * @public
+ */
+export interface PanelStateChangedEventArgs {
+    panelDef: StagePanelDef;
+    panelState: StagePanelState;
+}
+/** Panel State Changed Event class.
+ * @beta
+ */
+export declare class PanelStateChangedEvent extends UiEvent<PanelStateChangedEventArgs> {
+}
+/** @internal */
+export interface PanelSizeChangedEventArgs {
+    panelDef: StagePanelDef;
+    size: number | undefined;
+}
+/** @internal */
+export declare class PanelSizeChangedEvent extends UiEvent<PanelSizeChangedEventArgs> {
+}
+/**
+ * A StagePanelDef represents each Stage Panel within a Frontstage.
+ * @public
+ */
+export declare class StagePanelDef extends WidgetHost {
+    private _panelState;
+    private _defaultState;
+    private _maxSizeSpec;
+    private _minSize;
+    private _size;
+    private _defaultSize;
+    private _resizable;
+    private _pinned;
+    private _applicationData?;
+    private _location;
+    private _panelZones;
+    /** Constructor for PanelDef.
+     */
+    constructor();
+    /** @internal */
+    get maxSizeSpec(): StagePanelMaxSizeSpec | undefined;
+    /** @internal */
+    get minSize(): number | undefined;
+    /** Default size of the panel */
+    get size(): number | undefined;
+    set size(size: number | undefined);
+    /** Indicates whether the panel is resizable. */
+    get resizable(): boolean;
+    /** Indicates whether the panel is pinned. */
+    get pinned(): boolean;
+    /** Any application data to attach to this Panel. */
+    get applicationData(): any | undefined;
+    /** Location of panel. */
+    get location(): StagePanelLocation;
+    /** Panel state. Defaults to PanelState.Open. */
+    get panelState(): StagePanelState;
+    set panelState(panelState: StagePanelState);
+    /** @internal */
+    get defaultState(): StagePanelState;
+    /** @internal */
+    get defaultSize(): number | undefined;
+    /** Panel zones.
+     * @internal
+     */
+    get panelZones(): StagePanelZonesDef;
+    /** @internal */
+    initializeFromProps(props?: StagePanelProps, panelLocation?: StagePanelLocation): void;
+    /** Gets the list of Widgets. */
+    get widgetDefs(): ReadonlyArray<WidgetDef>;
+    /** Gets the list of Widgets (w/o StagePanelZone widgets).
+     * @internal
+     */
+    get panelWidgetDefs(): readonly WidgetDef[];
+    /** @internal */
+    updateDynamicWidgetDefs(stageId: string, stageUsage: string, location: ZoneLocation | StagePanelLocation, _section: StagePanelSection | undefined, allStageWidgetDefs: WidgetDef[], frontstageApplicationData?: any): void;
+}
+/** @internal */
+export declare type StagePanelZoneDefKeys = keyof Pick<StagePanelZonesDef, "start" | "end">;
+/** @internal */
+export declare class StagePanelZonesDef {
+    private _start;
+    private _end;
+    get start(): StagePanelZoneDef;
+    get end(): StagePanelZoneDef;
+    /** @internal */
+    initializeFromProps(props: StagePanelZonesProps, panelLocation: StagePanelLocation): void;
+    /** @internal */
+    [Symbol.iterator](): Iterator<[StagePanelZoneDefKeys, StagePanelZoneDef]>;
+}
+/** @internal */
+export declare class StagePanelZoneDef extends WidgetHost {
+    /** @internal */
+    initializeFromProps(props: StagePanelZoneProps, panelLocation: StagePanelLocation, panelZone: StagePanelZoneDefKeys): void;
+}
+/** @internal */
+export declare function toPanelSide(location: StagePanelLocation): PanelSide;
+/** @internal */
+export declare const setPanelSize: (base: {
+    readonly draggedTab: {
+        readonly tabId: string;
+        readonly position: {
+            readonly x: number;
+            readonly y: number;
+        };
+        readonly home: {
+            readonly widgetIndex: number;
+            readonly widgetId: string | undefined;
+            readonly side: PanelSide;
+        };
+    } | undefined;
+    readonly floatingWidgets: {
+        readonly byId: {
+            readonly [x: string]: {
+                readonly bounds: {
+                    readonly left: number;
+                    readonly top: number;
+                    readonly right: number;
+                    readonly bottom: number;
+                };
+                readonly id: string;
+                readonly home: {
+                    readonly widgetIndex: number;
+                    readonly widgetId: string | undefined;
+                    readonly side: PanelSide;
+                };
+                readonly userSized?: boolean | undefined;
+                readonly hidden?: boolean | undefined;
+            };
+        };
+        readonly allIds: readonly string[];
+    };
+    readonly popoutWidgets: {
+        readonly byId: {
+            readonly [x: string]: {
+                readonly bounds: {
+                    readonly left: number;
+                    readonly top: number;
+                    readonly right: number;
+                    readonly bottom: number;
+                };
+                readonly id: string;
+                readonly home: {
+                    readonly widgetIndex: number;
+                    readonly widgetId: string | undefined;
+                    readonly side: PanelSide;
+                };
+            };
+        };
+        readonly allIds: readonly string[];
+    };
+    readonly panels: {
+        readonly bottom: {
+            readonly span: boolean;
+            readonly side: import("@itwin/appui-layout-react").HorizontalPanelSide;
+            readonly collapseOffset: number;
+            readonly collapsed: boolean;
+            readonly maxSize: number;
+            readonly minSize: number;
+            readonly pinned: boolean;
+            readonly resizable: boolean;
+            readonly size: number | undefined;
+            readonly widgets: readonly string[];
+            readonly maxWidgetCount: number;
+            readonly splitterPercent: number | undefined;
+        };
+        readonly left: {
+            readonly side: import("@itwin/appui-layout-react").VerticalPanelSide;
+            readonly collapseOffset: number;
+            readonly collapsed: boolean;
+            readonly maxSize: number;
+            readonly minSize: number;
+            readonly pinned: boolean;
+            readonly resizable: boolean;
+            readonly size: number | undefined;
+            readonly widgets: readonly string[];
+            readonly maxWidgetCount: number;
+            readonly splitterPercent: number | undefined;
+        };
+        readonly right: {
+            readonly side: import("@itwin/appui-layout-react").VerticalPanelSide;
+            readonly collapseOffset: number;
+            readonly collapsed: boolean;
+            readonly maxSize: number;
+            readonly minSize: number;
+            readonly pinned: boolean;
+            readonly resizable: boolean;
+            readonly size: number | undefined;
+            readonly widgets: readonly string[];
+            readonly maxWidgetCount: number;
+            readonly splitterPercent: number | undefined;
+        };
+        readonly top: {
+            readonly span: boolean;
+            readonly side: import("@itwin/appui-layout-react").HorizontalPanelSide;
+            readonly collapseOffset: number;
+            readonly collapsed: boolean;
+            readonly maxSize: number;
+            readonly minSize: number;
+            readonly pinned: boolean;
+            readonly resizable: boolean;
+            readonly size: number | undefined;
+            readonly widgets: readonly string[];
+            readonly maxWidgetCount: number;
+            readonly splitterPercent: number | undefined;
+        };
+    };
+    readonly tabs: {
+        readonly [x: string]: {
+            readonly id: string;
+            readonly label: string;
+            readonly iconSpec?: boolean | import("react").ReactText | {
+                readonly type: string | import("react").JSXElementConstructor<any>;
+                readonly props: any;
+                readonly key: import("react").Key | null;
+            } | {} | {
+                readonly [Symbol.iterator]: () => Iterator<import("react").ReactNode, any, undefined>;
+            } | {
+                readonly key: import("react").Key | null;
+                readonly children: boolean | import("react").ReactText | {
+                    readonly type: string | import("react").JSXElementConstructor<any>;
+                    readonly props: any;
+                    readonly key: import("react").Key | null;
+                } | {} | {
+                    readonly [Symbol.iterator]: () => Iterator<import("react").ReactNode, any, undefined>;
+                } | any | null | undefined;
+                readonly type: string | import("react").JSXElementConstructor<any>;
+                readonly props: any;
+            } | {
+                readonly stringGetter: () => string;
+                readonly syncEventIds: readonly string[];
+                readonly value: string;
+                readonly refresh: () => boolean;
+            } | null | undefined;
+            readonly preferredFloatingWidgetSize?: {
+                readonly width: number;
+                readonly height: number;
+            } | undefined;
+            readonly preferredPanelWidgetSize?: "fit-content" | undefined;
+            readonly allowedPanelTargets?: readonly PanelSide[] | undefined;
+            readonly canPopout?: boolean | undefined;
+            readonly userSized?: boolean | undefined;
+            readonly isFloatingStateWindowResizable?: boolean | undefined;
+            readonly hideWithUiWhenFloating?: boolean | undefined;
+        };
+    };
+    readonly toolSettings: {
+        readonly type: "docked";
+    } | {
+        readonly type: "widget";
+    };
+    readonly widgets: {
+        readonly [x: string]: {
+            readonly activeTabId: string;
+            readonly id: string;
+            readonly minimized: boolean;
+            readonly tabs: readonly string[];
+            readonly isFloatingStateWindowResizable?: boolean | undefined;
+        };
+    };
+    readonly size: {
+        readonly width: number;
+        readonly height: number;
+    };
+}, side: PanelSide, size: number | undefined) => import("immer/dist/internal").WritableDraft<NineZoneState>;
 //# sourceMappingURL=StagePanelDef.d.ts.map