@itwin/appui-react 3.0.0-dev.100

package/lib/esm/appui-react/widgets/ToolWidgetComposer.js

@@ -0,0 +1,65 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+import * as React from "react";
+import widgetIconSvg from "@bentley/icons-generic/icons/home.svg?sprite";
+import { IconSpecUtilities } from "@itwin/appui-abstract";
+import { Icon, useProximityToMouse, useWidgetOpacityContext, WidgetElementSet, WidgetOpacityContext } from "@itwin/core-react";
+import { AppButton, ToolsArea } from "@itwin/appui-layout-react";
+import { BackstageManager } from "../backstage/BackstageManager";
+import { useFrameworkVersion } from "../hooks/useFrameworkVersion";
+import { UiFramework } from "../UiFramework";
+import { UiShowHideManager } from "../utils/UiShowHideManager";
+/**
+ * BackstageAppButton used to toggle display of Backstage.
+ * @public
+ */
+export function BackstageAppButton(props) {
+    const backstageLabel = React.useRef(UiFramework.translate("buttons.openBackstageMenu"));
+    const backstageToggleCommand = BackstageManager.getBackstageToggleCommand(props.icon);
+    const [icon, setIcon] = React.useState(props.icon ? props.icon : IconSpecUtilities.createSvgIconSpec(widgetIconSvg));
+    const isInitialMount = React.useRef(true);
+    const useSmallAppButton = "1" !== useFrameworkVersion();
+    const divClassName = useSmallAppButton ? "uifw-app-button-small" : undefined;
+    const { onElementRef, proximityScale } = useWidgetOpacityContext();
+    const ref = React.useRef(null);
+    React.useEffect(() => {
+        if (isInitialMount.current) {
+            isInitialMount.current = false;
+            onElementRef(ref);
+        }
+        else {
+            setIcon(props.icon ? props.icon : IconSpecUtilities.createSvgIconSpec(widgetIconSvg));
+        }
+    }, [props.icon, onElementRef]);
+    let buttonProximityScale;
+    if ("1" !== useFrameworkVersion() && UiShowHideManager.useProximityOpacity && !UiFramework.isMobile()) {
+        buttonProximityScale = proximityScale;
+    }
+    return (React.createElement("div", { ref: ref, className: divClassName },
+        React.createElement(AppButton, { small: useSmallAppButton, mouseProximity: buttonProximityScale, onClick: backstageToggleCommand.execute, icon: React.createElement(Icon, { iconSpec: icon }), title: backstageToggleCommand.tooltip || backstageLabel.current })));
+}
+/**
+ * ToolWidget component that supports use of ToolbarComposer-based Toolbars. The ToolWidget is shown in the top left of the content area
+ * and typically holds tools to manipulate or interrogate content. The horizontal toolbar often includes context specific tools based on
+ * selected items. The vertical toolbar typically contains a more fixed list of tools.
+ * @public
+ */
+export function ToolWidgetComposer(props) {
+    const { cornerItem, horizontalToolbar, verticalToolbar, ...otherProps } = props;
+    const [elementSet] = React.useState(new WidgetElementSet());
+    const handleChildRef = React.useCallback((elementRef) => {
+        elementSet.add(elementRef);
+    }, [elementSet]);
+    const proximityScale = useProximityToMouse(elementSet, UiShowHideManager.snapWidgetOpacity);
+    return (React.createElement(WidgetOpacityContext.Provider, { value: {
+            onElementRef: handleChildRef,
+            proximityScale,
+        } },
+        React.createElement(ToolsArea, { button: cornerItem, horizontalToolbar: horizontalToolbar, verticalToolbar: verticalToolbar, ...otherProps, onMouseEnter: UiShowHideManager.handleWidgetMouseEnter })));
+}
+//# sourceMappingURL=ToolWidgetComposer.js.map

package/lib/esm/appui-react/widgets/ToolWidgetComposer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolWidgetComposer.js","sourceRoot":"","sources":["../../../../src/appui-react/widgets/ToolWidgetComposer.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,aAAa,MAAM,8CAA8C,CAAC;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAe,IAAI,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC5I,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAU/D;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAA8B;IAC/D,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC,CAAC;IACxF,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,yBAAyB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACtF,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC;IACrH,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,iBAAiB,GAAG,GAAG,KAAK,mBAAmB,EAAE,CAAC;IACxD,MAAM,YAAY,GAAG,iBAAiB,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7E,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,uBAAuB,EAAE,CAAC;IACnE,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAiB,IAAI,CAAC,CAAC;IAE/C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,cAAc,CAAC,OAAO,EAAE;YAC1B,cAAc,CAAC,OAAO,GAAG,KAAK,CAAC;YAC/B,YAAY,CAAC,GAAG,CAAC,CAAC;SACnB;aAAM;YACL,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC;SACvF;IACH,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC;IAE/B,IAAI,oBAAwC,CAAC;IAE7C,IAAI,GAAG,KAAK,mBAAmB,EAAE,IAAI,iBAAiB,CAAC,mBAAmB,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE;QACrG,oBAAoB,GAAG,cAAc,CAAC;KACvC;IAED,OAAO,CACL,6BAAK,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,YAAY;QACpC,oBAAC,SAAS,IACR,KAAK,EAAE,iBAAiB,EACxB,cAAc,EAAE,oBAAoB,EACpC,OAAO,EAAE,sBAAsB,CAAC,OAAO,EACvC,IAAI,EACF,oBAAC,IAAI,IAAC,QAAQ,EAAE,IAAI,GAAI,EAE1B,KAAK,EAAE,sBAAsB,CAAC,OAAO,IAAI,cAAc,CAAC,OAAO,GAC/D,CACE,CACP,CAAC;AACJ,CAAC;AAcD;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAA8B;IAC/D,MAAM,EAAE,UAAU,EAAE,iBAAiB,EAAE,eAAe,EAAE,GAAG,UAAU,EAAE,GAAG,KAAK,CAAC;IAChF,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,gBAAgB,EAAE,CAAC,CAAC;IAC5D,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,UAAoC,EAAE,EAAE;QAChF,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC7B,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IACjB,MAAM,cAAc,GAAG,mBAAmB,CAAC,UAAU,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;IAE5F,OAAO,CACL,oBAAC,oBAAoB,CAAC,QAAQ,IAC5B,KAAK,EAAE;YACL,YAAY,EAAE,cAAc;YAC5B,cAAc;SACf;QAED,oBAAC,SAAS,IACR,MAAM,EAAE,UAAU,EAClB,iBAAiB,EAAE,iBAAiB,EACpC,eAAe,EAAE,eAAe,KAC5B,UAAU,EACd,YAAY,EAAE,iBAAiB,CAAC,sBAAsB,GACtD,CAC4B,CACjC,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Widget\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport widgetIconSvg from \"@bentley/icons-generic/icons/home.svg?sprite\";\r\nimport { IconSpecUtilities } from \"@itwin/appui-abstract\";\r\nimport { CommonProps, Icon, useProximityToMouse, useWidgetOpacityContext, WidgetElementSet, WidgetOpacityContext } from \"@itwin/core-react\";\r\nimport { AppButton, ToolsArea } from \"@itwin/appui-layout-react\";\r\nimport { BackstageManager } from \"../backstage/BackstageManager\";\r\nimport { useFrameworkVersion } from \"../hooks/useFrameworkVersion\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { UiShowHideManager } from \"../utils/UiShowHideManager\";\r\n\r\n/** Properties for the [[BackstageAppButton]] React component\r\n * @public\r\n */\r\nexport interface BackstageAppButtonProps {\r\n  /** Icon specification for the App button */\r\n  icon?: string;\r\n}\r\n\r\n/**\r\n * BackstageAppButton used to toggle display of Backstage.\r\n * @public\r\n */\r\nexport function BackstageAppButton(props: BackstageAppButtonProps) {\r\n  const backstageLabel = React.useRef(UiFramework.translate(\"buttons.openBackstageMenu\"));\r\n  const backstageToggleCommand = BackstageManager.getBackstageToggleCommand(props.icon);\r\n  const [icon, setIcon] = React.useState(props.icon ? props.icon : IconSpecUtilities.createSvgIconSpec(widgetIconSvg));\r\n  const isInitialMount = React.useRef(true);\r\n  const useSmallAppButton = \"1\" !== useFrameworkVersion();\r\n  const divClassName = useSmallAppButton ? \"uifw-app-button-small\" : undefined;\r\n  const { onElementRef, proximityScale } = useWidgetOpacityContext();\r\n  const ref = React.useRef<HTMLDivElement>(null);\r\n\r\n  React.useEffect(() => {\r\n    if (isInitialMount.current) {\r\n      isInitialMount.current = false;\r\n      onElementRef(ref);\r\n    } else {\r\n      setIcon(props.icon ? props.icon : IconSpecUtilities.createSvgIconSpec(widgetIconSvg));\r\n    }\r\n  }, [props.icon, onElementRef]);\r\n\r\n  let buttonProximityScale: number | undefined;\r\n\r\n  if (\"1\" !== useFrameworkVersion() && UiShowHideManager.useProximityOpacity && !UiFramework.isMobile()) {\r\n    buttonProximityScale = proximityScale;\r\n  }\r\n\r\n  return (\r\n    <div ref={ref} className={divClassName}>\r\n      <AppButton\r\n        small={useSmallAppButton}\r\n        mouseProximity={buttonProximityScale}\r\n        onClick={backstageToggleCommand.execute}\r\n        icon={\r\n          <Icon iconSpec={icon} />\r\n        }\r\n        title={backstageToggleCommand.tooltip || backstageLabel.current}\r\n      />\r\n    </div>\r\n  );\r\n}\r\n\r\n/** Properties for the [[ToolbarComposer]] React components\r\n * @public\r\n */\r\nexport interface ToolWidgetComposerProps extends CommonProps {\r\n  /** Optional Corner Item which for most stages is the [[BackstageAppButton]] used to toggle the display of the backstage menu. */\r\n  cornerItem?: React.ReactNode;\r\n  /** Optional Horizontal Toolbar */\r\n  horizontalToolbar?: React.ReactNode;\r\n  /** Optional Vertical Toolbar */\r\n  verticalToolbar?: React.ReactNode;\r\n}\r\n\r\n/**\r\n * ToolWidget component that supports use of ToolbarComposer-based Toolbars. The ToolWidget is shown in the top left of the content area\r\n * and typically holds tools to manipulate or interrogate content. The horizontal toolbar often includes context specific tools based on\r\n * selected items. The vertical toolbar typically contains a more fixed list of tools.\r\n * @public\r\n */\r\nexport function ToolWidgetComposer(props: ToolWidgetComposerProps) {\r\n  const { cornerItem, horizontalToolbar, verticalToolbar, ...otherProps } = props;\r\n  const [elementSet] = React.useState(new WidgetElementSet());\r\n  const handleChildRef = React.useCallback((elementRef: React.RefObject<Element>) => {\r\n    elementSet.add(elementRef);\r\n  }, [elementSet]);\r\n  const proximityScale = useProximityToMouse(elementSet, UiShowHideManager.snapWidgetOpacity);\r\n\r\n  return (\r\n    <WidgetOpacityContext.Provider\r\n      value={{\r\n        onElementRef: handleChildRef,\r\n        proximityScale,\r\n      }}\r\n    >\r\n      <ToolsArea\r\n        button={cornerItem}\r\n        horizontalToolbar={horizontalToolbar}\r\n        verticalToolbar={verticalToolbar}\r\n        {...otherProps}\r\n        onMouseEnter={UiShowHideManager.handleWidgetMouseEnter}\r\n      />\r\n    </WidgetOpacityContext.Provider>\r\n  );\r\n}\r\n"]}

package/lib/esm/appui-react/widgets/ToolbarWidgetBase.d.ts

@@ -0,0 +1,25 @@
+/** @packageDocumentation
+ * @module Widget
+ */
+import * as React from "react";
+import { Direction, ToolbarPanelAlignment } from "@itwin/appui-layout-react";
+import { ItemList } from "../shared/ItemMap";
+import { ToolbarWidgetProps, WidgetDef } from "./WidgetDef";
+/** A Toolbar Widget normally displayed in the top left & top right zones in the 9-Zone Layout system.
+ * @public
+ */
+export declare class ToolbarWidgetDefBase extends WidgetDef {
+    horizontalDirection: Direction;
+    verticalDirection: Direction;
+    horizontalPanelAlignment: ToolbarPanelAlignment;
+    verticalPanelAlignment: ToolbarPanelAlignment;
+    horizontalItems?: ItemList;
+    verticalItems?: ItemList;
+    private _toolbarBaseName;
+    constructor(def: ToolbarWidgetProps);
+    set widgetBaseName(baseName: string);
+    get widgetBaseName(): string;
+    renderHorizontalToolbar(): React.ReactNode;
+    renderVerticalToolbar(): React.ReactNode;
+}
+//# sourceMappingURL=ToolbarWidgetBase.d.ts.map

package/lib/esm/appui-react/widgets/ToolbarWidgetBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarWidgetBase.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widgets/ToolbarWidgetBase.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE5D;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,SAAS;IAC1C,mBAAmB,EAAE,SAAS,CAAC;IAC/B,iBAAiB,EAAE,SAAS,CAAC;IAE7B,wBAAwB,EAAE,qBAAqB,CAAC;IAChD,sBAAsB,EAAE,qBAAqB,CAAC;IAE9C,eAAe,CAAC,EAAE,QAAQ,CAAC;IAC3B,aAAa,CAAC,EAAE,QAAQ,CAAC;IAChC,OAAO,CAAC,gBAAgB,CAAM;gBAElB,GAAG,EAAE,kBAAkB;IAanC,IAAW,cAAc,CAAC,QAAQ,EAAE,MAAM,EAEzC;IACD,IAAW,cAAc,IAHW,MAAM,CAKzC;IAEM,uBAAuB,IAAI,KAAK,CAAC,SAAS;IAiB1C,qBAAqB,IAAI,KAAK,CAAC,SAAS;CAgBhD"}

package/lib/esm/appui-react/widgets/ToolbarWidgetBase.js

@@ -0,0 +1,48 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+import * as React from "react";
+import { Orientation } from "@itwin/core-react";
+import { Direction, ToolbarPanelAlignment } from "@itwin/appui-layout-react";
+import { Toolbar } from "../toolbar/Toolbar";
+import { WidgetDef } from "./WidgetDef";
+/** A Toolbar Widget normally displayed in the top left & top right zones in the 9-Zone Layout system.
+ * @public
+ */
+export class ToolbarWidgetDefBase extends WidgetDef {
+    constructor(def) {
+        super(def);
+        this._toolbarBaseName = "";
+        this.horizontalDirection = (def.horizontalDirection !== undefined) ? def.horizontalDirection : Direction.Bottom;
+        this.verticalDirection = (def.verticalDirection !== undefined) ? def.verticalDirection : Direction.Right;
+        this.horizontalPanelAlignment = ToolbarPanelAlignment.Start;
+        this.verticalPanelAlignment = ToolbarPanelAlignment.Start;
+        this.horizontalItems = def.horizontalItems;
+        this.verticalItems = def.verticalItems;
+    }
+    set widgetBaseName(baseName) {
+        this._toolbarBaseName = baseName;
+    }
+    get widgetBaseName() {
+        return this._toolbarBaseName;
+    }
+    renderHorizontalToolbar() {
+        const toolbarItems = this.horizontalItems;
+        if (toolbarItems && toolbarItems.items.length) {
+            return (React.createElement(Toolbar, { toolbarId: `${this.widgetBaseName}-horizontal`, orientation: Orientation.Horizontal, expandsTo: this.horizontalDirection, panelAlignment: this.horizontalPanelAlignment, items: toolbarItems }));
+        }
+        return null;
+    }
+    renderVerticalToolbar() {
+        const toolbarItems = this.verticalItems;
+        if (toolbarItems && toolbarItems.items.length) {
+            return (React.createElement(Toolbar, { toolbarId: `${this.widgetBaseName}-vertical`, orientation: Orientation.Vertical, expandsTo: this.verticalDirection, panelAlignment: this.verticalPanelAlignment, items: toolbarItems }));
+        }
+        return null;
+    }
+}
+//# sourceMappingURL=ToolbarWidgetBase.js.map

package/lib/esm/appui-react/widgets/ToolbarWidgetBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarWidgetBase.js","sourceRoot":"","sources":["../../../../src/appui-react/widgets/ToolbarWidgetBase.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAE7E,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAsB,SAAS,EAAE,MAAM,aAAa,CAAC;AAE5D;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,SAAS;IAWjD,YAAY,GAAuB;QACjC,KAAK,CAAC,GAAG,CAAC,CAAC;QAHL,qBAAgB,GAAG,EAAE,CAAC;QAK5B,IAAI,CAAC,mBAAmB,GAAG,CAAC,GAAG,CAAC,mBAAmB,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC;QAChH,IAAI,CAAC,iBAAiB,GAAG,CAAC,GAAG,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC;QAEzG,IAAI,CAAC,wBAAwB,GAAG,qBAAqB,CAAC,KAAK,CAAC;QAC5D,IAAI,CAAC,sBAAsB,GAAG,qBAAqB,CAAC,KAAK,CAAC;QAE1D,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC,eAAe,CAAC;QAC3C,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,aAAa,CAAC;IACzC,CAAC;IAED,IAAW,cAAc,CAAC,QAAgB;QACxC,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAC;IACnC,CAAC;IACD,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAEM,uBAAuB;QAC5B,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC;QAC1C,IAAI,YAAY,IAAI,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE;YAC7C,OAAO,CACL,oBAAC,OAAO,IACN,SAAS,EAAE,GAAG,IAAI,CAAC,cAAc,aAAa,EAC9C,WAAW,EAAE,WAAW,CAAC,UAAU,EACnC,SAAS,EAAE,IAAI,CAAC,mBAAmB,EACnC,cAAc,EAAE,IAAI,CAAC,wBAAwB,EAC7C,KAAK,EAAE,YAAY,GACnB,CACH,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,qBAAqB;QAC1B,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,YAAY,IAAI,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE;YAC7C,OAAO,CACL,oBAAC,OAAO,IACN,SAAS,EAAE,GAAG,IAAI,CAAC,cAAc,WAAW,EAC5C,WAAW,EAAE,WAAW,CAAC,QAAQ,EACjC,SAAS,EAAE,IAAI,CAAC,iBAAiB,EACjC,cAAc,EAAE,IAAI,CAAC,sBAAsB,EAC3C,KAAK,EAAE,YAAY,GACnB,CACH,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Widget\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { Orientation } from \"@itwin/core-react\";\r\nimport { Direction, ToolbarPanelAlignment } from \"@itwin/appui-layout-react\";\r\nimport { ItemList } from \"../shared/ItemMap\";\r\nimport { Toolbar } from \"../toolbar/Toolbar\";\r\nimport { ToolbarWidgetProps, WidgetDef } from \"./WidgetDef\";\r\n\r\n/** A Toolbar Widget normally displayed in the top left & top right zones in the 9-Zone Layout system.\r\n * @public\r\n */\r\nexport class ToolbarWidgetDefBase extends WidgetDef {\r\n  public horizontalDirection: Direction;\r\n  public verticalDirection: Direction;\r\n\r\n  public horizontalPanelAlignment: ToolbarPanelAlignment;\r\n  public verticalPanelAlignment: ToolbarPanelAlignment;\r\n\r\n  public horizontalItems?: ItemList;\r\n  public verticalItems?: ItemList;\r\n  private _toolbarBaseName = \"\";\r\n\r\n  constructor(def: ToolbarWidgetProps) {\r\n    super(def);\r\n\r\n    this.horizontalDirection = (def.horizontalDirection !== undefined) ? def.horizontalDirection : Direction.Bottom;\r\n    this.verticalDirection = (def.verticalDirection !== undefined) ? def.verticalDirection : Direction.Right;\r\n\r\n    this.horizontalPanelAlignment = ToolbarPanelAlignment.Start;\r\n    this.verticalPanelAlignment = ToolbarPanelAlignment.Start;\r\n\r\n    this.horizontalItems = def.horizontalItems;\r\n    this.verticalItems = def.verticalItems;\r\n  }\r\n\r\n  public set widgetBaseName(baseName: string) {\r\n    this._toolbarBaseName = baseName;\r\n  }\r\n  public get widgetBaseName() {\r\n    return this._toolbarBaseName;\r\n  }\r\n\r\n  public renderHorizontalToolbar(): React.ReactNode {\r\n    const toolbarItems = this.horizontalItems;\r\n    if (toolbarItems && toolbarItems.items.length) {\r\n      return (\r\n        <Toolbar\r\n          toolbarId={`${this.widgetBaseName}-horizontal`}\r\n          orientation={Orientation.Horizontal}\r\n          expandsTo={this.horizontalDirection}\r\n          panelAlignment={this.horizontalPanelAlignment}\r\n          items={toolbarItems}\r\n        />\r\n      );\r\n    }\r\n\r\n    return null;\r\n  }\r\n\r\n  public renderVerticalToolbar(): React.ReactNode {\r\n    const toolbarItems = this.verticalItems;\r\n    if (toolbarItems && toolbarItems.items.length) {\r\n      return (\r\n        <Toolbar\r\n          toolbarId={`${this.widgetBaseName}-vertical`}\r\n          orientation={Orientation.Vertical}\r\n          expandsTo={this.verticalDirection}\r\n          panelAlignment={this.verticalPanelAlignment}\r\n          items={toolbarItems}\r\n        />\r\n      );\r\n    }\r\n\r\n    return null;\r\n  }\r\n}\r\n"]}

package/lib/esm/appui-react/widgets/ViewToolWidgetComposer.d.ts

@@ -0,0 +1,28 @@
+/** @packageDocumentation
+ * @module Widget
+ */
+/// <reference types="react" />
+/**
+ * Props for [[ViewToolWidgetComposer]].
+ * @public
+ */
+export interface ViewToolWidgetComposerProps {
+    /** If true no navigation aid will be shown. Defaults to false. */
+    hideNavigationAid?: boolean;
+}
+/**
+ * ViewToolWidgetComposer composes a Navigation Widget with no tools defined by default. UiItemsProviders
+ * must be used to provide tools to populate the toolbars. See [[StandardNavigationToolsProvider]].
+ *  @example
+ * ```
+ * <ViewToolWidgetComposer />
+ * ```
+ * If no NavigationAid control is to be shown set hideNavigationAid.
+ *  * ```
+ * <ViewToolWidgetComposer hideNavigationAid />
+ * ```
+
+ * @public
+ */
+export declare function ViewToolWidgetComposer(props: ViewToolWidgetComposerProps): JSX.Element;
+//# sourceMappingURL=ViewToolWidgetComposer.d.ts.map

package/lib/esm/appui-react/widgets/ViewToolWidgetComposer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ViewToolWidgetComposer.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widgets/ViewToolWidgetComposer.tsx"],"names":[],"mappings":"AAIA;;GAEG;;AASH;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,kEAAkE;IAClE,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,2BAA2B,eAYxE"}

package/lib/esm/appui-react/widgets/ViewToolWidgetComposer.js

@@ -0,0 +1,33 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+import classnames from "classnames";
+import * as React from "react";
+import { ToolbarOrientation, ToolbarUsage } from "@itwin/appui-abstract";
+import { ToolbarComposer } from "../toolbar/ToolbarComposer";
+import { useUiVisibility } from "./BasicToolWidget";
+import { NavigationWidgetComposer } from "./NavigationWidgetComposer";
+/**
+ * ViewToolWidgetComposer composes a Navigation Widget with no tools defined by default. UiItemsProviders
+ * must be used to provide tools to populate the toolbars. See [[StandardNavigationToolsProvider]].
+ *  @example
+ * ```
+ * <ViewToolWidgetComposer />
+ * ```
+ * If no NavigationAid control is to be shown set hideNavigationAid.
+ *  * ```
+ * <ViewToolWidgetComposer hideNavigationAid />
+ * ```
+
+ * @public
+ */
+export function ViewToolWidgetComposer(props) {
+    const uiIsVisible = useUiVisibility();
+    const className = classnames(!uiIsVisible && "nz-hidden");
+    return (React.createElement(NavigationWidgetComposer, { className: className, hideNavigationAid: props.hideNavigationAid, horizontalToolbar: React.createElement(ToolbarComposer, { items: [], usage: ToolbarUsage.ViewNavigation, orientation: ToolbarOrientation.Horizontal }), verticalToolbar: React.createElement(ToolbarComposer, { items: [], usage: ToolbarUsage.ViewNavigation, orientation: ToolbarOrientation.Vertical }) }));
+}
+//# sourceMappingURL=ViewToolWidgetComposer.js.map

package/lib/esm/appui-react/widgets/ViewToolWidgetComposer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ViewToolWidgetComposer.js","sourceRoot":"","sources":["../../../../src/appui-react/widgets/ViewToolWidgetComposer.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAWtE;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAAkC;IACvE,MAAM,WAAW,GAAG,eAAe,EAAE,CAAC;IACtC,MAAM,SAAS,GAAG,UAAU,CAC1B,CAAC,WAAW,IAAI,WAAW,CAC5B,CAAC;IAEF,OAAO,CACL,oBAAC,wBAAwB,IAAC,SAAS,EAAE,SAAS,EAAE,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,EACxF,iBAAiB,EAAE,oBAAC,eAAe,IAAC,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,YAAY,CAAC,cAAc,EAAE,WAAW,EAAE,kBAAkB,CAAC,UAAU,GAAI,EACjI,eAAe,EAAE,oBAAC,eAAe,IAAC,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,YAAY,CAAC,cAAc,EAAE,WAAW,EAAE,kBAAkB,CAAC,QAAQ,GAAI,GAC7H,CACH,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Widget\r\n */\r\n\r\nimport classnames from \"classnames\";\r\nimport * as React from \"react\";\r\nimport { ToolbarOrientation, ToolbarUsage } from \"@itwin/appui-abstract\";\r\nimport { ToolbarComposer } from \"../toolbar/ToolbarComposer\";\r\nimport { useUiVisibility } from \"./BasicToolWidget\";\r\nimport { NavigationWidgetComposer } from \"./NavigationWidgetComposer\";\r\n\r\n/**\r\n * Props for [[ViewToolWidgetComposer]].\r\n * @public\r\n */\r\nexport interface ViewToolWidgetComposerProps {\r\n  /** If true no navigation aid will be shown. Defaults to false. */\r\n  hideNavigationAid?: boolean;\r\n}\r\n\r\n/**\r\n * ViewToolWidgetComposer composes a Navigation Widget with no tools defined by default. UiItemsProviders\r\n * must be used to provide tools to populate the toolbars. See [[StandardNavigationToolsProvider]].\r\n *  @example\r\n * ```\r\n * <ViewToolWidgetComposer />\r\n * ```\r\n * If no NavigationAid control is to be shown set hideNavigationAid.\r\n *  * ```\r\n * <ViewToolWidgetComposer hideNavigationAid />\r\n * ```\r\n\r\n * @public\r\n */\r\nexport function ViewToolWidgetComposer(props: ViewToolWidgetComposerProps) {\r\n  const uiIsVisible = useUiVisibility();\r\n  const className = classnames(\r\n    !uiIsVisible && \"nz-hidden\",\r\n  );\r\n\r\n  return (\r\n    <NavigationWidgetComposer className={className} hideNavigationAid={props.hideNavigationAid}\r\n      horizontalToolbar={<ToolbarComposer items={[]} usage={ToolbarUsage.ViewNavigation} orientation={ToolbarOrientation.Horizontal} />}\r\n      verticalToolbar={<ToolbarComposer items={[]} usage={ToolbarUsage.ViewNavigation} orientation={ToolbarOrientation.Vertical} />}\r\n    />\r\n  );\r\n}\r\n"]}

package/lib/esm/appui-react/widgets/Widget.d.ts

@@ -0,0 +1,14 @@
+/** @packageDocumentation
+ * @module Widget
+ */
+import * as React from "react";
+import { WidgetProps } from "./WidgetProps";
+/** Widget React component.
+ * A Widget is a collection of UI components tied to a particular Zone that allows the user to view and/or modify data relevant to their current context.
+ * @public
+ */
+export declare class Widget extends React.Component<WidgetProps> {
+    constructor(props: WidgetProps);
+    render(): null;
+}
+//# sourceMappingURL=Widget.d.ts.map

package/lib/esm/appui-react/widgets/Widget.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Widget.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widgets/Widget.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;GAGG;AACH,qBAAa,MAAO,SAAQ,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC;gBAE1C,KAAK,EAAE,WAAW;IAId,MAAM;CAIvB"}

package/lib/esm/appui-react/widgets/Widget.js

@@ -0,0 +1,21 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+import * as React from "react";
+/** Widget React component.
+ * A Widget is a collection of UI components tied to a particular Zone that allows the user to view and/or modify data relevant to their current context.
+ * @public
+ */
+export class Widget extends React.Component {
+    constructor(props) {
+        super(props);
+    }
+    render() {
+        return null;
+    }
+}
+//# sourceMappingURL=Widget.js.map

package/lib/esm/appui-react/widgets/Widget.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Widget.js","sourceRoot":"","sources":["../../../../src/appui-react/widgets/Widget.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B;;;GAGG;AACH,MAAM,OAAO,MAAO,SAAQ,KAAK,CAAC,SAAsB;IAEtD,YAAY,KAAkB;QAC5B,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAEe,MAAM;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;CAEF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Widget\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { WidgetProps } from \"./WidgetProps\";\r\n\r\n/** Widget React component.\r\n * A Widget is a collection of UI components tied to a particular Zone that allows the user to view and/or modify data relevant to their current context.\r\n * @public\r\n */\r\nexport class Widget extends React.Component<WidgetProps> {\r\n\r\n  constructor(props: WidgetProps) {\r\n    super(props);\r\n  }\r\n\r\n  public override render() {\r\n    return null;\r\n  }\r\n\r\n}\r\n"]}

package/lib/esm/appui-react/widgets/WidgetControl.d.ts

@@ -0,0 +1,34 @@
+/** @packageDocumentation
+ * @module Widget
+ */
+import * as React from "react";
+import { WidgetState } from "@itwin/appui-abstract";
+import { ConfigurableCreateInfo, ConfigurableUiControl, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl";
+import { WidgetDef } from "./WidgetDef";
+/** The base class for Widget controls.
+ * @public
+ */
+export declare class WidgetControl extends ConfigurableUiControl {
+    private _widgetDef;
+    private _reactNode;
+    constructor(info: ConfigurableCreateInfo, options: any);
+    /** The ReactNode associated with this control */
+    get reactNode(): React.ReactNode;
+    set reactNode(r: React.ReactNode);
+    /** The [[WidgetDef]] associated with this control */
+    get widgetDef(): WidgetDef;
+    set widgetDef(w: WidgetDef);
+    /** Gets the type of ConfigurableUiControl, which is 'Widget' in this case */
+    getType(): ConfigurableUiControlType;
+    /** Sets the [[WidgetState]] for this control */
+    setWidgetState(state: WidgetState): void;
+    /** Called when widget state changes. */
+    onWidgetStateChanged(): void;
+    /** Overwrite to save transient DOM state (i.e. scroll offset). */
+    saveTransientState(): void;
+    /** Overwrite to restore transient DOM state.
+     * @note Return true if the state is restored or the Widget will remount.
+     */
+    restoreTransientState(): boolean;
+}
+//# sourceMappingURL=WidgetControl.d.ts.map

package/lib/esm/appui-react/widgets/WidgetControl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WidgetControl.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widgets/WidgetControl.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AACnI,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;GAEG;AACH,qBAAa,aAAc,SAAQ,qBAAqB;IACtD,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,UAAU,CAAkB;gBAExB,IAAI,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG;IAItD,iDAAiD;IACjD,IAAW,SAAS,IAAI,KAAK,CAAC,SAAS,CAA4B;IACnE,IAAW,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,EAA0B;IAEjE,qDAAqD;IACrD,IAAW,SAAS,IAAI,SAAS,CAA4B;IAC7D,IAAW,SAAS,CAAC,CAAC,EAAE,SAAS,EAA0B;IAE3D,6EAA6E;IACtE,OAAO,IAAI,yBAAyB;IAE3C,gDAAgD;IACzC,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAI/C,wCAAwC;IACjC,oBAAoB,IAAI,IAAI;IAGnC,kEAAkE;IAC3D,kBAAkB,IAAI,IAAI;IAGjC;;OAEG;IACI,qBAAqB,IAAI,OAAO;CAGxC"}

package/lib/esm/appui-react/widgets/WidgetControl.js

@@ -0,0 +1,41 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+import { ConfigurableUiControl, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl";
+/** The base class for Widget controls.
+ * @public
+ */
+export class WidgetControl extends ConfigurableUiControl {
+    constructor(info, options) {
+        super(info, options);
+    }
+    /** The ReactNode associated with this control */
+    get reactNode() { return this._reactNode; }
+    set reactNode(r) { this._reactNode = r; }
+    /** The [[WidgetDef]] associated with this control */
+    get widgetDef() { return this._widgetDef; }
+    set widgetDef(w) { this._widgetDef = w; }
+    /** Gets the type of ConfigurableUiControl, which is 'Widget' in this case */
+    getType() { return ConfigurableUiControlType.Widget; }
+    /** Sets the [[WidgetState]] for this control */
+    setWidgetState(state) {
+        this.widgetDef.setWidgetState(state);
+    }
+    /** Called when widget state changes. */
+    onWidgetStateChanged() {
+    }
+    /** Overwrite to save transient DOM state (i.e. scroll offset). */
+    saveTransientState() {
+    }
+    /** Overwrite to restore transient DOM state.
+     * @note Return true if the state is restored or the Widget will remount.
+     */
+    restoreTransientState() {
+        return false;
+    }
+}
+//# sourceMappingURL=WidgetControl.js.map

package/lib/esm/appui-react/widgets/WidgetControl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WidgetControl.js","sourceRoot":"","sources":["../../../../src/appui-react/widgets/WidgetControl.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH,OAAO,EAA0B,qBAAqB,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AAGnI;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,qBAAqB;IAItD,YAAY,IAA4B,EAAE,OAAY;QACpD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACvB,CAAC;IAED,iDAAiD;IACjD,IAAW,SAAS,KAAsB,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACnE,IAAW,SAAS,CAAC,CAAkB,IAAI,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC;IAEjE,qDAAqD;IACrD,IAAW,SAAS,KAAgB,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAC7D,IAAW,SAAS,CAAC,CAAY,IAAI,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC;IAE3D,6EAA6E;IACtE,OAAO,KAAgC,OAAO,yBAAyB,CAAC,MAAM,CAAC,CAAC,CAAC;IAExF,gDAAgD;IACzC,cAAc,CAAC,KAAkB;QACtC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;IAED,wCAAwC;IACjC,oBAAoB;IAC3B,CAAC;IAED,kEAAkE;IAC3D,kBAAkB;IACzB,CAAC;IAED;;OAEG;IACI,qBAAqB;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Widget\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { WidgetState } from \"@itwin/appui-abstract\";\r\nimport { ConfigurableCreateInfo, ConfigurableUiControl, ConfigurableUiControlType } from \"../configurableui/ConfigurableUiControl\";\r\nimport { WidgetDef } from \"./WidgetDef\";\r\n\r\n/** The base class for Widget controls.\r\n * @public\r\n */\r\nexport class WidgetControl extends ConfigurableUiControl {\r\n  private _widgetDef!: WidgetDef;\r\n  private _reactNode: React.ReactNode;\r\n\r\n  constructor(info: ConfigurableCreateInfo, options: any) {\r\n    super(info, options);\r\n  }\r\n\r\n  /** The ReactNode associated with this control */\r\n  public get reactNode(): React.ReactNode { return this._reactNode; }\r\n  public set reactNode(r: React.ReactNode) { this._reactNode = r; }\r\n\r\n  /** The [[WidgetDef]] associated with this control */\r\n  public get widgetDef(): WidgetDef { return this._widgetDef; }\r\n  public set widgetDef(w: WidgetDef) { this._widgetDef = w; }\r\n\r\n  /** Gets the type of ConfigurableUiControl, which is 'Widget' in this case */\r\n  public getType(): ConfigurableUiControlType { return ConfigurableUiControlType.Widget; }\r\n\r\n  /** Sets the [[WidgetState]] for this control */\r\n  public setWidgetState(state: WidgetState): void {\r\n    this.widgetDef.setWidgetState(state);\r\n  }\r\n\r\n  /** Called when widget state changes. */\r\n  public onWidgetStateChanged(): void {\r\n  }\r\n\r\n  /** Overwrite to save transient DOM state (i.e. scroll offset). */\r\n  public saveTransientState(): void {\r\n  }\r\n\r\n  /** Overwrite to restore transient DOM state.\r\n   * @note Return true if the state is restored or the Widget will remount.\r\n   */\r\n  public restoreTransientState(): boolean {\r\n    return false;\r\n  }\r\n}\r\n"]}

package/lib/esm/appui-react/widgets/WidgetDef.d.ts

@@ -0,0 +1,191 @@
+/** @packageDocumentation
+ * @module Widget
+ */
+import * as React from "react";
+import { AbstractWidgetProps, BadgeType, ConditionalStringValue, PointProps, StringGetter, WidgetState } from "@itwin/appui-abstract";
+import { UiEvent } from "@itwin/core-react";
+import { Direction, PanelSide } from "@itwin/appui-layout-react";
+import { ConfigurableUiControlConstructor, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl";
+import { CommandItemDef } from "../shared/CommandItemDef";
+import { ItemList } from "../shared/ItemMap";
+import { WidgetControl } from "./WidgetControl";
+import { WidgetProps } from "./WidgetProps";
+/** Widget State Changed Event Args interface.
+ * @public
+ */
+export interface WidgetStateChangedEventArgs {
+    widgetDef: WidgetDef;
+    widgetState: WidgetState;
+}
+/** Widget State Changed Event class.
+ * @public
+ */
+export declare class WidgetStateChangedEvent extends UiEvent<WidgetStateChangedEventArgs> {
+}
+/** @internal */
+export interface WidgetChangedEventArgs {
+    widgetDef: WidgetDef;
+}
+/** @internal */
+export interface WidgetEventArgs {
+    widgetDef: WidgetDef;
+}
+/** Widget type enum.
+ * @public
+ */
+export declare enum WidgetType {
+    Tool = 0,
+    Navigation = 1,
+    FreeFrom = 2,
+    Rectangular = 3,
+    ToolSettings = 4,
+    StatusBar = 5
+}
+/** Properties for a Toolbar Widget.
+ * @public
+ */
+export interface ToolbarWidgetProps extends WidgetProps {
+    horizontalDirection?: Direction;
+    verticalDirection?: Direction;
+    horizontalItems?: ItemList;
+    verticalItems?: ItemList;
+}
+/** Properties for a Tool Widget.
+ * @public
+ */
+export interface ToolWidgetProps extends ToolbarWidgetProps {
+    appButton?: CommandItemDef;
+}
+/** Properties for a Navigation Widget.
+ * @public
+ */
+export interface NavigationWidgetProps extends ToolbarWidgetProps {
+    navigationAidId?: string;
+}
+/** Union of all Widget properties.
+ * @public
+ */
+export declare type AnyWidgetProps = WidgetProps | ToolWidgetProps | NavigationWidgetProps;
+/** Prototype for WidgetDef StateFunc
+ * @public
+ */
+export declare type WidgetStateFunc = (state: Readonly<WidgetState>) => WidgetState;
+/** @internal */
+export interface TabLocation {
+    widgetId: string;
+    widgetIndex: number;
+    side: PanelSide;
+    tabIndex: number;
+}
+/** A Widget Definition in the 9-Zone Layout system.
+ * @public
+ */
+export declare class WidgetDef {
+    private static _sId;
+    private _label;
+    private _tooltip;
+    private _widgetReactNode;
+    private _widgetControl;
+    private _defaultState;
+    private _state;
+    private _id;
+    private _classId;
+    private _priority;
+    private _isFreeform;
+    private _isFloatingStateSupported;
+    private _isFloatingStateWindowResizable;
+    private _isToolSettings;
+    private _isStatusBar;
+    private _stateChanged;
+    private _fillZone;
+    private _syncEventIds;
+    private _stateFunc?;
+    private _widgetType;
+    private _applicationData?;
+    private _iconSpec?;
+    private _badgeType?;
+    private _onWidgetStateChanged?;
+    private _saveTransientState?;
+    private _restoreTransientState?;
+    private _preferredPanelSize;
+    private _canPopout?;
+    private _floatingContainerId?;
+    private _defaultFloatingPosition;
+    private _tabLocation;
+    get state(): WidgetState;
+    get id(): string;
+    get classId(): string | ConfigurableUiControlConstructor | undefined;
+    get priority(): number;
+    get isFreeform(): boolean;
+    get isFloatingStateSupported(): boolean;
+    get isFloatingStateWindowResizable(): boolean;
+    get isToolSettings(): boolean;
+    get isStatusBar(): boolean;
+    get stateChanged(): boolean;
+    get fillZone(): boolean;
+    get syncEventIds(): string[];
+    get stateFunc(): WidgetStateFunc | undefined;
+    get applicationData(): any | undefined;
+    get isFloating(): boolean;
+    get iconSpec(): string | ConditionalStringValue | React.ReactNode;
+    get badgeType(): BadgeType | undefined;
+    get widgetType(): WidgetType;
+    set widgetType(type: WidgetType);
+    /** @internal */
+    get tabLocation(): TabLocation;
+    set tabLocation(tabLocation: TabLocation);
+    /** @internal */
+    get defaultFloatingPosition(): PointProps | undefined;
+    set defaultFloatingPosition(position: PointProps | undefined);
+    /** @internal */
+    get defaultState(): WidgetState;
+    constructor(widgetProps: WidgetProps);
+    static initializeFromWidgetProps(widgetProps: WidgetProps, me: WidgetDef): void;
+    static createWidgetPropsFromAbstractProps(abstractWidgetProps: AbstractWidgetProps): WidgetProps;
+    setUpSyncSupport(props: WidgetProps): void;
+    private _handleSyncUiEvent;
+    /** @alpha */
+    get preferredPanelSize(): "fit-content" | undefined;
+    /** Get the label string */
+    get label(): string;
+    /** Set the label.
+     * @param v A string or a function to get the string.
+     */
+    setLabel(v: string | ConditionalStringValue | StringGetter): void;
+    /** Get the tooltip string */
+    get tooltip(): string;
+    /** Set the tooltip.
+     * @param v A string or a function to get the string.
+     */
+    setTooltip(v: string | ConditionalStringValue | StringGetter): void;
+    get widgetControl(): WidgetControl | undefined;
+    getWidgetControl(type: ConfigurableUiControlType): WidgetControl | undefined;
+    get reactNode(): React.ReactNode;
+    set reactNode(node: React.ReactNode);
+    setWidgetState(newState: WidgetState): void;
+    setCanPopout(value: boolean | undefined): void;
+    get canPopout(): boolean | undefined;
+    setFloatingContainerId(value: string | undefined): void;
+    get floatingContainerId(): string | undefined;
+    canOpen(): boolean;
+    get isVisible(): boolean;
+    get activeState(): WidgetState;
+    get isActive(): boolean;
+    onWidgetStateChanged(): void;
+    /** Overwrite to save transient DOM state (i.e. scroll offset). */
+    saveTransientState(): void;
+    /** Overwrite to restore transient DOM state.
+     * @note Return true if the state is restored or the Widget will remount.
+     */
+    restoreTransientState(): boolean;
+    /** Opens the widget and makes it visible to the user.
+     * I.e. opens the stage panel or brings the floating widget to front of the screen.
+     * @alpha
+     */
+    show(): void;
+    /** Opens the widget and expands it to fill full size of the stage panel.
+     * @alpha
+     */
+    expand(): void;
+}
+//# sourceMappingURL=WidgetDef.d.ts.map

package/lib/esm/appui-react/widgets/WidgetDef.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WidgetDef.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widgets/WidgetDef.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,sBAAsB,EAAE,UAAU,EAAE,YAAY,EAAW,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC/I,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAA0B,gCAAgC,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AAG9I,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAI7C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAW5C;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,OAAO,CAAC,2BAA2B,CAAC;CAAI;AAErF,gBAAgB;AAChB,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,gBAAgB;AAChB,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,SAAS,CAAC;CACtB;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,IAAI,IAAA;IACJ,UAAU,IAAA;IACV,QAAQ,IAAA;IACR,WAAW,IAAA;IACX,YAAY,IAAA;IACZ,SAAS,IAAA;CACV;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,mBAAmB,CAAC,EAAE,SAAS,CAAC;IAChC,iBAAiB,CAAC,EAAE,SAAS,CAAC;IAE9B,eAAe,CAAC,EAAE,QAAQ,CAAC;IAC3B,aAAa,CAAC,EAAE,QAAQ,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;IACzD,SAAS,CAAC,EAAE,cAAc,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAC/D,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,oBAAY,cAAc,GAAG,WAAW,GAAG,eAAe,GAAG,qBAAqB,CAAC;AAEnF;;GAEG;AACH,oBAAY,eAAe,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,WAAW,CAAC;AAE5E,gBAAgB;AAChB,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAID;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAK;IACxB,OAAO,CAAC,MAAM,CAAsD;IACpE,OAAO,CAAC,QAAQ,CAAsD;IACtE,OAAO,CAAC,gBAAgB,CAAkB;IAC1C,OAAO,CAAC,cAAc,CAAiB;IACvC,OAAO,CAAC,aAAa,CAAqC;IAC1D,OAAO,CAAC,MAAM,CAAqC;IACnD,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,QAAQ,CAAoE;IACpF,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,yBAAyB,CAAkB;IACnD,OAAO,CAAC,+BAA+B,CAAiB;IACxD,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,YAAY,CAAkB;IACtC,OAAO,CAAC,aAAa,CAAkB;IACvC,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,UAAU,CAAC,CAAkB;IACrC,OAAO,CAAC,WAAW,CAAsC;IACzD,OAAO,CAAC,gBAAgB,CAAC,CAAM;IAC/B,OAAO,CAAC,SAAS,CAAC,CAAoD;IACtE,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,OAAO,CAAC,qBAAqB,CAAC,CAAa;IAC3C,OAAO,CAAC,mBAAmB,CAAC,CAAa;IACzC,OAAO,CAAC,sBAAsB,CAAC,CAAgB;IAC/C,OAAO,CAAC,mBAAmB,CAA4B;IACvD,OAAO,CAAC,UAAU,CAAC,CAAU;IAC7B,OAAO,CAAC,oBAAoB,CAAC,CAAS;IACtC,OAAO,CAAC,wBAAwB,CAAyB;IAEzD,OAAO,CAAC,YAAY,CAKlB;IAEF,IAAW,KAAK,IAAI,WAAW,CAAwB;IACvD,IAAW,EAAE,IAAI,MAAM,CAAqB;IAC5C,IAAW,OAAO,IAAI,MAAM,GAAG,gCAAgC,GAAG,SAAS,CAA0B;IACrG,IAAW,QAAQ,IAAI,MAAM,CAA2B;IACxD,IAAW,UAAU,IAAI,OAAO,CAA6B;IAC7D,IAAW,wBAAwB,IAAI,OAAO,CAA2C;IACzF,IAAW,8BAA8B,IAAI,OAAO,CAAiD;IACrG,IAAW,cAAc,IAAI,OAAO,CAAiC;IACrE,IAAW,WAAW,IAAI,OAAO,CAA8B;IAC/D,IAAW,YAAY,IAAI,OAAO,CAA+B;IACjE,IAAW,QAAQ,IAAI,OAAO,CAA2B;IACzD,IAAW,YAAY,IAAI,MAAM,EAAE,CAA+B;IAClE,IAAW,SAAS,IAAI,eAAe,GAAG,SAAS,CAA4B;IAC/E,IAAW,eAAe,IAAI,GAAG,GAAG,SAAS,CAAkC;IAC/E,IAAW,UAAU,IAAI,OAAO,CAAiD;IACjF,IAAW,QAAQ,IAAI,MAAM,GAAG,sBAAsB,GAAG,KAAK,CAAC,SAAS,CAA2B;IACnG,IAAW,SAAS,IAAI,SAAS,GAAG,SAAS,CAA4B;IAEzE,IAAW,UAAU,IAAI,UAAU,CAA6B;IAChE,IAAW,UAAU,CAAC,IAAI,EAAE,UAAU,EAA8B;IAEpE,gBAAgB;IAChB,IAAW,WAAW,IACc,WAAW,CADO;IACtD,IAAW,WAAW,CAAC,WAAW,EAAE,WAAW,EAAsC;IAErF,gBAAgB;IAChB,IAAW,uBAAuB,IACW,UAAU,GAAG,SAAS,CADW;IAC9E,IAAW,uBAAuB,CAAC,QAAQ,EAAE,UAAU,GAAG,SAAS,EAA+C;IAElH,gBAAgB;IAChB,IAAW,YAAY,gBAAiC;gBAE5C,WAAW,EAAE,WAAW;WAWtB,yBAAyB,CAAC,WAAW,EAAE,WAAW,EAAE,EAAE,EAAE,SAAS;WAmEjE,kCAAkC,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,WAAW;IAMhG,gBAAgB,CAAC,KAAK,EAAE,WAAW;IAQ1C,OAAO,CAAC,kBAAkB,CASxB;IAEF,aAAa;IACb,IAAW,kBAAkB,8BAE5B;IAED,2BAA2B;IAC3B,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED;;OAEG;IACI,QAAQ,CAAC,CAAC,EAAE,MAAM,GAAG,sBAAsB,GAAG,YAAY;IAOjE,6BAA6B;IAC7B,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED;;OAEG;IACI,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,sBAAsB,GAAG,YAAY;IAInE,IAAW,aAAa,IAAI,aAAa,GAAG,SAAS,CAEpD;IAEM,gBAAgB,CAAC,IAAI,EAAE,yBAAyB,GAAG,aAAa,GAAG,SAAS;IAqCnF,IAAW,SAAS,IAAI,KAAK,CAAC,SAAS,CAUtC;IAED,IAAW,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,EAEzC;IAEM,cAAc,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI;IAS3C,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS;IAI9C,IAAW,SAAS,IAAI,OAAO,GAAG,SAAS,CAE1C;IAEM,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS;IAIvD,IAAW,mBAAmB,IAAI,MAAM,GAAG,SAAS,CAEnD;IAEM,OAAO,IAAI,OAAO;IAIzB,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED,IAAW,WAAW,IAAI,WAAW,CAEpC;IAED,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAEM,oBAAoB,IAAI,IAAI;IAQnC,kEAAkE;IAC3D,kBAAkB,IAAI,IAAI;IAKjC;;OAEG;IACI,qBAAqB,IAAI,OAAO;IAavC;;;OAGG;IACI,IAAI;IAIX;;OAEG;IACI,MAAM;CAGd"}