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

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

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+export {};
 //# sourceMappingURL=WidgetConfig.js.map

package/lib/esm/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/esm/appui-react/widgets/WidgetControl.js

@@ -1,41 +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;
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* 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/WidgetDef.d.ts

@@ -1,171 +1,171 @@
-/** @packageDocumentation
- * @module Widget
- */
-import * as React from "react";
-import { BadgeType, ConditionalStringValue, PointProps, StringGetter, UiEvent } from "@itwin/appui-abstract";
-import { FloatingWidgetState, PanelSide } from "@itwin/appui-layout-react";
-import { ConfigurableUiControlConstructor, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl";
-import { WidgetControl } from "./WidgetControl";
-import { IconSpec, Rectangle, SizeProps } from "@itwin/core-react";
-import { WidgetConfig } from "./WidgetConfig";
-import { WidgetState } from "./WidgetState";
-import { StagePanelLocation } from "../stagepanels/StagePanelLocation";
-/** 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,
-    Rectangular = 2,
-    ToolSettings = 3,
-    StatusBar = 4
-}
-/** @internal */
-export interface TabLocation {
-    widgetId: string;
-    widgetIndex: number;
-    side: PanelSide;
-    tabIndex: number;
-    floatingWidget?: FloatingWidgetState;
-}
-/** 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 _id;
-    private _classId;
-    private _priority;
-    private _isFloatingStateSupported;
-    private _isFloatingStateWindowResizable;
-    private _stateChanged;
-    private _widgetType;
-    private _applicationData?;
-    private _icon?;
-    private _internalData?;
-    private _badge?;
-    private _onWidgetStateChanged?;
-    private _saveTransientState?;
-    private _restoreTransientState?;
-    private _preferredPanelSize;
-    private _defaultFloatingSize;
-    private _canPopout?;
-    private _floatingContainerId?;
-    private _defaultFloatingPosition;
-    private _hideWithUiWhenFloating?;
-    private _allowedPanelTargets?;
-    private _initialConfig?;
-    private _tabLocation?;
-    private _defaultTabLocation;
-    private _popoutBounds?;
-    get state(): WidgetState;
-    get id(): string;
-    get classId(): string | ConfigurableUiControlConstructor | undefined;
-    get priority(): number;
-    get isFloatingStateSupported(): boolean;
-    get isFloatingStateWindowResizable(): boolean;
-    get isToolSettings(): boolean;
-    get isStatusBar(): boolean;
-    get stateChanged(): boolean;
-    get applicationData(): any | undefined;
-    get isFloating(): boolean;
-    get iconSpec(): IconSpec;
-    set iconSpec(spec: IconSpec);
-    get badgeType(): BadgeType | undefined;
-    get initialConfig(): WidgetConfig | undefined;
-    get widgetType(): WidgetType;
-    set widgetType(type: WidgetType);
-    /** @internal */
-    get tabLocation(): TabLocation | undefined;
-    set tabLocation(tabLocation: TabLocation | undefined);
-    /** @internal */
-    get defaultTabLocation(): TabLocation;
-    /** @internal */
-    get defaultFloatingPosition(): PointProps | undefined;
-    set defaultFloatingPosition(position: PointProps | undefined);
-    /** @internal */
-    get defaultFloatingSize(): SizeProps | undefined;
-    set defaultFloatingSize(size: SizeProps | undefined);
-    /** @internal */
-    get defaultState(): WidgetState;
-    /** @internal */
-    get popoutBounds(): Rectangle | undefined;
-    set popoutBounds(bounds: Rectangle | undefined);
-    constructor();
-    /** @internal */
-    static create(config: WidgetConfig, type?: WidgetType): WidgetDef;
-    private initializeFromConfig;
-    /** @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;
-    set hideWithUiWhenFloating(hide: boolean | undefined);
-    get hideWithUiWhenFloating(): boolean;
-    get allowedPanelTargets(): ReadonlyArray<StagePanelLocation> | undefined;
-    set allowedPanelTargets(targets: ReadonlyArray<StagePanelLocation> | undefined);
-    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;
-}
+/** @packageDocumentation
+ * @module Widget
+ */
+import * as React from "react";
+import { BadgeType, ConditionalStringValue, PointProps, StringGetter, UiEvent } from "@itwin/appui-abstract";
+import { FloatingWidgetState, PanelSide } from "@itwin/appui-layout-react";
+import { ConfigurableUiControlConstructor, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl";
+import { WidgetControl } from "./WidgetControl";
+import { IconSpec, Rectangle, SizeProps } from "@itwin/core-react";
+import { WidgetConfig } from "./WidgetConfig";
+import { WidgetState } from "./WidgetState";
+import { StagePanelLocation } from "../stagepanels/StagePanelLocation";
+/** 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,
+    Rectangular = 2,
+    ToolSettings = 3,
+    StatusBar = 4
+}
+/** @internal */
+export interface TabLocation {
+    widgetId: string;
+    widgetIndex: number;
+    side: PanelSide;
+    tabIndex: number;
+    floatingWidget?: FloatingWidgetState;
+}
+/** 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 _id;
+    private _classId;
+    private _priority;
+    private _isFloatingStateSupported;
+    private _isFloatingStateWindowResizable;
+    private _stateChanged;
+    private _widgetType;
+    private _applicationData?;
+    private _icon?;
+    private _internalData?;
+    private _badge?;
+    private _onWidgetStateChanged?;
+    private _saveTransientState?;
+    private _restoreTransientState?;
+    private _preferredPanelSize;
+    private _defaultFloatingSize;
+    private _canPopout?;
+    private _floatingContainerId?;
+    private _defaultFloatingPosition;
+    private _hideWithUiWhenFloating?;
+    private _allowedPanelTargets?;
+    private _initialConfig?;
+    private _tabLocation?;
+    private _defaultTabLocation;
+    private _popoutBounds?;
+    get state(): WidgetState;
+    get id(): string;
+    get classId(): string | ConfigurableUiControlConstructor | undefined;
+    get priority(): number;
+    get isFloatingStateSupported(): boolean;
+    get isFloatingStateWindowResizable(): boolean;
+    get isToolSettings(): boolean;
+    get isStatusBar(): boolean;
+    get stateChanged(): boolean;
+    get applicationData(): any | undefined;
+    get isFloating(): boolean;
+    get iconSpec(): IconSpec;
+    set iconSpec(spec: IconSpec);
+    get badgeType(): BadgeType | undefined;
+    get initialConfig(): WidgetConfig | undefined;
+    get widgetType(): WidgetType;
+    set widgetType(type: WidgetType);
+    /** @internal */
+    get tabLocation(): TabLocation | undefined;
+    set tabLocation(tabLocation: TabLocation | undefined);
+    /** @internal */
+    get defaultTabLocation(): TabLocation;
+    /** @internal */
+    get defaultFloatingPosition(): PointProps | undefined;
+    set defaultFloatingPosition(position: PointProps | undefined);
+    /** @internal */
+    get defaultFloatingSize(): SizeProps | undefined;
+    set defaultFloatingSize(size: SizeProps | undefined);
+    /** @internal */
+    get defaultState(): WidgetState;
+    /** @internal */
+    get popoutBounds(): Rectangle | undefined;
+    set popoutBounds(bounds: Rectangle | undefined);
+    constructor();
+    /** @internal */
+    static create(config: WidgetConfig, type?: WidgetType): WidgetDef;
+    private initializeFromConfig;
+    /** @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;
+    set hideWithUiWhenFloating(hide: boolean | undefined);
+    get hideWithUiWhenFloating(): boolean;
+    get allowedPanelTargets(): ReadonlyArray<StagePanelLocation> | undefined;
+    set allowedPanelTargets(targets: ReadonlyArray<StagePanelLocation> | undefined);
+    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