@itwin/appui-react 4.0.0-dev.2 → 4.0.0-dev.4

package/lib/esm/appui-react/frontstage/FrontstageComposer.d.ts

@@ -0,0 +1,147 @@
+/** @packageDocumentation
+ * @module Frontstage
+ */
+import * as React from "react";
+import { PointProps, StagePanelLocation } from "@itwin/appui-abstract";
+import { CommonProps, RectangleProps } from "@itwin/core-react";
+import { NineZoneManagerProps, ResizeHandle, WidgetZoneId, ZoneTargetType } from "@itwin/appui-layout-react";
+import { StagePanelState } from "../stagepanels/StagePanelDef";
+import { WidgetTabs } from "../widgets/WidgetStack";
+import { ZoneDef } from "../zones/ZoneDef";
+import { FrontstageDef } from "./FrontstageDef";
+/** Interface defining callbacks for widget changes
+ * @deprecated in 3.0.
+ * @public
+ */
+export interface WidgetChangeHandler {
+    handleResize(zoneId: WidgetZoneId, resizeBy: number, handle: ResizeHandle, filledHeightDiff: number): void;
+    handleTabClick(widgetId: WidgetZoneId, tabIndex: number): void;
+    handleTabDragStart(widgetId: WidgetZoneId, tabIndex: number, initialPosition: PointProps, widgetBounds: RectangleProps): void;
+    handleTabDragEnd(): void;
+    handleTabDrag(dragged: PointProps): void;
+    handleWidgetStateChange(widgetId: WidgetZoneId, tabIndex: number, isOpening: boolean): void;
+}
+/** Interface defining callbacks for stage panel changes
+ * @deprecated in 3.5. Used in UI1.0 only.
+ * @public
+ */
+export interface StagePanelChangeHandler {
+    /** @alpha */
+    handlePanelInitialize(panelLocation: StagePanelLocation, size: number): void;
+    /** @alpha */
+    handlePanelResize(panelLocation: StagePanelLocation, resizeBy: number): void;
+    /** @alpha */
+    handlePanelPaneTargetChange(panelLocation: StagePanelLocation, paneIndex: number | undefined): void;
+    /** @alpha */
+    handlePanelTargetChange(panelLocation: StagePanelLocation | undefined): void;
+    /** @alpha */
+    handleTogglePanelCollapse(panelLocation: StagePanelLocation): void;
+}
+/** Interface defining callbacks for ZoneDropTarget changes
+ * @deprecated in 3.0.
+ * @public
+ */
+export interface TargetChangeHandler {
+    handleTargetChanged(zoneId: WidgetZoneId, type: ZoneTargetType, isTargeted: boolean): void;
+}
+/** Interface defining callbacks for nine zone changes
+ * @deprecated in 3.5. Used in UI1.0 only.
+ * @public
+ */
+export interface NineZoneChangeHandler {
+    handleFloatingZonesBoundsChange(bounds: RectangleProps): void;
+    handleZonesBoundsChange(bounds: RectangleProps): void;
+}
+/** Interface defining a provider for Zone definitions
+ * @deprecated in 3.5. Used in UI1.0 only.
+ * @public
+ */
+export interface ZoneDefProvider {
+    getZoneDef(zoneId: number): ZoneDef | undefined;
+}
+/** Runtime Props for the Frontstage
+ * @internal
+ */
+export interface FrontstageRuntimeProps {
+    frontstageDef: FrontstageDef;
+    nineZone: NineZoneManagerProps;
+    nineZoneChangeHandler: NineZoneChangeHandler;
+    stagePanelChangeHandler: StagePanelChangeHandler;
+    targetChangeHandler: TargetChangeHandler;
+    widgetChangeHandler: WidgetChangeHandler;
+    widgetTabs: WidgetTabs;
+    zoneDefProvider: ZoneDefProvider;
+}
+/** State for the FrontstageComposer component.
+ * @internal
+ */
+interface FrontstageComposerState {
+    allowPointerUpSelection: boolean;
+    modalFrontstageCount: number;
+    nineZone: NineZoneManagerProps;
+    widgetTabs: WidgetTabs;
+}
+/** FrontstageComposer React component.
+ * @deprecated in 3.0.
+ * @public
+ */
+export declare class FrontstageComposer extends React.Component<CommonProps, FrontstageComposerState> implements WidgetChangeHandler, TargetChangeHandler, ZoneDefProvider, StagePanelChangeHandler, NineZoneChangeHandler {
+    private _frontstageDef;
+    private _isMounted;
+    /** @internal */
+    readonly state: Readonly<FrontstageComposerState>;
+    constructor(props: CommonProps);
+    private determineNineZoneProps;
+    private initializeZoneBounds;
+    private determineWidgetTabs;
+    private _handleFrontstageActivatedEvent;
+    private initializeFrontstageLayout;
+    private _handleModalFrontstageChangedEvent;
+    private _closeModalStage;
+    private renderModalFrontstage;
+    render(): React.ReactNode;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private _handleWindowResize;
+    handleResize: (zoneId: WidgetZoneId, resizeBy: number, handle: ResizeHandle, filledHeightDiff: number) => void;
+    handleTabClick: (widgetId: WidgetZoneId, tabIndex: number) => void;
+    handleTabDragStart: (widgetId: WidgetZoneId, tabIndex: number, initialPosition: PointProps, widgetBounds: RectangleProps) => void;
+    handleTabDragEnd: () => void;
+    handleTabDrag: (dragged: PointProps) => void;
+    handleTargetChanged(zoneId: WidgetZoneId, type: ZoneTargetType, isTargeted: boolean): void;
+    /** @alpha */
+    handlePanelInitialize(panelLocation: StagePanelLocation, size: number): void;
+    /** @alpha */
+    handlePanelResize(panelLocation: StagePanelLocation, resizeBy: number): void;
+    /** @alpha */
+    handlePanelPaneTargetChange(panelLocation: StagePanelLocation, paneIndex: number | undefined): void;
+    /** @alpha */
+    handlePanelTargetChange(panelLocation: StagePanelLocation | undefined): void;
+    /** @alpha */
+    handleTogglePanelCollapse(panelLocation: StagePanelLocation): void;
+    handleFloatingZonesBoundsChange(bounds: RectangleProps): void;
+    handleZonesBoundsChange(bounds: RectangleProps): void;
+    handleWidgetStateChange(widgetId: WidgetZoneId, tabIndex: number, isOpening: boolean): void;
+    getZoneDef(zoneId: number): ZoneDef | undefined;
+    getGhostOutlineBounds(zoneId: WidgetZoneId): RectangleProps | undefined;
+    setZoneAllowsMerging(zoneId: WidgetZoneId, allowsMerging: boolean): void;
+    mergeZones(toMergeId: WidgetZoneId, targetId: WidgetZoneId): void;
+    private layout;
+    private _handleWidgetStateChangedEvent;
+    private _handlePanelStateChangedEvent;
+    private _handlePanelSizeChangedEvent;
+    private _handleToolActivatedEvent;
+    private _handleToolPanelOpenedEvent;
+    private _handlePointerDown;
+    private _handlePointerUp;
+    private setAllowPointerUpSelection;
+    private setPanelState;
+}
+/** @internal */
+export declare const panelStateToIsCollapsed: (panelState: StagePanelState) => boolean;
+/** @internal */
+export declare const isCollapsedToPanelState: (isCollapsed: boolean) => StagePanelState.Minimized | StagePanelState.Open;
+/** @internal */
+export declare const ToolGroupPanelContext: React.Context<boolean>;
+export {};
+//# sourceMappingURL=FrontstageComposer.d.ts.map

package/lib/esm/appui-react/frontstage/FrontstageComposer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrontstageComposer.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/FrontstageComposer.tsx"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAwB,MAAM,uBAAuB,CAAC;AAC7F,OAAO,EAAE,WAAW,EAAa,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC3E,OAAO,EACmE,oBAAoB,EAAE,YAAY,EAC1G,YAAY,EAAiB,cAAc,EAC5C,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAyD,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAGtH,OAAO,EAAa,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAa,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAKhD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAElC,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3G,cAAc,CAAC,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/D,kBAAkB,CAAC,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,YAAY,EAAE,cAAc,GAAG,IAAI,CAAC;IAC9H,gBAAgB,IAAI,IAAI,CAAC;IACzB,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,IAAI,CAAC;IAEzC,uBAAuB,CAAC,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;CAC7F;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,aAAa;IACb,qBAAqB,CAAC,aAAa,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7E,aAAa;IACb,iBAAiB,CAAC,aAAa,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7E,aAAa;IACb,2BAA2B,CAAC,aAAa,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IACpG,aAAa;IACb,uBAAuB,CAAC,aAAa,EAAE,kBAAkB,GAAG,SAAS,GAAG,IAAI,CAAC;IAC7E,aAAa;IACb,yBAAyB,CAAC,aAAa,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACpE;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,mBAAmB,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5F;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,+BAA+B,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;IAC9D,uBAAuB,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,aAAa,EAAE,aAAa,CAAC;IAC7B,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,UAAU,EAAE,UAAU,CAAC;IACvB,eAAe,EAAE,eAAe,CAAC;CAClC;AAED;;GAEG;AACH,UAAU,uBAAuB;IAC/B,uBAAuB,EAAE,OAAO,CAAC;IACjC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,UAAU,EAAE,UAAU,CAAC;CACxB;AAsBD;;;GAGG;AACH,qBAAa,kBAAmB,SAAQ,KAAK,CAAC,SAAS,CAAC,WAAW,EAAE,uBAAuB,CAC1F,YAAW,mBAAmB,EAAE,mBAAmB,EAAE,eAAe,EAAE,uBAAuB,EAAE,qBAAqB;IAEpH,OAAO,CAAC,cAAc,CAA4B;IAClD,OAAO,CAAC,UAAU,CAAS;IAE3B,gBAAgB;IAChB,SAAyB,KAAK,EAAE,QAAQ,CAAC,uBAAuB,CAAC,CAAC;gBAEtD,KAAK,EAAE,WAAW;IAkB9B,OAAO,CAAC,sBAAsB;IA8B9B,OAAO,CAAC,oBAAoB;IAiC5B,OAAO,CAAC,mBAAmB;IAuB3B,OAAO,CAAC,+BAA+B,CAsBrC;IAEF,OAAO,CAAC,0BAA0B;IAwClC,OAAO,CAAC,kCAAkC,CAIxC;IAEF,OAAO,CAAC,gBAAgB,CAEtB;IAEF,OAAO,CAAC,qBAAqB;IAuBb,MAAM,IAAI,KAAK,CAAC,SAAS;IA6CzB,iBAAiB,IAAI,IAAI;IAmBzB,oBAAoB,IAAI,IAAI;IAa5C,OAAO,CAAC,mBAAmB,CAEzB;IAGK,YAAY,WAAY,YAAY,YAAY,MAAM,UAAU,YAAY,oBAAoB,MAAM,UAa3G;IAEK,cAAc,aAAc,YAAY,YAAY,MAAM,UAoC/D;IAIK,kBAAkB,aAAc,YAAY,YAAY,MAAM,mBAAmB,UAAU,gBAAgB,cAAc,UAU9H;IAGK,gBAAgB,aAUrB;IAGK,aAAa,YAAa,UAAU,UAazC;IAGK,mBAAmB,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,OAAO,GAAG,IAAI;IAgBjG,aAAa;IACN,qBAAqB,CAAC,aAAa,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAkBnF,aAAa;IAEN,iBAAiB,CAAC,aAAa,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAyBnF,aAAa;IAEN,2BAA2B,CAAC,aAAa,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAS1G,aAAa;IAEN,uBAAuB,CAAC,aAAa,EAAE,kBAAkB,GAAG,SAAS,GAAG,IAAI;IAQnF,aAAa;IACN,yBAAyB,CAAC,aAAa,EAAE,kBAAkB,GAAG,IAAI;IAclE,+BAA+B,CAAC,MAAM,EAAE,cAAc;IAkBtD,uBAAuB,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI;IAmBrD,uBAAuB,CAAC,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,IAAI;IAmB3F,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAc/C,qBAAqB,CAAC,MAAM,EAAE,YAAY,GAAG,cAAc,GAAG,SAAS;IAKvE,oBAAoB,CAAC,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,OAAO,GAAG,IAAI;IAgBxE,UAAU,CAAC,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,YAAY,GAAG,IAAI;IAkBxE,OAAO,CAAC,MAAM;IAad,OAAO,CAAC,8BAA8B,CAOpC;IAEF,OAAO,CAAC,6BAA6B,CAEnC;IAGF,OAAO,CAAC,4BAA4B,CAElC;IAEF,OAAO,CAAC,yBAAyB,CAe/B;IAGF,OAAO,CAAC,2BAA2B,CAEjC;IAEF,OAAO,CAAC,kBAAkB,CAExB;IAEF,OAAO,CAAC,gBAAgB,CAEtB;IAEF,OAAO,CAAC,0BAA0B;IAelC,OAAO,CAAC,aAAa;CAkBtB;AAED,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,eAAgB,eAAe,YAQlE,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,gBAAiB,OAAO,qDAO3D,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,wBAA6B,CAAC"}