@itwin/appui-react 3.0.0-extension.1 → 3.1.0-dev.0

package/lib/cjs/appui-react/widget-panels/Frontstage.d.ts

@@ -4,7 +4,7 @@
 import "./Frontstage.scss";
 import * as React from "react";
 import { WidgetState } from "@itwin/appui-abstract";
-import { UiSettingsResult, UiSettingsStatus } from "@itwin/core-react";
+import { UiStateStorageResult, UiStateStorageStatus } from "@itwin/core-react";
 import { NineZoneDispatch, NineZoneLabels, NineZoneState, PanelSide, TabState } from "@itwin/appui-layout-react";
 import { FrontstageDef } from "../frontstage/FrontstageDef";
 import { StagePanelState, StagePanelZoneDefKeys } from "../stagepanels/StagePanelDef";
@@ -46,8 +46,8 @@ export declare function getPanelZoneWidgets(frontstageDef: FrontstageDef, panelZ
 /** @internal */
 export declare function addPanelWidgets(state: NineZoneState, frontstageDef: FrontstageDef, side: PanelSide): NineZoneState;
 /** @internal */
-export declare function isFrontstageStateSettingResult(settingsResult: UiSettingsResult): settingsResult is {
-    status: UiSettingsStatus.Success;
+export declare function isFrontstageStateSettingResult(settingsResult: UiStateStorageResult): settingsResult is {
+    status: UiStateStorageStatus.Success;
     setting: WidgetPanelsFrontstageState;
 };
 /** @internal */
@@ -62,13 +62,13 @@ export declare function initializeNineZoneState(frontstageDef: FrontstageDef): N
 export declare function restoreNineZoneState(frontstageDef: FrontstageDef, saved: SavedNineZoneState): NineZoneState;
 /** Prepares NineZoneState to be saved.
  * @note Removes toolSettings tab.
- * @note Removes tab labels.
+ * @note Removes tab labels and iconSpec.
  * @internal
  */
 export declare function packNineZoneState(state: NineZoneState): SavedNineZoneState;
 /** @internal */
 export declare function isPanelCollapsed(zoneStates: ReadonlyArray<ZoneState | undefined>, panelStates: ReadonlyArray<StagePanelState | undefined>): boolean;
-/** FrontstageState is saved in UiSettings.
+/** FrontstageState is saved in UiStateStorage.
  * @internal
  */
 export interface WidgetPanelsFrontstageState {
@@ -77,7 +77,7 @@ export interface WidgetPanelsFrontstageState {
     version: number;
     stateVersion: number;
 }
-declare type SavedTabState = Omit<TabState, "label" | "canPopout" | "isFloatingStateWindowResizable">;
+declare type SavedTabState = Omit<TabState, "label" | "canPopout" | "isFloatingStateWindowResizable" | "iconSpec">;
 interface SavedTabsState {
     readonly [id: string]: SavedTabState;
 }
@@ -193,6 +193,29 @@ export declare const setWidgetState: (base: {
         readonly [x: string]: {
             readonly id: string;
             readonly label: string;
+            readonly iconSpec?: boolean | React.ReactText | {
+                readonly type: string | React.JSXElementConstructor<any>;
+                readonly props: any;
+                readonly key: React.Key | null;
+            } | {} | {
+                readonly [Symbol.iterator]: () => Iterator<React.ReactNode, any, undefined>;
+            } | {
+                readonly key: React.Key | null;
+                readonly children: boolean | React.ReactText | {
+                    readonly type: string | React.JSXElementConstructor<any>;
+                    readonly props: any;
+                    readonly key: React.Key | null;
+                } | {} | {
+                    readonly [Symbol.iterator]: () => Iterator<React.ReactNode, any, undefined>;
+                } | any | null | undefined;
+                readonly type: string | React.JSXElementConstructor<any>;
+                readonly props: any;
+            } | {
+                readonly stringGetter: () => string;
+                readonly syncEventIds: readonly string[];
+                readonly value: string;
+                readonly refresh: () => boolean;
+            } | null | undefined;
             readonly preferredFloatingWidgetSize?: {
                 readonly width: number;
                 readonly height: number;
@@ -338,6 +361,29 @@ export declare const showWidget: (base: {
         readonly [x: string]: {
             readonly id: string;
             readonly label: string;
+            readonly iconSpec?: boolean | React.ReactText | {
+                readonly type: string | React.JSXElementConstructor<any>;
+                readonly props: any;
+                readonly key: React.Key | null;
+            } | {} | {
+                readonly [Symbol.iterator]: () => Iterator<React.ReactNode, any, undefined>;
+            } | {
+                readonly key: React.Key | null;
+                readonly children: boolean | React.ReactText | {
+                    readonly type: string | React.JSXElementConstructor<any>;
+                    readonly props: any;
+                    readonly key: React.Key | null;
+                } | {} | {
+                    readonly [Symbol.iterator]: () => Iterator<React.ReactNode, any, undefined>;
+                } | any | null | undefined;
+                readonly type: string | React.JSXElementConstructor<any>;
+                readonly props: any;
+            } | {
+                readonly stringGetter: () => string;
+                readonly syncEventIds: readonly string[];
+                readonly value: string;
+                readonly refresh: () => boolean;
+            } | null | undefined;
             readonly preferredFloatingWidgetSize?: {
                 readonly width: number;
                 readonly height: number;
@@ -483,6 +529,29 @@ export declare const expandWidget: (base: {
         readonly [x: string]: {
             readonly id: string;
             readonly label: string;
+            readonly iconSpec?: boolean | React.ReactText | {
+                readonly type: string | React.JSXElementConstructor<any>;
+                readonly props: any;
+                readonly key: React.Key | null;
+            } | {} | {
+                readonly [Symbol.iterator]: () => Iterator<React.ReactNode, any, undefined>;
+            } | {
+                readonly key: React.Key | null;
+                readonly children: boolean | React.ReactText | {
+                    readonly type: string | React.JSXElementConstructor<any>;
+                    readonly props: any;
+                    readonly key: React.Key | null;
+                } | {} | {
+                    readonly [Symbol.iterator]: () => Iterator<React.ReactNode, any, undefined>;
+                } | any | null | undefined;
+                readonly type: string | React.JSXElementConstructor<any>;
+                readonly props: any;
+            } | {
+                readonly stringGetter: () => string;
+                readonly syncEventIds: readonly string[];
+                readonly value: string;
+                readonly refresh: () => boolean;
+            } | null | undefined;
             readonly preferredFloatingWidgetSize?: {
                 readonly width: number;
                 readonly height: number;
@@ -628,6 +697,29 @@ export declare const setWidgetLabel: (base: {
         readonly [x: string]: {
             readonly id: string;
             readonly label: string;
+            readonly iconSpec?: boolean | React.ReactText | {
+                readonly type: string | React.JSXElementConstructor<any>;
+                readonly props: any;
+                readonly key: React.Key | null;
+            } | {} | {
+                readonly [Symbol.iterator]: () => Iterator<React.ReactNode, any, undefined>;
+            } | {
+                readonly key: React.Key | null;
+                readonly children: boolean | React.ReactText | {
+                    readonly type: string | React.JSXElementConstructor<any>;
+                    readonly props: any;
+                    readonly key: React.Key | null;
+                } | {} | {
+                    readonly [Symbol.iterator]: () => Iterator<React.ReactNode, any, undefined>;
+                } | any | null | undefined;
+                readonly type: string | React.JSXElementConstructor<any>;
+                readonly props: any;
+            } | {
+                readonly stringGetter: () => string;
+                readonly syncEventIds: readonly string[];
+                readonly value: string;
+                readonly refresh: () => boolean;
+            } | null | undefined;
             readonly preferredFloatingWidgetSize?: {
                 readonly width: number;
                 readonly height: number;
@@ -677,8 +769,6 @@ export declare function useFrontstageManager(frontstageDef: FrontstageDef): void
 /** @internal */
 export declare function useItemsManager(frontstageDef: FrontstageDef): void;
 /** @internal */
-export declare function useSyncDefinitions(frontstageDef: FrontstageDef): void;
-/** @internal */
 export declare function saveFrontstagePopoutWidgetSizeAndPosition(state: NineZoneState, stageId: string, stageVersion: number, childWindowId: string, childWindow: Window): Promise<NineZoneState>;
 export {};
 //# sourceMappingURL=Frontstage.d.ts.map

package/lib/cjs/appui-react/widget-panels/Frontstage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Frontstage.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widget-panels/Frontstage.tsx"],"names":[],"mappings":"AAKA;;GAEG;AAIH,OAAO,mBAAmB,CAAC;AAE3B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAsC,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACxF,OAAO,EAAmB,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACxF,OAAO,EAGiD,gBAAgB,EAAE,cAAc,EAAE,aAAa,EAC/E,SAAS,EAAqC,QAAQ,EAC7E,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,aAAa,EAAgE,MAAM,6BAA6B,CAAC;AAG1H,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAGtF,OAAO,EAAE,SAAS,EAAgD,MAAM,sBAAsB,CAAC;AAC/F,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAmC7C,gBAAgB;AAChB,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,aAAa,6BAmB5D;AAcD;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,aAAa,QAejE;AAsBD,gBAAgB;AAChB,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,aAAa,oBA8B/D;AAED,gBAAgB;AAChB,eAAO,MAAM,sBAAsB,oCAqBjC,CAAC;AAKH,gBAAgB;AAChB,wBAAgB,2BAA2B,CAAC,EAAE,aAAa,EAAE,EAAE;IAAE,aAAa,EAAE,aAAa,CAAA;CAAE,eA8B9F;AAED,gBAAgB;AAChB,wBAAgB,SAAS,mBAYxB;AAED,gBAAgB;AAChB,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,aAAa,GAAG,aAAa,CAwB3I;AAED,gBAAgB;AAEhB,wBAAgB,aAAa,CAAC,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,GAAG,aAAa,CAyDtJ;AAoBD;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,GAAG,aAAa,CA4B1G;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,GAAG,aAAa,CAY7G;AAMD,aAAK,aAAa,GAChB,WAAW,GACX,YAAY,GACZ,SAAS,GACT,YAAY,GACZ,aAAa,GACb,UAAU,GACV,UAAU,GACV,QAAQ,GACR,aAAa,GACb,WAAW,CAAC;AAed,gBAAgB;AAChB,wBAAgB,WAAW,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,qBAAqB,GAAG,aAAa,CA8BtF;AAUD,gBAAgB;AAChB,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,aAAa,EAAE,SAAS,EAAE,aAAa,GAAG,SAAS,EAAE,CA+DvG;AAED,gBAAgB;AAChB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,aAAa,EACpB,aAAa,EAAE,aAAa,EAC5B,IAAI,EAAE,SAAS,GACd,aAAa,CAef;AAED,gBAAgB;AAChB,wBAAgB,8BAA8B,CAAC,cAAc,EAAE,gBAAgB,GAAG,cAAc,IAAI;IAClG,MAAM,EAAE,gBAAgB,CAAC,OAAO,CAAC;IACjC,OAAO,EAAE,2BAA2B,CAAC;CACtC,CAIA;AAED,gBAAgB;AAChB,wBAAgB,eAAe,CAAC,QAAQ,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,EAAE,SAAS,EAAE,SAAS,iBAe1G;AAYD,gBAAgB;AAChB,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,CAgDnF;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,aAAa,EAAE,KAAK,EAAE,kBAAkB,GAAG,aAAa,CAmC3G;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,aAAa,GAAG,kBAAkB,CAmB1E;AAED,gBAAgB;AAChB,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,aAAa,CAAC,SAAS,GAAG,SAAS,CAAC,EAAE,WAAW,EAAE,aAAa,CAAC,eAAe,GAAG,SAAS,CAAC,WAIzI;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,EAAE,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;CACtB;AAGD,aAAK,aAAa,GAAG,IAAI,CAAC,QAAQ,EAAE,OAAO,GAAG,WAAW,GAAG,gCAAgC,CAAC,CAAC;AAE9F,UAAU,cAAc;IACtB,QAAQ,EAAE,EAAE,EAAE,MAAM,GAAG,aAAa,CAAC;CACtC;AASD,UAAU,kBAAmB,SAAQ,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC;IAC9D,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;CAE/B;AAgCD,gBAAgB;AAChB,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0GAoDzB,CAAC;AAEH,gBAAgB;AAChB,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4EAerB,CAAC;AAEH,gBAAgB;AAChB,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4EAgBvB,CAAC;AAEH,gBAAgB;AAChB,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2FAMzB,CAAC;AAEH,gBAAgB;AAChB,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,aAAa,QA6BnE;AAED,gBAAgB;AAChB,wBAAgB,yBAAyB,CAAC,aAAa,EAAE,aAAa,QAuBrE;AAED,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,4BAA4B,CAAC;AAEvE,gBAAgB;AAChB,wBAAgB,6BAA6B,CAAC,YAAY,EAAE,2BAA2B,CAAC,IAAI,CAAC,UAE5F;AA2BD,gBAAgB;AAChB,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,aAAa,QA4DhE;AAED,gBAAgB;AAEhB,wBAAgB,eAAe,CAAC,aAAa,EAAE,aAAa,QAqB3D;AAkBD,gBAAgB;AAChB,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,aAAa,QA4C9D;AAED,gBAAgB;AAChB,wBAAsB,yCAAyC,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,0BA4BtK"}
+{"version":3,"file":"Frontstage.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widget-panels/Frontstage.tsx"],"names":[],"mappings":"AAMA;;GAEG;AAIH,OAAO,mBAAmB,CAAC;AAE3B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAsC,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACxF,OAAO,EAAmB,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAChG,OAAO,EAGiD,gBAAgB,EAAE,cAAc,EAAE,aAAa,EAC/E,SAAS,EAAqC,QAAQ,EAC7E,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,aAAa,EAAgE,MAAM,6BAA6B,CAAC;AAG1H,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAGtF,OAAO,EAAE,SAAS,EAAgD,MAAM,sBAAsB,CAAC;AAC/F,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAqC7C,gBAAgB;AAChB,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,aAAa,6BAgB5D;AAcD;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,aAAa,QAejE;AAsBD,gBAAgB;AAChB,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,aAAa,oBA8B/D;AAED,gBAAgB;AAChB,eAAO,MAAM,sBAAsB,oCAqBjC,CAAC;AAKH,gBAAgB;AAChB,wBAAgB,2BAA2B,CAAC,EAAE,aAAa,EAAE,EAAE;IAAE,aAAa,EAAE,aAAa,CAAA;CAAE,eAmC9F;AAED,gBAAgB;AAChB,wBAAgB,SAAS,mBAYxB;AAED,gBAAgB;AAChB,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,aAAa,GAAG,aAAa,CA0B3I;AAED,gBAAgB;AAEhB,wBAAgB,aAAa,CAAC,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,GAAG,aAAa,CA0DtJ;AAoBD;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,GAAG,aAAa,CA4B1G;AAoBD;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,GAAG,aAAa,CAY7G;AAMD,aAAK,aAAa,GAChB,WAAW,GACX,YAAY,GACZ,SAAS,GACT,YAAY,GACZ,aAAa,GACb,UAAU,GACV,UAAU,GACV,QAAQ,GACR,aAAa,GACb,WAAW,CAAC;AAed,gBAAgB;AAChB,wBAAgB,WAAW,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,qBAAqB,GAAG,aAAa,CA8BtF;AAUD,gBAAgB;AAChB,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,aAAa,EAAE,SAAS,EAAE,aAAa,GAAG,SAAS,EAAE,CA+DvG;AAED,gBAAgB;AAChB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,aAAa,EACpB,aAAa,EAAE,aAAa,EAC5B,IAAI,EAAE,SAAS,GACd,aAAa,CAef;AAED,gBAAgB;AAChB,wBAAgB,8BAA8B,CAAC,cAAc,EAAE,oBAAoB,GAAG,cAAc,IAAI;IACtG,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC;IACrC,OAAO,EAAE,2BAA2B,CAAC;CACtC,CAIA;AAED,gBAAgB;AAChB,wBAAgB,eAAe,CAAC,QAAQ,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,EAAE,SAAS,EAAE,SAAS,iBAe1G;AAYD,gBAAgB;AAChB,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,CAgDnF;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,aAAa,EAAE,KAAK,EAAE,kBAAkB,GAAG,aAAa,CAoC3G;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,aAAa,GAAG,kBAAkB,CAmB1E;AAED,gBAAgB;AAChB,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,aAAa,CAAC,SAAS,GAAG,SAAS,CAAC,EAAE,WAAW,EAAE,aAAa,CAAC,eAAe,GAAG,SAAS,CAAC,WAIzI;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,EAAE,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;CACtB;AAGD,aAAK,aAAa,GAAG,IAAI,CAAC,QAAQ,EAAE,OAAO,GAAG,WAAW,GAAG,gCAAgC,GAAG,UAAU,CAAC,CAAC;AAE3G,UAAU,cAAc;IACtB,QAAQ,EAAE,EAAE,EAAE,MAAM,GAAG,aAAa,CAAC;CACtC;AASD,UAAU,kBAAmB,SAAQ,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC;IAC9D,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;CAE/B;AAgCD,gBAAgB;AAChB,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0GA0CzB,CAAC;AAoBH,gBAAgB;AAChB,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4EAerB,CAAC;AAEH,gBAAgB;AAChB,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4EAgBvB,CAAC;AAEH,gBAAgB;AAChB,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2FAMzB,CAAC;AAEH,gBAAgB;AAChB,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,aAAa,QAqCnE;AAED,gBAAgB;AAChB,wBAAgB,yBAAyB,CAAC,aAAa,EAAE,aAAa,QAuBrE;AAED,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,4BAA4B,CAAC;AAEvE,gBAAgB;AAChB,wBAAgB,6BAA6B,CAAC,YAAY,EAAE,2BAA2B,CAAC,IAAI,CAAC,UAE5F;AA2BD,gBAAgB;AAChB,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,aAAa,QA4DhE;AAED,gBAAgB;AAEhB,wBAAgB,eAAe,CAAC,aAAa,EAAE,aAAa,QAsB3D;AAkBD,gBAAgB;AAChB,wBAAsB,yCAAyC,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,0BA4BtK"}

package/lib/cjs/appui-react/widget-panels/Frontstage.js

@@ -3,8 +3,9 @@
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
+/* eslint-disable deprecation/deprecation */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.saveFrontstagePopoutWidgetSizeAndPosition = exports.useSyncDefinitions = exports.useItemsManager = exports.useFrontstageManager = exports.getFrontstageStateSettingName = exports.FRONTSTAGE_SETTINGS_NAMESPACE = exports.useSaveFrontstageSettings = exports.useSavedFrontstageState = exports.setWidgetLabel = exports.expandWidget = exports.showWidget = exports.setWidgetState = exports.isPanelCollapsed = exports.packNineZoneState = exports.restoreNineZoneState = exports.initializeNineZoneState = exports.initializePanel = exports.isFrontstageStateSettingResult = exports.addPanelWidgets = exports.getPanelZoneWidgets = exports.getWidgetId = exports.removeMissingWidgets = exports.addMissingWidgets = exports.appendWidgets = exports.addWidgets = exports.useLabels = exports.ActiveFrontstageDefProvider = exports.WidgetPanelsFrontstage = exports.useNineZoneDispatch = exports.useUpdateNineZoneSize = exports.useNineZoneState = void 0;
+exports.saveFrontstagePopoutWidgetSizeAndPosition = exports.useItemsManager = exports.useFrontstageManager = exports.getFrontstageStateSettingName = exports.FRONTSTAGE_SETTINGS_NAMESPACE = exports.useSaveFrontstageSettings = exports.useSavedFrontstageState = exports.setWidgetLabel = exports.expandWidget = exports.showWidget = exports.setWidgetState = exports.isPanelCollapsed = exports.packNineZoneState = exports.restoreNineZoneState = exports.initializeNineZoneState = exports.initializePanel = exports.isFrontstageStateSettingResult = exports.addPanelWidgets = exports.getPanelZoneWidgets = exports.getWidgetId = exports.removeMissingWidgets = exports.addMissingWidgets = exports.appendWidgets = exports.addWidgets = exports.useLabels = exports.ActiveFrontstageDefProvider = exports.WidgetPanelsFrontstage = exports.useNineZoneDispatch = exports.useUpdateNineZoneSize = exports.useNineZoneState = void 0;
 /** @packageDocumentation
  * @module Frontstage
  */
@@ -20,7 +21,7 @@ const Frontstage_1 = require("../frontstage/Frontstage");
 const FrontstageManager_1 = require("../frontstage/FrontstageManager");
 const StagePanelDef_1 = require("../stagepanels/StagePanelDef");
 const UiFramework_1 = require("../UiFramework");
-const useUiSettings_1 = require("../uisettings/useUiSettings");
+const useUiStateStorage_1 = require("../uistate/useUiStateStorage");
 const ZoneDef_1 = require("../zones/ZoneDef");
 const Content_1 = require("./Content");
 const FrontstageContent_1 = require("./FrontstageContent");
@@ -30,6 +31,7 @@ const Tab_1 = require("./Tab");
 const Toolbars_1 = require("./Toolbars");
 const ToolSettings_1 = require("./ToolSettings");
 const useEscapeSetFocusToHome_1 = require("../hooks/useEscapeSetFocusToHome");
+const react_redux_1 = require("react-redux");
 const panelZoneKeys = ["start", "middle", "end"];
 // istanbul ignore next
 const WidgetPanelsFrontstageComponent = React.memo(function WidgetPanelsFrontstageComponent() {
@@ -59,10 +61,7 @@ function useNineZoneState(frontstageDef) {
                 return;
             setNineZone(args.state);
         };
-        FrontstageManager_1.FrontstageManager.onFrontstageNineZoneStateChangedEvent.addListener(listener);
-        return () => {
-            FrontstageManager_1.FrontstageManager.onFrontstageNineZoneStateChangedEvent.removeListener(listener);
-        };
+        return FrontstageManager_1.FrontstageManager.onFrontstageNineZoneStateChangedEvent.addListener(listener);
     }, [frontstageDef]);
     return lastFrontstageDef.current === frontstageDef ? nineZone : frontstageDef.nineZoneState;
 }
@@ -179,11 +178,14 @@ function ActiveFrontstageDefProvider({ frontstageDef }) {
     useSaveFrontstageSettings(frontstageDef);
     useFrontstageManager(frontstageDef);
     useItemsManager(frontstageDef);
-    useSyncDefinitions(frontstageDef);
     const labels = useLabels();
+    const showWidgetIcon = (0, react_redux_1.useSelector)((state) => {
+        const frameworkState = state[UiFramework_1.UiFramework.frameworkStateKey];
+        return !!frameworkState.configurableUiState.showWidgetIcon;
+    });
     const handleKeyDown = (0, useEscapeSetFocusToHome_1.useEscapeSetFocusToHome)();
     return (React.createElement("div", { className: "uifw-widgetPanels-frontstage", onKeyDown: handleKeyDown, role: "presentation" },
-        React.createElement(appui_layout_react_1.NineZone, { dispatch: dispatch, labels: labels, state: nineZone, tab: tabElement, toolSettingsContent: toolSettingsContent, widgetContent: widgetContent }, widgetPanelsFrontstage)));
+        React.createElement(appui_layout_react_1.NineZone, { dispatch: dispatch, labels: labels, state: nineZone, tab: tabElement, showWidgetIcon: showWidgetIcon, toolSettingsContent: toolSettingsContent, widgetContent: widgetContent }, widgetPanelsFrontstage)));
 }
 exports.ActiveFrontstageDefProvider = ActiveFrontstageDefProvider;
 /** @internal */
@@ -203,20 +205,22 @@ function useLabels() {
 exports.useLabels = useLabels;
 /** @internal */
 function addWidgets(state, widgets, side, widgetId) {
-    if (widgets.length === 0)
+    const visibleWidgets = widgets.filter((w) => w.isVisible);
+    if (visibleWidgets.length === 0)
         return state;
     const tabs = new Array();
-    for (const widget of widgets) {
+    for (const widget of visibleWidgets) {
         const label = getWidgetLabel(widget.label);
         state = (0, appui_layout_react_1.addTab)(state, widget.id, {
             label,
+            iconSpec: widget.iconSpec,
             preferredPanelWidgetSize: widget.preferredPanelSize,
             canPopout: widget.canPopout,
             isFloatingStateWindowResizable: widget.isFloatingStateWindowResizable,
         });
         tabs.push(widget.id);
     }
-    const activeWidget = widgets.find((widget) => widget.isActive);
+    const activeWidget = visibleWidgets.find((widget) => widget.isActive);
     const minimized = !activeWidget;
     state = (0, appui_layout_react_1.addPanelWidget)(state, side, widgetId, tabs, {
         activeTabId: activeWidget ? activeWidget.id : tabs[0],
@@ -242,6 +246,7 @@ function appendWidgets(state, widgetDefs, side, preferredWidgetIndex) {
         const userSized = saveTab ? saveTab.userSized : undefined;
         state = (0, appui_layout_react_1.addTab)(state, widgetDef.id, {
             label,
+            iconSpec: widgetDef.iconSpec,
             canPopout: widgetDef.canPopout,
             preferredPanelWidgetSize,
             preferredFloatingWidgetSize,
@@ -329,6 +334,21 @@ function addMissingWidgets(frontstageDef, initialState) {
     return state;
 }
 exports.addMissingWidgets = addMissingWidgets;
+/** Removes widgets with Hidden defaultState. */
+function removeHiddenWidgets(state, frontstageDef) {
+    const tabs = Object.values(state.tabs);
+    for (const tab of tabs) {
+        const widgetDef = frontstageDef.findWidgetDef(tab.id);
+        if (!widgetDef)
+            continue;
+        if (widgetDef.defaultState === appui_abstract_1.WidgetState.Hidden) {
+            state = (0, immer_1.default)(state, (draft) => {
+                hideWidget(draft, widgetDef);
+            });
+        }
+    }
+    return state;
+}
 /** Removes NineZoneState widgets that are missing in frontstageDef.
  * @internal
  */
@@ -487,7 +507,7 @@ function addPanelWidgets(state, frontstageDef, side) {
 exports.addPanelWidgets = addPanelWidgets;
 /** @internal */
 function isFrontstageStateSettingResult(settingsResult) {
-    if (settingsResult.status === core_react_1.UiSettingsStatus.Success)
+    if (settingsResult.status === core_react_1.UiStateStorageStatus.Success)
         return true;
     return false;
 }
@@ -594,6 +614,7 @@ function restoreNineZoneState(frontstageDef, saved) {
             draft.tabs[tab.id] = {
                 ...tab,
                 label: getWidgetLabel((_a = widgetDef === null || widgetDef === void 0 ? void 0 : widgetDef.label) !== null && _a !== void 0 ? _a : "undefined"),
+                iconSpec: widgetDef === null || widgetDef === void 0 ? void 0 : widgetDef.iconSpec,
                 canPopout: widgetDef === null || widgetDef === void 0 ? void 0 : widgetDef.canPopout,
                 isFloatingStateWindowResizable: widgetDef === null || widgetDef === void 0 ? void 0 : widgetDef.isFloatingStateWindowResizable,
             };
@@ -614,7 +635,7 @@ function restoreNineZoneState(frontstageDef, saved) {
 exports.restoreNineZoneState = restoreNineZoneState;
 /** Prepares NineZoneState to be saved.
  * @note Removes toolSettings tab.
- * @note Removes tab labels.
+ * @note Removes tab labels and iconSpec.
  * @internal
  */
 function packNineZoneState(state) {
@@ -678,9 +699,9 @@ function addRemovedTab(nineZone, widgetDef) {
 }
 /** @internal */
 exports.setWidgetState = (0, immer_1.default)((nineZone, widgetDef, state) => {
-    const id = widgetDef.id;
-    let location = (0, appui_layout_react_1.findTab)(nineZone, id);
     if (state === appui_abstract_1.WidgetState.Open) {
+        const id = widgetDef.id;
+        let location = (0, appui_layout_react_1.findTab)(nineZone, id);
         if (!location) {
             addRemovedTab(nineZone, widgetDef);
             location = (0, appui_layout_react_1.findTab)(nineZone, id);
@@ -691,6 +712,8 @@ exports.setWidgetState = (0, immer_1.default)((nineZone, widgetDef, state) => {
         widget.activeTabId = id;
     }
     else if (state === appui_abstract_1.WidgetState.Closed) {
+        const id = widgetDef.id;
+        let location = (0, appui_layout_react_1.findTab)(nineZone, id);
         if (!location) {
             addRemovedTab(nineZone, widgetDef);
             location = (0, appui_layout_react_1.findTab)(nineZone, id);
@@ -713,21 +736,26 @@ exports.setWidgetState = (0, immer_1.default)((nineZone, widgetDef, state) => {
         }
     }
     else if (state === appui_abstract_1.WidgetState.Hidden) {
-        if (!location)
-            return;
-        const widgetId = location.widgetId;
-        const side = "side" in location ? location.side : "left";
-        const widgetIndex = "side" in location ? nineZone.panels[side].widgets.indexOf(widgetId) : 0;
-        const tabIndex = nineZone.widgets[location.widgetId].tabs.indexOf(id);
-        widgetDef.tabLocation = {
-            side,
-            tabIndex,
-            widgetId,
-            widgetIndex,
-        };
-        (0, appui_layout_react_1.removeTab)(nineZone, id);
+        hideWidget(nineZone, widgetDef);
     }
 });
+/** Stores widget location and hides it in the UI. */
+function hideWidget(state, widgetDef) {
+    const location = (0, appui_layout_react_1.findTab)(state, widgetDef.id);
+    if (!location)
+        return;
+    const widgetId = location.widgetId;
+    const side = "side" in location ? location.side : "left";
+    const widgetIndex = "side" in location ? state.panels[side].widgets.indexOf(widgetId) : 0;
+    const tabIndex = state.widgets[location.widgetId].tabs.indexOf(widgetDef.id);
+    widgetDef.tabLocation = {
+        side,
+        tabIndex,
+        widgetId,
+        widgetIndex,
+    };
+    (0, appui_layout_react_1.removeTab)(state, widgetDef.id);
+}
 /** @internal */
 exports.showWidget = (0, immer_1.default)((nineZone, id) => {
     const location = (0, appui_layout_react_1.findTab)(nineZone, id);
@@ -772,11 +800,16 @@ exports.setWidgetLabel = (0, immer_1.default)((nineZone, id, label) => {
 });
 /** @internal */
 function useSavedFrontstageState(frontstageDef) {
-    const uiSettingsStorage = (0, useUiSettings_1.useUiSettingsStorageContext)();
-    const uiSettingsRef = React.useRef(uiSettingsStorage);
+    const uiStateStorage = (0, useUiStateStorage_1.useUiStateStorageHandler)();
+    const uiStateStorageRef = React.useRef(uiStateStorage);
+    const isMountedRef = React.useRef(false);
+    React.useEffect(() => {
+        isMountedRef.current = true;
+        return () => { isMountedRef.current = false; };
+    }, []);
     React.useEffect(() => {
-        uiSettingsRef.current = uiSettingsStorage;
-    }, [uiSettingsStorage]);
+        uiStateStorageRef.current = uiStateStorage;
+    }, [uiStateStorage]);
     React.useEffect(() => {
         async function fetchFrontstageState() {
             if (frontstageDef.nineZoneState) {
@@ -785,17 +818,20 @@ function useSavedFrontstageState(frontstageDef) {
             }
             const id = frontstageDef.id;
             const version = frontstageDef.version;
-            const settingsResult = await uiSettingsRef.current.getSetting(exports.FRONTSTAGE_SETTINGS_NAMESPACE, getFrontstageStateSettingName(id));
-            if (isFrontstageStateSettingResult(settingsResult) &&
-                settingsResult.setting.version >= version &&
-                settingsResult.setting.stateVersion >= stateVersion) {
-                const restored = restoreNineZoneState(frontstageDef, settingsResult.setting.nineZone);
-                let state = addMissingWidgets(frontstageDef, restored);
-                state = processPopoutWidgets(state, frontstageDef);
-                frontstageDef.nineZoneState = state;
-                return;
+            const settingsResult = await uiStateStorageRef.current.getSetting(exports.FRONTSTAGE_SETTINGS_NAMESPACE, getFrontstageStateSettingName(id));
+            if (isMountedRef.current) {
+                if (isFrontstageStateSettingResult(settingsResult) &&
+                    settingsResult.setting.version >= version &&
+                    settingsResult.setting.stateVersion >= stateVersion) {
+                    const restored = restoreNineZoneState(frontstageDef, settingsResult.setting.nineZone);
+                    let state = addMissingWidgets(frontstageDef, restored);
+                    state = removeHiddenWidgets(state, frontstageDef);
+                    state = processPopoutWidgets(state, frontstageDef);
+                    frontstageDef.nineZoneState = state;
+                    return;
+                }
+                frontstageDef.nineZoneState = initializeNineZoneState(frontstageDef);
             }
-            frontstageDef.nineZoneState = initializeNineZoneState(frontstageDef);
         }
         fetchFrontstageState(); // eslint-disable-line @typescript-eslint/no-floating-promises
     }, [frontstageDef]);
@@ -804,7 +840,7 @@ exports.useSavedFrontstageState = useSavedFrontstageState;
 /** @internal */
 function useSaveFrontstageSettings(frontstageDef) {
     const nineZone = useNineZoneState(frontstageDef);
-    const uiSettingsStorage = (0, useUiSettings_1.useUiSettingsStorageContext)();
+    const uiSettingsStorage = (0, useUiStateStorage_1.useUiStateStorageHandler)();
     // eslint-disable-next-line react-hooks/exhaustive-deps
     const saveSetting = React.useCallback(debounce(async (id, version, state) => {
         const setting = {
@@ -891,7 +927,7 @@ function useFrontstageManager(frontstageDef) {
             FrontstageManager_1.FrontstageManager.onWidgetExpandEvent.removeListener(listener);
         };
     }, [frontstageDef]);
-    const uiSettingsStorage = (0, useUiSettings_1.useUiSettingsStorageContext)();
+    const uiSettingsStorage = (0, useUiStateStorage_1.useUiStateStorageHandler)();
     React.useEffect(() => {
         const listener = (args) => {
             // TODO: track restoring frontstages to support workflows:  i.e. prevent loading frontstage OR saving layout when delete is pending
@@ -932,6 +968,7 @@ function useItemsManager(frontstageDef) {
             return;
         state = addMissingWidgets(def, state);
         state = removeMissingWidgets(def, state);
+        state = removeHiddenWidgets(state, def); // TODO: should only apply to widgets provided by registered provider in onUiProviderRegisteredEvent.
         def.nineZoneState = state;
     };
     React.useEffect(() => {
@@ -960,53 +997,6 @@ function determineNewWidgets(defs, state) {
     return (defs || []).filter((def) => !(def.id in state.tabs) || !tabShownInCurrentWidget(def, state));
 }
 /** @internal */
-function useSyncDefinitions(frontstageDef) {
-    const nineZone = useNineZoneState(frontstageDef);
-    React.useEffect(() => {
-        if (!nineZone)
-            return;
-        for (const panelSide of appui_layout_react_1.panelSides) {
-            const panel = nineZone.panels[panelSide];
-            const location = toStagePanelLocation(panelSide);
-            const panelDef = frontstageDef.getStagePanelDef(location);
-            if (panelDef) {
-                panelDef.size = panel.size;
-                let newState = panel.collapsed ? StagePanelDef_1.StagePanelState.Minimized : StagePanelDef_1.StagePanelState.Open;
-                if (panelDef.panelState === StagePanelDef_1.StagePanelState.Off && newState === StagePanelDef_1.StagePanelState.Minimized)
-                    newState = StagePanelDef_1.StagePanelState.Off;
-                panelDef.panelState = newState;
-            }
-            for (const widgetId of panel.widgets) {
-                const widget = nineZone.widgets[widgetId];
-                // istanbul ignore else
-                if (widget) {
-                    for (const tabId of widget.tabs) {
-                        const widgetDef = frontstageDef.findWidgetDef(tabId);
-                        let widgetState = appui_abstract_1.WidgetState.Open;
-                        if (widget.minimized || tabId !== widget.activeTabId)
-                            widgetState = appui_abstract_1.WidgetState.Closed;
-                        widgetDef && widgetDef.setWidgetState(widgetState);
-                    }
-                }
-            }
-        }
-        for (const widgetId of nineZone.floatingWidgets.allIds) {
-            const widget = nineZone.widgets[widgetId];
-            // istanbul ignore else
-            if (widget) {
-                for (const tabId of widget.tabs) {
-                    const widgetDef = frontstageDef.findWidgetDef(tabId);
-                    let widgetState = appui_abstract_1.WidgetState.Open;
-                    if (widget.minimized || tabId !== widget.activeTabId)
-                        widgetState = appui_abstract_1.WidgetState.Closed;
-                    widgetDef && widgetDef.setWidgetState(widgetState);
-                }
-            }
-        }
-    }, [nineZone, frontstageDef]);
-}
-exports.useSyncDefinitions = useSyncDefinitions;
-/** @internal */
 async function saveFrontstagePopoutWidgetSizeAndPosition(state, stageId, stageVersion, childWindowId, childWindow) {
     const location = (0, appui_layout_react_1.findWidget)(state, childWindowId);
     // istanbul ignore else
@@ -1029,7 +1019,7 @@ async function saveFrontstagePopoutWidgetSizeAndPosition(state, stageId, stageVe
             stateVersion,
             version: stageVersion,
         };
-        await UiFramework_1.UiFramework.getUiSettingsStorage().saveSetting(exports.FRONTSTAGE_SETTINGS_NAMESPACE, getFrontstageStateSettingName(stageId), setting);
+        await UiFramework_1.UiFramework.getUiStateStorage().saveSetting(exports.FRONTSTAGE_SETTINGS_NAMESPACE, getFrontstageStateSettingName(stageId), setting);
         return newState;
     }
     // istanbul ignore next