@itwin/appui-react 4.0.0-dev.12 → 4.0.0-dev.14

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

@@ -1,35 +1,35 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Widget
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ToolWidgetComposer = void 0;
-const React = require("react");
-const core_react_1 = require("@itwin/core-react");
-const appui_layout_react_1 = require("@itwin/appui-layout-react");
-const UiFramework_1 = require("../UiFramework");
-/**
- * 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
- */
-function ToolWidgetComposer(props) {
-    const { cornerItem, horizontalToolbar, verticalToolbar, ...otherProps } = props;
-    const [elementSet] = React.useState(new core_react_1.WidgetElementSet());
-    const handleChildRef = React.useCallback((elementRef) => {
-        elementSet.add(elementRef);
-    }, [elementSet]);
-    const proximityScale = (0, core_react_1.useProximityToMouse)(elementSet, UiFramework_1.UiFramework.visibility.snapWidgetOpacity);
-    return (React.createElement(core_react_1.WidgetOpacityContext.Provider, { value: {
-            onElementRef: handleChildRef,
-            proximityScale,
-        } },
-        React.createElement(appui_layout_react_1.ToolsArea, { button: cornerItem, horizontalToolbar: horizontalToolbar, verticalToolbar: verticalToolbar, ...otherProps, onMouseEnter: UiFramework_1.UiFramework.visibility.handleWidgetMouseEnter })));
-}
-exports.ToolWidgetComposer = ToolWidgetComposer;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolWidgetComposer = void 0;
+const React = require("react");
+const core_react_1 = require("@itwin/core-react");
+const appui_layout_react_1 = require("@itwin/appui-layout-react");
+const UiFramework_1 = require("../UiFramework");
+/**
+ * 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
+ */
+function ToolWidgetComposer(props) {
+    const { cornerItem, horizontalToolbar, verticalToolbar, ...otherProps } = props;
+    const [elementSet] = React.useState(new core_react_1.WidgetElementSet());
+    const handleChildRef = React.useCallback((elementRef) => {
+        elementSet.add(elementRef);
+    }, [elementSet]);
+    const proximityScale = (0, core_react_1.useProximityToMouse)(elementSet, UiFramework_1.UiFramework.visibility.snapWidgetOpacity);
+    return (React.createElement(core_react_1.WidgetOpacityContext.Provider, { value: {
+            onElementRef: handleChildRef,
+            proximityScale,
+        } },
+        React.createElement(appui_layout_react_1.ToolsArea, { button: cornerItem, horizontalToolbar: horizontalToolbar, verticalToolbar: verticalToolbar, ...otherProps, onMouseEnter: UiFramework_1.UiFramework.visibility.handleWidgetMouseEnter })));
+}
+exports.ToolWidgetComposer = ToolWidgetComposer;
 //# sourceMappingURL=ToolWidgetComposer.js.map

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

@@ -1,27 +1,27 @@
-/** @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;
+/** @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/cjs/appui-react/widgets/ViewToolWidgetComposer.js

@@ -1,37 +1,37 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Widget
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ViewToolWidgetComposer = void 0;
-const classnames_1 = require("classnames");
-const React = require("react");
-const ToolbarComposer_1 = require("../toolbar/ToolbarComposer");
-const useUiVisibility_1 = require("../hooks/useUiVisibility");
-const NavigationWidgetComposer_1 = require("./NavigationWidgetComposer");
-const ToolbarItem_1 = require("../toolbar/ToolbarItem");
-/**
- * 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
- */
-function ViewToolWidgetComposer(props) {
-    const uiIsVisible = (0, useUiVisibility_1.useUiVisibility)();
-    // istanbul ignore next
-    const className = (0, classnames_1.default)(!uiIsVisible && "nz-hidden");
-    return (React.createElement(NavigationWidgetComposer_1.NavigationWidgetComposer, { className: className, hideNavigationAid: props.hideNavigationAid, horizontalToolbar: React.createElement(ToolbarComposer_1.ToolbarComposer, { items: [], usage: ToolbarItem_1.ToolbarUsage.ViewNavigation, orientation: ToolbarItem_1.ToolbarOrientation.Horizontal }), verticalToolbar: React.createElement(ToolbarComposer_1.ToolbarComposer, { items: [], usage: ToolbarItem_1.ToolbarUsage.ViewNavigation, orientation: ToolbarItem_1.ToolbarOrientation.Vertical }) }));
-}
-exports.ViewToolWidgetComposer = ViewToolWidgetComposer;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewToolWidgetComposer = void 0;
+const classnames_1 = require("classnames");
+const React = require("react");
+const ToolbarComposer_1 = require("../toolbar/ToolbarComposer");
+const useUiVisibility_1 = require("../hooks/useUiVisibility");
+const NavigationWidgetComposer_1 = require("./NavigationWidgetComposer");
+const ToolbarItem_1 = require("../toolbar/ToolbarItem");
+/**
+ * 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
+ */
+function ViewToolWidgetComposer(props) {
+    const uiIsVisible = (0, useUiVisibility_1.useUiVisibility)();
+    // istanbul ignore next
+    const className = (0, classnames_1.default)(!uiIsVisible && "nz-hidden");
+    return (React.createElement(NavigationWidgetComposer_1.NavigationWidgetComposer, { className: className, hideNavigationAid: props.hideNavigationAid, horizontalToolbar: React.createElement(ToolbarComposer_1.ToolbarComposer, { items: [], usage: ToolbarItem_1.ToolbarUsage.ViewNavigation, orientation: ToolbarItem_1.ToolbarOrientation.Horizontal }), verticalToolbar: React.createElement(ToolbarComposer_1.ToolbarComposer, { items: [], usage: ToolbarItem_1.ToolbarUsage.ViewNavigation, orientation: ToolbarItem_1.ToolbarOrientation.Vertical }) }));
+}
+exports.ViewToolWidgetComposer = ViewToolWidgetComposer;
 //# sourceMappingURL=ViewToolWidgetComposer.js.map

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

@@ -1,39 +1,39 @@
-/** @packageDocumentation
- * @module Widget
- */
-/// <reference types="react" />
-import { BadgeType, ConditionalStringValue, PointProps } from "@itwin/appui-abstract";
-import { IconSpec, SizeProps } from "@itwin/core-react";
-import { StagePanelLocation } from "../stagepanels/StagePanelLocation";
-import { WidgetState } from "./WidgetState";
-/** Describes options of a floating widget.
- * @public
- */
-export interface CanFloatWidgetOptions {
-    readonly isResizable?: boolean;
-    readonly defaultPosition?: PointProps;
-    readonly defaultSize?: SizeProps;
-    readonly containerId?: string;
-    readonly hideWithUi?: boolean;
-}
-/** Describes the data needed to provide a widget.
- * @public
- */
-export interface Widget {
-    readonly id: string;
-    /** Stage panels to which this widget can be docked. All stage panels are allowed if nothing is provided. */
-    readonly allowedPanels?: ReadonlyArray<StagePanelLocation>;
-    readonly badge?: BadgeType;
-    /** Defaults to `false`. */
-    readonly canPopout?: boolean;
-    /** Set to `false` to disable floating of a widget. Alternatively options object can be provided which enables floating. Defaults to `true`. */
-    readonly canFloat?: boolean | CanFloatWidgetOptions;
-    readonly defaultState?: WidgetState;
-    /** Content of the Widget. */
-    readonly content?: React.ReactNode;
-    readonly icon?: IconSpec;
-    readonly label?: string | ConditionalStringValue;
-    readonly priority?: number;
-    readonly tooltip?: string | ConditionalStringValue;
-}
+/** @packageDocumentation
+ * @module Widget
+ */
+/// <reference types="react" />
+import { BadgeType, ConditionalStringValue, PointProps } from "@itwin/appui-abstract";
+import { IconSpec, SizeProps } from "@itwin/core-react";
+import { StagePanelLocation } from "../stagepanels/StagePanelLocation";
+import { WidgetState } from "./WidgetState";
+/** Describes options of a floating widget.
+ * @public
+ */
+export interface CanFloatWidgetOptions {
+    readonly isResizable?: boolean;
+    readonly defaultPosition?: PointProps;
+    readonly defaultSize?: SizeProps;
+    readonly containerId?: string;
+    readonly hideWithUi?: boolean;
+}
+/** Describes the data needed to provide a widget.
+ * @public
+ */
+export interface Widget {
+    readonly id: string;
+    /** Stage panels to which this widget can be docked. All stage panels are allowed if nothing is provided. */
+    readonly allowedPanels?: ReadonlyArray<StagePanelLocation>;
+    readonly badge?: BadgeType;
+    /** Defaults to `false`. */
+    readonly canPopout?: boolean;
+    /** Set to `false` to disable floating of a widget. Alternatively options object can be provided which enables floating. Defaults to `true`. */
+    readonly canFloat?: boolean | CanFloatWidgetOptions;
+    readonly defaultState?: WidgetState;
+    /** Content of the Widget. */
+    readonly content?: React.ReactNode;
+    readonly icon?: IconSpec;
+    readonly label?: string | ConditionalStringValue;
+    readonly priority?: number;
+    readonly tooltip?: string | ConditionalStringValue;
+}
 //# sourceMappingURL=Widget.d.ts.map

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

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Widget
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=Widget.js.map

package/lib/cjs/appui-react/widgets/WidgetConfig.d.ts

@@ -1,16 +1,16 @@
-/** @packageDocumentation
- * @module Widget
- */
-import { Widget } from "./Widget";
-/** Configuration from which a widget is created.
- * @public
- */
-export interface WidgetConfig extends Widget {
-    /** If set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */
-    readonly labelKey?: string;
-    /** If set, it is used to define a key that is used to look up a localized string. This value is used only if tooltip is not explicitly set. */
-    readonly tooltipKey?: string;
-    /** @alpha */
-    readonly preferredPanelSize?: "fit-content";
-}
+/** @packageDocumentation
+ * @module Widget
+ */
+import { Widget } from "./Widget";
+/** Configuration from which a widget is created.
+ * @public
+ */
+export interface WidgetConfig extends Widget {
+    /** If set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */
+    readonly labelKey?: string;
+    /** If set, it is used to define a key that is used to look up a localized string. This value is used only if tooltip is not explicitly set. */
+    readonly tooltipKey?: string;
+    /** @alpha */
+    readonly preferredPanelSize?: "fit-content";
+}
 //# sourceMappingURL=WidgetConfig.d.ts.map

package/lib/cjs/appui-react/widgets/WidgetConfig.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Widget
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=WidgetConfig.js.map

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

@@ -1,34 +1,34 @@
-/** @packageDocumentation
- * @module Widget
- */
-import * as React from "react";
-import { ConfigurableCreateInfo, ConfigurableUiControl, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl";
-import { WidgetDef } from "./WidgetDef";
-import { WidgetState } from "./WidgetState";
-/** 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;
-}
+/** @packageDocumentation
+ * @module Widget
+ */
+import * as React from "react";
+import { ConfigurableCreateInfo, ConfigurableUiControl, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl";
+import { WidgetDef } from "./WidgetDef";
+import { WidgetState } from "./WidgetState";
+/** 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/cjs/appui-react/widgets/WidgetControl.js

@@ -1,45 +1,45 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Widget
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WidgetControl = void 0;
-const ConfigurableUiControl_1 = require("../configurableui/ConfigurableUiControl");
-/** The base class for Widget controls.
- * @public
- */
-class WidgetControl extends ConfigurableUiControl_1.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 ConfigurableUiControl_1.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;
-    }
-}
-exports.WidgetControl = WidgetControl;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WidgetControl = void 0;
+const ConfigurableUiControl_1 = require("../configurableui/ConfigurableUiControl");
+/** The base class for Widget controls.
+ * @public
+ */
+class WidgetControl extends ConfigurableUiControl_1.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 ConfigurableUiControl_1.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;
+    }
+}
+exports.WidgetControl = WidgetControl;
 //# sourceMappingURL=WidgetControl.js.map