@itwin/appui-react 4.6.3 → 4.7.0

package/lib/cjs/appui-react/uistate/AppUiSettings.d.ts

@@ -4,11 +4,12 @@
 import type { UiStateStorage } from "@itwin/core-react";
 import { UiStateEntry } from "@itwin/core-react";
 import type { UserSettingsProvider } from "../UiFramework";
+import type { ThemeId } from "../theme/ThemeManager";
 /** Default values that may be specified for [[AppUiSettings]].
  * @public
  */
 export interface InitialAppUiSettings {
-    colorTheme: string;
+    colorTheme: ThemeId;
     dragInteraction: boolean;
     widgetOpacity: number;
     showWidgetIcon?: boolean;
@@ -18,8 +19,8 @@ export interface InitialAppUiSettings {
     useToolAsToolSettingsLabel?: boolean;
     toolbarOpacity: number;
 }
-/** These are the UI settings that are stored in the Redux store. They control the color theme, the UI version,
- * how toolbar group buttons work, and the opacity of widgets in 1.0 and floating widget in 2.0 when the cursor
+/** These are the UI settings that are stored in the Redux store. They control the color theme,
+ * how toolbar group buttons work, and the opacity of floating widget when the cursor
  * is not inside them. It is expect that an IModelApp using App UI components will create and register AppUiSettings with
  * defaults specific to their application. This would be done by calling the following.
  *
@@ -34,7 +35,7 @@ export declare class AppUiSettings implements UserSettingsProvider {
     private static _settingNamespace;
     private _settings;
     private _applyingLocalSettings;
-    colorTheme: UiStateEntry<string>;
+    colorTheme: UiStateEntry<ThemeId>;
     dragInteraction: UiStateEntry<boolean>;
     widgetOpacity: UiStateEntry<number>;
     showWidgetIcon: UiStateEntry<boolean>;

package/lib/cjs/appui-react/uistate/AppUiSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AppUiSettings.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/uistate/AppUiSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAM3D;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,OAAO,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa;IACb,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;;GAUG;AACH,qBAAa,aAAc,YAAW,oBAAoB;IACxD,SAAgB,UAAU,2BAA2B;IAErD,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAmB;IACnD,OAAO,CAAC,SAAS,CAAgC;IACjD,OAAO,CAAC,sBAAsB,CAAS;IAEhC,UAAU,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IACjC,eAAe,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IACvC,aAAa,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IACpC,cAAc,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IACtC,0BAA0B,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAClD,mBAAmB,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAC3C,0BAA0B,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAClD,cAAc,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IAE5C,OAAO,CAAC,aAAa,CAInB;gBAEU,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC;IA8EnD,OAAO,CAAC,iBAAiB,CAsCvB;IAEW,KAAK,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ7C,gBAAgB,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAGtE"}
+{"version":3,"file":"AppUiSettings.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/uistate/AppUiSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAG3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAIrD;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,OAAO,CAAC;IACpB,eAAe,EAAE,OAAO,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa;IACb,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;;GAUG;AACH,qBAAa,aAAc,YAAW,oBAAoB;IACxD,SAAgB,UAAU,2BAA2B;IAErD,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAmB;IACnD,OAAO,CAAC,SAAS,CAAgC;IACjD,OAAO,CAAC,sBAAsB,CAAS;IAEhC,UAAU,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAClC,eAAe,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IACvC,aAAa,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IACpC,cAAc,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IACtC,0BAA0B,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAClD,mBAAmB,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAC3C,0BAA0B,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAClD,cAAc,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IAE5C,OAAO,CAAC,aAAa,CAInB;gBAEU,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC;IA8EnD,OAAO,CAAC,iBAAiB,CAsCvB;IAEW,KAAK,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ7C,gBAAgB,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAGtE"}

package/lib/cjs/appui-react/uistate/AppUiSettings.js

@@ -11,8 +11,8 @@ exports.AppUiSettings = void 0;
 const core_react_1 = require("@itwin/core-react");
 const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
 const UiFramework_1 = require("../UiFramework");
-/** These are the UI settings that are stored in the Redux store. They control the color theme, the UI version,
- * how toolbar group buttons work, and the opacity of widgets in 1.0 and floating widget in 2.0 when the cursor
+/** These are the UI settings that are stored in the Redux store. They control the color theme,
+ * how toolbar group buttons work, and the opacity of floating widget when the cursor
  * is not inside them. It is expect that an IModelApp using App UI components will create and register AppUiSettings with
  * defaults specific to their application. This would be done by calling the following.
  *

package/lib/cjs/appui-react/uistate/AppUiSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppUiSettings.js","sourceRoot":"","sources":["../../../../src/appui-react/uistate/AppUiSettings.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAGH,kDAAiD;AACjD,2EAAwE;AAExE,gDAA6C;AAoB7C;;;;;;;;;;GAUG;AACH,MAAa,aAAa;IAsBxB,YAAY,QAAuC;QArBnC,eAAU,GAAG,uBAAuB,CAAC;QAG7C,cAAS,GAA6B,EAAE,CAAC;QACzC,2BAAsB,GAAG,KAAK,CAAC;QAW/B,kBAAa,GAAG,CAAC,KAAa,EAAE,EAAE;YACxC,yBAAW,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACjC,6FAA6F;YAC7F,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;QAC1D,CAAC,CAAC;QAgFM,sBAAiB,GAAG,KAAK,EAAE,IAAqB,EAAE,EAAE;YAC1D,IAAI,IAAI,CAAC,sBAAsB;gBAAE,OAAO;YAExC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,0BAA0B,CAAC,EAAE;gBACjD,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBACnE,8GAA8G;gBAC9G,MAAM,CAAC,YAAY,CAAC,OAAO,CACzB,mBAAmB,EACnB,yBAAW,CAAC,aAAa,EAAE,CAC5B,CAAC;aACH;YAED,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qCAAqC,CAAC;gBAC1D,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAE1E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qCAAqC,CAAC;gBAC1D,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAEzE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,kDAAkD,CAAC;gBACvE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAC/C,yBAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;YAEJ,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,mCAAmC,CAAC;gBACxD,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAExE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,0CAA0C,CAAC;gBAC/D,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,CACxC,yBAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;YAEJ,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oDAAoD,CAAC;gBACzE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAC/C,yBAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;YAEJ,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oCAAoC,CAAC;gBACzD,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC;QAnHA,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,UAAU,GAAG,IAAI,yBAAY,CAChC,aAAa,CAAC,iBAAiB,EAC/B,YAAY,EACZ,yBAAW,CAAC,aAAa,EACzB,IAAI,CAAC,aAAa,EAClB,QAAQ,CAAC,UAAU,CACpB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErC,IAAI,CAAC,eAAe,GAAG,IAAI,yBAAY,CACrC,aAAa,CAAC,iBAAiB,EAC/B,iBAAiB,EACjB,GAAG,EAAE,CAAC,yBAAW,CAAC,kBAAkB,EACpC,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAC5D,QAAQ,CAAC,eAAe,CACzB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE1C,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAY,CACpC,aAAa,CAAC,iBAAiB,EAC/B,gBAAgB,EAChB,GAAG,EAAE,CAAC,yBAAW,CAAC,cAAc,EAChC,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EACxD,QAAQ,CAAC,cAAc,CACxB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,IAAI,CAAC,0BAA0B,GAAG,IAAI,yBAAY,CAChD,aAAa,CAAC,iBAAiB,EAC/B,4BAA4B,EAC5B,GAAG,EAAE,CAAC,yBAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EACpE,QAAQ,CAAC,0BAA0B,CACpC,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,aAAa,GAAG,IAAI,yBAAY,CACnC,aAAa,CAAC,iBAAiB,EAC/B,eAAe,EACf,GAAG,EAAE,CAAC,yBAAW,CAAC,gBAAgB,EAAE,EACpC,CAAC,KAAa,EAAE,EAAE,CAAC,yBAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,EACtD,QAAQ,CAAC,aAAa,CACvB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAExC,IAAI,CAAC,mBAAmB,GAAG,IAAI,yBAAY,CACzC,aAAa,CAAC,iBAAiB,EAC/B,qBAAqB,EACrB,GAAG,EAAE,CAAC,yBAAW,CAAC,mBAAmB,EACrC,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAC7D,QAAQ,CAAC,mBAAmB,CAC7B,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE9C,IAAI,CAAC,0BAA0B,GAAG,IAAI,yBAAY,CAChD,aAAa,CAAC,iBAAiB,EAC/B,4BAA4B,EAC5B,GAAG,EAAE,CAAC,yBAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EACpE,QAAQ,CAAC,0BAA0B,CACpC,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAY,CACpC,aAAa,CAAC,iBAAiB,EAC/B,aAAa,EACb,GAAG,EAAE,CAAC,yBAAW,CAAC,iBAAiB,EAAE,EACrC,CAAC,KAAa,EAAE,EAAE,CAAC,yBAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EACvD,QAAQ,CAAC,cAAc,CACxB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC1E,CAAC;IA0CM,KAAK,CAAC,KAAK,CAAC,OAAuB;QACxC,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;QACnC,IAAI,KAAK,EAAE,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE;YAC1C,MAAM,OAAO,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;SAChD;QACD,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC;IACtC,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,OAAuB;QACnD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;;AAnJc,+BAAiB,GAAG,eAAe,AAAlB,CAAmB;AAHxC,sCAAa","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Settings\n */\n\nimport type { UiStateStorage } from \"@itwin/core-react\";\nimport { UiStateEntry } from \"@itwin/core-react\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\nimport type { UserSettingsProvider } from \"../UiFramework\";\nimport { UiFramework } from \"../UiFramework\";\nimport type { UiSyncEventArgs } from \"../syncui/UiSyncEvent\";\n\n// cSpell:ignore configurableui\n\n/** Default values that may be specified for [[AppUiSettings]].\n * @public\n */\nexport interface InitialAppUiSettings {\n  colorTheme: string;\n  dragInteraction: boolean;\n  widgetOpacity: number;\n  showWidgetIcon?: boolean;\n  /** @alpha */\n  autoCollapseUnpinnedPanels?: boolean;\n  animateToolSettings?: boolean;\n  useToolAsToolSettingsLabel?: boolean;\n  toolbarOpacity: number;\n}\n\n/** These are the UI settings that are stored in the Redux store. They control the color theme, the UI version,\n * how toolbar group buttons work, and the opacity of widgets in 1.0 and floating widget in 2.0 when the cursor\n * is not inside them. It is expect that an IModelApp using App UI components will create and register AppUiSettings with\n * defaults specific to their application. This would be done by calling the following.\n *\n * ```ts\n * UiFramework.registerUserSettingsProvider(new AppUiSettings(defaults));\n * ```\n *\n * @public\n */\nexport class AppUiSettings implements UserSettingsProvider {\n  public readonly providerId = \"AppUiSettingsProvider\";\n\n  private static _settingNamespace = \"AppUiSettings\";\n  private _settings: Array<UiStateEntry<any>> = [];\n  private _applyingLocalSettings = false;\n\n  public colorTheme: UiStateEntry<string>;\n  public dragInteraction: UiStateEntry<boolean>;\n  public widgetOpacity: UiStateEntry<number>;\n  public showWidgetIcon: UiStateEntry<boolean>;\n  public autoCollapseUnpinnedPanels: UiStateEntry<boolean>;\n  public animateToolSettings: UiStateEntry<boolean>;\n  public useToolAsToolSettingsLabel: UiStateEntry<boolean>;\n  public toolbarOpacity: UiStateEntry<number>;\n\n  private setColorTheme = (theme: string) => {\n    UiFramework.setColorTheme(theme);\n    // always store to local storage to avoid flicker during startup if user is not yet logged-in\n    window.localStorage.setItem(\"uifw:defaultTheme\", theme);\n  };\n\n  constructor(defaults: Partial<InitialAppUiSettings>) {\n    this._settings = [];\n\n    this.colorTheme = new UiStateEntry<string>(\n      AppUiSettings._settingNamespace,\n      \"ColorTheme\",\n      UiFramework.getColorTheme,\n      this.setColorTheme,\n      defaults.colorTheme\n    );\n    this._settings.push(this.colorTheme);\n\n    this.dragInteraction = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"DragInteraction\",\n      () => UiFramework.useDragInteraction,\n      (value: boolean) => UiFramework.setUseDragInteraction(value),\n      defaults.dragInteraction\n    );\n    this._settings.push(this.dragInteraction);\n\n    this.showWidgetIcon = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"ShowWidgetIcon\",\n      () => UiFramework.showWidgetIcon,\n      (value: boolean) => UiFramework.setShowWidgetIcon(value),\n      defaults.showWidgetIcon\n    );\n    this._settings.push(this.showWidgetIcon);\n\n    this.autoCollapseUnpinnedPanels = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"AutoCollapseUnpinnedPanels\",\n      () => UiFramework.autoCollapseUnpinnedPanels,\n      (value: boolean) => UiFramework.setAutoCollapseUnpinnedPanels(value),\n      defaults.autoCollapseUnpinnedPanels\n    );\n    this._settings.push(this.autoCollapseUnpinnedPanels);\n\n    this.widgetOpacity = new UiStateEntry<number>(\n      AppUiSettings._settingNamespace,\n      \"WidgetOpacity\",\n      () => UiFramework.getWidgetOpacity(),\n      (value: number) => UiFramework.setWidgetOpacity(value),\n      defaults.widgetOpacity\n    );\n    this._settings.push(this.widgetOpacity);\n\n    this.animateToolSettings = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"AnimateToolSettings\",\n      () => UiFramework.animateToolSettings,\n      (value: boolean) => UiFramework.setAnimateToolSettings(value),\n      defaults.animateToolSettings\n    );\n    this._settings.push(this.animateToolSettings);\n\n    this.useToolAsToolSettingsLabel = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"UseToolAsToolSettingsLabel\",\n      () => UiFramework.useToolAsToolSettingsLabel,\n      (value: boolean) => UiFramework.setUseToolAsToolSettingsLabel(value),\n      defaults.useToolAsToolSettingsLabel\n    );\n    this._settings.push(this.useToolAsToolSettingsLabel);\n\n    this.toolbarOpacity = new UiStateEntry<number>(\n      AppUiSettings._settingNamespace,\n      \"ToolOpacity\",\n      () => UiFramework.getToolbarOpacity(),\n      (value: number) => UiFramework.setToolbarOpacity(value),\n      defaults.toolbarOpacity\n    );\n    this._settings.push(this.toolbarOpacity);\n\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(this.handleSyncUiEvent);\n  }\n\n  private handleSyncUiEvent = async (args: UiSyncEventArgs) => {\n    if (this._applyingLocalSettings) return;\n\n    if (args.eventIds.has(\"configurableui:set_theme\")) {\n      await this.colorTheme.saveSetting(UiFramework.getUiStateStorage());\n      // always store as default theme in local storage to avoid flicker during startup if user is not yet logged-in\n      window.localStorage.setItem(\n        \"uifw:defaultTheme\",\n        UiFramework.getColorTheme()\n      );\n    }\n\n    if (args.eventIds.has(\"configurableui:set-drag-interaction\"))\n      await this.dragInteraction.saveSetting(UiFramework.getUiStateStorage());\n\n    if (args.eventIds.has(\"configurableui:set-show-widget-icon\"))\n      await this.showWidgetIcon.saveSetting(UiFramework.getUiStateStorage());\n\n    if (args.eventIds.has(\"configurableui:set-auto-collapse-unpinned-panels\"))\n      await this.autoCollapseUnpinnedPanels.saveSetting(\n        UiFramework.getUiStateStorage()\n      );\n\n    if (args.eventIds.has(\"configurableui:set_widget_opacity\"))\n      await this.widgetOpacity.saveSetting(UiFramework.getUiStateStorage());\n\n    if (args.eventIds.has(\"configurableui:set-animate-tool-settings\"))\n      await this.animateToolSettings.saveSetting(\n        UiFramework.getUiStateStorage()\n      );\n\n    if (args.eventIds.has(\"configurableui:set-use-tool-as-tool-settings-label\"))\n      await this.useToolAsToolSettingsLabel.saveSetting(\n        UiFramework.getUiStateStorage()\n      );\n\n    if (args.eventIds.has(\"configurableui:set-toolbar-opacity\"))\n      await this.toolbarOpacity.saveSetting(UiFramework.getUiStateStorage());\n  };\n\n  public async apply(storage: UiStateStorage): Promise<void> {\n    this._applyingLocalSettings = true;\n    for await (const setting of this._settings) {\n      await setting.getSettingAndApplyValue(storage);\n    }\n    this._applyingLocalSettings = false;\n  }\n\n  public async loadUserSettings(storage: UiStateStorage): Promise<void> {\n    await this.apply(storage);\n  }\n}\n"]}
+{"version":3,"file":"AppUiSettings.js","sourceRoot":"","sources":["../../../../src/appui-react/uistate/AppUiSettings.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAGH,kDAAiD;AACjD,2EAAwE;AAExE,gDAA6C;AAqB7C;;;;;;;;;;GAUG;AACH,MAAa,aAAa;IAsBxB,YAAY,QAAuC;QArBnC,eAAU,GAAG,uBAAuB,CAAC;QAG7C,cAAS,GAA6B,EAAE,CAAC;QACzC,2BAAsB,GAAG,KAAK,CAAC;QAW/B,kBAAa,GAAG,CAAC,KAAc,EAAE,EAAE;YACzC,yBAAW,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACjC,6FAA6F;YAC7F,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;QAC1D,CAAC,CAAC;QAgFM,sBAAiB,GAAG,KAAK,EAAE,IAAqB,EAAE,EAAE;YAC1D,IAAI,IAAI,CAAC,sBAAsB;gBAAE,OAAO;YAExC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,0BAA0B,CAAC,EAAE;gBACjD,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBACnE,8GAA8G;gBAC9G,MAAM,CAAC,YAAY,CAAC,OAAO,CACzB,mBAAmB,EACnB,yBAAW,CAAC,aAAa,EAAE,CAC5B,CAAC;aACH;YAED,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qCAAqC,CAAC;gBAC1D,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAE1E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qCAAqC,CAAC;gBAC1D,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAEzE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,kDAAkD,CAAC;gBACvE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAC/C,yBAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;YAEJ,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,mCAAmC,CAAC;gBACxD,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAExE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,0CAA0C,CAAC;gBAC/D,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,CACxC,yBAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;YAEJ,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oDAAoD,CAAC;gBACzE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAC/C,yBAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;YAEJ,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oCAAoC,CAAC;gBACzD,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC;QAnHA,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,UAAU,GAAG,IAAI,yBAAY,CAChC,aAAa,CAAC,iBAAiB,EAC/B,YAAY,EACZ,yBAAW,CAAC,aAAa,EACzB,IAAI,CAAC,aAAa,EAClB,QAAQ,CAAC,UAAU,CACpB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErC,IAAI,CAAC,eAAe,GAAG,IAAI,yBAAY,CACrC,aAAa,CAAC,iBAAiB,EAC/B,iBAAiB,EACjB,GAAG,EAAE,CAAC,yBAAW,CAAC,kBAAkB,EACpC,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAC5D,QAAQ,CAAC,eAAe,CACzB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE1C,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAY,CACpC,aAAa,CAAC,iBAAiB,EAC/B,gBAAgB,EAChB,GAAG,EAAE,CAAC,yBAAW,CAAC,cAAc,EAChC,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EACxD,QAAQ,CAAC,cAAc,CACxB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,IAAI,CAAC,0BAA0B,GAAG,IAAI,yBAAY,CAChD,aAAa,CAAC,iBAAiB,EAC/B,4BAA4B,EAC5B,GAAG,EAAE,CAAC,yBAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EACpE,QAAQ,CAAC,0BAA0B,CACpC,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,aAAa,GAAG,IAAI,yBAAY,CACnC,aAAa,CAAC,iBAAiB,EAC/B,eAAe,EACf,GAAG,EAAE,CAAC,yBAAW,CAAC,gBAAgB,EAAE,EACpC,CAAC,KAAa,EAAE,EAAE,CAAC,yBAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,EACtD,QAAQ,CAAC,aAAa,CACvB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAExC,IAAI,CAAC,mBAAmB,GAAG,IAAI,yBAAY,CACzC,aAAa,CAAC,iBAAiB,EAC/B,qBAAqB,EACrB,GAAG,EAAE,CAAC,yBAAW,CAAC,mBAAmB,EACrC,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAC7D,QAAQ,CAAC,mBAAmB,CAC7B,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE9C,IAAI,CAAC,0BAA0B,GAAG,IAAI,yBAAY,CAChD,aAAa,CAAC,iBAAiB,EAC/B,4BAA4B,EAC5B,GAAG,EAAE,CAAC,yBAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EACpE,QAAQ,CAAC,0BAA0B,CACpC,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAY,CACpC,aAAa,CAAC,iBAAiB,EAC/B,aAAa,EACb,GAAG,EAAE,CAAC,yBAAW,CAAC,iBAAiB,EAAE,EACrC,CAAC,KAAa,EAAE,EAAE,CAAC,yBAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EACvD,QAAQ,CAAC,cAAc,CACxB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC1E,CAAC;IA0CM,KAAK,CAAC,KAAK,CAAC,OAAuB;QACxC,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;QACnC,IAAI,KAAK,EAAE,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE;YAC1C,MAAM,OAAO,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;SAChD;QACD,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC;IACtC,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,OAAuB;QACnD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;;AAnJc,+BAAiB,GAAG,eAAe,AAAlB,CAAmB;AAHxC,sCAAa","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Settings\n */\n\nimport type { UiStateStorage } from \"@itwin/core-react\";\nimport { UiStateEntry } from \"@itwin/core-react\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\nimport type { UserSettingsProvider } from \"../UiFramework\";\nimport { UiFramework } from \"../UiFramework\";\nimport type { UiSyncEventArgs } from \"../syncui/UiSyncEvent\";\nimport type { ThemeId } from \"../theme/ThemeManager\";\n\n// cSpell:ignore configurableui\n\n/** Default values that may be specified for [[AppUiSettings]].\n * @public\n */\nexport interface InitialAppUiSettings {\n  colorTheme: ThemeId;\n  dragInteraction: boolean;\n  widgetOpacity: number;\n  showWidgetIcon?: boolean;\n  /** @alpha */\n  autoCollapseUnpinnedPanels?: boolean;\n  animateToolSettings?: boolean;\n  useToolAsToolSettingsLabel?: boolean;\n  toolbarOpacity: number;\n}\n\n/** These are the UI settings that are stored in the Redux store. They control the color theme,\n * how toolbar group buttons work, and the opacity of floating widget when the cursor\n * is not inside them. It is expect that an IModelApp using App UI components will create and register AppUiSettings with\n * defaults specific to their application. This would be done by calling the following.\n *\n * ```ts\n * UiFramework.registerUserSettingsProvider(new AppUiSettings(defaults));\n * ```\n *\n * @public\n */\nexport class AppUiSettings implements UserSettingsProvider {\n  public readonly providerId = \"AppUiSettingsProvider\";\n\n  private static _settingNamespace = \"AppUiSettings\";\n  private _settings: Array<UiStateEntry<any>> = [];\n  private _applyingLocalSettings = false;\n\n  public colorTheme: UiStateEntry<ThemeId>;\n  public dragInteraction: UiStateEntry<boolean>;\n  public widgetOpacity: UiStateEntry<number>;\n  public showWidgetIcon: UiStateEntry<boolean>;\n  public autoCollapseUnpinnedPanels: UiStateEntry<boolean>;\n  public animateToolSettings: UiStateEntry<boolean>;\n  public useToolAsToolSettingsLabel: UiStateEntry<boolean>;\n  public toolbarOpacity: UiStateEntry<number>;\n\n  private setColorTheme = (theme: ThemeId) => {\n    UiFramework.setColorTheme(theme);\n    // always store to local storage to avoid flicker during startup if user is not yet logged-in\n    window.localStorage.setItem(\"uifw:defaultTheme\", theme);\n  };\n\n  constructor(defaults: Partial<InitialAppUiSettings>) {\n    this._settings = [];\n\n    this.colorTheme = new UiStateEntry<ThemeId>(\n      AppUiSettings._settingNamespace,\n      \"ColorTheme\",\n      UiFramework.getColorTheme,\n      this.setColorTheme,\n      defaults.colorTheme\n    );\n    this._settings.push(this.colorTheme);\n\n    this.dragInteraction = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"DragInteraction\",\n      () => UiFramework.useDragInteraction,\n      (value: boolean) => UiFramework.setUseDragInteraction(value),\n      defaults.dragInteraction\n    );\n    this._settings.push(this.dragInteraction);\n\n    this.showWidgetIcon = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"ShowWidgetIcon\",\n      () => UiFramework.showWidgetIcon,\n      (value: boolean) => UiFramework.setShowWidgetIcon(value),\n      defaults.showWidgetIcon\n    );\n    this._settings.push(this.showWidgetIcon);\n\n    this.autoCollapseUnpinnedPanels = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"AutoCollapseUnpinnedPanels\",\n      () => UiFramework.autoCollapseUnpinnedPanels,\n      (value: boolean) => UiFramework.setAutoCollapseUnpinnedPanels(value),\n      defaults.autoCollapseUnpinnedPanels\n    );\n    this._settings.push(this.autoCollapseUnpinnedPanels);\n\n    this.widgetOpacity = new UiStateEntry<number>(\n      AppUiSettings._settingNamespace,\n      \"WidgetOpacity\",\n      () => UiFramework.getWidgetOpacity(),\n      (value: number) => UiFramework.setWidgetOpacity(value),\n      defaults.widgetOpacity\n    );\n    this._settings.push(this.widgetOpacity);\n\n    this.animateToolSettings = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"AnimateToolSettings\",\n      () => UiFramework.animateToolSettings,\n      (value: boolean) => UiFramework.setAnimateToolSettings(value),\n      defaults.animateToolSettings\n    );\n    this._settings.push(this.animateToolSettings);\n\n    this.useToolAsToolSettingsLabel = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"UseToolAsToolSettingsLabel\",\n      () => UiFramework.useToolAsToolSettingsLabel,\n      (value: boolean) => UiFramework.setUseToolAsToolSettingsLabel(value),\n      defaults.useToolAsToolSettingsLabel\n    );\n    this._settings.push(this.useToolAsToolSettingsLabel);\n\n    this.toolbarOpacity = new UiStateEntry<number>(\n      AppUiSettings._settingNamespace,\n      \"ToolOpacity\",\n      () => UiFramework.getToolbarOpacity(),\n      (value: number) => UiFramework.setToolbarOpacity(value),\n      defaults.toolbarOpacity\n    );\n    this._settings.push(this.toolbarOpacity);\n\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(this.handleSyncUiEvent);\n  }\n\n  private handleSyncUiEvent = async (args: UiSyncEventArgs) => {\n    if (this._applyingLocalSettings) return;\n\n    if (args.eventIds.has(\"configurableui:set_theme\")) {\n      await this.colorTheme.saveSetting(UiFramework.getUiStateStorage());\n      // always store as default theme in local storage to avoid flicker during startup if user is not yet logged-in\n      window.localStorage.setItem(\n        \"uifw:defaultTheme\",\n        UiFramework.getColorTheme()\n      );\n    }\n\n    if (args.eventIds.has(\"configurableui:set-drag-interaction\"))\n      await this.dragInteraction.saveSetting(UiFramework.getUiStateStorage());\n\n    if (args.eventIds.has(\"configurableui:set-show-widget-icon\"))\n      await this.showWidgetIcon.saveSetting(UiFramework.getUiStateStorage());\n\n    if (args.eventIds.has(\"configurableui:set-auto-collapse-unpinned-panels\"))\n      await this.autoCollapseUnpinnedPanels.saveSetting(\n        UiFramework.getUiStateStorage()\n      );\n\n    if (args.eventIds.has(\"configurableui:set_widget_opacity\"))\n      await this.widgetOpacity.saveSetting(UiFramework.getUiStateStorage());\n\n    if (args.eventIds.has(\"configurableui:set-animate-tool-settings\"))\n      await this.animateToolSettings.saveSetting(\n        UiFramework.getUiStateStorage()\n      );\n\n    if (args.eventIds.has(\"configurableui:set-use-tool-as-tool-settings-label\"))\n      await this.useToolAsToolSettingsLabel.saveSetting(\n        UiFramework.getUiStateStorage()\n      );\n\n    if (args.eventIds.has(\"configurableui:set-toolbar-opacity\"))\n      await this.toolbarOpacity.saveSetting(UiFramework.getUiStateStorage());\n  };\n\n  public async apply(storage: UiStateStorage): Promise<void> {\n    this._applyingLocalSettings = true;\n    for await (const setting of this._settings) {\n      await setting.getSettingAndApplyValue(storage);\n    }\n    this._applyingLocalSettings = false;\n  }\n\n  public async loadUserSettings(storage: UiStateStorage): Promise<void> {\n    await this.apply(storage);\n  }\n}\n"]}

package/lib/cjs/appui-react/uistate/useUiStateStorage.d.ts

@@ -13,7 +13,16 @@ export declare const UiStateStorageContext: React.Context<UiStateStorage>;
 export interface UiSettingsProviderProps {
     children?: React.ReactNode;
 }
-/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings.
+/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings
+ * through [[UiFramework.setUiStateStorage]].
+ *
+ * This component should wrap the [[ConfigurableUiContent]].
+ *
+ * ```tsx
+ *  <UiStateStorageHandler>
+ *    <ConfigurableUiContent />
+ *  </UiStateStorageHandler>
+ * ```
  * @public
  */
 export declare function UiStateStorageHandler(props: UiSettingsProviderProps): JSX.Element;

package/lib/cjs/appui-react/uistate/useUiStateStorage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useUiStateStorage.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/uistate/useUiStateStorage.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AASxD,cAAc;AACd,wBAAgB,wBAAwB,IAAI,cAAc,CAEzD;AAED,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,+BAEjC,CAAC;AAGF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,uBAAuB,eAyBnE"}
+{"version":3,"file":"useUiStateStorage.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/uistate/useUiStateStorage.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AASxD,cAAc;AACd,wBAAgB,wBAAwB,IAAI,cAAc,CAEzD;AAED,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,+BAEjC,CAAC;AAGF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,uBAAuB,eAyBnE"}

package/lib/cjs/appui-react/uistate/useUiStateStorage.js

@@ -20,7 +20,16 @@ exports.useUiStateStorageHandler = useUiStateStorageHandler;
 /** @internal */
 exports.UiStateStorageContext = React.createContext(new core_react_1.LocalStateStorage());
 exports.UiStateStorageContext.displayName = "uifw:UiStateStorageContext";
-/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings.
+/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings
+ * through [[UiFramework.setUiStateStorage]].
+ *
+ * This component should wrap the [[ConfigurableUiContent]].
+ *
+ * ```tsx
+ *  <UiStateStorageHandler>
+ *    <ConfigurableUiContent />
+ *  </UiStateStorageHandler>
+ * ```
  * @public
  */
 function UiStateStorageHandler(props) {

package/lib/cjs/appui-react/uistate/useUiStateStorage.js.map

@@ -1 +1 @@
-{"version":3,"file":"useUiStateStorage.js","sourceRoot":"","sources":["../../../../src/appui-react/uistate/useUiStateStorage.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAEH,+BAA+B;AAE/B,kDAAsD;AACtD,gDAA6C;AAC7C,2EAGyC;AAGzC,cAAc;AACd,SAAgB,wBAAwB;IACtC,OAAO,KAAK,CAAC,UAAU,CAAC,6BAAqB,CAAC,CAAC;AACjD,CAAC;AAFD,4DAEC;AAED,gBAAgB;AACH,QAAA,qBAAqB,GAAG,KAAK,CAAC,aAAa,CACtD,IAAI,8BAAiB,EAAE,CACxB,CAAC;AACF,6BAAqB,CAAC,WAAW,GAAG,4BAA4B,CAAC;AASjE;;GAEG;AACH,SAAgB,qBAAqB,CAAC,KAA8B;IAClE,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CACpD,yBAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,IACE,6CAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE;gBACtD,qCAAa,CAAC,qBAAqB;aACpC,CAAC;gBAEF,eAAe,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACrD,CAAC,CAAC;QAEF,OAAO,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,OAAO,CACL,oBAAC,6BAAqB,CAAC,QAAQ,IAC7B,QAAQ,EAAE,KAAK,CAAC,QAAQ,EACxB,KAAK,EAAE,YAAY,GACnB,CACH,CAAC;AACJ,CAAC;AAzBD,sDAyBC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module UiStateStorage\n */\n\nimport * as React from \"react\";\nimport type { UiStateStorage } from \"@itwin/core-react\";\nimport { LocalStateStorage } from \"@itwin/core-react\";\nimport { UiFramework } from \"../UiFramework\";\nimport {\n  SyncUiEventDispatcher,\n  SyncUiEventId,\n} from \"../syncui/SyncUiEventDispatcher\";\nimport type { UiSyncEventArgs } from \"../syncui/UiSyncEvent\";\n\n/** @public */\nexport function useUiStateStorageHandler(): UiStateStorage {\n  return React.useContext(UiStateStorageContext);\n}\n\n/** @internal */\nexport const UiStateStorageContext = React.createContext<UiStateStorage>(\n  new LocalStateStorage()\n);\nUiStateStorageContext.displayName = \"uifw:UiStateStorageContext\";\n\n/** Properties for the [[UiStateStorageHandler]] component.\n * @public\n */\nexport interface UiSettingsProviderProps {\n  children?: React.ReactNode;\n}\n\n/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings.\n * @public\n */\nexport function UiStateStorageHandler(props: UiSettingsProviderProps) {\n  const [stateStorage, setStateStorage] = React.useState(\n    UiFramework.getUiStateStorage()\n  );\n\n  React.useEffect(() => {\n    // istanbul ignore next\n    const handleSyncUiEvent = (args: UiSyncEventArgs): void => {\n      if (\n        SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, [\n          SyncUiEventId.UiStateStorageChanged,\n        ])\n      )\n        setStateStorage(UiFramework.getUiStateStorage());\n    };\n\n    return SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);\n  });\n\n  return (\n    <UiStateStorageContext.Provider\n      children={props.children} // eslint-disable-line react/no-children-prop\n      value={stateStorage}\n    />\n  );\n}\n"]}
+{"version":3,"file":"useUiStateStorage.js","sourceRoot":"","sources":["../../../../src/appui-react/uistate/useUiStateStorage.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAEH,+BAA+B;AAE/B,kDAAsD;AACtD,gDAA6C;AAC7C,2EAGyC;AAGzC,cAAc;AACd,SAAgB,wBAAwB;IACtC,OAAO,KAAK,CAAC,UAAU,CAAC,6BAAqB,CAAC,CAAC;AACjD,CAAC;AAFD,4DAEC;AAED,gBAAgB;AACH,QAAA,qBAAqB,GAAG,KAAK,CAAC,aAAa,CACtD,IAAI,8BAAiB,EAAE,CACxB,CAAC;AACF,6BAAqB,CAAC,WAAW,GAAG,4BAA4B,CAAC;AASjE;;;;;;;;;;;GAWG;AACH,SAAgB,qBAAqB,CAAC,KAA8B;IAClE,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CACpD,yBAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,IACE,6CAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE;gBACtD,qCAAa,CAAC,qBAAqB;aACpC,CAAC;gBAEF,eAAe,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACrD,CAAC,CAAC;QAEF,OAAO,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,OAAO,CACL,oBAAC,6BAAqB,CAAC,QAAQ,IAC7B,QAAQ,EAAE,KAAK,CAAC,QAAQ,EACxB,KAAK,EAAE,YAAY,GACnB,CACH,CAAC;AACJ,CAAC;AAzBD,sDAyBC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module UiStateStorage\n */\n\nimport * as React from \"react\";\nimport type { UiStateStorage } from \"@itwin/core-react\";\nimport { LocalStateStorage } from \"@itwin/core-react\";\nimport { UiFramework } from \"../UiFramework\";\nimport {\n  SyncUiEventDispatcher,\n  SyncUiEventId,\n} from \"../syncui/SyncUiEventDispatcher\";\nimport type { UiSyncEventArgs } from \"../syncui/UiSyncEvent\";\n\n/** @public */\nexport function useUiStateStorageHandler(): UiStateStorage {\n  return React.useContext(UiStateStorageContext);\n}\n\n/** @internal */\nexport const UiStateStorageContext = React.createContext<UiStateStorage>(\n  new LocalStateStorage()\n);\nUiStateStorageContext.displayName = \"uifw:UiStateStorageContext\";\n\n/** Properties for the [[UiStateStorageHandler]] component.\n * @public\n */\nexport interface UiSettingsProviderProps {\n  children?: React.ReactNode;\n}\n\n/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings\n * through [[UiFramework.setUiStateStorage]].\n *\n * This component should wrap the [[ConfigurableUiContent]].\n *\n * ```tsx\n *  <UiStateStorageHandler>\n *    <ConfigurableUiContent />\n *  </UiStateStorageHandler>\n * ```\n * @public\n */\nexport function UiStateStorageHandler(props: UiSettingsProviderProps) {\n  const [stateStorage, setStateStorage] = React.useState(\n    UiFramework.getUiStateStorage()\n  );\n\n  React.useEffect(() => {\n    // istanbul ignore next\n    const handleSyncUiEvent = (args: UiSyncEventArgs): void => {\n      if (\n        SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, [\n          SyncUiEventId.UiStateStorageChanged,\n        ])\n      )\n        setStateStorage(UiFramework.getUiStateStorage());\n    };\n\n    return SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);\n  });\n\n  return (\n    <UiStateStorageContext.Provider\n      children={props.children} // eslint-disable-line react/no-children-prop\n      value={stateStorage}\n    />\n  );\n}\n"]}

package/lib/cjs/appui-react/utils/matchesWords.d.ts

@@ -0,0 +1,22 @@
+/** @packageDocumentation
+ * @module Utilities
+ */
+/**
+ * Interface that returns indices of matches
+ * @internal
+ */
+export interface IMatch {
+    start: number;
+    end: number;
+}
+/**
+ * Matches beginning of words supporting non-ASCII languages.
+ * @param word Filter string
+ * @param target String being searched
+ * @param contiguous - If true the filter string must be found "contiguous" in the searched string (E.g. "pul" will match "Git: Pull").
+ * Otherwise also matches sub string of the word with beginnings of the words in the target (e.g. "gp" or "g p" will match "Git: Pull").
+ * Useful in cases where the target is words (e.g. command labels)
+ * @internal
+ */
+export declare function matchesWords(word: string, target: string, contiguous?: boolean): IMatch[] | null;
+//# sourceMappingURL=matchesWords.d.ts.map

package/lib/cjs/appui-react/utils/matchesWords.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchesWords.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/matchesWords.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,UAAU,GAAE,OAAe,GAC1B,MAAM,EAAE,GAAG,IAAI,CAkBjB"}

package/lib/cjs/appui-react/utils/matchesWords.js

@@ -0,0 +1,103 @@
+"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 Utilities
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matchesWords = void 0;
+/**
+ * Matches beginning of words supporting non-ASCII languages.
+ * @param word Filter string
+ * @param target String being searched
+ * @param contiguous - If true the filter string must be found "contiguous" in the searched string (E.g. "pul" will match "Git: Pull").
+ * Otherwise also matches sub string of the word with beginnings of the words in the target (e.g. "gp" or "g p" will match "Git: Pull").
+ * Useful in cases where the target is words (e.g. command labels)
+ * @internal
+ */
+function matchesWords(word, target, contiguous = false) {
+    if (!target || target.length === 0) {
+        return null;
+    }
+    let result = null;
+    let i = 0;
+    word = word.toLowerCase();
+    target = target.toLowerCase();
+    while (i < target.length &&
+        (result = matchesWordsInternal(word, target, 0, i, contiguous)) === null) {
+        i = nextWord(target, i + 1);
+    }
+    return result;
+}
+exports.matchesWords = matchesWords;
+function matchesWordsInternal(word, target, i, j, contiguous) {
+    if (i === word.length) {
+        return [];
+    }
+    else if (j === target.length) {
+        return null;
+    }
+    else if (!charactersMatch(word.charCodeAt(i), target.charCodeAt(j))) {
+        return null;
+    }
+    else {
+        let result = null;
+        let nextWordIndex = j + 1;
+        result = matchesWordsInternal(word, target, i + 1, j + 1, contiguous);
+        if (!contiguous) {
+            while (!result &&
+                (nextWordIndex = nextWord(target, nextWordIndex)) < target.length) {
+                result = matchesWordsInternal(word, target, i + 1, nextWordIndex, contiguous);
+                nextWordIndex++;
+            }
+        }
+        return result === null ? null : join({ start: j, end: j + 1 }, result);
+    }
+}
+function nextWord(word, start) {
+    for (let i = start; i < word.length; i++) {
+        if (isWordSeparator(word.charCodeAt(i)) ||
+            (i > 0 && isWordSeparator(word.charCodeAt(i - 1)))) {
+            return i;
+        }
+    }
+    return word.length;
+}
+var CharCode;
+(function (CharCode) {
+    CharCode[CharCode["Space"] = 32] = "Space";
+    CharCode[CharCode["Tab"] = 9] = "Tab";
+    CharCode[CharCode["LineFeed"] = 10] = "LineFeed";
+    CharCode[CharCode["CarriageReturn"] = 13] = "CarriageReturn";
+})(CharCode || (CharCode = {}));
+function isWhitespace(code) {
+    return (code === CharCode.Space ||
+        code === CharCode.Tab ||
+        code === CharCode.LineFeed ||
+        code === CharCode.CarriageReturn);
+}
+const wordSeparators = new Set();
+"`~!@#$%^&*()-=+[{]}\\|;:'\",.<>/?"
+    .split("")
+    .forEach((s) => wordSeparators.add(s.charCodeAt(0)));
+function isWordSeparator(code) {
+    return isWhitespace(code) || wordSeparators.has(code);
+}
+function charactersMatch(codeA, codeB) {
+    return codeA === codeB || (isWordSeparator(codeA) && isWordSeparator(codeB));
+}
+function join(head, tail) {
+    if (tail.length === 0) {
+        tail = [head];
+    }
+    else if (head.end === tail[0].start) {
+        tail[0].start = head.start;
+    }
+    else {
+        tail.unshift(head);
+    }
+    return tail;
+}
+//# sourceMappingURL=matchesWords.js.map

package/lib/cjs/appui-react/utils/matchesWords.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchesWords.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/matchesWords.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAWH;;;;;;;;GAQG;AACH,SAAgB,YAAY,CAC1B,IAAY,EACZ,MAAc,EACd,aAAsB,KAAK;IAE3B,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QAClC,OAAO,IAAI,CAAC;KACb;IAED,IAAI,MAAM,GAAoB,IAAI,CAAC;IACnC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEV,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAC1B,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;IAC9B,OACE,CAAC,GAAG,MAAM,CAAC,MAAM;QACjB,CAAC,MAAM,GAAG,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC,KAAK,IAAI,EACxE;QACA,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;KAC7B;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAtBD,oCAsBC;AAED,SAAS,oBAAoB,CAC3B,IAAY,EACZ,MAAc,EACd,CAAS,EACT,CAAS,EACT,UAAmB;IAEnB,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE;QACrB,OAAO,EAAE,CAAC;KACX;SAAM,IAAI,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE;QAC9B,OAAO,IAAI,CAAC;KACb;SAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE;QACrE,OAAO,IAAI,CAAC;KACb;SAAM;QACL,IAAI,MAAM,GAAoB,IAAI,CAAC;QACnC,IAAI,aAAa,GAAG,CAAC,GAAG,CAAC,CAAC;QAC1B,MAAM,GAAG,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC;QACtE,IAAI,CAAC,UAAU,EAAE;YACf,OACE,CAAC,MAAM;gBACP,CAAC,aAAa,GAAG,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EACjE;gBACA,MAAM,GAAG,oBAAoB,CAC3B,IAAI,EACJ,MAAM,EACN,CAAC,GAAG,CAAC,EACL,aAAa,EACb,UAAU,CACX,CAAC;gBACF,aAAa,EAAE,CAAC;aACjB;SACF;QACD,OAAO,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;KACxE;AACH,CAAC;AAED,SAAS,QAAQ,CAAC,IAAY,EAAE,KAAa;IAC3C,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACxC,IACE,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACnC,CAAC,CAAC,GAAG,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAClD;YACA,OAAO,CAAC,CAAC;SACV;KACF;IACD,OAAO,IAAI,CAAC,MAAM,CAAC;AACrB,CAAC;AAED,IAAK,QAKJ;AALD,WAAK,QAAQ;IACX,0CAAU,CAAA;IACV,qCAAO,CAAA;IACP,gDAAa,CAAA;IACb,4DAAmB,CAAA;AACrB,CAAC,EALI,QAAQ,KAAR,QAAQ,QAKZ;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,OAAO,CACL,IAAI,KAAK,QAAQ,CAAC,KAAK;QACvB,IAAI,KAAK,QAAQ,CAAC,GAAG;QACrB,IAAI,KAAK,QAAQ,CAAC,QAAQ;QAC1B,IAAI,KAAK,QAAQ,CAAC,cAAc,CACjC,CAAC;AACJ,CAAC;AACD,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;AACzC,mCAAmC;KAChC,KAAK,CAAC,EAAE,CAAC;KACT,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEvD,SAAS,eAAe,CAAC,IAAY;IACnC,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,eAAe,CAAC,KAAa,EAAE,KAAa;IACnD,OAAO,KAAK,KAAK,KAAK,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;AAC/E,CAAC;AAED,SAAS,IAAI,CAAC,IAAY,EAAE,IAAc;IACxC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QACrB,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;KACf;SAAM,IAAI,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE;QACrC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;KAC5B;SAAM;QACL,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KACpB;IACD,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Utilities\n */\n\n/**\n * Interface that returns indices of matches\n * @internal\n */\nexport interface IMatch {\n  start: number;\n  end: number;\n}\n\n/**\n * Matches beginning of words supporting non-ASCII languages.\n * @param word Filter string\n * @param target String being searched\n * @param contiguous - If true the filter string must be found \"contiguous\" in the searched string (E.g. \"pul\" will match \"Git: Pull\").\n * Otherwise also matches sub string of the word with beginnings of the words in the target (e.g. \"gp\" or \"g p\" will match \"Git: Pull\").\n * Useful in cases where the target is words (e.g. command labels)\n * @internal\n */\nexport function matchesWords(\n  word: string,\n  target: string,\n  contiguous: boolean = false\n): IMatch[] | null {\n  if (!target || target.length === 0) {\n    return null;\n  }\n\n  let result: IMatch[] | null = null;\n  let i = 0;\n\n  word = word.toLowerCase();\n  target = target.toLowerCase();\n  while (\n    i < target.length &&\n    (result = matchesWordsInternal(word, target, 0, i, contiguous)) === null\n  ) {\n    i = nextWord(target, i + 1);\n  }\n\n  return result;\n}\n\nfunction matchesWordsInternal(\n  word: string,\n  target: string,\n  i: number,\n  j: number,\n  contiguous: boolean\n): IMatch[] | null {\n  if (i === word.length) {\n    return [];\n  } else if (j === target.length) {\n    return null;\n  } else if (!charactersMatch(word.charCodeAt(i), target.charCodeAt(j))) {\n    return null;\n  } else {\n    let result: IMatch[] | null = null;\n    let nextWordIndex = j + 1;\n    result = matchesWordsInternal(word, target, i + 1, j + 1, contiguous);\n    if (!contiguous) {\n      while (\n        !result &&\n        (nextWordIndex = nextWord(target, nextWordIndex)) < target.length\n      ) {\n        result = matchesWordsInternal(\n          word,\n          target,\n          i + 1,\n          nextWordIndex,\n          contiguous\n        );\n        nextWordIndex++;\n      }\n    }\n    return result === null ? null : join({ start: j, end: j + 1 }, result);\n  }\n}\n\nfunction nextWord(word: string, start: number): number {\n  for (let i = start; i < word.length; i++) {\n    if (\n      isWordSeparator(word.charCodeAt(i)) ||\n      (i > 0 && isWordSeparator(word.charCodeAt(i - 1)))\n    ) {\n      return i;\n    }\n  }\n  return word.length;\n}\n\nenum CharCode {\n  Space = 32,\n  Tab = 9,\n  LineFeed = 10,\n  CarriageReturn = 13,\n}\n\nfunction isWhitespace(code: number): boolean {\n  return (\n    code === CharCode.Space ||\n    code === CharCode.Tab ||\n    code === CharCode.LineFeed ||\n    code === CharCode.CarriageReturn\n  );\n}\nconst wordSeparators = new Set<number>();\n\"`~!@#$%^&*()-=+[{]}\\\\|;:'\\\",.<>/?\"\n  .split(\"\")\n  .forEach((s) => wordSeparators.add(s.charCodeAt(0)));\n\nfunction isWordSeparator(code: number): boolean {\n  return isWhitespace(code) || wordSeparators.has(code);\n}\n\nfunction charactersMatch(codeA: number, codeB: number): boolean {\n  return codeA === codeB || (isWordSeparator(codeA) && isWordSeparator(codeB));\n}\n\nfunction join(head: IMatch, tail: IMatch[]): IMatch[] {\n  if (tail.length === 0) {\n    tail = [head];\n  } else if (head.end === tail[0].start) {\n    tail[0].start = head.start;\n  } else {\n    tail.unshift(head);\n  }\n  return tail;\n}\n"]}

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":"AAIA;;GAEG;;AAIH,OAAO,mBAAmB,CAAC;AAK3B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAa,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAEpE,OAAO,KAAK,EAEV,WAAW,EACX,cAAc,EACd,aAAa,EACb,SAAS,EACT,QAAQ,EACT,MAAM,2BAA2B,CAAC;AAsBnC,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAe,MAAM,8BAA8B,CAAC;AAG5E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAmBtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AA6BvE,gBAAgB;AAChB,wBAAgB,cAAc,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,eAiBtE;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,aAAa,QAajE;AAED,gBAAgB;AAChB,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,aAAa,wDAE/D;AAED,gBAAgB;AAChB,wBAAgB,sBAAsB,uBAqBrC;AAMD,UAAU,gCAAgC;IACxC,MAAM,EAAE,WAAW,CAAC;IACpB,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED,gBAAgB;AAChB,wBAAgB,2BAA2B,CAAC,EAC1C,aAAa,EACb,MAAM,GACP,EAAE,gCAAgC,eAuDlC;AAED,gBAAgB;AAChB,wBAAgB,SAAS,mBAqBxB;AAmBD,gBAAgB;AAChB,wBAAgB,UAAU,CACxB,KAAK,EAAE,aAAa,EACpB,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,EACjC,IAAI,EAAE,SAAS,EACf,QAAQ,EAAE,QAAQ,GACjB,aAAa,CAuBf;AAED,gBAAgB;AAEhB,wBAAgB,aAAa,CAC3B,KAAK,EAAE,aAAa,EACpB,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC,EACpC,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,iBAAiB,GACzB,aAAa,CAqGf;AAmBD;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,aAAa,EAAE,aAAa,EAC5B,YAAY,EAAE,aAAa,GAC1B,aAAa,CAsGf;AAgDD,KAAK,QAAQ,GACT,WAAW,GACX,SAAS,GACT,YAAY,GACZ,UAAU,GACV,UAAU,GACV,QAAQ,GACR,aAAa,GACb,WAAW,CAAC;AAEhB,gBAAgB;AAChB,wBAAgB,WAAW,CACzB,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,iBAAiB,GACzB,QAAQ,CAmBV;AAED,gBAAgB;AAChB,wBAAgB,sBAAsB,CACpC,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,iBAAiB,GACzB,aAAa,CAAC,SAAS,CAAC,CAI1B;AAED,gBAAgB;AAChB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,aAAa,EACpB,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,GAC3B,aAAa,CAwBf;AAED,gBAAgB;AAChB,wBAAgB,8BAA8B,CAC5C,cAAc,EAAE,oBAAoB,GACnC,cAAc,IAAI;IACnB,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC;IACrC,OAAO,EAAE,2BAA2B,CAAC;CACtC,CAGA;AAED,gBAAgB;AAChB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,aAAa,EACpB,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,iBAsB7B;AAED,gBAAgB;AAChB,eAAO,MAAM,YAAY,KAAK,CAAC;AAE/B,gBAAgB;AAChB,wBAAgB,uBAAuB,CACrC,aAAa,EAAE,aAAa,GAC3B,aAAa,CAyDf;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,aAAa,EAC5B,KAAK,EAAE,kBAAkB,GACxB,aAAa,CA2Ff;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,aAAa,GAAG,kBAAkB,CAe1E;AAED,gBAAgB;AAChB,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,eAAe,GAAG,SAAS,WAEvE;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,EAAE,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IACxB,mHAAmH;IACnH,OAAO,EAAE,MAAM,CAAC;IAChB,+FAA+F;IAC/F,YAAY,EAAE,MAAM,CAAC;CACtB;AAGD,KAAK,aAAa,GAAG,IAAI,CACvB,QAAQ,EACR,OAAO,GAAG,WAAW,GAAG,gCAAgC,GAAG,UAAU,CACtE,CAAC;AAEF,UAAU,cAAc;IACtB,QAAQ,EAAE,EAAE,EAAE,MAAM,GAAG,aAAa,CAAC;CACtC;AAED,UAAU,kBAAmB,SAAQ,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC;IAC9D,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;CAC/B;AAED,gBAAgB;AAChB,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,iBAgBlE;AAED,gBAAgB;AAChB,wBAAgB,YAAY,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,iBAepE;AAED,gBAAgB;AAChB,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,aAAa,QA+CnE;AAED,gBAAgB;AAChB,wBAAgB,yBAAyB,CACvC,aAAa,EAAE,aAAa,EAC5B,KAAK,EAAE,WAAW,QA2CnB;AAED,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,4BAA4B,CAAC;AAEvE,gBAAgB;AAChB,wBAAgB,6BAA6B,CAC3C,YAAY,EAAE,2BAA2B,CAAC,IAAI,CAAC,UAGhD;AAsBD,gBAAgB;AAChB,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,aAAa,EAC5B,0BAA0B,CAAC,EAAE,OAAO,QA8DrC;AAED,gBAAgB;AAEhB,wBAAgB,eAAe,CAAC,aAAa,EAAE,aAAa,QAqB3D"}
+{"version":3,"file":"Frontstage.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widget-panels/Frontstage.tsx"],"names":[],"mappings":"AAIA;;GAEG;;AAIH,OAAO,mBAAmB,CAAC;AAK3B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAa,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAEpE,OAAO,KAAK,EAEV,WAAW,EACX,cAAc,EACd,aAAa,EACb,SAAS,EACT,QAAQ,EACT,MAAM,2BAA2B,CAAC;AAyBnC,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAe,MAAM,8BAA8B,CAAC;AAG5E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAuBtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAoDvE,gBAAgB;AAChB,wBAAgB,cAAc,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,eAiBtE;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,aAAa,QAajE;AAED,gBAAgB;AAChB,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,aAAa,wDAE/D;AAED,gBAAgB;AAChB,wBAAgB,sBAAsB,uBAqBrC;AAMD,UAAU,gCAAgC;IACxC,MAAM,EAAE,WAAW,CAAC;IACpB,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED,gBAAgB;AAChB,wBAAgB,2BAA2B,CAAC,EAC1C,aAAa,EACb,MAAM,GACP,EAAE,gCAAgC,eA+DlC;AAED,gBAAgB;AAChB,wBAAgB,SAAS,mBAqBxB;AAmBD,gBAAgB;AAChB,wBAAgB,UAAU,CACxB,KAAK,EAAE,aAAa,EACpB,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,EACjC,IAAI,EAAE,SAAS,EACf,QAAQ,EAAE,QAAQ,GACjB,aAAa,CAuBf;AAED,gBAAgB;AAEhB,wBAAgB,aAAa,CAC3B,KAAK,EAAE,aAAa,EACpB,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC,EACpC,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,iBAAiB,GACzB,aAAa,CAqGf;AAmBD;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,aAAa,EAAE,aAAa,EAC5B,YAAY,EAAE,aAAa,GAC1B,aAAa,CAsGf;AAgDD,KAAK,QAAQ,GACT,WAAW,GACX,SAAS,GACT,YAAY,GACZ,UAAU,GACV,UAAU,GACV,QAAQ,GACR,aAAa,GACb,WAAW,CAAC;AAEhB,gBAAgB;AAChB,wBAAgB,WAAW,CACzB,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,iBAAiB,GACzB,QAAQ,CAmBV;AAED,gBAAgB;AAChB,wBAAgB,sBAAsB,CACpC,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,iBAAiB,GACzB,aAAa,CAAC,SAAS,CAAC,CAI1B;AAED,gBAAgB;AAChB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,aAAa,EACpB,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,GAC3B,aAAa,CAwBf;AAED,gBAAgB;AAChB,wBAAgB,8BAA8B,CAC5C,cAAc,EAAE,oBAAoB,GACnC,cAAc,IAAI;IACnB,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC;IACrC,OAAO,EAAE,2BAA2B,CAAC;CACtC,CAGA;AAED,gBAAgB;AAChB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,aAAa,EACpB,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,iBAsB7B;AAED,gBAAgB;AAChB,eAAO,MAAM,YAAY,KAAK,CAAC;AAE/B,gBAAgB;AAChB,wBAAgB,uBAAuB,CACrC,aAAa,EAAE,aAAa,GAC3B,aAAa,CAyDf;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,aAAa,EAC5B,KAAK,EAAE,kBAAkB,GACxB,aAAa,CA2Ff;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,aAAa,GAAG,kBAAkB,CAe1E;AAED,gBAAgB;AAChB,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,eAAe,GAAG,SAAS,WAEvE;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,EAAE,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IACxB,mHAAmH;IACnH,OAAO,EAAE,MAAM,CAAC;IAChB,+FAA+F;IAC/F,YAAY,EAAE,MAAM,CAAC;CACtB;AAGD,KAAK,aAAa,GAAG,IAAI,CACvB,QAAQ,EACR,OAAO,GAAG,WAAW,GAAG,gCAAgC,GAAG,UAAU,CACtE,CAAC;AAEF,UAAU,cAAc;IACtB,QAAQ,EAAE,EAAE,EAAE,MAAM,GAAG,aAAa,CAAC;CACtC;AAED,UAAU,kBAAmB,SAAQ,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC;IAC9D,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;CAC/B;AAED,gBAAgB;AAChB,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,iBAgBlE;AAED,gBAAgB;AAChB,wBAAgB,YAAY,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,iBAepE;AAED,gBAAgB;AAChB,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,aAAa,QA+CnE;AAED,gBAAgB;AAChB,wBAAgB,yBAAyB,CACvC,aAAa,EAAE,aAAa,EAC5B,KAAK,EAAE,WAAW,QAkDnB;AAED,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,4BAA4B,CAAC;AAEvE,gBAAgB;AAChB,wBAAgB,6BAA6B,CAC3C,YAAY,EAAE,2BAA2B,CAAC,IAAI,CAAC,UAGhD;AAmCD,gBAAgB;AAChB,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,aAAa,EAC5B,0BAA0B,CAAC,EAAE,OAAO,QA8DrC;AAED,gBAAgB;AAEhB,wBAAgB,eAAe,CAAC,aAAa,EAAE,aAAa,QAqB3D"}

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

@@ -38,17 +38,29 @@ const WidgetState_1 = require("../widgets/WidgetState");
 const StagePanelSection_1 = require("../stagepanels/StagePanelSection");
 const StagePanelLocation_1 = require("../stagepanels/StagePanelLocation");
 const UiItemsManager_1 = require("../ui-items-provider/UiItemsManager");
+const PreviewFeatures_1 = require("../preview/PreviewFeatures");
+const classnames_1 = require("classnames");
 function WidgetPanelsFrontstageComponent() {
     const activeModalFrontstageInfo = (0, ModalFrontstageComposer_1.useActiveModalFrontstageInfo)();
     const uiIsVisible = (0, useUiVisibility_1.useUiVisibility)();
-    return (React.createElement(React.Fragment, null,
-        React.createElement(ToolSettings_1.WidgetPanelsToolSettings, null),
-        React.createElement(components_react_1.ToolbarPopupAutoHideContext.Provider, { value: !uiIsVisible },
-            React.createElement(ModalFrontstageComposer_1.ModalFrontstageComposer, { stageInfo: activeModalFrontstageInfo }),
-            React.createElement(appui_layout_react_1.WidgetPanels, { className: "uifw-widgetPanels", centerContent: React.createElement(Toolbars_1.WidgetPanelsToolbars, null) },
-                React.createElement(FrontstageContent_1.WidgetPanelsFrontstageContent, null)),
-            React.createElement(StatusBar_1.WidgetPanelsStatusBar, null),
-            React.createElement(appui_layout_react_1.FloatingWidgets, null))));
+    const previewFeatures = (0, PreviewFeatures_1.usePreviewFeatures)();
+    const previewContentAlwaysMaxSizeDockedClass = (0, ToolSettings_1.useShouldRenderDockedToolSettings)() &&
+        previewFeatures.contentAlwaysMaxSize &&
+        "preview-contentAlwaysMaxSize-toolSettingsDocked";
+    const previewContentAlwaysMaxSizeTopPanelClass = (0, appui_layout_react_1.useLayout)((state) => {
+        return state.panels.top.widgets.length > 0;
+    }) &&
+        previewFeatures.contentAlwaysMaxSize &&
+        "preview-contentAlwaysMaxSize-topPanelActive";
+    return (React.createElement(appui_layout_react_1.PreviewLayoutFeaturesProvider, { ...previewFeatures },
+        React.createElement(appui_layout_react_1.PreviewMaximizedWidgetFeatureProvider, { enabled: previewFeatures.enableMaximizedFloatingWidget },
+            React.createElement(ToolSettings_1.WidgetPanelsToolSettings, null),
+            React.createElement(components_react_1.ToolbarPopupAutoHideContext.Provider, { value: !uiIsVisible },
+                React.createElement(ModalFrontstageComposer_1.ModalFrontstageComposer, { stageInfo: activeModalFrontstageInfo }),
+                React.createElement(appui_layout_react_1.WidgetPanels, { className: (0, classnames_1.default)("uifw-widgetPanels", previewContentAlwaysMaxSizeDockedClass, previewContentAlwaysMaxSizeTopPanelClass), centerContent: React.createElement(Toolbars_1.WidgetPanelsToolbars, null) },
+                    React.createElement(FrontstageContent_1.WidgetPanelsFrontstageContent, null)),
+                React.createElement(StatusBar_1.WidgetPanelsStatusBar, null),
+                React.createElement(appui_layout_react_1.FloatingWidgets, null)))));
 }
 const widgetContent = React.createElement(Content_1.WidgetContent, null);
 const toolSettingsContent = React.createElement(ToolSettings_1.ToolSettingsContent, null);
@@ -674,6 +686,7 @@ exports.useSavedFrontstageState = useSavedFrontstageState;
 /** @internal */
 function useSaveFrontstageSettings(frontstageDef, store) {
     const uiSettingsStorage = (0, useUiStateStorage_1.useUiStateStorageHandler)();
+    const pendingSave = React.useRef(() => { });
     const saveSetting = React.useMemo(() => {
         const debounced = debounce(async (frontstage, state) => {
             const id = frontstage.id;
@@ -691,8 +704,14 @@ function useSaveFrontstageSettings(frontstageDef, store) {
             debounced(frontstage, state);
         };
         save.cancel = debounced.cancel;
+        pendingSave.current = debounced.immediate;
         return save;
     }, [uiSettingsStorage]);
+    React.useEffect(() => {
+        return () => {
+            pendingSave.current();
+        };
+    }, [frontstageDef]);
     React.useEffect(() => {
         return () => {
             saveSetting.cancel();
@@ -718,16 +737,30 @@ exports.getFrontstageStateSettingName = getFrontstageStateSettingName;
 // istanbul ignore next
 function debounce(func, duration) {
     let timeout;
+    let handler;
     const debounced = (...args) => {
-        const handler = () => {
+        handler = () => {
             timeout = undefined;
             return func(...args);
         };
         window.clearTimeout(timeout);
         timeout = window.setTimeout(handler, duration);
     };
+    /**
+     * Will cancel the timeout without running the function.
+     */
     debounced.cancel = () => {
         window.clearTimeout(timeout);
+        timeout = undefined;
+    };
+    /**
+     * If not already ran, will run the function immediately and remove the timeout.
+     */
+    debounced.immediate = () => {
+        if (timeout === undefined)
+            return;
+        debounced.cancel();
+        handler?.();
     };
     return debounced;
 }