@itwin/appui-react 4.0.0 → 4.0.1

package/lib/esm/appui-react/uiprovider/DefaultDialogGridContainer.scss

@@ -1,212 +1,212 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-
-.uifw-default-resizer-parent {
-  min-width: 200px;
-
-  &.uifw-fill {
-    width: 100%;
-    height: 100%;
-  }
-}
-
-.uifw-label-disabled {
-  color: var(--iui-color-text-disabled);
-}
-
-div.uifw-default-property-lock input[type="checkbox"] {
-  margin-right: 8px;
-}
-
-.uifw-default-center-across-width {
-  display: flex;
-  flex-direction: row;
-  justify-content: center;
-  align-content: center;
-  grid-column: 1 / span 2;
-}
-
-.uifw-width-100percent {
-  width: 100%;
-}
-
-.uifw-width-6rem {
-  width: 6rem;
-}
-
-.uifw-width-fit-content {
-  width: fit-content;
-}
-
-div.uifw-default-inline-editor-group {
-  display: flex;
-  flex-wrap: nowrap;
-}
-
-div.uifw-default-inline-editor-group .uifw-default-label {
-  margin-right: 4px;
-  margin-left: 4px;
-  width: auto;
-  align-self: center;
-  margin-bottom: 6px;
-}
-
-div.nz-toolSettings-docked .uifw-default-inline-editor-group .uifw-default-label {
-  margin-bottom: 0px;
-}
-
-div.uifw-default-inline-editor-group .uifw-default-editor {
-  margin-right: 6px;
-  margin-bottom: 6px;
-
-  &:last-child {
-    margin-right: 0px;
-  }
-}
-
-div.uifw-default-lock-and-label {
-  align-content: flex-start;
-  align-items: center;
-  flex-direction: row;
-  display: inline-flex;
-  margin-bottom: 6px;
-
-  .uifw-default-property-lock {
-    padding: 0 4px 0 0;
-  }
-
-  &:last-child {
-    margin-bottom: 3px;
-  }
-}
-
-.uifw-default-inline-label-and-editor {
-  display: flex;
-  flex-direction: row;
-  width: auto;
-}
-
-.uifw-default-wide-only-display {
-  display: inline-flex;
-  flex-wrap: none;
-}
-
-.uifw-default-narrow-only-display {
-  display: none;
-}
-
-/* Fixed spacing used to hold lock/enable toggle in first column */
-.uifw-default-lock {
-  min-width: 30px;
-  height: 1rem;
-  margin: 3px;
-}
-
-.uifw-default-editor {
-  margin-bottom: 6px;
-  display: flex;
-  align-items: center;
-
-  &:last-child {
-    margin-bottom: 3px;
-  }
-}
-
-div.uifw-default-container {
-  display: grid;
-  grid-template-columns: auto 1fr;
-  grid-row-gap: 0px;
-  row-gap: 0px;
-  grid-column-gap: 8px;
-  column-gap: 8px;
-  font-family: var(--iui-font-sans);
-  font-size: 14px;
-  -webkit-box-sizing: border-box;
-  -moz-box-sizing: border-box;
-  box-sizing: border-box;
-  align-items: center;
-  margin: 4px 4px 0px 4px;
-}
-
-.uifw-default-label {
-  width: fit-content;
-  margin-left: auto;
-  white-space: nowrap;
-}
-
-/* Overrides when uifw-default-narrow class is added to parent container div */
-div.uifw-default-container.uifw-default-narrow {
-  grid-template-columns: 1fr;
-}
-
-div.uifw-default-container.uifw-default-narrow div.uifw-default-center-across-width {
-  display: flex;
-  flex-direction: row;
-  justify-content: center;
-  align-content: center;
-  grid-column: 1 / span 1;
-}
-
-div.uifw-default-container.uifw-default-narrow .uifw-default-narrow-only-display {
-  display: block;
-}
-
-div.uifw-default-container.uifw-default-narrow .uifw-default-lock-and-label.uifw-default-wide-only-display {
-  display: none;
-}
-
-div.uifw-default-container.uifw-default-narrow div.uifw-default-inline-editor-group {
-  display: flex;
-  flex-wrap: wrap;
-}
-
-div.uifw-default-container.uifw-default-narrow .uifw-default-lock {
-  min-width: 0px;
-  height: 1rem;
-  margin-left: 0px;
-}
-
-div.uifw-default-container.uifw-default-narrow .uifw-default-lock-and-label {
-  margin-bottom: 0px;
-}
-
-div.uifw-default-container.uifw-default-narrow .uifw-default-label {
-  text-align: left;
-  margin-bottom: 3px;
-  align-self: flex-start;
-}
-
-div.uifw-default-container.uifw-default-narrow .uifw-default-inline-label-and-editor {
-  align-content: flex-start;
-  display: flex;
-  flex-direction: column;
-  width: auto;
-}
-
-div.uifw-default-container.uifw-default-narrow .uifw-default-inline-editor-group .uifw-default-editor {
-  margin-left: 0px;
-}
-
-div.nz-toolSettings-docked div.uifw-default-lock-and-label {
-  margin-bottom: 0;
-  align-self: center;
-}
-
-div.nz-toolSettings-docked div.uifw-default-inline-editor-group .uifw-default-editor {
-  margin-bottom: 0;
-  align-self: center;
-}
-
-div.nz-toolSettings-docked .uifw-default-editor:last-child {
-  margin-bottom: 0;
-  align-self: center;
-}
-
-/* Override the GridLayout case where width is 100% */
-div.nz-toolSettings-docked {
-  border-top: none;
-  border-left: none;
-  border-right: none;
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+
+.uifw-default-resizer-parent {
+  min-width: 200px;
+
+  &.uifw-fill {
+    width: 100%;
+    height: 100%;
+  }
+}
+
+.uifw-label-disabled {
+  color: var(--iui-color-text-disabled);
+}
+
+div.uifw-default-property-lock input[type="checkbox"] {
+  margin-right: 8px;
+}
+
+.uifw-default-center-across-width {
+  display: flex;
+  flex-direction: row;
+  justify-content: center;
+  align-content: center;
+  grid-column: 1 / span 2;
+}
+
+.uifw-width-100percent {
+  width: 100%;
+}
+
+.uifw-width-6rem {
+  width: 6rem;
+}
+
+.uifw-width-fit-content {
+  width: fit-content;
+}
+
+div.uifw-default-inline-editor-group {
+  display: flex;
+  flex-wrap: nowrap;
+}
+
+div.uifw-default-inline-editor-group .uifw-default-label {
+  margin-right: 4px;
+  margin-left: 4px;
+  width: auto;
+  align-self: center;
+  margin-bottom: 6px;
+}
+
+div.nz-toolSettings-docked .uifw-default-inline-editor-group .uifw-default-label {
+  margin-bottom: 0px;
+}
+
+div.uifw-default-inline-editor-group .uifw-default-editor {
+  margin-right: 6px;
+  margin-bottom: 6px;
+
+  &:last-child {
+    margin-right: 0px;
+  }
+}
+
+div.uifw-default-lock-and-label {
+  align-content: flex-start;
+  align-items: center;
+  flex-direction: row;
+  display: inline-flex;
+  margin-bottom: 6px;
+
+  .uifw-default-property-lock {
+    padding: 0 4px 0 0;
+  }
+
+  &:last-child {
+    margin-bottom: 3px;
+  }
+}
+
+.uifw-default-inline-label-and-editor {
+  display: flex;
+  flex-direction: row;
+  width: auto;
+}
+
+.uifw-default-wide-only-display {
+  display: inline-flex;
+  flex-wrap: none;
+}
+
+.uifw-default-narrow-only-display {
+  display: none;
+}
+
+/* Fixed spacing used to hold lock/enable toggle in first column */
+.uifw-default-lock {
+  min-width: 30px;
+  height: 1rem;
+  margin: 3px;
+}
+
+.uifw-default-editor {
+  margin-bottom: 6px;
+  display: flex;
+  align-items: center;
+
+  &:last-child {
+    margin-bottom: 3px;
+  }
+}
+
+div.uifw-default-container {
+  display: grid;
+  grid-template-columns: auto 1fr;
+  grid-row-gap: 0px;
+  row-gap: 0px;
+  grid-column-gap: 8px;
+  column-gap: 8px;
+  font-family: var(--iui-font-sans);
+  font-size: 14px;
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+  align-items: center;
+  margin: 4px 4px 0px 4px;
+}
+
+.uifw-default-label {
+  width: fit-content;
+  margin-left: auto;
+  white-space: nowrap;
+}
+
+/* Overrides when uifw-default-narrow class is added to parent container div */
+div.uifw-default-container.uifw-default-narrow {
+  grid-template-columns: 1fr;
+}
+
+div.uifw-default-container.uifw-default-narrow div.uifw-default-center-across-width {
+  display: flex;
+  flex-direction: row;
+  justify-content: center;
+  align-content: center;
+  grid-column: 1 / span 1;
+}
+
+div.uifw-default-container.uifw-default-narrow .uifw-default-narrow-only-display {
+  display: block;
+}
+
+div.uifw-default-container.uifw-default-narrow .uifw-default-lock-and-label.uifw-default-wide-only-display {
+  display: none;
+}
+
+div.uifw-default-container.uifw-default-narrow div.uifw-default-inline-editor-group {
+  display: flex;
+  flex-wrap: wrap;
+}
+
+div.uifw-default-container.uifw-default-narrow .uifw-default-lock {
+  min-width: 0px;
+  height: 1rem;
+  margin-left: 0px;
+}
+
+div.uifw-default-container.uifw-default-narrow .uifw-default-lock-and-label {
+  margin-bottom: 0px;
+}
+
+div.uifw-default-container.uifw-default-narrow .uifw-default-label {
+  text-align: left;
+  margin-bottom: 3px;
+  align-self: flex-start;
+}
+
+div.uifw-default-container.uifw-default-narrow .uifw-default-inline-label-and-editor {
+  align-content: flex-start;
+  display: flex;
+  flex-direction: column;
+  width: auto;
+}
+
+div.uifw-default-container.uifw-default-narrow .uifw-default-inline-editor-group .uifw-default-editor {
+  margin-left: 0px;
+}
+
+div.nz-toolSettings-docked div.uifw-default-lock-and-label {
+  margin-bottom: 0;
+  align-self: center;
+}
+
+div.nz-toolSettings-docked div.uifw-default-inline-editor-group .uifw-default-editor {
+  margin-bottom: 0;
+  align-self: center;
+}
+
+div.nz-toolSettings-docked .uifw-default-editor:last-child {
+  margin-bottom: 0;
+  align-self: center;
+}
+
+/* Override the GridLayout case where width is 100% */
+div.nz-toolSettings-docked {
+  border-top: none;
+  border-left: none;
+  border-right: none;
+}

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

@@ -1 +1 @@
-{"version":3,"file":"AppUiSettings.js","sourceRoot":"","sources":["../../../../src/appui-react/uistate/AppUiSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAkB,MAAM,mBAAmB,CAAC;AAEjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAwB,MAAM,gBAAgB,CAAC;AAmBnE;;;;;;;;;;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,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACjC,6FAA6F;YAC7F,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;QAC1D,CAAC,CAAC;QA4CM,sBAAiB,GAAG,KAAK,EAAE,IAAqB,EAAE,EAAE;YAC1D,IAAI,IAAI,CAAC,sBAAsB;gBAC7B,OAAO;YAET,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,0BAA0B,CAAC,EAAE;gBACjD,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBACnE,8GAA8G;gBAC9G,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,WAAW,CAAC,aAAa,EAAE,CAAC,CAAC;aAC/E;YAED,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qCAAqC,CAAC;gBAC1D,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAE1E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qCAAqC,CAAC;gBAC1D,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAEzE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,kDAAkD,CAAC;gBACvE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAErF,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,mCAAmC,CAAC;gBACxD,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAExE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,0CAA0C,CAAC;gBAC/D,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAE9E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oDAAoD,CAAC;gBACzE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAErF,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oCAAoC,CAAC;gBACzD,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC;QAvEA,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,UAAU,GAAG,IAAI,YAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,YAAY,EAAE,WAAW,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC9J,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErC,IAAI,CAAC,eAAe,GAAG,IAAI,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,iBAAiB,EACjG,GAAG,EAAE,CAAC,WAAW,CAAC,kBAAkB,EACpC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;QAC1F,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE1C,IAAI,CAAC,cAAc,GAAG,IAAI,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,gBAAgB,EAC/F,GAAG,EAAE,CAAC,WAAW,CAAC,cAAc,EAChC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;QACrF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,IAAI,CAAC,0BAA0B,GAAG,IAAI,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,4BAA4B,EACvH,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;QAC7G,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,aAAa,GAAG,IAAI,YAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,eAAe,EAC5F,GAAG,EAAE,CAAC,WAAW,CAAC,gBAAgB,EAAE,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,WAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;QACxH,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAExC,IAAI,CAAC,mBAAmB,GAAG,IAAI,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,qBAAqB,EACzG,GAAG,EAAE,CAAC,WAAW,CAAC,mBAAmB,EACrC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;QAC/F,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE9C,IAAI,CAAC,0BAA0B,GAAG,IAAI,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,4BAA4B,EACvH,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;QAC7G,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,cAAc,GAAG,IAAI,YAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,aAAa,EAC3F,GAAG,EAAE,CAAC,WAAW,CAAC,iBAAiB,EAAE,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,WAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC3H,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC1E,CAAC;IAkCM,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;;AAvGc,+BAAiB,GAAG,eAAe,AAAlB,CAAmB;SAHxC,aAAa","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Settings\r\n */\r\n\r\nimport { UiStateEntry, UiStateStorage } from \"@itwin/core-react\";\r\nimport { UiSyncEventArgs } from \"@itwin/appui-abstract\";\r\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\r\nimport { UiFramework, UserSettingsProvider } from \"../UiFramework\";\r\n\r\n// cSpell:ignore configurableui\r\n\r\n/** Default values that may be specified for [[AppUiSettings]].\r\n * @public\r\n */\r\nexport interface InitialAppUiSettings {\r\n  colorTheme: string;\r\n  dragInteraction: boolean;\r\n  widgetOpacity: number;\r\n  showWidgetIcon?: boolean;\r\n  /** @alpha */\r\n  autoCollapseUnpinnedPanels?: boolean;\r\n  animateToolSettings?: boolean;\r\n  useToolAsToolSettingsLabel?: boolean;\r\n  toolbarOpacity: number;\r\n}\r\n\r\n/** These are the UI settings that are stored in the Redux store. They control the color theme, the UI version,\r\n * how toolbar group buttons work, and the opacity of widgets in 1.0 and floating widget in 2.0 when the cursor\r\n * is not inside them. It is expect that an IModelApp using App UI components will create and register AppUiSettings with\r\n * defaults specific to their application. This would be done by calling the following.\r\n *\r\n * ```ts\r\n * UiFramework.registerUserSettingsProvider(new AppUiSettings(defaults));\r\n * ```\r\n *\r\n * @public\r\n */\r\nexport class AppUiSettings implements UserSettingsProvider {\r\n  public readonly providerId = \"AppUiSettingsProvider\";\r\n\r\n  private static _settingNamespace = \"AppUiSettings\";\r\n  private _settings: Array<UiStateEntry<any>> = [];\r\n  private _applyingLocalSettings = false;\r\n\r\n  public colorTheme: UiStateEntry<string>;\r\n  public dragInteraction: UiStateEntry<boolean>;\r\n  public widgetOpacity: UiStateEntry<number>;\r\n  public showWidgetIcon: UiStateEntry<boolean>;\r\n  public autoCollapseUnpinnedPanels: UiStateEntry<boolean>;\r\n  public animateToolSettings: UiStateEntry<boolean>;\r\n  public useToolAsToolSettingsLabel: UiStateEntry<boolean>;\r\n  public toolbarOpacity: UiStateEntry<number>;\r\n\r\n  private setColorTheme = (theme: string) => {\r\n    UiFramework.setColorTheme(theme);\r\n    // always store to local storage to avoid flicker during startup if user is not yet logged-in\r\n    window.localStorage.setItem(\"uifw:defaultTheme\", theme);\r\n  };\r\n\r\n  constructor(defaults: Partial<InitialAppUiSettings>) {\r\n    this._settings = [];\r\n\r\n    this.colorTheme = new UiStateEntry<string>(AppUiSettings._settingNamespace, \"ColorTheme\", UiFramework.getColorTheme, this.setColorTheme, defaults.colorTheme);\r\n    this._settings.push(this.colorTheme);\r\n\r\n    this.dragInteraction = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"DragInteraction\",\r\n      () => UiFramework.useDragInteraction,\r\n      (value: boolean) => UiFramework.setUseDragInteraction(value), defaults.dragInteraction);\r\n    this._settings.push(this.dragInteraction);\r\n\r\n    this.showWidgetIcon = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"ShowWidgetIcon\",\r\n      () => UiFramework.showWidgetIcon,\r\n      (value: boolean) => UiFramework.setShowWidgetIcon(value), defaults.showWidgetIcon);\r\n    this._settings.push(this.showWidgetIcon);\r\n\r\n    this.autoCollapseUnpinnedPanels = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"AutoCollapseUnpinnedPanels\",\r\n      () => UiFramework.autoCollapseUnpinnedPanels,\r\n      (value: boolean) => UiFramework.setAutoCollapseUnpinnedPanels(value), defaults.autoCollapseUnpinnedPanels);\r\n    this._settings.push(this.autoCollapseUnpinnedPanels);\r\n\r\n    this.widgetOpacity = new UiStateEntry<number>(AppUiSettings._settingNamespace, \"WidgetOpacity\",\r\n      () => UiFramework.getWidgetOpacity(), (value: number) => UiFramework.setWidgetOpacity(value), defaults.widgetOpacity);\r\n    this._settings.push(this.widgetOpacity);\r\n\r\n    this.animateToolSettings = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"AnimateToolSettings\",\r\n      () => UiFramework.animateToolSettings,\r\n      (value: boolean) => UiFramework.setAnimateToolSettings(value), defaults.animateToolSettings);\r\n    this._settings.push(this.animateToolSettings);\r\n\r\n    this.useToolAsToolSettingsLabel = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"UseToolAsToolSettingsLabel\",\r\n      () => UiFramework.useToolAsToolSettingsLabel,\r\n      (value: boolean) => UiFramework.setUseToolAsToolSettingsLabel(value), defaults.useToolAsToolSettingsLabel);\r\n    this._settings.push(this.useToolAsToolSettingsLabel);\r\n\r\n    this.toolbarOpacity = new UiStateEntry<number>(AppUiSettings._settingNamespace, \"ToolOpacity\",\r\n      () => UiFramework.getToolbarOpacity(), (value: number) => UiFramework.setToolbarOpacity(value), defaults.toolbarOpacity);\r\n    this._settings.push(this.toolbarOpacity);\r\n\r\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(this.handleSyncUiEvent);\r\n  }\r\n\r\n  private handleSyncUiEvent = async (args: UiSyncEventArgs) => {\r\n    if (this._applyingLocalSettings)\r\n      return;\r\n\r\n    if (args.eventIds.has(\"configurableui:set_theme\")) {\r\n      await this.colorTheme.saveSetting(UiFramework.getUiStateStorage());\r\n      // always store as default theme in local storage to avoid flicker during startup if user is not yet logged-in\r\n      window.localStorage.setItem(\"uifw:defaultTheme\", UiFramework.getColorTheme());\r\n    }\r\n\r\n    if (args.eventIds.has(\"configurableui:set-drag-interaction\"))\r\n      await this.dragInteraction.saveSetting(UiFramework.getUiStateStorage());\r\n\r\n    if (args.eventIds.has(\"configurableui:set-show-widget-icon\"))\r\n      await this.showWidgetIcon.saveSetting(UiFramework.getUiStateStorage());\r\n\r\n    if (args.eventIds.has(\"configurableui:set-auto-collapse-unpinned-panels\"))\r\n      await this.autoCollapseUnpinnedPanels.saveSetting(UiFramework.getUiStateStorage());\r\n\r\n    if (args.eventIds.has(\"configurableui:set_widget_opacity\"))\r\n      await this.widgetOpacity.saveSetting(UiFramework.getUiStateStorage());\r\n\r\n    if (args.eventIds.has(\"configurableui:set-animate-tool-settings\"))\r\n      await this.animateToolSettings.saveSetting(UiFramework.getUiStateStorage());\r\n\r\n    if (args.eventIds.has(\"configurableui:set-use-tool-as-tool-settings-label\"))\r\n      await this.useToolAsToolSettingsLabel.saveSetting(UiFramework.getUiStateStorage());\r\n\r\n    if (args.eventIds.has(\"configurableui:set-toolbar-opacity\"))\r\n      await this.toolbarOpacity.saveSetting(UiFramework.getUiStateStorage());\r\n  };\r\n\r\n  public async apply(storage: UiStateStorage): Promise<void> {\r\n    this._applyingLocalSettings = true;\r\n    for await (const setting of this._settings) {\r\n      await setting.getSettingAndApplyValue(storage);\r\n    }\r\n    this._applyingLocalSettings = false;\r\n  }\r\n\r\n  public async loadUserSettings(storage: UiStateStorage): Promise<void> {\r\n    await this.apply(storage);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"AppUiSettings.js","sourceRoot":"","sources":["../../../../src/appui-react/uistate/AppUiSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAkB,MAAM,mBAAmB,CAAC;AAEjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAwB,MAAM,gBAAgB,CAAC;AAmBnE;;;;;;;;;;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,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACjC,6FAA6F;YAC7F,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;QAC1D,CAAC,CAAC;QA4CM,sBAAiB,GAAG,KAAK,EAAE,IAAqB,EAAE,EAAE;YAC1D,IAAI,IAAI,CAAC,sBAAsB;gBAC7B,OAAO;YAET,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,0BAA0B,CAAC,EAAE;gBACjD,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBACnE,8GAA8G;gBAC9G,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,WAAW,CAAC,aAAa,EAAE,CAAC,CAAC;aAC/E;YAED,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qCAAqC,CAAC;gBAC1D,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAE1E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qCAAqC,CAAC;gBAC1D,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAEzE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,kDAAkD,CAAC;gBACvE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAErF,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,mCAAmC,CAAC;gBACxD,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAExE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,0CAA0C,CAAC;gBAC/D,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAE9E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oDAAoD,CAAC;gBACzE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAErF,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oCAAoC,CAAC;gBACzD,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC;QAvEA,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,UAAU,GAAG,IAAI,YAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,YAAY,EAAE,WAAW,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC9J,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErC,IAAI,CAAC,eAAe,GAAG,IAAI,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,iBAAiB,EACjG,GAAG,EAAE,CAAC,WAAW,CAAC,kBAAkB,EACpC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;QAC1F,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE1C,IAAI,CAAC,cAAc,GAAG,IAAI,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,gBAAgB,EAC/F,GAAG,EAAE,CAAC,WAAW,CAAC,cAAc,EAChC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;QACrF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,IAAI,CAAC,0BAA0B,GAAG,IAAI,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,4BAA4B,EACvH,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;QAC7G,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,aAAa,GAAG,IAAI,YAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,eAAe,EAC5F,GAAG,EAAE,CAAC,WAAW,CAAC,gBAAgB,EAAE,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,WAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;QACxH,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAExC,IAAI,CAAC,mBAAmB,GAAG,IAAI,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,qBAAqB,EACzG,GAAG,EAAE,CAAC,WAAW,CAAC,mBAAmB,EACrC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;QAC/F,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE9C,IAAI,CAAC,0BAA0B,GAAG,IAAI,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,4BAA4B,EACvH,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;QAC7G,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,cAAc,GAAG,IAAI,YAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,aAAa,EAC3F,GAAG,EAAE,CAAC,WAAW,CAAC,iBAAiB,EAAE,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,WAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC3H,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC1E,CAAC;IAkCM,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;;AAvGc,+BAAiB,GAAG,eAAe,AAAlB,CAAmB;SAHxC,aAAa","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 { UiStateEntry, UiStateStorage } from \"@itwin/core-react\";\nimport { UiSyncEventArgs } from \"@itwin/appui-abstract\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\nimport { UiFramework, UserSettingsProvider } from \"../UiFramework\";\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>(AppUiSettings._settingNamespace, \"ColorTheme\", UiFramework.getColorTheme, this.setColorTheme, defaults.colorTheme);\n    this._settings.push(this.colorTheme);\n\n    this.dragInteraction = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"DragInteraction\",\n      () => UiFramework.useDragInteraction,\n      (value: boolean) => UiFramework.setUseDragInteraction(value), defaults.dragInteraction);\n    this._settings.push(this.dragInteraction);\n\n    this.showWidgetIcon = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"ShowWidgetIcon\",\n      () => UiFramework.showWidgetIcon,\n      (value: boolean) => UiFramework.setShowWidgetIcon(value), defaults.showWidgetIcon);\n    this._settings.push(this.showWidgetIcon);\n\n    this.autoCollapseUnpinnedPanels = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"AutoCollapseUnpinnedPanels\",\n      () => UiFramework.autoCollapseUnpinnedPanels,\n      (value: boolean) => UiFramework.setAutoCollapseUnpinnedPanels(value), defaults.autoCollapseUnpinnedPanels);\n    this._settings.push(this.autoCollapseUnpinnedPanels);\n\n    this.widgetOpacity = new UiStateEntry<number>(AppUiSettings._settingNamespace, \"WidgetOpacity\",\n      () => UiFramework.getWidgetOpacity(), (value: number) => UiFramework.setWidgetOpacity(value), defaults.widgetOpacity);\n    this._settings.push(this.widgetOpacity);\n\n    this.animateToolSettings = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"AnimateToolSettings\",\n      () => UiFramework.animateToolSettings,\n      (value: boolean) => UiFramework.setAnimateToolSettings(value), defaults.animateToolSettings);\n    this._settings.push(this.animateToolSettings);\n\n    this.useToolAsToolSettingsLabel = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"UseToolAsToolSettingsLabel\",\n      () => UiFramework.useToolAsToolSettingsLabel,\n      (value: boolean) => UiFramework.setUseToolAsToolSettingsLabel(value), defaults.useToolAsToolSettingsLabel);\n    this._settings.push(this.useToolAsToolSettingsLabel);\n\n    this.toolbarOpacity = new UiStateEntry<number>(AppUiSettings._settingNamespace, \"ToolOpacity\",\n      () => UiFramework.getToolbarOpacity(), (value: number) => UiFramework.setToolbarOpacity(value), defaults.toolbarOpacity);\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)\n      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(\"uifw:defaultTheme\", UiFramework.getColorTheme());\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(UiFramework.getUiStateStorage());\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(UiFramework.getUiStateStorage());\n\n    if (args.eventIds.has(\"configurableui:set-use-tool-as-tool-settings-label\"))\n      await this.useToolAsToolSettingsLabel.saveSetting(UiFramework.getUiStateStorage());\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/esm/appui-react/uistate/useUiStateStorage.js.map

@@ -1 +1 @@
-{"version":3,"file":"useUiStateStorage.js","sourceRoot":"","sources":["../../../../src/appui-react/uistate/useUiStateStorage.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,iBAAiB,EAAkB,MAAM,mBAAmB,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAEvF,cAAc;AACd,MAAM,UAAU,wBAAwB;IACtC,OAAO,KAAK,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;AACjD,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,CAAC,aAAa,CAAiB,IAAI,iBAAiB,EAAE,CAAC,CAAC;AAClG,qBAAqB,CAAC,WAAW,GAAG,4BAA4B,CAAC;AASjE;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAA8B;IAClE,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAExF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,IAAI,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;gBAChG,eAAe,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACrD,CAAC,CAAC;QAEF,OAAO,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,OAAO,CACL,oBAAC,qBAAqB,CAAC,QAAQ,IAC7B,QAAQ,EAAE,KAAK,CAAC,QAAQ,EACxB,KAAK,EAAE,YAAY,GACnB,CACH,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module UiStateStorage\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { UiSyncEventArgs } from \"@itwin/appui-abstract\";\r\nimport { LocalStateStorage, UiStateStorage } from \"@itwin/core-react\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { SyncUiEventDispatcher, SyncUiEventId } from \"../syncui/SyncUiEventDispatcher\";\r\n\r\n/** @public */\r\nexport function useUiStateStorageHandler(): UiStateStorage {\r\n  return React.useContext(UiStateStorageContext);\r\n}\r\n\r\n/** @internal */\r\nexport const UiStateStorageContext = React.createContext<UiStateStorage>(new LocalStateStorage());\r\nUiStateStorageContext.displayName = \"uifw:UiStateStorageContext\";\r\n\r\n/** Properties for the [[UiStateStorageHandler]] component.\r\n * @public\r\n */\r\nexport interface UiSettingsProviderProps {\r\n  children?: React.ReactNode;\r\n}\r\n\r\n/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings.\r\n * @public\r\n */\r\nexport function UiStateStorageHandler(props: UiSettingsProviderProps) {\r\n  const [stateStorage, setStateStorage] = React.useState(UiFramework.getUiStateStorage());\r\n\r\n  React.useEffect(() => {\r\n    // istanbul ignore next\r\n    const handleSyncUiEvent = (args: UiSyncEventArgs): void => {\r\n      if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, [SyncUiEventId.UiStateStorageChanged]))\r\n        setStateStorage(UiFramework.getUiStateStorage());\r\n    };\r\n\r\n    return SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);\r\n  });\r\n\r\n  return (\r\n    <UiStateStorageContext.Provider\r\n      children={props.children} // eslint-disable-line react/no-children-prop\r\n      value={stateStorage}\r\n    />\r\n  );\r\n}\r\n"]}
+{"version":3,"file":"useUiStateStorage.js","sourceRoot":"","sources":["../../../../src/appui-react/uistate/useUiStateStorage.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,iBAAiB,EAAkB,MAAM,mBAAmB,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAEvF,cAAc;AACd,MAAM,UAAU,wBAAwB;IACtC,OAAO,KAAK,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;AACjD,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,CAAC,aAAa,CAAiB,IAAI,iBAAiB,EAAE,CAAC,CAAC;AAClG,qBAAqB,CAAC,WAAW,GAAG,4BAA4B,CAAC;AASjE;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAA8B;IAClE,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAExF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,IAAI,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;gBAChG,eAAe,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACrD,CAAC,CAAC;QAEF,OAAO,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,OAAO,CACL,oBAAC,qBAAqB,CAAC,QAAQ,IAC7B,QAAQ,EAAE,KAAK,CAAC,QAAQ,EACxB,KAAK,EAAE,YAAY,GACnB,CACH,CAAC;AACJ,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 UiStateStorage\n */\n\nimport * as React from \"react\";\nimport { UiSyncEventArgs } from \"@itwin/appui-abstract\";\nimport { LocalStateStorage, UiStateStorage } from \"@itwin/core-react\";\nimport { UiFramework } from \"../UiFramework\";\nimport { SyncUiEventDispatcher, SyncUiEventId } from \"../syncui/SyncUiEventDispatcher\";\n\n/** @public */\nexport function useUiStateStorageHandler(): UiStateStorage {\n  return React.useContext(UiStateStorageContext);\n}\n\n/** @internal */\nexport const UiStateStorageContext = React.createContext<UiStateStorage>(new LocalStateStorage());\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(UiFramework.getUiStateStorage());\n\n  React.useEffect(() => {\n    // istanbul ignore next\n    const handleSyncUiEvent = (args: UiSyncEventArgs): void => {\n      if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, [SyncUiEventId.UiStateStorageChanged]))\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/esm/appui-react/utils/InternalUiShowHideManager.js

@@ -30,13 +30,13 @@ class UiShowHideSettingsProvider {
             InternalUiShowHideManager.setSnapWidgetOpacity(result.setting);
     }
     static async storeAutoHideUi(v, storage) {
-        void (storage !== null && storage !== void 0 ? storage : UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._autoHideUiKey, v);
+        void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._autoHideUiKey, v);
     }
     static async storeUseProximityOpacity(v, storage) {
-        void (storage !== null && storage !== void 0 ? storage : UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._useProximityOpacityKey, v);
+        void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._useProximityOpacityKey, v);
     }
     static async storeSnapWidgetOpacity(v, storage) {
-        void (storage !== null && storage !== void 0 ? storage : UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._snapWidgetOpacityKey, v);
+        void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._snapWidgetOpacityKey, v);
     }
 }
 UiShowHideSettingsProvider._settingsNamespace = "AppUiSettings";

package/lib/esm/appui-react/utils/InternalUiShowHideManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"InternalUiShowHideManager.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/InternalUiShowHideManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAkB,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzE,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACvF,OAAO,EAAE,WAAW,EAAwB,MAAM,gBAAgB,CAAC;AAEnE;;GAEG;AACH,MAAa,0BAA0B;IAAvC;QAKkB,eAAU,GAAG,4BAA4B,CAAC;IA+B5D,CAAC;IA7BQ,MAAM,CAAC,UAAU;QACtB,WAAW,CAAC,4BAA4B,CAAC,IAAI,0BAA0B,EAAE,CAAC,CAAC;IAC7E,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,OAAuB;QACnD,IAAI,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,cAAc,CAAC,CAAC;QAChI,IAAI,MAAM,CAAC,MAAM,KAAK,oBAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE1D,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,uBAAuB,CAAC,CAAC;QACrI,IAAI,MAAM,CAAC,MAAM,KAAK,oBAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,sBAAsB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAEnE,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,qBAAqB,CAAC,CAAC;QACnI,IAAI,MAAM,CAAC,MAAM,KAAK,oBAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAU,EAAE,OAAwB;QACtE,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IACjH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAU,EAAE,OAAwB;QAC/E,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC;IAC1H,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAU,EAAE,OAAwB;QAC7E,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC;IACxH,CAAC;;AAlCc,6CAAkB,GAAG,eAAe,AAAlB,CAAmB;AACrC,yCAAc,GAAG,YAAY,AAAf,CAAgB;AAC9B,kDAAuB,GAAG,qBAAqB,AAAxB,CAAyB;AAChD,gDAAqB,GAAG,mBAAmB,AAAtB,CAAuB;SAJhD,0BAA0B;AAsCvC;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,CAAC,CAAE,uBAAuB;AAErE;;GAEG;AACH,MAAa,yBAAyB;IAUpC,sCAAsC;IAC/B,MAAM,KAAK,WAAW;QAC3B,OAAO,yBAAyB,CAAC,YAAY,CAAC;IAChD,CAAC;IACM,MAAM,KAAK,WAAW,CAAC,OAAgB;QAC5C,yBAAyB,CAAC,YAAY,GAAG,OAAO,CAAC;IACnD,CAAC;IAED,cAAc;IACP,MAAM,CAAC,aAAa,CAAC,KAAc;QACxC,yBAAyB,CAAC,WAAW,GAAG,KAAK,CAAC;IAChD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAc;QACjD,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;IACzD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,oBAAoB,CAAC,KAAc;QAC/C,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,UAAU;QAC1B,OAAO,yBAAyB,CAAC,WAAW,CAAC;IAC/C,CAAC;IAEM,MAAM,KAAK,UAAU,CAAC,QAAiB;QAC5C,KAAK,0BAA0B,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC1D,yBAAyB,CAAC,WAAW,GAAG,QAAQ,CAAC;QACjD,qBAAqB,CAAC,4BAA4B,CAAC,aAAa,CAAC,4BAA4B,CAAC,CAAC;IACjG,CAAC;IACD,oFAAoF;IAC7E,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,yBAAyB,CAAC,eAAe,GAAG,QAAQ,CAAC;QACrD,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,gFAAgF;IACzE,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,yBAAyB,CAAC,eAAe,GAAG,QAAQ,CAAC;QACrD,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,iGAAiG;IAC1F,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,IAAY;QAC3C,yBAAyB,CAAC,eAAe,GAAG,IAAI,CAAC;IACnD,CAAC;IAED,6GAA6G;IACtG,MAAM,KAAK,mBAAmB;QACnC,OAAO,yBAAyB,CAAC,oBAAoB,CAAC;IACxD,CAAC;IACM,MAAM,KAAK,mBAAmB,CAAC,KAAc;QAClD,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;QACvD,KAAK,0BAA0B,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;QAChE,qBAAqB,CAAC,4BAA4B,CAAC,aAAa,CAAC,4BAA4B,CAAC,CAAC;QAC/F,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,kFAAkF;IAC3E,MAAM,KAAK,iBAAiB;QACjC,OAAO,yBAAyB,CAAC,kBAAkB,CAAC;IACtD,CAAC;IACM,MAAM,KAAK,iBAAiB,CAAC,KAAc;QAChD,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;QACrD,KAAK,0BAA0B,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;QAC9D,qBAAqB,CAAC,4BAA4B,CAAC,aAAa,CAAC,4BAA4B,CAAC,CAAC;QAC/F,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,qBAAqB;QACjC,uBAAuB;QACvB,IAAI,CAAC,yBAAyB,CAAC,WAAW;YACxC,OAAO;QAET,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;IAClD,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,sBAAsB,CAAC,MAAkD;QACrF,IAAI,CAAC,yBAAyB,CAAC,WAAW;YACxC,OAAO;QAET,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;IAClD,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,sBAAsB,CAAC,MAAkD;QACrF,IAAI,CAAC,yBAAyB,CAAC,WAAW;YACxC,OAAO;QAET,yBAAyB,CAAC,oBAAoB,EAAE,CAAC;IACnD,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,mBAAmB;QAC/B,UAAU,CAAC,GAAG,EAAE;YACd,yBAAyB,CAAC,MAAM,EAAE,CAAC;YACnC,yBAAyB,CAAC,UAAU,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,oDAAoD;IAC7C,MAAM,CAAC,oBAAoB;QAChC,UAAU,CAAC,GAAG,EAAE;YACd,yBAAyB,CAAC,MAAM,EAAE,CAAC;YACnC,yBAAyB,CAAC,WAAW,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,WAAW;QACxB,YAAY,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEO,MAAM,CAAC,UAAU;QACvB,yBAAyB,CAAC,WAAW,EAAE,CAAC;QACxC,yBAAyB,CAAC,QAAQ,GAAG,UAAU,CAAC,yBAAyB,CAAC,MAAM,EAAE,yBAAyB,CAAC,eAAe,CAAC,CAAC;IAC/H,CAAC;IAEO,MAAM,CAAC,MAAM;QACnB,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAEO,MAAM,CAAC,MAAM;QACnB,WAAW,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,SAAS;QACrB,yBAAyB,CAAC,WAAW,EAAE,CAAC;QACxC,2DAA2D;QAC3D,yBAAyB,CAAC,YAAY,GAAG,IAAI,CAAC;QAC9C,yBAAyB,CAAC,WAAW,GAAG,IAAI,CAAC;QAC7C,yBAAyB,CAAC,eAAe,GAAG,KAAK,CAAC;QAClD,yBAAyB,CAAC,eAAe,GAAG,KAAK,CAAC;QAClD,yBAAyB,CAAC,eAAe,GAAG,uBAAuB,CAAC;QACpE,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;QACvD,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;IACvD,CAAC;;AAjKc,sCAAY,GAAY,IAAI,CAAC;AAC7B,qCAAW,GAAY,IAAI,CAAC;AAC5B,yCAAe,GAAY,KAAK,CAAC;AACjC,yCAAe,GAAY,KAAK,CAAC;AACjC,yCAAe,GAAW,uBAAuB,CAAC;AAElD,8CAAoB,GAAY,KAAK,CAAC;AACtC,4CAAkB,GAAY,KAAK,CAAC;SARxC,yBAAyB","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Utilities\r\n */\r\n\r\nimport { UiStateStorage, UiStateStorageStatus } from \"@itwin/core-react\";\r\nimport { SyncUiEventDispatcher, SyncUiEventId } from \"../syncui/SyncUiEventDispatcher\";\r\nimport { UiFramework, UserSettingsProvider } from \"../UiFramework\";\r\n\r\n/** Class that maintain UiShowHide user settings between sessions\r\n * @internal\r\n */\r\nexport class UiShowHideSettingsProvider implements UserSettingsProvider {\r\n  private static _settingsNamespace = \"AppUiSettings\";\r\n  private static _autoHideUiKey = \"AutoHideUi\";\r\n  private static _useProximityOpacityKey = \"UseProximityOpacity\";\r\n  private static _snapWidgetOpacityKey = \"SnapWidgetOpacity\";\r\n  public readonly providerId = \"UiShowHideSettingsProvider\";\r\n\r\n  public static initialize() {\r\n    UiFramework.registerUserSettingsProvider(new UiShowHideSettingsProvider());\r\n  }\r\n\r\n  public async loadUserSettings(storage: UiStateStorage): Promise<void> {\r\n    let result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._autoHideUiKey);\r\n    if (result.status === UiStateStorageStatus.Success)\r\n      InternalUiShowHideManager.setAutoHideUi(result.setting);\r\n\r\n    result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._useProximityOpacityKey);\r\n    if (result.status === UiStateStorageStatus.Success)\r\n      InternalUiShowHideManager.setUseProximityOpacity(result.setting);\r\n\r\n    result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._snapWidgetOpacityKey);\r\n    if (result.status === UiStateStorageStatus.Success)\r\n      InternalUiShowHideManager.setSnapWidgetOpacity(result.setting);\r\n  }\r\n\r\n  public static async storeAutoHideUi(v: boolean, storage?: UiStateStorage) {\r\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._autoHideUiKey, v);\r\n  }\r\n\r\n  public static async storeUseProximityOpacity(v: boolean, storage?: UiStateStorage) {\r\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._useProximityOpacityKey, v);\r\n  }\r\n\r\n  public static async storeSnapWidgetOpacity(v: boolean, storage?: UiStateStorage) {\r\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._snapWidgetOpacityKey, v);\r\n  }\r\n}\r\n\r\n/** The default inactivity time.\r\n * @internal\r\n */\r\nexport const INACTIVITY_TIME_DEFAULT = 3500;  /** Wait 3.5 seconds */\r\n\r\n/** Maintains Ui Show/Hide state. The `Ui` includes widgets, panels and the status bar.\r\n * @internal\r\n */\r\nexport class InternalUiShowHideManager {\r\n  private static _isUiVisible: boolean = true;\r\n  private static _autoHideUi: boolean = true;\r\n  private static _showHidePanels: boolean = false;\r\n  private static _showHideFooter: boolean = false;\r\n  private static _inactivityTime: number = INACTIVITY_TIME_DEFAULT;\r\n  private static _timeout: NodeJS.Timeout;\r\n  private static _useProximityOpacity: boolean = false;\r\n  private static _snapWidgetOpacity: boolean = false;\r\n\r\n  /** Determines if the Ui is visible */\r\n  public static get isUiVisible() {\r\n    return InternalUiShowHideManager._isUiVisible;\r\n  }\r\n  public static set isUiVisible(visible: boolean) {\r\n    InternalUiShowHideManager._isUiVisible = visible;\r\n  }\r\n\r\n  /** @public */\r\n  public static setAutoHideUi(value: boolean) {\r\n    InternalUiShowHideManager._autoHideUi = value;\r\n  }\r\n\r\n  /** @internal */\r\n  public static setUseProximityOpacity(value: boolean) {\r\n    InternalUiShowHideManager._useProximityOpacity = value;\r\n  }\r\n\r\n  /** @internal */\r\n  public static setSnapWidgetOpacity(value: boolean) {\r\n    InternalUiShowHideManager._snapWidgetOpacity = value;\r\n  }\r\n\r\n  /** Determines whether the `auto-hide Ui` feature is on. Defaults to false.\r\n   * When true, the Ui automatically hides after a few seconds of inactivity.\r\n   */\r\n  public static get autoHideUi(): boolean {\r\n    return InternalUiShowHideManager._autoHideUi;\r\n  }\r\n\r\n  public static set autoHideUi(autoHide: boolean) {\r\n    void UiShowHideSettingsProvider.storeAutoHideUi(autoHide);\r\n    InternalUiShowHideManager._autoHideUi = autoHide;\r\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.ShowHideManagerSettingChange);\r\n  }\r\n  /** Determines whether the widget panels are shown and hidden. Defaults to false. */\r\n  public static get showHidePanels(): boolean {\r\n    return InternalUiShowHideManager._showHidePanels;\r\n  }\r\n  public static set showHidePanels(showHide: boolean) {\r\n    InternalUiShowHideManager._showHidePanels = showHide;\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Determines whether the status bar is shown and hidden. Defaults to false. */\r\n  public static get showHideFooter(): boolean {\r\n    return InternalUiShowHideManager._showHideFooter;\r\n  }\r\n  public static set showHideFooter(showHide: boolean) {\r\n    InternalUiShowHideManager._showHideFooter = showHide;\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */\r\n  public static get inactivityTime(): number {\r\n    return InternalUiShowHideManager._inactivityTime;\r\n  }\r\n  public static set inactivityTime(time: number) {\r\n    InternalUiShowHideManager._inactivityTime = time;\r\n  }\r\n\r\n  /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */\r\n  public static get useProximityOpacity(): boolean {\r\n    return InternalUiShowHideManager._useProximityOpacity;\r\n  }\r\n  public static set useProximityOpacity(value: boolean) {\r\n    InternalUiShowHideManager._useProximityOpacity = value;\r\n    void UiShowHideSettingsProvider.storeUseProximityOpacity(value);\r\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.ShowHideManagerSettingChange);\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Determines whether the opacity of a toolbar should snap. Defaults to false. */\r\n  public static get snapWidgetOpacity(): boolean {\r\n    return InternalUiShowHideManager._snapWidgetOpacity;\r\n  }\r\n  public static set snapWidgetOpacity(value: boolean) {\r\n    InternalUiShowHideManager._snapWidgetOpacity = value;\r\n    void UiShowHideSettingsProvider.storeSnapWidgetOpacity(value);\r\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.ShowHideManagerSettingChange);\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Handler for when a Frontstage is ready */\r\n  public static handleFrontstageReady() {\r\n    // istanbul ignore next\r\n    if (!InternalUiShowHideManager._autoHideUi)\r\n      return;\r\n\r\n    InternalUiShowHideManager.showUiAndResetTimer();\r\n  }\r\n\r\n  /** Handler for when the mouse moves over the content area */\r\n  public static handleContentMouseMove(_event?: React.MouseEvent<HTMLElement, MouseEvent>) {\r\n    if (!InternalUiShowHideManager._autoHideUi)\r\n      return;\r\n\r\n    InternalUiShowHideManager.showUiAndResetTimer();\r\n  }\r\n\r\n  /** Handler for when the mouse enters a widget */\r\n  public static handleWidgetMouseEnter(_event?: React.MouseEvent<HTMLElement, MouseEvent>) {\r\n    if (!InternalUiShowHideManager._autoHideUi)\r\n      return;\r\n\r\n    InternalUiShowHideManager.showUiAndCancelTimer();\r\n  }\r\n\r\n  /** Shows the Ui and resets the inactivity timer */\r\n  public static showUiAndResetTimer() {\r\n    setTimeout(() => {\r\n      InternalUiShowHideManager.showUi();\r\n      InternalUiShowHideManager.resetTimer();\r\n    });\r\n  }\r\n\r\n  /** Shows the Ui and cancels the inactivity timer */\r\n  public static showUiAndCancelTimer() {\r\n    setTimeout(() => {\r\n      InternalUiShowHideManager.showUi();\r\n      InternalUiShowHideManager.cancelTimer();\r\n    });\r\n  }\r\n\r\n  private static cancelTimer() {\r\n    clearTimeout(InternalUiShowHideManager._timeout);\r\n  }\r\n\r\n  private static resetTimer() {\r\n    InternalUiShowHideManager.cancelTimer();\r\n    InternalUiShowHideManager._timeout = setTimeout(InternalUiShowHideManager.hideUi, InternalUiShowHideManager._inactivityTime);\r\n  }\r\n\r\n  private static showUi() {\r\n    UiFramework.setIsUiVisible(true);\r\n  }\r\n\r\n  private static hideUi() {\r\n    UiFramework.setIsUiVisible(false);\r\n  }\r\n\r\n  /** @internal */\r\n  public static terminate() {\r\n    InternalUiShowHideManager.cancelTimer();\r\n    // Ensure that next use will have default values for tests.\r\n    InternalUiShowHideManager._isUiVisible = true;\r\n    InternalUiShowHideManager._autoHideUi = true;\r\n    InternalUiShowHideManager._showHidePanels = false;\r\n    InternalUiShowHideManager._showHideFooter = false;\r\n    InternalUiShowHideManager._inactivityTime = INACTIVITY_TIME_DEFAULT;\r\n    InternalUiShowHideManager._useProximityOpacity = false;\r\n    InternalUiShowHideManager._snapWidgetOpacity = false;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"InternalUiShowHideManager.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/InternalUiShowHideManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAkB,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzE,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACvF,OAAO,EAAE,WAAW,EAAwB,MAAM,gBAAgB,CAAC;AAEnE;;GAEG;AACH,MAAa,0BAA0B;IAAvC;QAKkB,eAAU,GAAG,4BAA4B,CAAC;IA+B5D,CAAC;IA7BQ,MAAM,CAAC,UAAU;QACtB,WAAW,CAAC,4BAA4B,CAAC,IAAI,0BAA0B,EAAE,CAAC,CAAC;IAC7E,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,OAAuB;QACnD,IAAI,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,cAAc,CAAC,CAAC;QAChI,IAAI,MAAM,CAAC,MAAM,KAAK,oBAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE1D,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,uBAAuB,CAAC,CAAC;QACrI,IAAI,MAAM,CAAC,MAAM,KAAK,oBAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,sBAAsB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAEnE,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,qBAAqB,CAAC,CAAC;QACnI,IAAI,MAAM,CAAC,MAAM,KAAK,oBAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAU,EAAE,OAAwB;QACtE,KAAK,CAAC,OAAO,IAAI,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IACjH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAU,EAAE,OAAwB;QAC/E,KAAK,CAAC,OAAO,IAAI,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC;IAC1H,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAU,EAAE,OAAwB;QAC7E,KAAK,CAAC,OAAO,IAAI,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC;IACxH,CAAC;;AAlCc,6CAAkB,GAAG,eAAe,AAAlB,CAAmB;AACrC,yCAAc,GAAG,YAAY,AAAf,CAAgB;AAC9B,kDAAuB,GAAG,qBAAqB,AAAxB,CAAyB;AAChD,gDAAqB,GAAG,mBAAmB,AAAtB,CAAuB;SAJhD,0BAA0B;AAsCvC;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,CAAC,CAAE,uBAAuB;AAErE;;GAEG;AACH,MAAa,yBAAyB;IAUpC,sCAAsC;IAC/B,MAAM,KAAK,WAAW;QAC3B,OAAO,yBAAyB,CAAC,YAAY,CAAC;IAChD,CAAC;IACM,MAAM,KAAK,WAAW,CAAC,OAAgB;QAC5C,yBAAyB,CAAC,YAAY,GAAG,OAAO,CAAC;IACnD,CAAC;IAED,cAAc;IACP,MAAM,CAAC,aAAa,CAAC,KAAc;QACxC,yBAAyB,CAAC,WAAW,GAAG,KAAK,CAAC;IAChD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAc;QACjD,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;IACzD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,oBAAoB,CAAC,KAAc;QAC/C,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,UAAU;QAC1B,OAAO,yBAAyB,CAAC,WAAW,CAAC;IAC/C,CAAC;IAEM,MAAM,KAAK,UAAU,CAAC,QAAiB;QAC5C,KAAK,0BAA0B,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC1D,yBAAyB,CAAC,WAAW,GAAG,QAAQ,CAAC;QACjD,qBAAqB,CAAC,4BAA4B,CAAC,aAAa,CAAC,4BAA4B,CAAC,CAAC;IACjG,CAAC;IACD,oFAAoF;IAC7E,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,yBAAyB,CAAC,eAAe,GAAG,QAAQ,CAAC;QACrD,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,gFAAgF;IACzE,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,yBAAyB,CAAC,eAAe,GAAG,QAAQ,CAAC;QACrD,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,iGAAiG;IAC1F,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,IAAY;QAC3C,yBAAyB,CAAC,eAAe,GAAG,IAAI,CAAC;IACnD,CAAC;IAED,6GAA6G;IACtG,MAAM,KAAK,mBAAmB;QACnC,OAAO,yBAAyB,CAAC,oBAAoB,CAAC;IACxD,CAAC;IACM,MAAM,KAAK,mBAAmB,CAAC,KAAc;QAClD,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;QACvD,KAAK,0BAA0B,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;QAChE,qBAAqB,CAAC,4BAA4B,CAAC,aAAa,CAAC,4BAA4B,CAAC,CAAC;QAC/F,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,kFAAkF;IAC3E,MAAM,KAAK,iBAAiB;QACjC,OAAO,yBAAyB,CAAC,kBAAkB,CAAC;IACtD,CAAC;IACM,MAAM,KAAK,iBAAiB,CAAC,KAAc;QAChD,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;QACrD,KAAK,0BAA0B,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;QAC9D,qBAAqB,CAAC,4BAA4B,CAAC,aAAa,CAAC,4BAA4B,CAAC,CAAC;QAC/F,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,qBAAqB;QACjC,uBAAuB;QACvB,IAAI,CAAC,yBAAyB,CAAC,WAAW;YACxC,OAAO;QAET,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;IAClD,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,sBAAsB,CAAC,MAAkD;QACrF,IAAI,CAAC,yBAAyB,CAAC,WAAW;YACxC,OAAO;QAET,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;IAClD,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,sBAAsB,CAAC,MAAkD;QACrF,IAAI,CAAC,yBAAyB,CAAC,WAAW;YACxC,OAAO;QAET,yBAAyB,CAAC,oBAAoB,EAAE,CAAC;IACnD,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,mBAAmB;QAC/B,UAAU,CAAC,GAAG,EAAE;YACd,yBAAyB,CAAC,MAAM,EAAE,CAAC;YACnC,yBAAyB,CAAC,UAAU,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,oDAAoD;IAC7C,MAAM,CAAC,oBAAoB;QAChC,UAAU,CAAC,GAAG,EAAE;YACd,yBAAyB,CAAC,MAAM,EAAE,CAAC;YACnC,yBAAyB,CAAC,WAAW,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,WAAW;QACxB,YAAY,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEO,MAAM,CAAC,UAAU;QACvB,yBAAyB,CAAC,WAAW,EAAE,CAAC;QACxC,yBAAyB,CAAC,QAAQ,GAAG,UAAU,CAAC,yBAAyB,CAAC,MAAM,EAAE,yBAAyB,CAAC,eAAe,CAAC,CAAC;IAC/H,CAAC;IAEO,MAAM,CAAC,MAAM;QACnB,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAEO,MAAM,CAAC,MAAM;QACnB,WAAW,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,SAAS;QACrB,yBAAyB,CAAC,WAAW,EAAE,CAAC;QACxC,2DAA2D;QAC3D,yBAAyB,CAAC,YAAY,GAAG,IAAI,CAAC;QAC9C,yBAAyB,CAAC,WAAW,GAAG,IAAI,CAAC;QAC7C,yBAAyB,CAAC,eAAe,GAAG,KAAK,CAAC;QAClD,yBAAyB,CAAC,eAAe,GAAG,KAAK,CAAC;QAClD,yBAAyB,CAAC,eAAe,GAAG,uBAAuB,CAAC;QACpE,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;QACvD,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;IACvD,CAAC;;AAjKc,sCAAY,GAAY,IAAI,CAAC;AAC7B,qCAAW,GAAY,IAAI,CAAC;AAC5B,yCAAe,GAAY,KAAK,CAAC;AACjC,yCAAe,GAAY,KAAK,CAAC;AACjC,yCAAe,GAAW,uBAAuB,CAAC;AAElD,8CAAoB,GAAY,KAAK,CAAC;AACtC,4CAAkB,GAAY,KAAK,CAAC;SARxC,yBAAyB","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\nimport { UiStateStorage, UiStateStorageStatus } from \"@itwin/core-react\";\nimport { SyncUiEventDispatcher, SyncUiEventId } from \"../syncui/SyncUiEventDispatcher\";\nimport { UiFramework, UserSettingsProvider } from \"../UiFramework\";\n\n/** Class that maintain UiShowHide user settings between sessions\n * @internal\n */\nexport class UiShowHideSettingsProvider implements UserSettingsProvider {\n  private static _settingsNamespace = \"AppUiSettings\";\n  private static _autoHideUiKey = \"AutoHideUi\";\n  private static _useProximityOpacityKey = \"UseProximityOpacity\";\n  private static _snapWidgetOpacityKey = \"SnapWidgetOpacity\";\n  public readonly providerId = \"UiShowHideSettingsProvider\";\n\n  public static initialize() {\n    UiFramework.registerUserSettingsProvider(new UiShowHideSettingsProvider());\n  }\n\n  public async loadUserSettings(storage: UiStateStorage): Promise<void> {\n    let result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._autoHideUiKey);\n    if (result.status === UiStateStorageStatus.Success)\n      InternalUiShowHideManager.setAutoHideUi(result.setting);\n\n    result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._useProximityOpacityKey);\n    if (result.status === UiStateStorageStatus.Success)\n      InternalUiShowHideManager.setUseProximityOpacity(result.setting);\n\n    result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._snapWidgetOpacityKey);\n    if (result.status === UiStateStorageStatus.Success)\n      InternalUiShowHideManager.setSnapWidgetOpacity(result.setting);\n  }\n\n  public static async storeAutoHideUi(v: boolean, storage?: UiStateStorage) {\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._autoHideUiKey, v);\n  }\n\n  public static async storeUseProximityOpacity(v: boolean, storage?: UiStateStorage) {\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._useProximityOpacityKey, v);\n  }\n\n  public static async storeSnapWidgetOpacity(v: boolean, storage?: UiStateStorage) {\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._snapWidgetOpacityKey, v);\n  }\n}\n\n/** The default inactivity time.\n * @internal\n */\nexport const INACTIVITY_TIME_DEFAULT = 3500;  /** Wait 3.5 seconds */\n\n/** Maintains Ui Show/Hide state. The `Ui` includes widgets, panels and the status bar.\n * @internal\n */\nexport class InternalUiShowHideManager {\n  private static _isUiVisible: boolean = true;\n  private static _autoHideUi: boolean = true;\n  private static _showHidePanels: boolean = false;\n  private static _showHideFooter: boolean = false;\n  private static _inactivityTime: number = INACTIVITY_TIME_DEFAULT;\n  private static _timeout: NodeJS.Timeout;\n  private static _useProximityOpacity: boolean = false;\n  private static _snapWidgetOpacity: boolean = false;\n\n  /** Determines if the Ui is visible */\n  public static get isUiVisible() {\n    return InternalUiShowHideManager._isUiVisible;\n  }\n  public static set isUiVisible(visible: boolean) {\n    InternalUiShowHideManager._isUiVisible = visible;\n  }\n\n  /** @public */\n  public static setAutoHideUi(value: boolean) {\n    InternalUiShowHideManager._autoHideUi = value;\n  }\n\n  /** @internal */\n  public static setUseProximityOpacity(value: boolean) {\n    InternalUiShowHideManager._useProximityOpacity = value;\n  }\n\n  /** @internal */\n  public static setSnapWidgetOpacity(value: boolean) {\n    InternalUiShowHideManager._snapWidgetOpacity = value;\n  }\n\n  /** Determines whether the `auto-hide Ui` feature is on. Defaults to false.\n   * When true, the Ui automatically hides after a few seconds of inactivity.\n   */\n  public static get autoHideUi(): boolean {\n    return InternalUiShowHideManager._autoHideUi;\n  }\n\n  public static set autoHideUi(autoHide: boolean) {\n    void UiShowHideSettingsProvider.storeAutoHideUi(autoHide);\n    InternalUiShowHideManager._autoHideUi = autoHide;\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.ShowHideManagerSettingChange);\n  }\n  /** Determines whether the widget panels are shown and hidden. Defaults to false. */\n  public static get showHidePanels(): boolean {\n    return InternalUiShowHideManager._showHidePanels;\n  }\n  public static set showHidePanels(showHide: boolean) {\n    InternalUiShowHideManager._showHidePanels = showHide;\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\n  }\n\n  /** Determines whether the status bar is shown and hidden. Defaults to false. */\n  public static get showHideFooter(): boolean {\n    return InternalUiShowHideManager._showHideFooter;\n  }\n  public static set showHideFooter(showHide: boolean) {\n    InternalUiShowHideManager._showHideFooter = showHide;\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\n  }\n\n  /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */\n  public static get inactivityTime(): number {\n    return InternalUiShowHideManager._inactivityTime;\n  }\n  public static set inactivityTime(time: number) {\n    InternalUiShowHideManager._inactivityTime = time;\n  }\n\n  /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */\n  public static get useProximityOpacity(): boolean {\n    return InternalUiShowHideManager._useProximityOpacity;\n  }\n  public static set useProximityOpacity(value: boolean) {\n    InternalUiShowHideManager._useProximityOpacity = value;\n    void UiShowHideSettingsProvider.storeUseProximityOpacity(value);\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.ShowHideManagerSettingChange);\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\n  }\n\n  /** Determines whether the opacity of a toolbar should snap. Defaults to false. */\n  public static get snapWidgetOpacity(): boolean {\n    return InternalUiShowHideManager._snapWidgetOpacity;\n  }\n  public static set snapWidgetOpacity(value: boolean) {\n    InternalUiShowHideManager._snapWidgetOpacity = value;\n    void UiShowHideSettingsProvider.storeSnapWidgetOpacity(value);\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.ShowHideManagerSettingChange);\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\n  }\n\n  /** Handler for when a Frontstage is ready */\n  public static handleFrontstageReady() {\n    // istanbul ignore next\n    if (!InternalUiShowHideManager._autoHideUi)\n      return;\n\n    InternalUiShowHideManager.showUiAndResetTimer();\n  }\n\n  /** Handler for when the mouse moves over the content area */\n  public static handleContentMouseMove(_event?: React.MouseEvent<HTMLElement, MouseEvent>) {\n    if (!InternalUiShowHideManager._autoHideUi)\n      return;\n\n    InternalUiShowHideManager.showUiAndResetTimer();\n  }\n\n  /** Handler for when the mouse enters a widget */\n  public static handleWidgetMouseEnter(_event?: React.MouseEvent<HTMLElement, MouseEvent>) {\n    if (!InternalUiShowHideManager._autoHideUi)\n      return;\n\n    InternalUiShowHideManager.showUiAndCancelTimer();\n  }\n\n  /** Shows the Ui and resets the inactivity timer */\n  public static showUiAndResetTimer() {\n    setTimeout(() => {\n      InternalUiShowHideManager.showUi();\n      InternalUiShowHideManager.resetTimer();\n    });\n  }\n\n  /** Shows the Ui and cancels the inactivity timer */\n  public static showUiAndCancelTimer() {\n    setTimeout(() => {\n      InternalUiShowHideManager.showUi();\n      InternalUiShowHideManager.cancelTimer();\n    });\n  }\n\n  private static cancelTimer() {\n    clearTimeout(InternalUiShowHideManager._timeout);\n  }\n\n  private static resetTimer() {\n    InternalUiShowHideManager.cancelTimer();\n    InternalUiShowHideManager._timeout = setTimeout(InternalUiShowHideManager.hideUi, InternalUiShowHideManager._inactivityTime);\n  }\n\n  private static showUi() {\n    UiFramework.setIsUiVisible(true);\n  }\n\n  private static hideUi() {\n    UiFramework.setIsUiVisible(false);\n  }\n\n  /** @internal */\n  public static terminate() {\n    InternalUiShowHideManager.cancelTimer();\n    // Ensure that next use will have default values for tests.\n    InternalUiShowHideManager._isUiVisible = true;\n    InternalUiShowHideManager._autoHideUi = true;\n    InternalUiShowHideManager._showHidePanels = false;\n    InternalUiShowHideManager._showHideFooter = false;\n    InternalUiShowHideManager._inactivityTime = INACTIVITY_TIME_DEFAULT;\n    InternalUiShowHideManager._useProximityOpacity = false;\n    InternalUiShowHideManager._snapWidgetOpacity = false;\n  }\n}\n"]}

package/lib/esm/appui-react/utils/PropsHelper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PropsHelper.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAoB,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE/D,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,mBAAmB,IAAI,uBAAuB,EAAE,mBAAmB,IAAI,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAE7K;;GAEG;AACH,qBAAa,WAAW;IACtB,sHAAsH;WACxG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,sBAAsB;IAW1K,8BAA8B;WAChB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,MAAM;IAW7F,+JAA+J;WAEjJ,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,sBAAsB,GAAG,KAAK,CAAC,SAAS,GAAG,GAAG,CAAC,OAAO,GAAG,SAAS;IAO3G,4FAA4F;WAC9E,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG;IAOtD,kEAAkE;WACpD,4BAA4B,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAarK"}
+{"version":3,"file":"PropsHelper.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAoB,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EACL,sBAAsB,EACtB,YAAY,EAEZ,mBAAmB,IAAI,uBAAuB,EAE9C,mBAAmB,IAAI,uBAAuB,EAC/C,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,qBAAa,WAAW;IACtB,sHAAsH;WACxG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,sBAAsB;IAW1K,8BAA8B;WAChB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,MAAM;IAW7F,+JAA+J;WAEjJ,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,sBAAsB,GAAG,KAAK,CAAC,SAAS,GAAG,GAAG,CAAC,OAAO,GAAG,SAAS;IAO3G,4FAA4F;WAC9E,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG;IAOtD,kEAAkE;WACpD,4BAA4B,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAarK"}

package/lib/esm/appui-react/utils/PropsHelper.js

@@ -5,10 +5,11 @@
 /** @packageDocumentation
  * @module Utilities
  */
+/* eslint-disable @typescript-eslint/ban-ts-comment */
 import * as React from "react";
 import { Icon, IconHelper } from "@itwin/core-react";
+import { ConditionalStringValue, } from "@itwin/appui-abstract";
 import { UiFramework } from "../UiFramework";
-import { ConditionalStringValue } from "@itwin/appui-abstract";
 /** A set of helper methods for various props
  * @public
  */

package/lib/esm/appui-react/utils/PropsHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"PropsHelper.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,IAAI,EAAE,UAAU,EAAY,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,sBAAsB,EAAgH,MAAM,uBAAuB,CAAC;AAE7K;;GAEG;AACH,MAAM,OAAO,WAAW;IACtB,sHAAsH;IAC/G,MAAM,CAAC,aAAa,CAAC,aAAyE,EAAE,SAAkB;QACvH,IAAI,aAAa,EAAE;YACjB,OAAO,aAAa,CAAC;SACtB;QAED,IAAI,QAAQ,GAAG,EAAE,CAAC;QAClB,IAAI,SAAS;YACX,QAAQ,GAAG,WAAW,CAAC,YAAY,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,iBAAiB,CAAC,IAAoD;QAClF,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,KAAK,GAAG,IAAI,CAAC;aACV,IAAI,IAAI,YAAY,sBAAsB;YAC7C,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;;YAEnB,KAAK,GAAG,IAAI,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+JAA+J;IAC/J,gEAAgE;IACzD,MAAM,CAAC,OAAO,CAAC,QAA2D;QAC/E,IAAI,QAAQ,YAAY,sBAAsB;YAC5C,OAAO,oBAAC,IAAI,IAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,GAAI,CAAC;QAE5C,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,oBAAC,IAAI,IAAC,QAAQ,EAAE,QAAQ,GAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,CAAC;IAED,4FAA4F;IACrF,MAAM,CAAC,cAAc,CAAC,MAAW,EAAE,OAAY;QACpD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC;SAChD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kEAAkE;IAC3D,MAAM,CAAC,4BAA4B,CAAC,QAAkB,EAAE,YAA+B;QAC5F,uBAAuB;QACvB,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC;YAC9C,OAAO,EAAE,CAAC;QAEZ,uBAAuB;QACvB,IAAI,CAAC,YAAY;YACf,YAAY,GAAG,IAAI,GAAG,EAAe,CAAC;QAExC,MAAM,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAE5D,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Utilities\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { Icon, IconHelper, IconSpec } from \"@itwin/core-react\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { ConditionalStringValue, StringGetter, AbstractWidgetProps as UIA_AbstractWidgetProps, CommonBackstageItem as UIA_CommonBackstageItem } from \"@itwin/appui-abstract\";\r\n\r\n/** A set of helper methods for various props\r\n * @public\r\n */\r\nexport class PropsHelper {\r\n  /** Get spec for returning a string. Could be a simple string of a 'StringGetter' method used to return the string. */\r\n  public static getStringSpec(explicitValue: string | StringGetter | ConditionalStringValue | undefined, stringKey?: string): string | StringGetter | ConditionalStringValue {\r\n    if (explicitValue) {\r\n      return explicitValue;\r\n    }\r\n\r\n    let outValue = \"\";\r\n    if (stringKey)\r\n      outValue = UiFramework.localization.getLocalizedString(stringKey);\r\n    return outValue;\r\n  }\r\n\r\n  /** Get the display string. */\r\n  public static getStringFromSpec(spec: string | StringGetter | ConditionalStringValue): string {\r\n    let label = \"\";\r\n    if (typeof spec === \"string\")\r\n      label = spec;\r\n    else if (spec instanceof ConditionalStringValue)\r\n      label = spec.value;\r\n    else\r\n      label = spec();\r\n    return label;\r\n  }\r\n\r\n  /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  public static getIcon(iconSpec: string | ConditionalStringValue | React.ReactNode): JSX.Element | undefined {\r\n    if (iconSpec instanceof ConditionalStringValue)\r\n      return <Icon iconSpec={iconSpec.value} />;\r\n\r\n    return (iconSpec) ? <Icon iconSpec={iconSpec} /> : undefined;\r\n  }\r\n\r\n  /** returns true if the two objects are the same using a shallow compare of each property */\r\n  public static isShallowEqual(newObj: any, prevObj: any) {\r\n    for (const key in newObj) {\r\n      if (newObj[key] !== prevObj[key]) return false;\r\n    }\r\n    return true;\r\n  }\r\n\r\n  /** @deprecated in 4.0 These abstract props types are obsolete. */\r\n  public static getAbstractPropsForReactIcon(iconSpec: IconSpec, internalData?: Map<string, any>): Partial<UIA_AbstractWidgetProps> | Partial<UIA_CommonBackstageItem> { // eslint-disable-line deprecation/deprecation\r\n    // istanbul ignore else\r\n    if (!iconSpec || !React.isValidElement(iconSpec))\r\n      return {};\r\n\r\n    // istanbul ignore else\r\n    if (!internalData)\r\n      internalData = new Map<string, any>();\r\n\r\n    const icon = IconHelper.getIconData(iconSpec, internalData);\r\n\r\n    return (icon === \"\" ? { icon } : { icon, internalData });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"PropsHelper.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,sDAAsD;AAEtD,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,IAAI,EAAE,UAAU,EAAY,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EACL,sBAAsB,GAMvB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C;;GAEG;AACH,MAAM,OAAO,WAAW;IACtB,sHAAsH;IAC/G,MAAM,CAAC,aAAa,CAAC,aAAyE,EAAE,SAAkB;QACvH,IAAI,aAAa,EAAE;YACjB,OAAO,aAAa,CAAC;SACtB;QAED,IAAI,QAAQ,GAAG,EAAE,CAAC;QAClB,IAAI,SAAS;YACX,QAAQ,GAAG,WAAW,CAAC,YAAY,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,iBAAiB,CAAC,IAAoD;QAClF,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,KAAK,GAAG,IAAI,CAAC;aACV,IAAI,IAAI,YAAY,sBAAsB;YAC7C,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;;YAEnB,KAAK,GAAG,IAAI,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+JAA+J;IAC/J,gEAAgE;IACzD,MAAM,CAAC,OAAO,CAAC,QAA2D;QAC/E,IAAI,QAAQ,YAAY,sBAAsB;YAC5C,OAAO,oBAAC,IAAI,IAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,GAAI,CAAC;QAE5C,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,oBAAC,IAAI,IAAC,QAAQ,EAAE,QAAQ,GAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,CAAC;IAED,4FAA4F;IACrF,MAAM,CAAC,cAAc,CAAC,MAAW,EAAE,OAAY;QACpD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC;SAChD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kEAAkE;IAC3D,MAAM,CAAC,4BAA4B,CAAC,QAAkB,EAAE,YAA+B;QAC5F,uBAAuB;QACvB,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC;YAC9C,OAAO,EAAE,CAAC;QAEZ,uBAAuB;QACvB,IAAI,CAAC,YAAY;YACf,YAAY,GAAG,IAAI,GAAG,EAAe,CAAC;QAExC,MAAM,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAE5D,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF","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/* eslint-disable @typescript-eslint/ban-ts-comment */\n\nimport * as React from \"react\";\nimport { Icon, IconHelper, IconSpec } from \"@itwin/core-react\";\nimport {\n  ConditionalStringValue,\n  StringGetter,\n  // @ts-ignore Removed in 4.0\n  AbstractWidgetProps as UIA_AbstractWidgetProps,\n  // @ts-ignore Removed in 4.0\n  CommonBackstageItem as UIA_CommonBackstageItem,\n} from \"@itwin/appui-abstract\";\nimport { UiFramework } from \"../UiFramework\";\n/** A set of helper methods for various props\n * @public\n */\nexport class PropsHelper {\n  /** Get spec for returning a string. Could be a simple string of a 'StringGetter' method used to return the string. */\n  public static getStringSpec(explicitValue: string | StringGetter | ConditionalStringValue | undefined, stringKey?: string): string | StringGetter | ConditionalStringValue {\n    if (explicitValue) {\n      return explicitValue;\n    }\n\n    let outValue = \"\";\n    if (stringKey)\n      outValue = UiFramework.localization.getLocalizedString(stringKey);\n    return outValue;\n  }\n\n  /** Get the display string. */\n  public static getStringFromSpec(spec: string | StringGetter | ConditionalStringValue): string {\n    let label = \"\";\n    if (typeof spec === \"string\")\n      label = spec;\n    else if (spec instanceof ConditionalStringValue)\n      label = spec.value;\n    else\n      label = spec();\n    return label;\n  }\n\n  /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  public static getIcon(iconSpec: string | ConditionalStringValue | React.ReactNode): JSX.Element | undefined {\n    if (iconSpec instanceof ConditionalStringValue)\n      return <Icon iconSpec={iconSpec.value} />;\n\n    return (iconSpec) ? <Icon iconSpec={iconSpec} /> : undefined;\n  }\n\n  /** returns true if the two objects are the same using a shallow compare of each property */\n  public static isShallowEqual(newObj: any, prevObj: any) {\n    for (const key in newObj) {\n      if (newObj[key] !== prevObj[key]) return false;\n    }\n    return true;\n  }\n\n  /** @deprecated in 4.0 These abstract props types are obsolete. */\n  public static getAbstractPropsForReactIcon(iconSpec: IconSpec, internalData?: Map<string, any>): Partial<UIA_AbstractWidgetProps> | Partial<UIA_CommonBackstageItem> { // eslint-disable-line deprecation/deprecation\n    // istanbul ignore else\n    if (!iconSpec || !React.isValidElement(iconSpec))\n      return {};\n\n    // istanbul ignore else\n    if (!internalData)\n      internalData = new Map<string, any>();\n\n    const icon = IconHelper.getIconData(iconSpec, internalData);\n\n    return (icon === \"\" ? { icon } : { icon, internalData });\n  }\n}\n"]}