@itwin/appui-abstract 3.6.1 → 3.7.0-dev.2

package/CHANGELOG.md

@@ -1,11 +1,6 @@
 # Change Log - @itwin/appui-abstract
 
-This log was last generated on Fri, 24 Feb 2023 22:00:48 GMT and should not be manually modified.
-
-## 3.6.1
-Fri, 24 Feb 2023 22:00:48 GMT
-
-_Version update only_
+This log was last generated on Wed, 08 Feb 2023 14:58:39 GMT and should not be manually modified.
 
 ## 3.6.0
 Wed, 08 Feb 2023 14:58:39 GMT
@@ -248,7 +243,7 @@ Mon, 24 Jan 2022 14:00:52 GMT
 - UiFramework and UiIModelComponent initialize method no longer take localization argument, uses IModelApp.localization internally.
 - Remove old aribiter related functions that are not used.
 - Add BaseUiItemsProvider class
-- Replaced ui-core Slider with one from iTwinUi-react. 
+- Replaced ui-core Slider with one from iTwinUi-react.
 - Add support for widget tab icons in UI-2
 
 ## 2.19.28
@@ -911,7 +906,7 @@ Wed, 06 May 2020 13:17:49 GMT
 - In source documentation. Some learning docs & API changes.
 - TOC for UI 2.0 Docs, @alpha to @beta, Components Examples
 - Started ui-components Learning doc section
-- Update doc tags for automatic UI creation 
+- Update doc tags for automatic UI creation
 - Refactor to remove duplicate ComponentGenerator instantiation. Rename files and components to remove React reference.
 - Update auto-generated dialog items to work with the Tool Settings Bar.
 - Add ConditionalBoolean support for isHidden and isDisabled properties.

package/lib/cjs/appui-abstract/dialogs/DialogItem.d.ts

@@ -18,7 +18,7 @@ export interface EditorPosition {
     /** Determines the column position for the type editor */
     columnIndex: number;
     /** Number of columns to occupy. Defaults to 1
-     * @deprecated in 2.x.
+     * @deprecated in 2.19. No longer necessary, ignored.
      */
     columnSpan?: number;
 }

package/lib/cjs/appui-abstract/dialogs/DialogItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"DialogItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/dialogs/DialogItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA0DH;;GAEG;AACH,MAAa,cAAc;IACzB,YAAmB,WAAgC,EAAU,MAAS,EAAU,aAAsB,EAAU,WAAqB;QAAlH,gBAAW,GAAX,WAAW,CAAqB;QAAU,WAAM,GAAN,MAAM,CAAG;QAAU,kBAAa,GAAb,aAAa,CAAS;QAAU,gBAAW,GAAX,WAAW,CAAU;IAAI,CAAC;IAE1I,IAAW,UAAU;QACnB,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED,IAAW,UAAU,CAAC,GAAY;QAChC,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;IACzB,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,KAAK,CAAC,GAAM;QACrB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;IACpB,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED,IAAW,YAAY,CAAC,GAAuB;QAC7C,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC;IAC3B,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,IAAW,eAAe;QACxB,uBAAuB;QACvB,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,WAAW,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,YAAY,IAAI;YAC7K,OAAO;gBACL,KAAK,EAAE,IAAI,CAAC,MAAM;gBAClB,YAAY,EAAE,IAAI,CAAC,aAAa;aACd,CAAC;QACvB,uBAAuB;QACvB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED,IAAW,eAAe,CAAC,GAAoB;QAC7C,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,KAAqB,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC;IACxC,CAAC;IAED,IAAW,QAAQ;QACjB,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC;QACpC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,UAAU,EAAE,CAAC;IAC9E,CAAC;IAED,IAAW,IAAI;QACb,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC;IAClE,CAAC;IAEM,YAAY,CAAC,cAA8B,EAAE,YAAyB;QAC3E,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,cAAc,EAAE,UAAU,EAAE,IAAI,CAAC,WAAW,EAAE,YAAY,EAAE,CAAC;IACjI,CAAC;CACF;AA3DD,wCA2DC","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 Dialog\n */\n\nimport { PropertyDescription } from \"../properties/Description\";\n\n/** [[DialogItemValue]] Interface of PrimitiveValue types that have type editor support for use in dialogs.\n * @public\n */\nexport interface DialogItemValue {\n  value?: number | string | boolean | Date;\n  displayValue?: string;\n}\n/** [[EditorPosition]] Interface used to identify the location of the item a DialogItem property value.\n * @public\n */\nexport interface EditorPosition {\n  /** Determine the order the row is shown in UI */\n  rowPriority: number;\n  /** Determines the column position for the type editor */\n  columnIndex: number;\n  /** Number of columns to occupy. Defaults to 1\n   * @deprecated in 2.x.\n   */\n  columnSpan?: number;\n}\n\n/** [[BaseDialogItem]] contains only the members necessary to create a PropertyRecord.\n * @public\n */\nexport interface BaseDialogItem {\n  readonly value: DialogItemValue;\n  readonly property: PropertyDescription;\n  readonly isDisabled?: boolean;\n}\n/** [[DialogItem]] is the specification that the display engine turns into a UI item.\n * @see See learning documentation [DialogItem]($docs/learning/ui/abstract/dialogitem.md)\n * @public\n */\nexport interface DialogItem extends BaseDialogItem {\n  readonly editorPosition: EditorPosition;\n  readonly lockProperty?: BaseDialogItem;\n}\n\n/** [[DialogPropertyItem]] us the specification to use if you are defining the components directly, e.g., in React\n * @public\n */\nexport interface DialogPropertyItem {\n  readonly value: DialogItemValue;\n  readonly propertyName: string;\n}\n\n/** [[DialogPropertySyncItem]] is used to pass sync messages for DialogPropertyItems\n * @public\n */\nexport interface DialogPropertySyncItem extends DialogPropertyItem {\n  readonly isDisabled?: boolean;\n  readonly property?: PropertyDescription;\n}\n\n/** [[DialogProperty]] is a generic helper class that assists working with properties used by UiLayoutDataProvider implementations (i.e. Tool Settings and Dynamic Dialogs).\n * @public\n */\nexport class DialogProperty<T> {\n  constructor(public description: PropertyDescription, private _value: T, private _displayValue?: string, private _isDisabled?: boolean) { }\n\n  public get isDisabled() {\n    return !!this._isDisabled;\n  }\n\n  public set isDisabled(val: boolean) {\n    this._isDisabled = val;\n  }\n\n  public get value() {\n    return this._value;\n  }\n\n  public set value(val: T) {\n    this._value = val;\n  }\n\n  public get name() {\n    return this.description.name;\n  }\n\n  public set displayValue(val: string | undefined) {\n    this._displayValue = val;\n  }\n\n  public get displayValue() {\n    return this._displayValue;\n  }\n\n  public get dialogItemValue() {\n    // istanbul ignore else\n    if (typeof this._value === \"string\" || typeof this._value === \"number\" || typeof this._value === \"undefined\" || typeof this._value === \"boolean\" || this._value instanceof Date)\n      return {\n        value: this._value,\n        displayValue: this._displayValue,\n      } as DialogItemValue;\n    // istanbul ignore next\n    throw new Error(\"Not valid primitive type\");\n  }\n\n  public set dialogItemValue(val: DialogItemValue) {\n    this._value = val.value as unknown as T;\n    this._displayValue = val.displayValue;\n  }\n\n  public get syncItem(): DialogPropertySyncItem {\n    const isDisabled = this._isDisabled;\n    return { propertyName: this.name, value: this.dialogItemValue, isDisabled };\n  }\n\n  public get item(): DialogPropertyItem {\n    return { propertyName: this.name, value: this.dialogItemValue };\n  }\n\n  public toDialogItem(editorPosition: EditorPosition, lockProperty?: DialogItem): DialogItem {\n    return { value: this.dialogItemValue, property: this.description, editorPosition, isDisabled: this._isDisabled, lockProperty };\n  }\n}\n"]}
+{"version":3,"file":"DialogItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/dialogs/DialogItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA0DH;;GAEG;AACH,MAAa,cAAc;IACzB,YAAmB,WAAgC,EAAU,MAAS,EAAU,aAAsB,EAAU,WAAqB;QAAlH,gBAAW,GAAX,WAAW,CAAqB;QAAU,WAAM,GAAN,MAAM,CAAG;QAAU,kBAAa,GAAb,aAAa,CAAS;QAAU,gBAAW,GAAX,WAAW,CAAU;IAAI,CAAC;IAE1I,IAAW,UAAU;QACnB,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED,IAAW,UAAU,CAAC,GAAY;QAChC,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;IACzB,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,KAAK,CAAC,GAAM;QACrB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;IACpB,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED,IAAW,YAAY,CAAC,GAAuB;QAC7C,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC;IAC3B,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,IAAW,eAAe;QACxB,uBAAuB;QACvB,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,WAAW,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,YAAY,IAAI;YAC7K,OAAO;gBACL,KAAK,EAAE,IAAI,CAAC,MAAM;gBAClB,YAAY,EAAE,IAAI,CAAC,aAAa;aACd,CAAC;QACvB,uBAAuB;QACvB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED,IAAW,eAAe,CAAC,GAAoB;QAC7C,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,KAAqB,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC;IACxC,CAAC;IAED,IAAW,QAAQ;QACjB,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC;QACpC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,UAAU,EAAE,CAAC;IAC9E,CAAC;IAED,IAAW,IAAI;QACb,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC;IAClE,CAAC;IAEM,YAAY,CAAC,cAA8B,EAAE,YAAyB;QAC3E,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,cAAc,EAAE,UAAU,EAAE,IAAI,CAAC,WAAW,EAAE,YAAY,EAAE,CAAC;IACjI,CAAC;CACF;AA3DD,wCA2DC","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 Dialog\n */\n\nimport { PropertyDescription } from \"../properties/Description\";\n\n/** [[DialogItemValue]] Interface of PrimitiveValue types that have type editor support for use in dialogs.\n * @public\n */\nexport interface DialogItemValue {\n  value?: number | string | boolean | Date;\n  displayValue?: string;\n}\n/** [[EditorPosition]] Interface used to identify the location of the item a DialogItem property value.\n * @public\n */\nexport interface EditorPosition {\n  /** Determine the order the row is shown in UI */\n  rowPriority: number;\n  /** Determines the column position for the type editor */\n  columnIndex: number;\n  /** Number of columns to occupy. Defaults to 1\n   * @deprecated in 2.19. No longer necessary, ignored.\n   */\n  columnSpan?: number;\n}\n\n/** [[BaseDialogItem]] contains only the members necessary to create a PropertyRecord.\n * @public\n */\nexport interface BaseDialogItem {\n  readonly value: DialogItemValue;\n  readonly property: PropertyDescription;\n  readonly isDisabled?: boolean;\n}\n/** [[DialogItem]] is the specification that the display engine turns into a UI item.\n * @see See learning documentation [DialogItem]($docs/learning/ui/abstract/dialogitem.md)\n * @public\n */\nexport interface DialogItem extends BaseDialogItem {\n  readonly editorPosition: EditorPosition;\n  readonly lockProperty?: BaseDialogItem;\n}\n\n/** [[DialogPropertyItem]] us the specification to use if you are defining the components directly, e.g., in React\n * @public\n */\nexport interface DialogPropertyItem {\n  readonly value: DialogItemValue;\n  readonly propertyName: string;\n}\n\n/** [[DialogPropertySyncItem]] is used to pass sync messages for DialogPropertyItems\n * @public\n */\nexport interface DialogPropertySyncItem extends DialogPropertyItem {\n  readonly isDisabled?: boolean;\n  readonly property?: PropertyDescription;\n}\n\n/** [[DialogProperty]] is a generic helper class that assists working with properties used by UiLayoutDataProvider implementations (i.e. Tool Settings and Dynamic Dialogs).\n * @public\n */\nexport class DialogProperty<T> {\n  constructor(public description: PropertyDescription, private _value: T, private _displayValue?: string, private _isDisabled?: boolean) { }\n\n  public get isDisabled() {\n    return !!this._isDisabled;\n  }\n\n  public set isDisabled(val: boolean) {\n    this._isDisabled = val;\n  }\n\n  public get value() {\n    return this._value;\n  }\n\n  public set value(val: T) {\n    this._value = val;\n  }\n\n  public get name() {\n    return this.description.name;\n  }\n\n  public set displayValue(val: string | undefined) {\n    this._displayValue = val;\n  }\n\n  public get displayValue() {\n    return this._displayValue;\n  }\n\n  public get dialogItemValue() {\n    // istanbul ignore else\n    if (typeof this._value === \"string\" || typeof this._value === \"number\" || typeof this._value === \"undefined\" || typeof this._value === \"boolean\" || this._value instanceof Date)\n      return {\n        value: this._value,\n        displayValue: this._displayValue,\n      } as DialogItemValue;\n    // istanbul ignore next\n    throw new Error(\"Not valid primitive type\");\n  }\n\n  public set dialogItemValue(val: DialogItemValue) {\n    this._value = val.value as unknown as T;\n    this._displayValue = val.displayValue;\n  }\n\n  public get syncItem(): DialogPropertySyncItem {\n    const isDisabled = this._isDisabled;\n    return { propertyName: this.name, value: this.dialogItemValue, isDisabled };\n  }\n\n  public get item(): DialogPropertyItem {\n    return { propertyName: this.name, value: this.dialogItemValue };\n  }\n\n  public toDialogItem(editorPosition: EditorPosition, lockProperty?: DialogItem): DialogItem {\n    return { value: this.dialogItemValue, property: this.description, editorPosition, isDisabled: this._isDisabled, lockProperty };\n  }\n}\n"]}

package/lib/cjs/appui-abstract/statusbar/StatusBarItem.d.ts

@@ -36,7 +36,7 @@ export declare enum StatusBarLabelSide {
     Right = 1
 }
 /** Type for StatusBar Item Id
- * @deprecated in 3.6.
+ * @deprecated in 3.6. Please use `CommonStatusBarItem["id"]` from @itwin/appui-react.
  * @public
  */
 export declare type StatusBarItemId = CommonStatusBarItem["id"];

package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"StatusBarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;;GAGG;AACH,IAAY,gBAeX;AAfD,WAAY,gBAAgB;IAC1B,4CAA4C;IAC5C,6DAAW,CAAA;IACX,4CAA4C;IAC5C,uDAAQ,CAAA;IACR,mCAAmC;IACnC,yDAAS,CAAA;IACT,mCAAmC;IACnC,2DAAU,CAAA;IACV,sCAAsC;IACtC,iEAAa,CAAA;IACb,sCAAsC;IACtC,yDAAS,CAAA;IACT,4CAA4C;IAC5C,6DAAW,CAAA;AACb,CAAC,EAfW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAe3B;AAED;;;GAGG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,8EAA8E;IAC9E,2DAAI,CAAA;IACJ,6CAA6C;IAC7C,6DAAK,CAAA;AACP,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B;AA0ED;;;GAGG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAQ,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AACpH,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC;AAEF;;;GAGG;AACI,MAAM,4BAA4B,GAAG,CAAC,IAAyB,EAAsC,EAAE;IAC5G,OAAQ,IAAmC,CAAC,KAAK,KAAK,SAAS,IAAK,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAChL,CAAC,CAAC;AAFW,QAAA,4BAA4B,gCAEvC;AAEF;;;GAGG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAO,CAAC,CAAE,IAAoC,CAAC,QAAQ,CAAC,CAAC,8CAA8C;AACzG,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC;AAEF;;;GAGG;AACH,MAAa,8BAA8B;;AAA3C,wEAgBC;AAfC,oDAAoD;AACtC,+CAAgB,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,OAAwC,EAAE,OAAmB,EAAE,SAAgD,EAA+B,EAAE,CAAC,CAAC;IACtR,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,OAAO;IACb,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,kDAAkD;AACpC,8CAAe,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,SAAS,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAA+C,EAA8B,EAAE,CAAC,CAAC;IAClS,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,KAAK;IACX,SAAS;IACT,GAAG,SAAS;CACb,CAAC,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 StatusBar\n */\n\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\n\n/** Status bar Groups/Sections from Left to Right\n * @deprecated in 3.6. Use [StatusBarSection]($appui-react) instead.\n * @public\n */\nexport enum StatusBarSection {\n  /** area for tool assistance and messages */\n  Message = 0,\n  /** area for tool assistance and messages */\n  Left = 0,\n  /** items specific to stage/task */\n  Stage = 1,\n  /** items specific to stage/task */\n  Center = 1,\n  /** Select scope and selection info */\n  Selection = 2,\n  /** Select scope and selection info */\n  Right = 2,\n  /** items that only show based on context */\n  Context = 3,\n}\n\n/** Defines which side of Icon where label is placed\n * @deprecated in 3.6. Use [StatusBarLabelSide]($appui-react) instead.\n * @public\n */\nexport enum StatusBarLabelSide {\n  /** Label is placed left side of icon. This is the default if not specified */\n  Left,\n  /** Label is placed on right side of icon. */\n  Right,\n}\n\n/** Type for StatusBar Item Id\n * @deprecated in 3.6.\n * @public\n */\nexport type StatusBarItemId = CommonStatusBarItem[\"id\"]; // eslint-disable-line deprecation/deprecation\n\n/** Describes the data needed to insert a button into the status bar.\n * @deprecated in 3.6. Use [CommonStatusBarItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\n  /** can be used by application to store miscellaneous data. */\n  applicationData?: any;\n  /** Describes badge. Renders no badge if not specified. */\n  readonly badgeType?: BadgeType;\n  /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\n  readonly id: string;\n  /** optional data to used by item implementor. */\n  readonly internalData?: Map<string, any>;\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\n  readonly isHidden?: boolean | ConditionalBooleanValue;\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\n  /** Priority within a section (recommend using values 1 through 100). */\n  readonly itemPriority: number;\n  /** status bar section */\n  readonly section: StatusBarSection; // eslint-disable-line deprecation/deprecation\n}\n\n/** Describes the data needed to insert an action item into the status bar.\n * @deprecated in 3.6. Use [StatusBarActionItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarActionItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\n  /** method to execute when icon is pressed */\n  readonly execute: () => void;\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** Label. */\n  readonly label?: string | ConditionalStringValue;\n  /** tooltip. */\n  readonly tooltip?: string | ConditionalStringValue;\n}\n\n/** Describes the data needed to insert a label item with an optional icon into the status bar.\n * @deprecated in 3.6. Use [StatusBarLabelItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarLabelItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** Label. */\n  readonly label: string | ConditionalStringValue;\n  /** Defines which side of icon to display label if icon is defined. */\n  readonly labelSide?: StatusBarLabelSide; // eslint-disable-line deprecation/deprecation\n}\n\n/** Describes the data needed to insert a custom item into the status bar. This is used to allow extension\n *  implementer to create a framework specific component.\n * @deprecated in 3.6. Use [StatusBarCustomItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarCustomItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\n  readonly isCustom: true;\n}\n\n/** Describes the data needed to insert a button into the status bar.\n * @deprecated in 3.6. Use [AnyStatusBarItem]($appui-react) instead.\n * @public\n */\nexport type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem; // eslint-disable-line deprecation/deprecation\n\n/** AbstractStatusBarActionItem type guard.\n * @deprecated in 3.6. Use [isStatusBarActionItem]($appui-react) instead.\n * @public\n */\nexport const isAbstractStatusBarActionItem = (item: CommonStatusBarItem): item is AbstractStatusBarActionItem => { // eslint-disable-line deprecation/deprecation\n  return (item as AbstractStatusBarActionItem).execute !== undefined; // eslint-disable-line deprecation/deprecation\n};\n\n/** AbstractStatusBarLabelItem type guard.\n * @deprecated in 3.6. Use [isStatusBarLabelItem]($appui-react) instead.\n * @public\n */\nexport const isAbstractStatusBarLabelItem = (item: CommonStatusBarItem): item is AbstractStatusBarLabelItem => { // eslint-disable-line deprecation/deprecation\n  return (item as AbstractStatusBarLabelItem).label !== undefined && (item as AbstractStatusBarActionItem).execute === undefined; // eslint-disable-line deprecation/deprecation\n};\n\n/** AbstractStatusBarCustomItem type guard.\n * @deprecated in 3.6. Use [isStatusBarCustomItem]($appui-react) instead.\n * @public\n */\nexport const isAbstractStatusBarCustomItem = (item: CommonStatusBarItem): item is AbstractStatusBarCustomItem => { // eslint-disable-line deprecation/deprecation\n  return !!(item as AbstractStatusBarCustomItem).isCustom; // eslint-disable-line deprecation/deprecation\n};\n\n/** Helper class to create Abstract StatusBar Item definitions.\n * @deprecated in 3.6. Use [StatusBarItemUtilities]($appui-react) instead.\n * @public\n */\nexport class AbstractStatusBarItemUtilities {\n  /** Creates a StatusBar item to perform an action */\n  public static createActionItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem>): AbstractStatusBarActionItem => ({ // eslint-disable-line deprecation/deprecation\n    id, section, itemPriority,\n    icon, tooltip,\n    execute,\n    ...overrides,\n  });\n\n  /** Creates a StatusBar item to display a label */\n  public static createLabelItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide = StatusBarLabelSide.Right, overrides?: Partial<AbstractStatusBarLabelItem>): AbstractStatusBarLabelItem => ({ // eslint-disable-line deprecation/deprecation\n    id, section, itemPriority,\n    icon, label,\n    labelSide,\n    ...overrides,\n  });\n}\n"]}
+{"version":3,"file":"StatusBarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;;GAGG;AACH,IAAY,gBAeX;AAfD,WAAY,gBAAgB;IAC1B,4CAA4C;IAC5C,6DAAW,CAAA;IACX,4CAA4C;IAC5C,uDAAQ,CAAA;IACR,mCAAmC;IACnC,yDAAS,CAAA;IACT,mCAAmC;IACnC,2DAAU,CAAA;IACV,sCAAsC;IACtC,iEAAa,CAAA;IACb,sCAAsC;IACtC,yDAAS,CAAA;IACT,4CAA4C;IAC5C,6DAAW,CAAA;AACb,CAAC,EAfW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAe3B;AAED;;;GAGG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,8EAA8E;IAC9E,2DAAI,CAAA;IACJ,6CAA6C;IAC7C,6DAAK,CAAA;AACP,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B;AA0ED;;;GAGG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAQ,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AACpH,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC;AAEF;;;GAGG;AACI,MAAM,4BAA4B,GAAG,CAAC,IAAyB,EAAsC,EAAE;IAC5G,OAAQ,IAAmC,CAAC,KAAK,KAAK,SAAS,IAAK,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAChL,CAAC,CAAC;AAFW,QAAA,4BAA4B,gCAEvC;AAEF;;;GAGG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAO,CAAC,CAAE,IAAoC,CAAC,QAAQ,CAAC,CAAC,8CAA8C;AACzG,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC;AAEF;;;GAGG;AACH,MAAa,8BAA8B;;AAA3C,wEAgBC;AAfC,oDAAoD;AACtC,+CAAgB,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,OAAwC,EAAE,OAAmB,EAAE,SAAgD,EAA+B,EAAE,CAAC,CAAC;IACtR,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,OAAO;IACb,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,kDAAkD;AACpC,8CAAe,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,SAAS,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAA+C,EAA8B,EAAE,CAAC,CAAC;IAClS,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,KAAK;IACX,SAAS;IACT,GAAG,SAAS;CACb,CAAC,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 StatusBar\n */\n\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\n\n/** Status bar Groups/Sections from Left to Right\n * @deprecated in 3.6. Use [StatusBarSection]($appui-react) instead.\n * @public\n */\nexport enum StatusBarSection {\n  /** area for tool assistance and messages */\n  Message = 0,\n  /** area for tool assistance and messages */\n  Left = 0,\n  /** items specific to stage/task */\n  Stage = 1,\n  /** items specific to stage/task */\n  Center = 1,\n  /** Select scope and selection info */\n  Selection = 2,\n  /** Select scope and selection info */\n  Right = 2,\n  /** items that only show based on context */\n  Context = 3,\n}\n\n/** Defines which side of Icon where label is placed\n * @deprecated in 3.6. Use [StatusBarLabelSide]($appui-react) instead.\n * @public\n */\nexport enum StatusBarLabelSide {\n  /** Label is placed left side of icon. This is the default if not specified */\n  Left,\n  /** Label is placed on right side of icon. */\n  Right,\n}\n\n/** Type for StatusBar Item Id\n * @deprecated in 3.6. Please use `CommonStatusBarItem[\"id\"]` from @itwin/appui-react.\n * @public\n */\nexport type StatusBarItemId = CommonStatusBarItem[\"id\"]; // eslint-disable-line deprecation/deprecation\n\n/** Describes the data needed to insert a button into the status bar.\n * @deprecated in 3.6. Use [CommonStatusBarItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\n  /** can be used by application to store miscellaneous data. */\n  applicationData?: any;\n  /** Describes badge. Renders no badge if not specified. */\n  readonly badgeType?: BadgeType;\n  /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\n  readonly id: string;\n  /** optional data to used by item implementor. */\n  readonly internalData?: Map<string, any>;\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\n  readonly isHidden?: boolean | ConditionalBooleanValue;\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\n  /** Priority within a section (recommend using values 1 through 100). */\n  readonly itemPriority: number;\n  /** status bar section */\n  readonly section: StatusBarSection; // eslint-disable-line deprecation/deprecation\n}\n\n/** Describes the data needed to insert an action item into the status bar.\n * @deprecated in 3.6. Use [StatusBarActionItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarActionItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\n  /** method to execute when icon is pressed */\n  readonly execute: () => void;\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** Label. */\n  readonly label?: string | ConditionalStringValue;\n  /** tooltip. */\n  readonly tooltip?: string | ConditionalStringValue;\n}\n\n/** Describes the data needed to insert a label item with an optional icon into the status bar.\n * @deprecated in 3.6. Use [StatusBarLabelItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarLabelItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** Label. */\n  readonly label: string | ConditionalStringValue;\n  /** Defines which side of icon to display label if icon is defined. */\n  readonly labelSide?: StatusBarLabelSide; // eslint-disable-line deprecation/deprecation\n}\n\n/** Describes the data needed to insert a custom item into the status bar. This is used to allow extension\n *  implementer to create a framework specific component.\n * @deprecated in 3.6. Use [StatusBarCustomItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarCustomItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\n  readonly isCustom: true;\n}\n\n/** Describes the data needed to insert a button into the status bar.\n * @deprecated in 3.6. Use [AnyStatusBarItem]($appui-react) instead.\n * @public\n */\nexport type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem; // eslint-disable-line deprecation/deprecation\n\n/** AbstractStatusBarActionItem type guard.\n * @deprecated in 3.6. Use [isStatusBarActionItem]($appui-react) instead.\n * @public\n */\nexport const isAbstractStatusBarActionItem = (item: CommonStatusBarItem): item is AbstractStatusBarActionItem => { // eslint-disable-line deprecation/deprecation\n  return (item as AbstractStatusBarActionItem).execute !== undefined; // eslint-disable-line deprecation/deprecation\n};\n\n/** AbstractStatusBarLabelItem type guard.\n * @deprecated in 3.6. Use [isStatusBarLabelItem]($appui-react) instead.\n * @public\n */\nexport const isAbstractStatusBarLabelItem = (item: CommonStatusBarItem): item is AbstractStatusBarLabelItem => { // eslint-disable-line deprecation/deprecation\n  return (item as AbstractStatusBarLabelItem).label !== undefined && (item as AbstractStatusBarActionItem).execute === undefined; // eslint-disable-line deprecation/deprecation\n};\n\n/** AbstractStatusBarCustomItem type guard.\n * @deprecated in 3.6. Use [isStatusBarCustomItem]($appui-react) instead.\n * @public\n */\nexport const isAbstractStatusBarCustomItem = (item: CommonStatusBarItem): item is AbstractStatusBarCustomItem => { // eslint-disable-line deprecation/deprecation\n  return !!(item as AbstractStatusBarCustomItem).isCustom; // eslint-disable-line deprecation/deprecation\n};\n\n/** Helper class to create Abstract StatusBar Item definitions.\n * @deprecated in 3.6. Use [StatusBarItemUtilities]($appui-react) instead.\n * @public\n */\nexport class AbstractStatusBarItemUtilities {\n  /** Creates a StatusBar item to perform an action */\n  public static createActionItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem>): AbstractStatusBarActionItem => ({ // eslint-disable-line deprecation/deprecation\n    id, section, itemPriority,\n    icon, tooltip,\n    execute,\n    ...overrides,\n  });\n\n  /** Creates a StatusBar item to display a label */\n  public static createLabelItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide = StatusBarLabelSide.Right, overrides?: Partial<AbstractStatusBarLabelItem>): AbstractStatusBarLabelItem => ({ // eslint-disable-line deprecation/deprecation\n    id, section, itemPriority,\n    icon, label,\n    labelSide,\n    ...overrides,\n  });\n}\n"]}

package/lib/cjs/appui-abstract/toolbars/ToolbarItem.d.ts

@@ -100,7 +100,7 @@ export interface CustomButtonDefinition extends ToolbarItem {
  */
 export declare type CommonToolbarItem = ActionButton | GroupButton | CustomButtonDefinition;
 /** Type for Toolbar Item Id
- * @deprecated in 3.6.
+ * @deprecated in 3.6. Please use `ToolbarItem["id"]` from @itwin/appui-react.
  * @public
  */
 export declare type ToolbarItemId = CommonToolbarItem["id"];

package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"ToolbarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/toolbars/ToolbarItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;;GAGG;AACH,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,4GAA4G;IAC5G,6EAAuB,CAAA;IACvB,iFAAiF;IACjF,mEAAkB,CAAA;AACpB,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAED;;;GAGG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,uEAAc,CAAA;IACd,wBAAwB;IACxB,mEAAY,CAAA;AACd,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B;AAuFD;;GAEG;AACH,MAAa,oBAAoB;IAiB/B,+BAA+B;IACxB,MAAM,CAAC,cAAc,CAAC,IAAuB;QAClD,OAAQ,IAAqB,CAAC,OAAO,KAAK,SAAS,CAAC;IACtD,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,aAAa,CAAC,IAAuB;QACjD,OAAQ,IAAoB,CAAC,KAAK,KAAK,SAAS,CAAC;IACnD,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,kBAAkB,CAAC,IAAuB;QACtD,OAAO,CAAC,CAAE,IAA+B,CAAC,QAAQ,CAAC;IACrD,CAAC;;AA9BH,oDA+BC;AA9BC,+BAA+B;AACjB,uCAAkB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,OAAmB,EAAE,SAAiC,EAAgB,EAAE,CAAC,CAAC;IAC7N,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,8BAA8B;AAChB,sCAAiB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,KAAgD,EAAE,SAAgC,EAAe,EAAE,CAAC,CAAC;IACvP,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,KAAK;IACL,GAAG,SAAS;CACb,CAAC,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 Toolbar\n */\n\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\n\n/** Used to specify the usage of the toolbar which determine the toolbar position.\n * @deprecated in 3.6. Use [ToolbarUsage]($appui-react) instead.\n * @public\n */\nexport enum ToolbarUsage {\n  /** Contains tools to Create Update and Delete content - in ninezone this is in top left of content area. */\n  ContentManipulation = 0,\n  /** Manipulate view/camera - in ninezone this is in top right of content area. */\n  ViewNavigation = 1,\n}\n\n/** Used to specify the orientation of the toolbar.\n * @deprecated in 3.6. Use [ToolbarOrientation]($appui-react) instead.\n * @public\n */\nexport enum ToolbarOrientation {\n  /** Horizontal toolbar. */\n  Horizontal = 0,\n  /** Vertical toolbar. */\n  Vertical = 1,\n}\n\n/** Describes the data needed to insert a UI items into an existing set of UI items.\n * @public\n */\nexport interface ToolbarItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\n  /** can be used by application to store miscellaneous data. */\n  readonly applicationData?: any;\n  /** Describes badge. Renders no badge if not specified. */\n  readonly badgeType?: BadgeType;\n  /** Optional description */\n  readonly description?: string | ConditionalStringValue;\n  /** Require uniqueId for the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\n  readonly id: string;\n  /** optional data to used by item implementor. */\n  readonly internalData?: Map<string, any>;\n  /** Defines if the item is active (shown with an active stripe/bar). */\n  readonly isActive?: boolean;\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\n  readonly isHidden?: boolean | ConditionalBooleanValue;\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\n  /** Describes if the item should appear pressed (used for displaying toggle state). This property is NOT used by Toolbars\n   * constructed using the `ToolbarWithOverflow` component, which are used in AppUi 2.0 and later. For these later toolbars\n   * the icon is usually changed to denote the state of a toggle.\n   */\n  readonly isPressed?: boolean;\n  /** Specifies the item's grouping value. Items are sorted by group and then item priority. When\n   * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\n   * allows extensions enough gaps to insert their own groups. If the value is not specified a groupPriority of 0 is used.\n   */\n  readonly groupPriority?: number;\n  /** Priority within a toolbar or group. */\n  readonly itemPriority: number;\n  /** Optional parent tool group to add tool. */\n  readonly parentToolGroupId?: string;\n}\n\n/** Describes the data needed to insert an action button into a toolbar.\n * @public\n */\nexport interface ActionButton extends ToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\n  readonly icon: string | ConditionalStringValue;\n  /** label, shown as tool tip on a button or an item label in a group. */\n  readonly label: string | ConditionalStringValue;\n  /** function to run when the button is pressed. */\n  readonly execute: () => void;\n}\n\n/** Describes the data needed to insert a group button into a toolbar.\n * @public\n */\nexport interface GroupButton extends ToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon: string | ConditionalStringValue;\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\n  readonly label: string | ConditionalStringValue;\n  /** label shown as the title in at top of group panel. */\n  readonly panelLabel?: string | ConditionalStringValue;\n  /** children of the group */\n  readonly items: ReadonlyArray<ActionButton | GroupButton>; // eslint-disable-line deprecation/deprecation\n}\n\n/** Describes the data needed to insert a custom button into a toolbar.\n * @public\n */\nexport interface CustomButtonDefinition extends ToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\n  readonly label?: string | ConditionalStringValue;\n  /** parameter that marks data as being a custom definition. */\n  readonly isCustom: true;\n}\n\n/** Any Button Type that can be inserted into a toolbar.\n * @public\n */\nexport type CommonToolbarItem = ActionButton | GroupButton | CustomButtonDefinition;\n\n/** Type for Toolbar Item Id\n * @deprecated in 3.6.\n * @public\n */\nexport type ToolbarItemId = CommonToolbarItem[\"id\"]; // eslint-disable-line deprecation/deprecation\n\n/** Helper class to create Abstract StatusBar Item definitions.\n * @public\n */\nexport class ToolbarItemUtilities {\n  /** Creates an Action Button */\n  public static createActionButton = (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, execute: () => void, overrides?: Partial<ActionButton>): ActionButton => ({\n    id, itemPriority,\n    icon, label,\n    execute,\n    ...overrides,\n  });\n\n  /** Creates a Group button. */\n  public static createGroupButton = (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, items: ReadonlyArray<ActionButton | GroupButton>, overrides?: Partial<GroupButton>): GroupButton => ({\n    id, itemPriority,\n    icon, label,\n    items,\n    ...overrides,\n  });\n\n  /** ActionButton type guard. */\n  public static isActionButton(item: CommonToolbarItem): item is ActionButton {\n    return (item as ActionButton).execute !== undefined;\n  }\n\n  /** GroupButton type guard. */\n  public static isGroupButton(item: CommonToolbarItem): item is GroupButton {\n    return (item as GroupButton).items !== undefined;\n  }\n\n  /** CustomButtonDefinition type guard. */\n  public static isCustomDefinition(item: CommonToolbarItem): item is CustomButtonDefinition {\n    return !!(item as CustomButtonDefinition).isCustom;\n  }\n}\n"]}
+{"version":3,"file":"ToolbarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/toolbars/ToolbarItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;;GAGG;AACH,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,4GAA4G;IAC5G,6EAAuB,CAAA;IACvB,iFAAiF;IACjF,mEAAkB,CAAA;AACpB,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAED;;;GAGG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,uEAAc,CAAA;IACd,wBAAwB;IACxB,mEAAY,CAAA;AACd,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B;AAuFD;;GAEG;AACH,MAAa,oBAAoB;IAiB/B,+BAA+B;IACxB,MAAM,CAAC,cAAc,CAAC,IAAuB;QAClD,OAAQ,IAAqB,CAAC,OAAO,KAAK,SAAS,CAAC;IACtD,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,aAAa,CAAC,IAAuB;QACjD,OAAQ,IAAoB,CAAC,KAAK,KAAK,SAAS,CAAC;IACnD,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,kBAAkB,CAAC,IAAuB;QACtD,OAAO,CAAC,CAAE,IAA+B,CAAC,QAAQ,CAAC;IACrD,CAAC;;AA9BH,oDA+BC;AA9BC,+BAA+B;AACjB,uCAAkB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,OAAmB,EAAE,SAAiC,EAAgB,EAAE,CAAC,CAAC;IAC7N,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,8BAA8B;AAChB,sCAAiB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,KAAgD,EAAE,SAAgC,EAAe,EAAE,CAAC,CAAC;IACvP,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,KAAK;IACL,GAAG,SAAS;CACb,CAAC,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 Toolbar\n */\n\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\n\n/** Used to specify the usage of the toolbar which determine the toolbar position.\n * @deprecated in 3.6. Use [ToolbarUsage]($appui-react) instead.\n * @public\n */\nexport enum ToolbarUsage {\n  /** Contains tools to Create Update and Delete content - in ninezone this is in top left of content area. */\n  ContentManipulation = 0,\n  /** Manipulate view/camera - in ninezone this is in top right of content area. */\n  ViewNavigation = 1,\n}\n\n/** Used to specify the orientation of the toolbar.\n * @deprecated in 3.6. Use [ToolbarOrientation]($appui-react) instead.\n * @public\n */\nexport enum ToolbarOrientation {\n  /** Horizontal toolbar. */\n  Horizontal = 0,\n  /** Vertical toolbar. */\n  Vertical = 1,\n}\n\n/** Describes the data needed to insert a UI items into an existing set of UI items.\n * @public\n */\nexport interface ToolbarItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\n  /** can be used by application to store miscellaneous data. */\n  readonly applicationData?: any;\n  /** Describes badge. Renders no badge if not specified. */\n  readonly badgeType?: BadgeType;\n  /** Optional description */\n  readonly description?: string | ConditionalStringValue;\n  /** Require uniqueId for the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\n  readonly id: string;\n  /** optional data to used by item implementor. */\n  readonly internalData?: Map<string, any>;\n  /** Defines if the item is active (shown with an active stripe/bar). */\n  readonly isActive?: boolean;\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\n  readonly isHidden?: boolean | ConditionalBooleanValue;\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\n  /** Describes if the item should appear pressed (used for displaying toggle state). This property is NOT used by Toolbars\n   * constructed using the `ToolbarWithOverflow` component, which are used in AppUi 2.0 and later. For these later toolbars\n   * the icon is usually changed to denote the state of a toggle.\n   */\n  readonly isPressed?: boolean;\n  /** Specifies the item's grouping value. Items are sorted by group and then item priority. When\n   * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\n   * allows extensions enough gaps to insert their own groups. If the value is not specified a groupPriority of 0 is used.\n   */\n  readonly groupPriority?: number;\n  /** Priority within a toolbar or group. */\n  readonly itemPriority: number;\n  /** Optional parent tool group to add tool. */\n  readonly parentToolGroupId?: string;\n}\n\n/** Describes the data needed to insert an action button into a toolbar.\n * @public\n */\nexport interface ActionButton extends ToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\n  readonly icon: string | ConditionalStringValue;\n  /** label, shown as tool tip on a button or an item label in a group. */\n  readonly label: string | ConditionalStringValue;\n  /** function to run when the button is pressed. */\n  readonly execute: () => void;\n}\n\n/** Describes the data needed to insert a group button into a toolbar.\n * @public\n */\nexport interface GroupButton extends ToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon: string | ConditionalStringValue;\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\n  readonly label: string | ConditionalStringValue;\n  /** label shown as the title in at top of group panel. */\n  readonly panelLabel?: string | ConditionalStringValue;\n  /** children of the group */\n  readonly items: ReadonlyArray<ActionButton | GroupButton>; // eslint-disable-line deprecation/deprecation\n}\n\n/** Describes the data needed to insert a custom button into a toolbar.\n * @public\n */\nexport interface CustomButtonDefinition extends ToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\n  readonly label?: string | ConditionalStringValue;\n  /** parameter that marks data as being a custom definition. */\n  readonly isCustom: true;\n}\n\n/** Any Button Type that can be inserted into a toolbar.\n * @public\n */\nexport type CommonToolbarItem = ActionButton | GroupButton | CustomButtonDefinition;\n\n/** Type for Toolbar Item Id\n * @deprecated in 3.6. Please use `ToolbarItem[\"id\"]` from @itwin/appui-react.\n * @public\n */\nexport type ToolbarItemId = CommonToolbarItem[\"id\"]; // eslint-disable-line deprecation/deprecation\n\n/** Helper class to create Abstract StatusBar Item definitions.\n * @public\n */\nexport class ToolbarItemUtilities {\n  /** Creates an Action Button */\n  public static createActionButton = (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, execute: () => void, overrides?: Partial<ActionButton>): ActionButton => ({\n    id, itemPriority,\n    icon, label,\n    execute,\n    ...overrides,\n  });\n\n  /** Creates a Group button. */\n  public static createGroupButton = (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, items: ReadonlyArray<ActionButton | GroupButton>, overrides?: Partial<GroupButton>): GroupButton => ({\n    id, itemPriority,\n    icon, label,\n    items,\n    ...overrides,\n  });\n\n  /** ActionButton type guard. */\n  public static isActionButton(item: CommonToolbarItem): item is ActionButton {\n    return (item as ActionButton).execute !== undefined;\n  }\n\n  /** GroupButton type guard. */\n  public static isGroupButton(item: CommonToolbarItem): item is GroupButton {\n    return (item as GroupButton).items !== undefined;\n  }\n\n  /** CustomButtonDefinition type guard. */\n  public static isCustomDefinition(item: CommonToolbarItem): item is CustomButtonDefinition {\n    return !!(item as CustomButtonDefinition).isCustom;\n  }\n}\n"]}

package/lib/cjs/appui-abstract/utils/IconSpecUtilities.d.ts

@@ -10,7 +10,7 @@ export declare class IconSpecUtilities {
     static readonly WEB_COMPONENT_PREFIX = "webSvg:";
     /** Create an IconSpec for an SVG loaded into web component with sprite loader
      * This method is deprecated --  use createWebComponentIconSpec()
-     * @public @deprecated in 3.2.
+     * @public @deprecated in 3.2. Please avoid using the Sprite loader and use IconSpecUtilities.createWebComponentIconSpec() instead.
     */
     static createSvgIconSpec(svgSrc: string): string;
     /** Create an IconSpec for an SVG loaded into web component with svg-loader
@@ -19,7 +19,7 @@ export declare class IconSpecUtilities {
     static createWebComponentIconSpec(srcString: string): string;
     /** Get the SVG Source from an sprite IconSpec
      * This method is deprecated -- use getWebComponentSource()
-     * @public @deprecated in 3.2.
+     * @public @deprecated in 3.2. avoid using the Sprite loader and use IconSpecUtilities.getWebComponentSource() instead.
     */
     static getSvgSource(iconSpec: string): string | undefined;
     /** Get the SVG Source from an svg-loader IconSpec

package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js

@@ -14,7 +14,7 @@ exports.IconSpecUtilities = void 0;
 class IconSpecUtilities {
     /** Create an IconSpec for an SVG loaded into web component with sprite loader
      * This method is deprecated --  use createWebComponentIconSpec()
-     * @public @deprecated in 3.2.
+     * @public @deprecated in 3.2. Please avoid using the Sprite loader and use IconSpecUtilities.createWebComponentIconSpec() instead.
     */
     static createSvgIconSpec(svgSrc) {
         return `${IconSpecUtilities.SVG_PREFIX}${svgSrc}`;
@@ -27,7 +27,7 @@ class IconSpecUtilities {
     }
     /** Get the SVG Source from an sprite IconSpec
      * This method is deprecated -- use getWebComponentSource()
-     * @public @deprecated in 3.2.
+     * @public @deprecated in 3.2. avoid using the Sprite loader and use IconSpecUtilities.getWebComponentSource() instead.
     */
     static getSvgSource(iconSpec) {
         if (iconSpec.startsWith(IconSpecUtilities.SVG_PREFIX) && iconSpec.length > 4) {

package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js.map

@@ -1 +1 @@
-{"version":3,"file":"IconSpecUtilities.js","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/IconSpecUtilities.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;GAEG;AACH,MAAa,iBAAiB;IAK5B;;;MAGE;IACK,MAAM,CAAC,iBAAiB,CAAC,MAAc;QAC5C,OAAO,GAAG,iBAAiB,CAAC,UAAU,GAAG,MAAM,EAAE,CAAC;IACpD,CAAC;IACD;;MAEE;IACK,MAAM,CAAC,0BAA0B,CAAC,SAAiB;QACxD,OAAO,GAAG,iBAAiB,CAAC,oBAAoB,GAAG,SAAS,EAAE,CAAC;IACjE,CAAC;IAED;;;MAGE;IACK,MAAM,CAAC,YAAY,CAAC,QAAgB;QACzC,IAAI,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5E,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;MAEE;IAEK,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,IAAI,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACtF,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IAEnB,CAAC;;AAzCH,8CA0CC;AAzCC,+DAA+D;AACxC,4BAAU,GAAG,MAAM,CAAC;AACpB,sCAAoB,GAAG,SAAS,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/** Creates an IconSpec with an SVG source and gets the SVG source from an IconSpec.\n * @public\n */\nexport class IconSpecUtilities {\n  /** Prefix for an SVG IconSpec loaded with the Sprite loader */\n  public static readonly SVG_PREFIX = \"svg:\";\n  public static readonly WEB_COMPONENT_PREFIX = \"webSvg:\";\n\n  /** Create an IconSpec for an SVG loaded into web component with sprite loader\n   * This method is deprecated --  use createWebComponentIconSpec()\n   * @public @deprecated in 3.2.\n  */\n  public static createSvgIconSpec(svgSrc: string): string {\n    return `${IconSpecUtilities.SVG_PREFIX}${svgSrc}`;\n  }\n  /** Create an IconSpec for an SVG loaded into web component with svg-loader\n   * @public\n  */\n  public static createWebComponentIconSpec(srcString: string): string {\n    return `${IconSpecUtilities.WEB_COMPONENT_PREFIX}${srcString}`;\n  }\n\n  /** Get the SVG Source from an sprite IconSpec\n   * This method is deprecated -- use getWebComponentSource()\n   * @public @deprecated in 3.2.\n  */\n  public static getSvgSource(iconSpec: string): string | undefined {\n    if (iconSpec.startsWith(IconSpecUtilities.SVG_PREFIX) && iconSpec.length > 4) {\n      return iconSpec.slice(4);\n    }\n\n    return undefined;\n  }\n  /** Get the SVG Source from an svg-loader IconSpec\n   * @public\n  */\n\n  public static getWebComponentSource(iconSpec: string): string | undefined {\n    if (iconSpec.startsWith(IconSpecUtilities.WEB_COMPONENT_PREFIX) && iconSpec.length > 7) {\n      return iconSpec.slice(7);\n    }\n\n    return undefined;\n\n  }\n}\n"]}
+{"version":3,"file":"IconSpecUtilities.js","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/IconSpecUtilities.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;GAEG;AACH,MAAa,iBAAiB;IAK5B;;;MAGE;IACK,MAAM,CAAC,iBAAiB,CAAC,MAAc;QAC5C,OAAO,GAAG,iBAAiB,CAAC,UAAU,GAAG,MAAM,EAAE,CAAC;IACpD,CAAC;IACD;;MAEE;IACK,MAAM,CAAC,0BAA0B,CAAC,SAAiB;QACxD,OAAO,GAAG,iBAAiB,CAAC,oBAAoB,GAAG,SAAS,EAAE,CAAC;IACjE,CAAC;IAED;;;MAGE;IACK,MAAM,CAAC,YAAY,CAAC,QAAgB;QACzC,IAAI,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5E,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;MAEE;IAEK,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,IAAI,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACtF,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IAEnB,CAAC;;AAzCH,8CA0CC;AAzCC,+DAA+D;AACxC,4BAAU,GAAG,MAAM,CAAC;AACpB,sCAAoB,GAAG,SAAS,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/** Creates an IconSpec with an SVG source and gets the SVG source from an IconSpec.\n * @public\n */\nexport class IconSpecUtilities {\n  /** Prefix for an SVG IconSpec loaded with the Sprite loader */\n  public static readonly SVG_PREFIX = \"svg:\";\n  public static readonly WEB_COMPONENT_PREFIX = \"webSvg:\";\n\n  /** Create an IconSpec for an SVG loaded into web component with sprite loader\n   * This method is deprecated --  use createWebComponentIconSpec()\n   * @public @deprecated in 3.2. Please avoid using the Sprite loader and use IconSpecUtilities.createWebComponentIconSpec() instead.\n  */\n  public static createSvgIconSpec(svgSrc: string): string {\n    return `${IconSpecUtilities.SVG_PREFIX}${svgSrc}`;\n  }\n  /** Create an IconSpec for an SVG loaded into web component with svg-loader\n   * @public\n  */\n  public static createWebComponentIconSpec(srcString: string): string {\n    return `${IconSpecUtilities.WEB_COMPONENT_PREFIX}${srcString}`;\n  }\n\n  /** Get the SVG Source from an sprite IconSpec\n   * This method is deprecated -- use getWebComponentSource()\n   * @public @deprecated in 3.2. avoid using the Sprite loader and use IconSpecUtilities.getWebComponentSource() instead.\n  */\n  public static getSvgSource(iconSpec: string): string | undefined {\n    if (iconSpec.startsWith(IconSpecUtilities.SVG_PREFIX) && iconSpec.length > 4) {\n      return iconSpec.slice(4);\n    }\n\n    return undefined;\n  }\n  /** Get the SVG Source from an svg-loader IconSpec\n   * @public\n  */\n\n  public static getWebComponentSource(iconSpec: string): string | undefined {\n    if (iconSpec.startsWith(IconSpecUtilities.WEB_COMPONENT_PREFIX) && iconSpec.length > 7) {\n      return iconSpec.slice(7);\n    }\n\n    return undefined;\n\n  }\n}\n"]}

package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.d.ts

@@ -25,7 +25,7 @@ export interface AbstractWidgetProps extends ProvidedItem {
     /** used to explicitly set the tooltip shown by a component. */
     readonly tooltip?: string | ConditionalStringValue;
     /** Indicates whether the Widget is free-form or rectangular. Defaults to false for rectangular. The default is false.
-     * @deprecated in 3.0.
+     * @deprecated in 3.0. Free-form widgets are obsolete.
      * */
     readonly isFreeform?: boolean;
     /** Application data attached to the Widget. */
@@ -58,7 +58,7 @@ export interface AbstractWidgetProps extends ProvidedItem {
     readonly syncEventIds?: string[];
     /** Function executed to determine the state of the widget.
      *  Used by UI 1.0 widgets ONLY.
-     * @deprecated in 3.3.
+     * @deprecated in 3.3. UI 1.0 support will be removed in AppUi 4.0.
     */
     readonly stateFunc?: (state: Readonly<WidgetState>) => WidgetState;
     /** Badge to be overlaid on the widget tab. */

package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractWidgetProps.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Widget\n */\n\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\nimport { WidgetState } from \"./WidgetState\";\n\n/** Properties for a Widget.\n * @deprecated in 3.6. Use [CommonWidgetProps]($appui-react) instead.\n * @public\n */\nexport interface AbstractWidgetProps extends ProvidedItem { // eslint-disable-line deprecation/deprecation\n  /** Gets the widget content. */\n  readonly getWidgetContent: () => any;\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** Id used to uniquely identify the widget.\n   * @note It is recommended to provide unique widget id to correctly save/restore App layout.\n   */\n  readonly id?: string;\n  /** Default Widget state. Controls how the Widget is initially displayed. Defaults to WidgetState.Unloaded. */\n  readonly defaultState?: WidgetState; // eslint-disable-line deprecation/deprecation\n  /** if set, component will be considered selected but will NOT display an \"active stripe\" - defaults to false. Typically used by buttons that toggle between two states. */\n  readonly label?: string | ConditionalStringValue;\n  /** used to explicitly set the tooltip shown by a component. */\n  readonly tooltip?: string | ConditionalStringValue;\n  /** Indicates whether the Widget is free-form or rectangular. Defaults to false for rectangular. The default is false.\n   * @deprecated in 3.0.\n   * */\n  readonly isFreeform?: boolean;\n  /** Application data attached to the Widget. */\n  readonly applicationData?: any;\n  /** optional data to used by item implementor. */\n  readonly internalData?: Map<string, any>;\n  /** Indicates whether this Widget is for the Tool Settings. */\n  readonly isToolSettings?: boolean;\n  /** Indicates whether this Widget is for the Status Bar. */\n  readonly isStatusBar?: boolean;\n  /** Indicates whether this Widget should fill the available space in the Zone. */\n  readonly fillZone?: boolean;\n  /** Indicates if widget can be popped out to a child window. Defaults to false. */\n  readonly canPopout?: boolean;\n  /** If the widget state is changed to `floating` and the floatingContainerId is defined, the widget will be added to a\n   * floating panel by that name. If no name is specified, a GUID is used. */\n  readonly floatingContainerId?: string;\n  /** Indicates if widget can be in floating state, default to true. */\n  readonly isFloatingStateSupported?: boolean;\n  /** Indicates if floating widget is resizable, defaults to false which caused the widget to be auto-sized.. */\n  readonly isFloatingStateWindowResizable?: boolean;\n  /** Defines that default Top Left position when widget is floated via API calls */\n  readonly defaultFloatingPosition?: { x: number, y: number };\n  /** Widget priority */\n  readonly priority?: number;\n  /** Defines the SyncUi event Ids that will trigger the stateFunc to run to determine the state of the widget. */\n  readonly syncEventIds?: string[];\n  /** Function executed to determine the state of the widget.\n   *  Used by UI 1.0 widgets ONLY.\n   * @deprecated in 3.3.\n  */\n  readonly stateFunc?: (state: Readonly<WidgetState>) => WidgetState; // eslint-disable-line deprecation/deprecation\n  /** Badge to be overlaid on the widget tab. */\n  readonly badgeType?: BadgeType;\n  /** Handler for widget state changed event */\n  readonly onWidgetStateChanged?: () => void;\n  /** Save transient DOM state (i.e. scroll offset). */\n  readonly saveTransientState?: () => void;\n  /** Restore transient DOM state.\n   * @note Return true if the state is restored or the Widget will remount.\n   */\n  readonly restoreTransientState?: () => boolean;\n  /** Optional default size to use when floating a widget. If not specified then the default is to size to content if possible.\n   * Certain widget can't be intrinsically sized and must specify a content. These are typically ones that use a canvas element\n   * internally. */\n  defaultFloatingSize?: { width: number, height: number };\n  /** Optional prop that tells the widget system to fade this widget out with the rest of the UI when it is in floating state */\n  hideWithUiWhenFloating?: boolean;\n  /** Optional prop specifying which Panel sides can be docking targets for this widget. If this prop is not specified, all sides are allowed.\n   *  An empty array is treated the same as an undefined prop, allowing all targets. */\n  readonly allowedPanelTargets?:  ReadonlyArray<\"left\"|\"right\"|\"bottom\"|\"top\">;\n}\n"]}
+{"version":3,"file":"AbstractWidgetProps.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Widget\n */\n\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\nimport { WidgetState } from \"./WidgetState\";\n\n/** Properties for a Widget.\n * @deprecated in 3.6. Use [CommonWidgetProps]($appui-react) instead.\n * @public\n */\nexport interface AbstractWidgetProps extends ProvidedItem { // eslint-disable-line deprecation/deprecation\n  /** Gets the widget content. */\n  readonly getWidgetContent: () => any;\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** Id used to uniquely identify the widget.\n   * @note It is recommended to provide unique widget id to correctly save/restore App layout.\n   */\n  readonly id?: string;\n  /** Default Widget state. Controls how the Widget is initially displayed. Defaults to WidgetState.Unloaded. */\n  readonly defaultState?: WidgetState; // eslint-disable-line deprecation/deprecation\n  /** if set, component will be considered selected but will NOT display an \"active stripe\" - defaults to false. Typically used by buttons that toggle between two states. */\n  readonly label?: string | ConditionalStringValue;\n  /** used to explicitly set the tooltip shown by a component. */\n  readonly tooltip?: string | ConditionalStringValue;\n  /** Indicates whether the Widget is free-form or rectangular. Defaults to false for rectangular. The default is false.\n   * @deprecated in 3.0. Free-form widgets are obsolete.\n   * */\n  readonly isFreeform?: boolean;\n  /** Application data attached to the Widget. */\n  readonly applicationData?: any;\n  /** optional data to used by item implementor. */\n  readonly internalData?: Map<string, any>;\n  /** Indicates whether this Widget is for the Tool Settings. */\n  readonly isToolSettings?: boolean;\n  /** Indicates whether this Widget is for the Status Bar. */\n  readonly isStatusBar?: boolean;\n  /** Indicates whether this Widget should fill the available space in the Zone. */\n  readonly fillZone?: boolean;\n  /** Indicates if widget can be popped out to a child window. Defaults to false. */\n  readonly canPopout?: boolean;\n  /** If the widget state is changed to `floating` and the floatingContainerId is defined, the widget will be added to a\n   * floating panel by that name. If no name is specified, a GUID is used. */\n  readonly floatingContainerId?: string;\n  /** Indicates if widget can be in floating state, default to true. */\n  readonly isFloatingStateSupported?: boolean;\n  /** Indicates if floating widget is resizable, defaults to false which caused the widget to be auto-sized.. */\n  readonly isFloatingStateWindowResizable?: boolean;\n  /** Defines that default Top Left position when widget is floated via API calls */\n  readonly defaultFloatingPosition?: { x: number, y: number };\n  /** Widget priority */\n  readonly priority?: number;\n  /** Defines the SyncUi event Ids that will trigger the stateFunc to run to determine the state of the widget. */\n  readonly syncEventIds?: string[];\n  /** Function executed to determine the state of the widget.\n   *  Used by UI 1.0 widgets ONLY.\n   * @deprecated in 3.3. UI 1.0 support will be removed in AppUi 4.0.\n  */\n  readonly stateFunc?: (state: Readonly<WidgetState>) => WidgetState; // eslint-disable-line deprecation/deprecation\n  /** Badge to be overlaid on the widget tab. */\n  readonly badgeType?: BadgeType;\n  /** Handler for widget state changed event */\n  readonly onWidgetStateChanged?: () => void;\n  /** Save transient DOM state (i.e. scroll offset). */\n  readonly saveTransientState?: () => void;\n  /** Restore transient DOM state.\n   * @note Return true if the state is restored or the Widget will remount.\n   */\n  readonly restoreTransientState?: () => boolean;\n  /** Optional default size to use when floating a widget. If not specified then the default is to size to content if possible.\n   * Certain widget can't be intrinsically sized and must specify a content. These are typically ones that use a canvas element\n   * internally. */\n  defaultFloatingSize?: { width: number, height: number };\n  /** Optional prop that tells the widget system to fade this widget out with the rest of the UI when it is in floating state */\n  hideWithUiWhenFloating?: boolean;\n  /** Optional prop specifying which Panel sides can be docking targets for this widget. If this prop is not specified, all sides are allowed.\n   *  An empty array is treated the same as an undefined prop, allowing all targets. */\n  readonly allowedPanelTargets?:  ReadonlyArray<\"left\"|\"right\"|\"bottom\"|\"top\">;\n}\n"]}

package/lib/cjs/appui-abstract/widget/StagePanel.d.ts

@@ -2,7 +2,7 @@
  * @module Widget
  */
 /** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].
- * @public @deprecated in 3.0.
+ * @public @deprecated in 3.0. UI 1.0 support will be removed in AppUi 4.0.
  */
 export declare enum AbstractZoneLocation {
     CenterLeft = 4,
@@ -16,12 +16,12 @@ export declare enum AbstractZoneLocation {
  */
 export declare enum StagePanelLocation {
     Top = 101,
-    /** @deprecated Used in UI1.0 only. */
+    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
     TopMost = 102,
     Left = 103,
     Right = 104,
     Bottom = 105,
-    /** @deprecated Used in UI1.0 only. */
+    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
     BottomMost = 106
 }
 /** Enum for Stage Panel Sections

package/lib/cjs/appui-abstract/widget/StagePanel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StagePanel.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,oBAAY,oBAAoB;IAC9B,UAAU,IAAI;IACd,WAAW,IAAI;IACf,UAAU,IAAI;IACd,WAAW,IAAI;CAChB;AAED;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,GAAG,MAAM;IACT,sCAAsC;IACtC,OAAO,MAAA;IACP,IAAI,MAAA;IACJ,KAAK,MAAA;IACL,MAAM,MAAA;IACN,sCAAsC;IACtC,UAAU,MAAA;CACX;AAED;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,KAAK,IAAA;IACL,mGAAmG;IACnG,MAAM,IAAA;IACN,GAAG,IAAA;CACJ"}
+{"version":3,"file":"StagePanel.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,oBAAY,oBAAoB;IAC9B,UAAU,IAAI;IACd,WAAW,IAAI;IACf,UAAU,IAAI;IACd,WAAW,IAAI;CAChB;AAED;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,GAAG,MAAM;IACT,sEAAsE;IACtE,OAAO,MAAA;IACP,IAAI,MAAA;IACJ,KAAK,MAAA;IACL,MAAM,MAAA;IACN,sEAAsE;IACtE,UAAU,MAAA;CACX;AAED;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,KAAK,IAAA;IACL,mGAAmG;IACnG,MAAM,IAAA;IACN,GAAG,IAAA;CACJ"}

package/lib/cjs/appui-abstract/widget/StagePanel.js

@@ -9,7 +9,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StagePanelSection = exports.StagePanelLocation = exports.AbstractZoneLocation = void 0;
 /** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].
- * @public @deprecated in 3.0.
+ * @public @deprecated in 3.0. UI 1.0 support will be removed in AppUi 4.0.
  */
 var AbstractZoneLocation;
 (function (AbstractZoneLocation) {
@@ -25,12 +25,12 @@ var AbstractZoneLocation;
 var StagePanelLocation;
 (function (StagePanelLocation) {
     StagePanelLocation[StagePanelLocation["Top"] = 101] = "Top";
-    /** @deprecated Used in UI1.0 only. */
+    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
     StagePanelLocation[StagePanelLocation["TopMost"] = 102] = "TopMost";
     StagePanelLocation[StagePanelLocation["Left"] = 103] = "Left";
     StagePanelLocation[StagePanelLocation["Right"] = 104] = "Right";
     StagePanelLocation[StagePanelLocation["Bottom"] = 105] = "Bottom";
-    /** @deprecated Used in UI1.0 only. */
+    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
     StagePanelLocation[StagePanelLocation["BottomMost"] = 106] = "BottomMost";
 })(StagePanelLocation = exports.StagePanelLocation || (exports.StagePanelLocation = {}));
 /** Enum for Stage Panel Sections

package/lib/cjs/appui-abstract/widget/StagePanel.js.map

@@ -1 +1 @@
-{"version":3,"file":"StagePanel.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;GAEG;AACH,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,2EAAc,CAAA;IACd,6EAAe,CAAA;IACf,2EAAc,CAAA;IACd,6EAAe,CAAA;AACjB,CAAC,EALW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAK/B;AAED;;;GAGG;AACH,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B,2DAAS,CAAA;IACT,sCAAsC;IACtC,mEAAO,CAAA;IACP,6DAAI,CAAA;IACJ,+DAAK,CAAA;IACL,iEAAM,CAAA;IACN,sCAAsC;IACtC,yEAAU,CAAA;AACZ,CAAC,EATW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAS7B;AAED;;;GAGG;AACH,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,2DAAK,CAAA;IACL,mGAAmG;IACnG,6DAAM,CAAA;IACN,uDAAG,CAAA;AACL,CAAC,EALW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAK5B","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 Widget\n */\n\n/** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].\n * @public @deprecated in 3.0.\n */\nexport enum AbstractZoneLocation {\n  CenterLeft = 4,\n  CenterRight = 6,\n  BottomLeft = 7,\n  BottomRight = 9,\n}\n\n/** Available Stage Panel locations.\n * @deprecated in 3.6. Use [StagePanelLocation]($appui-react) instead.\n * @public\n */\nexport enum StagePanelLocation {\n  Top = 101,\n  /** @deprecated Used in UI1.0 only. */\n  TopMost,\n  Left,\n  Right,\n  Bottom,\n  /** @deprecated Used in UI1.0 only. */\n  BottomMost,\n}\n\n/** Enum for Stage Panel Sections\n * @deprecated in 3.6. Use [StagePanelSection]($appui-react) instead.\n * @public\n */\nexport enum StagePanelSection {\n  Start,\n  /** @deprecated in 3.2. - all widgets that a targeted for Middle will be placed in `End` section */\n  Middle,\n  End,\n}\n"]}
+{"version":3,"file":"StagePanel.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;GAEG;AACH,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,2EAAc,CAAA;IACd,6EAAe,CAAA;IACf,2EAAc,CAAA;IACd,6EAAe,CAAA;AACjB,CAAC,EALW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAK/B;AAED;;;GAGG;AACH,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B,2DAAS,CAAA;IACT,sEAAsE;IACtE,mEAAO,CAAA;IACP,6DAAI,CAAA;IACJ,+DAAK,CAAA;IACL,iEAAM,CAAA;IACN,sEAAsE;IACtE,yEAAU,CAAA;AACZ,CAAC,EATW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAS7B;AAED;;;GAGG;AACH,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,2DAAK,CAAA;IACL,mGAAmG;IACnG,6DAAM,CAAA;IACN,uDAAG,CAAA;AACL,CAAC,EALW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAK5B","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 Widget\n */\n\n/** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].\n * @public @deprecated in 3.0. UI 1.0 support will be removed in AppUi 4.0.\n */\nexport enum AbstractZoneLocation {\n  CenterLeft = 4,\n  CenterRight = 6,\n  BottomLeft = 7,\n  BottomRight = 9,\n}\n\n/** Available Stage Panel locations.\n * @deprecated in 3.6. Use [StagePanelLocation]($appui-react) instead.\n * @public\n */\nexport enum StagePanelLocation {\n  Top = 101,\n  /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */\n  TopMost,\n  Left,\n  Right,\n  Bottom,\n  /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */\n  BottomMost,\n}\n\n/** Enum for Stage Panel Sections\n * @deprecated in 3.6. Use [StagePanelSection]($appui-react) instead.\n * @public\n */\nexport enum StagePanelSection {\n  Start,\n  /** @deprecated in 3.2. - all widgets that a targeted for Middle will be placed in `End` section */\n  Middle,\n  End,\n}\n"]}

package/lib/esm/appui-abstract/dialogs/DialogItem.d.ts

@@ -18,7 +18,7 @@ export interface EditorPosition {
     /** Determines the column position for the type editor */
     columnIndex: number;
     /** Number of columns to occupy. Defaults to 1
-     * @deprecated in 2.x.
+     * @deprecated in 2.19. No longer necessary, ignored.
      */
     columnSpan?: number;
 }

package/lib/esm/appui-abstract/dialogs/DialogItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"DialogItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/dialogs/DialogItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA0DH;;GAEG;AACH,MAAM,OAAO,cAAc;IACzB,YAAmB,WAAgC,EAAU,MAAS,EAAU,aAAsB,EAAU,WAAqB;QAAlH,gBAAW,GAAX,WAAW,CAAqB;QAAU,WAAM,GAAN,MAAM,CAAG;QAAU,kBAAa,GAAb,aAAa,CAAS;QAAU,gBAAW,GAAX,WAAW,CAAU;IAAI,CAAC;IAE1I,IAAW,UAAU;QACnB,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED,IAAW,UAAU,CAAC,GAAY;QAChC,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;IACzB,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,KAAK,CAAC,GAAM;QACrB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;IACpB,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED,IAAW,YAAY,CAAC,GAAuB;QAC7C,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC;IAC3B,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,IAAW,eAAe;QACxB,uBAAuB;QACvB,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,WAAW,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,YAAY,IAAI;YAC7K,OAAO;gBACL,KAAK,EAAE,IAAI,CAAC,MAAM;gBAClB,YAAY,EAAE,IAAI,CAAC,aAAa;aACd,CAAC;QACvB,uBAAuB;QACvB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED,IAAW,eAAe,CAAC,GAAoB;QAC7C,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,KAAqB,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC;IACxC,CAAC;IAED,IAAW,QAAQ;QACjB,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC;QACpC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,UAAU,EAAE,CAAC;IAC9E,CAAC;IAED,IAAW,IAAI;QACb,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC;IAClE,CAAC;IAEM,YAAY,CAAC,cAA8B,EAAE,YAAyB;QAC3E,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,cAAc,EAAE,UAAU,EAAE,IAAI,CAAC,WAAW,EAAE,YAAY,EAAE,CAAC;IACjI,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 Dialog\n */\n\nimport { PropertyDescription } from \"../properties/Description\";\n\n/** [[DialogItemValue]] Interface of PrimitiveValue types that have type editor support for use in dialogs.\n * @public\n */\nexport interface DialogItemValue {\n  value?: number | string | boolean | Date;\n  displayValue?: string;\n}\n/** [[EditorPosition]] Interface used to identify the location of the item a DialogItem property value.\n * @public\n */\nexport interface EditorPosition {\n  /** Determine the order the row is shown in UI */\n  rowPriority: number;\n  /** Determines the column position for the type editor */\n  columnIndex: number;\n  /** Number of columns to occupy. Defaults to 1\n   * @deprecated in 2.x.\n   */\n  columnSpan?: number;\n}\n\n/** [[BaseDialogItem]] contains only the members necessary to create a PropertyRecord.\n * @public\n */\nexport interface BaseDialogItem {\n  readonly value: DialogItemValue;\n  readonly property: PropertyDescription;\n  readonly isDisabled?: boolean;\n}\n/** [[DialogItem]] is the specification that the display engine turns into a UI item.\n * @see See learning documentation [DialogItem]($docs/learning/ui/abstract/dialogitem.md)\n * @public\n */\nexport interface DialogItem extends BaseDialogItem {\n  readonly editorPosition: EditorPosition;\n  readonly lockProperty?: BaseDialogItem;\n}\n\n/** [[DialogPropertyItem]] us the specification to use if you are defining the components directly, e.g., in React\n * @public\n */\nexport interface DialogPropertyItem {\n  readonly value: DialogItemValue;\n  readonly propertyName: string;\n}\n\n/** [[DialogPropertySyncItem]] is used to pass sync messages for DialogPropertyItems\n * @public\n */\nexport interface DialogPropertySyncItem extends DialogPropertyItem {\n  readonly isDisabled?: boolean;\n  readonly property?: PropertyDescription;\n}\n\n/** [[DialogProperty]] is a generic helper class that assists working with properties used by UiLayoutDataProvider implementations (i.e. Tool Settings and Dynamic Dialogs).\n * @public\n */\nexport class DialogProperty<T> {\n  constructor(public description: PropertyDescription, private _value: T, private _displayValue?: string, private _isDisabled?: boolean) { }\n\n  public get isDisabled() {\n    return !!this._isDisabled;\n  }\n\n  public set isDisabled(val: boolean) {\n    this._isDisabled = val;\n  }\n\n  public get value() {\n    return this._value;\n  }\n\n  public set value(val: T) {\n    this._value = val;\n  }\n\n  public get name() {\n    return this.description.name;\n  }\n\n  public set displayValue(val: string | undefined) {\n    this._displayValue = val;\n  }\n\n  public get displayValue() {\n    return this._displayValue;\n  }\n\n  public get dialogItemValue() {\n    // istanbul ignore else\n    if (typeof this._value === \"string\" || typeof this._value === \"number\" || typeof this._value === \"undefined\" || typeof this._value === \"boolean\" || this._value instanceof Date)\n      return {\n        value: this._value,\n        displayValue: this._displayValue,\n      } as DialogItemValue;\n    // istanbul ignore next\n    throw new Error(\"Not valid primitive type\");\n  }\n\n  public set dialogItemValue(val: DialogItemValue) {\n    this._value = val.value as unknown as T;\n    this._displayValue = val.displayValue;\n  }\n\n  public get syncItem(): DialogPropertySyncItem {\n    const isDisabled = this._isDisabled;\n    return { propertyName: this.name, value: this.dialogItemValue, isDisabled };\n  }\n\n  public get item(): DialogPropertyItem {\n    return { propertyName: this.name, value: this.dialogItemValue };\n  }\n\n  public toDialogItem(editorPosition: EditorPosition, lockProperty?: DialogItem): DialogItem {\n    return { value: this.dialogItemValue, property: this.description, editorPosition, isDisabled: this._isDisabled, lockProperty };\n  }\n}\n"]}
+{"version":3,"file":"DialogItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/dialogs/DialogItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA0DH;;GAEG;AACH,MAAM,OAAO,cAAc;IACzB,YAAmB,WAAgC,EAAU,MAAS,EAAU,aAAsB,EAAU,WAAqB;QAAlH,gBAAW,GAAX,WAAW,CAAqB;QAAU,WAAM,GAAN,MAAM,CAAG;QAAU,kBAAa,GAAb,aAAa,CAAS;QAAU,gBAAW,GAAX,WAAW,CAAU;IAAI,CAAC;IAE1I,IAAW,UAAU;QACnB,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED,IAAW,UAAU,CAAC,GAAY;QAChC,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;IACzB,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,KAAK,CAAC,GAAM;QACrB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;IACpB,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED,IAAW,YAAY,CAAC,GAAuB;QAC7C,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC;IAC3B,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,IAAW,eAAe;QACxB,uBAAuB;QACvB,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,WAAW,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,YAAY,IAAI;YAC7K,OAAO;gBACL,KAAK,EAAE,IAAI,CAAC,MAAM;gBAClB,YAAY,EAAE,IAAI,CAAC,aAAa;aACd,CAAC;QACvB,uBAAuB;QACvB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED,IAAW,eAAe,CAAC,GAAoB;QAC7C,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,KAAqB,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC;IACxC,CAAC;IAED,IAAW,QAAQ;QACjB,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC;QACpC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,UAAU,EAAE,CAAC;IAC9E,CAAC;IAED,IAAW,IAAI;QACb,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC;IAClE,CAAC;IAEM,YAAY,CAAC,cAA8B,EAAE,YAAyB;QAC3E,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,cAAc,EAAE,UAAU,EAAE,IAAI,CAAC,WAAW,EAAE,YAAY,EAAE,CAAC;IACjI,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 Dialog\n */\n\nimport { PropertyDescription } from \"../properties/Description\";\n\n/** [[DialogItemValue]] Interface of PrimitiveValue types that have type editor support for use in dialogs.\n * @public\n */\nexport interface DialogItemValue {\n  value?: number | string | boolean | Date;\n  displayValue?: string;\n}\n/** [[EditorPosition]] Interface used to identify the location of the item a DialogItem property value.\n * @public\n */\nexport interface EditorPosition {\n  /** Determine the order the row is shown in UI */\n  rowPriority: number;\n  /** Determines the column position for the type editor */\n  columnIndex: number;\n  /** Number of columns to occupy. Defaults to 1\n   * @deprecated in 2.19. No longer necessary, ignored.\n   */\n  columnSpan?: number;\n}\n\n/** [[BaseDialogItem]] contains only the members necessary to create a PropertyRecord.\n * @public\n */\nexport interface BaseDialogItem {\n  readonly value: DialogItemValue;\n  readonly property: PropertyDescription;\n  readonly isDisabled?: boolean;\n}\n/** [[DialogItem]] is the specification that the display engine turns into a UI item.\n * @see See learning documentation [DialogItem]($docs/learning/ui/abstract/dialogitem.md)\n * @public\n */\nexport interface DialogItem extends BaseDialogItem {\n  readonly editorPosition: EditorPosition;\n  readonly lockProperty?: BaseDialogItem;\n}\n\n/** [[DialogPropertyItem]] us the specification to use if you are defining the components directly, e.g., in React\n * @public\n */\nexport interface DialogPropertyItem {\n  readonly value: DialogItemValue;\n  readonly propertyName: string;\n}\n\n/** [[DialogPropertySyncItem]] is used to pass sync messages for DialogPropertyItems\n * @public\n */\nexport interface DialogPropertySyncItem extends DialogPropertyItem {\n  readonly isDisabled?: boolean;\n  readonly property?: PropertyDescription;\n}\n\n/** [[DialogProperty]] is a generic helper class that assists working with properties used by UiLayoutDataProvider implementations (i.e. Tool Settings and Dynamic Dialogs).\n * @public\n */\nexport class DialogProperty<T> {\n  constructor(public description: PropertyDescription, private _value: T, private _displayValue?: string, private _isDisabled?: boolean) { }\n\n  public get isDisabled() {\n    return !!this._isDisabled;\n  }\n\n  public set isDisabled(val: boolean) {\n    this._isDisabled = val;\n  }\n\n  public get value() {\n    return this._value;\n  }\n\n  public set value(val: T) {\n    this._value = val;\n  }\n\n  public get name() {\n    return this.description.name;\n  }\n\n  public set displayValue(val: string | undefined) {\n    this._displayValue = val;\n  }\n\n  public get displayValue() {\n    return this._displayValue;\n  }\n\n  public get dialogItemValue() {\n    // istanbul ignore else\n    if (typeof this._value === \"string\" || typeof this._value === \"number\" || typeof this._value === \"undefined\" || typeof this._value === \"boolean\" || this._value instanceof Date)\n      return {\n        value: this._value,\n        displayValue: this._displayValue,\n      } as DialogItemValue;\n    // istanbul ignore next\n    throw new Error(\"Not valid primitive type\");\n  }\n\n  public set dialogItemValue(val: DialogItemValue) {\n    this._value = val.value as unknown as T;\n    this._displayValue = val.displayValue;\n  }\n\n  public get syncItem(): DialogPropertySyncItem {\n    const isDisabled = this._isDisabled;\n    return { propertyName: this.name, value: this.dialogItemValue, isDisabled };\n  }\n\n  public get item(): DialogPropertyItem {\n    return { propertyName: this.name, value: this.dialogItemValue };\n  }\n\n  public toDialogItem(editorPosition: EditorPosition, lockProperty?: DialogItem): DialogItem {\n    return { value: this.dialogItemValue, property: this.description, editorPosition, isDisabled: this._isDisabled, lockProperty };\n  }\n}\n"]}

package/lib/esm/appui-abstract/statusbar/StatusBarItem.d.ts

@@ -36,7 +36,7 @@ export declare enum StatusBarLabelSide {
     Right = 1
 }
 /** Type for StatusBar Item Id
- * @deprecated in 3.6.
+ * @deprecated in 3.6. Please use `CommonStatusBarItem["id"]` from @itwin/appui-react.
  * @public
  */
 export declare type StatusBarItemId = CommonStatusBarItem["id"];

package/lib/esm/appui-abstract/statusbar/StatusBarItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"StatusBarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,CAAN,IAAY,gBAeX;AAfD,WAAY,gBAAgB;IAC1B,4CAA4C;IAC5C,6DAAW,CAAA;IACX,4CAA4C;IAC5C,uDAAQ,CAAA;IACR,mCAAmC;IACnC,yDAAS,CAAA;IACT,mCAAmC;IACnC,2DAAU,CAAA;IACV,sCAAsC;IACtC,iEAAa,CAAA;IACb,sCAAsC;IACtC,yDAAS,CAAA;IACT,4CAA4C;IAC5C,6DAAW,CAAA;AACb,CAAC,EAfW,gBAAgB,KAAhB,gBAAgB,QAe3B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,8EAA8E;IAC9E,2DAAI,CAAA;IACJ,6CAA6C;IAC7C,6DAAK,CAAA;AACP,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AA0ED;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAQ,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AACpH,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,IAAyB,EAAsC,EAAE;IAC5G,OAAQ,IAAmC,CAAC,KAAK,KAAK,SAAS,IAAK,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAChL,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAO,CAAC,CAAE,IAAoC,CAAC,QAAQ,CAAC,CAAC,8CAA8C;AACzG,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,8BAA8B;;AACzC,oDAAoD;AACtC,+CAAgB,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,OAAwC,EAAE,OAAmB,EAAE,SAAgD,EAA+B,EAAE,CAAC,CAAC;IACtR,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,OAAO;IACb,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,kDAAkD;AACpC,8CAAe,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,SAAS,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAA+C,EAA8B,EAAE,CAAC,CAAC;IAClS,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,KAAK;IACX,SAAS;IACT,GAAG,SAAS;CACb,CAAC,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 StatusBar\n */\n\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\n\n/** Status bar Groups/Sections from Left to Right\n * @deprecated in 3.6. Use [StatusBarSection]($appui-react) instead.\n * @public\n */\nexport enum StatusBarSection {\n  /** area for tool assistance and messages */\n  Message = 0,\n  /** area for tool assistance and messages */\n  Left = 0,\n  /** items specific to stage/task */\n  Stage = 1,\n  /** items specific to stage/task */\n  Center = 1,\n  /** Select scope and selection info */\n  Selection = 2,\n  /** Select scope and selection info */\n  Right = 2,\n  /** items that only show based on context */\n  Context = 3,\n}\n\n/** Defines which side of Icon where label is placed\n * @deprecated in 3.6. Use [StatusBarLabelSide]($appui-react) instead.\n * @public\n */\nexport enum StatusBarLabelSide {\n  /** Label is placed left side of icon. This is the default if not specified */\n  Left,\n  /** Label is placed on right side of icon. */\n  Right,\n}\n\n/** Type for StatusBar Item Id\n * @deprecated in 3.6.\n * @public\n */\nexport type StatusBarItemId = CommonStatusBarItem[\"id\"]; // eslint-disable-line deprecation/deprecation\n\n/** Describes the data needed to insert a button into the status bar.\n * @deprecated in 3.6. Use [CommonStatusBarItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\n  /** can be used by application to store miscellaneous data. */\n  applicationData?: any;\n  /** Describes badge. Renders no badge if not specified. */\n  readonly badgeType?: BadgeType;\n  /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\n  readonly id: string;\n  /** optional data to used by item implementor. */\n  readonly internalData?: Map<string, any>;\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\n  readonly isHidden?: boolean | ConditionalBooleanValue;\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\n  /** Priority within a section (recommend using values 1 through 100). */\n  readonly itemPriority: number;\n  /** status bar section */\n  readonly section: StatusBarSection; // eslint-disable-line deprecation/deprecation\n}\n\n/** Describes the data needed to insert an action item into the status bar.\n * @deprecated in 3.6. Use [StatusBarActionItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarActionItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\n  /** method to execute when icon is pressed */\n  readonly execute: () => void;\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** Label. */\n  readonly label?: string | ConditionalStringValue;\n  /** tooltip. */\n  readonly tooltip?: string | ConditionalStringValue;\n}\n\n/** Describes the data needed to insert a label item with an optional icon into the status bar.\n * @deprecated in 3.6. Use [StatusBarLabelItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarLabelItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** Label. */\n  readonly label: string | ConditionalStringValue;\n  /** Defines which side of icon to display label if icon is defined. */\n  readonly labelSide?: StatusBarLabelSide; // eslint-disable-line deprecation/deprecation\n}\n\n/** Describes the data needed to insert a custom item into the status bar. This is used to allow extension\n *  implementer to create a framework specific component.\n * @deprecated in 3.6. Use [StatusBarCustomItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarCustomItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\n  readonly isCustom: true;\n}\n\n/** Describes the data needed to insert a button into the status bar.\n * @deprecated in 3.6. Use [AnyStatusBarItem]($appui-react) instead.\n * @public\n */\nexport type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem; // eslint-disable-line deprecation/deprecation\n\n/** AbstractStatusBarActionItem type guard.\n * @deprecated in 3.6. Use [isStatusBarActionItem]($appui-react) instead.\n * @public\n */\nexport const isAbstractStatusBarActionItem = (item: CommonStatusBarItem): item is AbstractStatusBarActionItem => { // eslint-disable-line deprecation/deprecation\n  return (item as AbstractStatusBarActionItem).execute !== undefined; // eslint-disable-line deprecation/deprecation\n};\n\n/** AbstractStatusBarLabelItem type guard.\n * @deprecated in 3.6. Use [isStatusBarLabelItem]($appui-react) instead.\n * @public\n */\nexport const isAbstractStatusBarLabelItem = (item: CommonStatusBarItem): item is AbstractStatusBarLabelItem => { // eslint-disable-line deprecation/deprecation\n  return (item as AbstractStatusBarLabelItem).label !== undefined && (item as AbstractStatusBarActionItem).execute === undefined; // eslint-disable-line deprecation/deprecation\n};\n\n/** AbstractStatusBarCustomItem type guard.\n * @deprecated in 3.6. Use [isStatusBarCustomItem]($appui-react) instead.\n * @public\n */\nexport const isAbstractStatusBarCustomItem = (item: CommonStatusBarItem): item is AbstractStatusBarCustomItem => { // eslint-disable-line deprecation/deprecation\n  return !!(item as AbstractStatusBarCustomItem).isCustom; // eslint-disable-line deprecation/deprecation\n};\n\n/** Helper class to create Abstract StatusBar Item definitions.\n * @deprecated in 3.6. Use [StatusBarItemUtilities]($appui-react) instead.\n * @public\n */\nexport class AbstractStatusBarItemUtilities {\n  /** Creates a StatusBar item to perform an action */\n  public static createActionItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem>): AbstractStatusBarActionItem => ({ // eslint-disable-line deprecation/deprecation\n    id, section, itemPriority,\n    icon, tooltip,\n    execute,\n    ...overrides,\n  });\n\n  /** Creates a StatusBar item to display a label */\n  public static createLabelItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide = StatusBarLabelSide.Right, overrides?: Partial<AbstractStatusBarLabelItem>): AbstractStatusBarLabelItem => ({ // eslint-disable-line deprecation/deprecation\n    id, section, itemPriority,\n    icon, label,\n    labelSide,\n    ...overrides,\n  });\n}\n"]}
+{"version":3,"file":"StatusBarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,CAAN,IAAY,gBAeX;AAfD,WAAY,gBAAgB;IAC1B,4CAA4C;IAC5C,6DAAW,CAAA;IACX,4CAA4C;IAC5C,uDAAQ,CAAA;IACR,mCAAmC;IACnC,yDAAS,CAAA;IACT,mCAAmC;IACnC,2DAAU,CAAA;IACV,sCAAsC;IACtC,iEAAa,CAAA;IACb,sCAAsC;IACtC,yDAAS,CAAA;IACT,4CAA4C;IAC5C,6DAAW,CAAA;AACb,CAAC,EAfW,gBAAgB,KAAhB,gBAAgB,QAe3B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,8EAA8E;IAC9E,2DAAI,CAAA;IACJ,6CAA6C;IAC7C,6DAAK,CAAA;AACP,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AA0ED;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAQ,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AACpH,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,IAAyB,EAAsC,EAAE;IAC5G,OAAQ,IAAmC,CAAC,KAAK,KAAK,SAAS,IAAK,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAChL,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAO,CAAC,CAAE,IAAoC,CAAC,QAAQ,CAAC,CAAC,8CAA8C;AACzG,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,8BAA8B;;AACzC,oDAAoD;AACtC,+CAAgB,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,OAAwC,EAAE,OAAmB,EAAE,SAAgD,EAA+B,EAAE,CAAC,CAAC;IACtR,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,OAAO;IACb,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,kDAAkD;AACpC,8CAAe,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,SAAS,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAA+C,EAA8B,EAAE,CAAC,CAAC;IAClS,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,KAAK;IACX,SAAS;IACT,GAAG,SAAS;CACb,CAAC,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 StatusBar\n */\n\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\n\n/** Status bar Groups/Sections from Left to Right\n * @deprecated in 3.6. Use [StatusBarSection]($appui-react) instead.\n * @public\n */\nexport enum StatusBarSection {\n  /** area for tool assistance and messages */\n  Message = 0,\n  /** area for tool assistance and messages */\n  Left = 0,\n  /** items specific to stage/task */\n  Stage = 1,\n  /** items specific to stage/task */\n  Center = 1,\n  /** Select scope and selection info */\n  Selection = 2,\n  /** Select scope and selection info */\n  Right = 2,\n  /** items that only show based on context */\n  Context = 3,\n}\n\n/** Defines which side of Icon where label is placed\n * @deprecated in 3.6. Use [StatusBarLabelSide]($appui-react) instead.\n * @public\n */\nexport enum StatusBarLabelSide {\n  /** Label is placed left side of icon. This is the default if not specified */\n  Left,\n  /** Label is placed on right side of icon. */\n  Right,\n}\n\n/** Type for StatusBar Item Id\n * @deprecated in 3.6. Please use `CommonStatusBarItem[\"id\"]` from @itwin/appui-react.\n * @public\n */\nexport type StatusBarItemId = CommonStatusBarItem[\"id\"]; // eslint-disable-line deprecation/deprecation\n\n/** Describes the data needed to insert a button into the status bar.\n * @deprecated in 3.6. Use [CommonStatusBarItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\n  /** can be used by application to store miscellaneous data. */\n  applicationData?: any;\n  /** Describes badge. Renders no badge if not specified. */\n  readonly badgeType?: BadgeType;\n  /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\n  readonly id: string;\n  /** optional data to used by item implementor. */\n  readonly internalData?: Map<string, any>;\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\n  readonly isHidden?: boolean | ConditionalBooleanValue;\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\n  /** Priority within a section (recommend using values 1 through 100). */\n  readonly itemPriority: number;\n  /** status bar section */\n  readonly section: StatusBarSection; // eslint-disable-line deprecation/deprecation\n}\n\n/** Describes the data needed to insert an action item into the status bar.\n * @deprecated in 3.6. Use [StatusBarActionItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarActionItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\n  /** method to execute when icon is pressed */\n  readonly execute: () => void;\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** Label. */\n  readonly label?: string | ConditionalStringValue;\n  /** tooltip. */\n  readonly tooltip?: string | ConditionalStringValue;\n}\n\n/** Describes the data needed to insert a label item with an optional icon into the status bar.\n * @deprecated in 3.6. Use [StatusBarLabelItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarLabelItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** Label. */\n  readonly label: string | ConditionalStringValue;\n  /** Defines which side of icon to display label if icon is defined. */\n  readonly labelSide?: StatusBarLabelSide; // eslint-disable-line deprecation/deprecation\n}\n\n/** Describes the data needed to insert a custom item into the status bar. This is used to allow extension\n *  implementer to create a framework specific component.\n * @deprecated in 3.6. Use [StatusBarCustomItem]($appui-react) instead.\n * @public\n */\nexport interface AbstractStatusBarCustomItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\n  readonly isCustom: true;\n}\n\n/** Describes the data needed to insert a button into the status bar.\n * @deprecated in 3.6. Use [AnyStatusBarItem]($appui-react) instead.\n * @public\n */\nexport type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem; // eslint-disable-line deprecation/deprecation\n\n/** AbstractStatusBarActionItem type guard.\n * @deprecated in 3.6. Use [isStatusBarActionItem]($appui-react) instead.\n * @public\n */\nexport const isAbstractStatusBarActionItem = (item: CommonStatusBarItem): item is AbstractStatusBarActionItem => { // eslint-disable-line deprecation/deprecation\n  return (item as AbstractStatusBarActionItem).execute !== undefined; // eslint-disable-line deprecation/deprecation\n};\n\n/** AbstractStatusBarLabelItem type guard.\n * @deprecated in 3.6. Use [isStatusBarLabelItem]($appui-react) instead.\n * @public\n */\nexport const isAbstractStatusBarLabelItem = (item: CommonStatusBarItem): item is AbstractStatusBarLabelItem => { // eslint-disable-line deprecation/deprecation\n  return (item as AbstractStatusBarLabelItem).label !== undefined && (item as AbstractStatusBarActionItem).execute === undefined; // eslint-disable-line deprecation/deprecation\n};\n\n/** AbstractStatusBarCustomItem type guard.\n * @deprecated in 3.6. Use [isStatusBarCustomItem]($appui-react) instead.\n * @public\n */\nexport const isAbstractStatusBarCustomItem = (item: CommonStatusBarItem): item is AbstractStatusBarCustomItem => { // eslint-disable-line deprecation/deprecation\n  return !!(item as AbstractStatusBarCustomItem).isCustom; // eslint-disable-line deprecation/deprecation\n};\n\n/** Helper class to create Abstract StatusBar Item definitions.\n * @deprecated in 3.6. Use [StatusBarItemUtilities]($appui-react) instead.\n * @public\n */\nexport class AbstractStatusBarItemUtilities {\n  /** Creates a StatusBar item to perform an action */\n  public static createActionItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem>): AbstractStatusBarActionItem => ({ // eslint-disable-line deprecation/deprecation\n    id, section, itemPriority,\n    icon, tooltip,\n    execute,\n    ...overrides,\n  });\n\n  /** Creates a StatusBar item to display a label */\n  public static createLabelItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide = StatusBarLabelSide.Right, overrides?: Partial<AbstractStatusBarLabelItem>): AbstractStatusBarLabelItem => ({ // eslint-disable-line deprecation/deprecation\n    id, section, itemPriority,\n    icon, label,\n    labelSide,\n    ...overrides,\n  });\n}\n"]}

package/lib/esm/appui-abstract/toolbars/ToolbarItem.d.ts

@@ -100,7 +100,7 @@ export interface CustomButtonDefinition extends ToolbarItem {
  */
 export declare type CommonToolbarItem = ActionButton | GroupButton | CustomButtonDefinition;
 /** Type for Toolbar Item Id
- * @deprecated in 3.6.
+ * @deprecated in 3.6. Please use `ToolbarItem["id"]` from @itwin/appui-react.
  * @public
  */
 export declare type ToolbarItemId = CommonToolbarItem["id"];

package/lib/esm/appui-abstract/toolbars/ToolbarItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"ToolbarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/toolbars/ToolbarItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,4GAA4G;IAC5G,6EAAuB,CAAA;IACvB,iFAAiF;IACjF,mEAAkB,CAAA;AACpB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,uEAAc,CAAA;IACd,wBAAwB;IACxB,mEAAY,CAAA;AACd,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAuFD;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAiB/B,+BAA+B;IACxB,MAAM,CAAC,cAAc,CAAC,IAAuB;QAClD,OAAQ,IAAqB,CAAC,OAAO,KAAK,SAAS,CAAC;IACtD,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,aAAa,CAAC,IAAuB;QACjD,OAAQ,IAAoB,CAAC,KAAK,KAAK,SAAS,CAAC;IACnD,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,kBAAkB,CAAC,IAAuB;QACtD,OAAO,CAAC,CAAE,IAA+B,CAAC,QAAQ,CAAC;IACrD,CAAC;;AA7BD,+BAA+B;AACjB,uCAAkB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,OAAmB,EAAE,SAAiC,EAAgB,EAAE,CAAC,CAAC;IAC7N,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,8BAA8B;AAChB,sCAAiB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,KAAgD,EAAE,SAAgC,EAAe,EAAE,CAAC,CAAC;IACvP,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,KAAK;IACL,GAAG,SAAS;CACb,CAAC,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 Toolbar\n */\n\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\n\n/** Used to specify the usage of the toolbar which determine the toolbar position.\n * @deprecated in 3.6. Use [ToolbarUsage]($appui-react) instead.\n * @public\n */\nexport enum ToolbarUsage {\n  /** Contains tools to Create Update and Delete content - in ninezone this is in top left of content area. */\n  ContentManipulation = 0,\n  /** Manipulate view/camera - in ninezone this is in top right of content area. */\n  ViewNavigation = 1,\n}\n\n/** Used to specify the orientation of the toolbar.\n * @deprecated in 3.6. Use [ToolbarOrientation]($appui-react) instead.\n * @public\n */\nexport enum ToolbarOrientation {\n  /** Horizontal toolbar. */\n  Horizontal = 0,\n  /** Vertical toolbar. */\n  Vertical = 1,\n}\n\n/** Describes the data needed to insert a UI items into an existing set of UI items.\n * @public\n */\nexport interface ToolbarItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\n  /** can be used by application to store miscellaneous data. */\n  readonly applicationData?: any;\n  /** Describes badge. Renders no badge if not specified. */\n  readonly badgeType?: BadgeType;\n  /** Optional description */\n  readonly description?: string | ConditionalStringValue;\n  /** Require uniqueId for the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\n  readonly id: string;\n  /** optional data to used by item implementor. */\n  readonly internalData?: Map<string, any>;\n  /** Defines if the item is active (shown with an active stripe/bar). */\n  readonly isActive?: boolean;\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\n  readonly isHidden?: boolean | ConditionalBooleanValue;\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\n  /** Describes if the item should appear pressed (used for displaying toggle state). This property is NOT used by Toolbars\n   * constructed using the `ToolbarWithOverflow` component, which are used in AppUi 2.0 and later. For these later toolbars\n   * the icon is usually changed to denote the state of a toggle.\n   */\n  readonly isPressed?: boolean;\n  /** Specifies the item's grouping value. Items are sorted by group and then item priority. When\n   * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\n   * allows extensions enough gaps to insert their own groups. If the value is not specified a groupPriority of 0 is used.\n   */\n  readonly groupPriority?: number;\n  /** Priority within a toolbar or group. */\n  readonly itemPriority: number;\n  /** Optional parent tool group to add tool. */\n  readonly parentToolGroupId?: string;\n}\n\n/** Describes the data needed to insert an action button into a toolbar.\n * @public\n */\nexport interface ActionButton extends ToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\n  readonly icon: string | ConditionalStringValue;\n  /** label, shown as tool tip on a button or an item label in a group. */\n  readonly label: string | ConditionalStringValue;\n  /** function to run when the button is pressed. */\n  readonly execute: () => void;\n}\n\n/** Describes the data needed to insert a group button into a toolbar.\n * @public\n */\nexport interface GroupButton extends ToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon: string | ConditionalStringValue;\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\n  readonly label: string | ConditionalStringValue;\n  /** label shown as the title in at top of group panel. */\n  readonly panelLabel?: string | ConditionalStringValue;\n  /** children of the group */\n  readonly items: ReadonlyArray<ActionButton | GroupButton>; // eslint-disable-line deprecation/deprecation\n}\n\n/** Describes the data needed to insert a custom button into a toolbar.\n * @public\n */\nexport interface CustomButtonDefinition extends ToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\n  readonly label?: string | ConditionalStringValue;\n  /** parameter that marks data as being a custom definition. */\n  readonly isCustom: true;\n}\n\n/** Any Button Type that can be inserted into a toolbar.\n * @public\n */\nexport type CommonToolbarItem = ActionButton | GroupButton | CustomButtonDefinition;\n\n/** Type for Toolbar Item Id\n * @deprecated in 3.6.\n * @public\n */\nexport type ToolbarItemId = CommonToolbarItem[\"id\"]; // eslint-disable-line deprecation/deprecation\n\n/** Helper class to create Abstract StatusBar Item definitions.\n * @public\n */\nexport class ToolbarItemUtilities {\n  /** Creates an Action Button */\n  public static createActionButton = (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, execute: () => void, overrides?: Partial<ActionButton>): ActionButton => ({\n    id, itemPriority,\n    icon, label,\n    execute,\n    ...overrides,\n  });\n\n  /** Creates a Group button. */\n  public static createGroupButton = (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, items: ReadonlyArray<ActionButton | GroupButton>, overrides?: Partial<GroupButton>): GroupButton => ({\n    id, itemPriority,\n    icon, label,\n    items,\n    ...overrides,\n  });\n\n  /** ActionButton type guard. */\n  public static isActionButton(item: CommonToolbarItem): item is ActionButton {\n    return (item as ActionButton).execute !== undefined;\n  }\n\n  /** GroupButton type guard. */\n  public static isGroupButton(item: CommonToolbarItem): item is GroupButton {\n    return (item as GroupButton).items !== undefined;\n  }\n\n  /** CustomButtonDefinition type guard. */\n  public static isCustomDefinition(item: CommonToolbarItem): item is CustomButtonDefinition {\n    return !!(item as CustomButtonDefinition).isCustom;\n  }\n}\n"]}
+{"version":3,"file":"ToolbarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/toolbars/ToolbarItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,4GAA4G;IAC5G,6EAAuB,CAAA;IACvB,iFAAiF;IACjF,mEAAkB,CAAA;AACpB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,uEAAc,CAAA;IACd,wBAAwB;IACxB,mEAAY,CAAA;AACd,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAuFD;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAiB/B,+BAA+B;IACxB,MAAM,CAAC,cAAc,CAAC,IAAuB;QAClD,OAAQ,IAAqB,CAAC,OAAO,KAAK,SAAS,CAAC;IACtD,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,aAAa,CAAC,IAAuB;QACjD,OAAQ,IAAoB,CAAC,KAAK,KAAK,SAAS,CAAC;IACnD,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,kBAAkB,CAAC,IAAuB;QACtD,OAAO,CAAC,CAAE,IAA+B,CAAC,QAAQ,CAAC;IACrD,CAAC;;AA7BD,+BAA+B;AACjB,uCAAkB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,OAAmB,EAAE,SAAiC,EAAgB,EAAE,CAAC,CAAC;IAC7N,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,8BAA8B;AAChB,sCAAiB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,KAAgD,EAAE,SAAgC,EAAe,EAAE,CAAC,CAAC;IACvP,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,KAAK;IACL,GAAG,SAAS;CACb,CAAC,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 Toolbar\n */\n\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\n\n/** Used to specify the usage of the toolbar which determine the toolbar position.\n * @deprecated in 3.6. Use [ToolbarUsage]($appui-react) instead.\n * @public\n */\nexport enum ToolbarUsage {\n  /** Contains tools to Create Update and Delete content - in ninezone this is in top left of content area. */\n  ContentManipulation = 0,\n  /** Manipulate view/camera - in ninezone this is in top right of content area. */\n  ViewNavigation = 1,\n}\n\n/** Used to specify the orientation of the toolbar.\n * @deprecated in 3.6. Use [ToolbarOrientation]($appui-react) instead.\n * @public\n */\nexport enum ToolbarOrientation {\n  /** Horizontal toolbar. */\n  Horizontal = 0,\n  /** Vertical toolbar. */\n  Vertical = 1,\n}\n\n/** Describes the data needed to insert a UI items into an existing set of UI items.\n * @public\n */\nexport interface ToolbarItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\n  /** can be used by application to store miscellaneous data. */\n  readonly applicationData?: any;\n  /** Describes badge. Renders no badge if not specified. */\n  readonly badgeType?: BadgeType;\n  /** Optional description */\n  readonly description?: string | ConditionalStringValue;\n  /** Require uniqueId for the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\n  readonly id: string;\n  /** optional data to used by item implementor. */\n  readonly internalData?: Map<string, any>;\n  /** Defines if the item is active (shown with an active stripe/bar). */\n  readonly isActive?: boolean;\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\n  readonly isHidden?: boolean | ConditionalBooleanValue;\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\n  /** Describes if the item should appear pressed (used for displaying toggle state). This property is NOT used by Toolbars\n   * constructed using the `ToolbarWithOverflow` component, which are used in AppUi 2.0 and later. For these later toolbars\n   * the icon is usually changed to denote the state of a toggle.\n   */\n  readonly isPressed?: boolean;\n  /** Specifies the item's grouping value. Items are sorted by group and then item priority. When\n   * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\n   * allows extensions enough gaps to insert their own groups. If the value is not specified a groupPriority of 0 is used.\n   */\n  readonly groupPriority?: number;\n  /** Priority within a toolbar or group. */\n  readonly itemPriority: number;\n  /** Optional parent tool group to add tool. */\n  readonly parentToolGroupId?: string;\n}\n\n/** Describes the data needed to insert an action button into a toolbar.\n * @public\n */\nexport interface ActionButton extends ToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\n  readonly icon: string | ConditionalStringValue;\n  /** label, shown as tool tip on a button or an item label in a group. */\n  readonly label: string | ConditionalStringValue;\n  /** function to run when the button is pressed. */\n  readonly execute: () => void;\n}\n\n/** Describes the data needed to insert a group button into a toolbar.\n * @public\n */\nexport interface GroupButton extends ToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon: string | ConditionalStringValue;\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\n  readonly label: string | ConditionalStringValue;\n  /** label shown as the title in at top of group panel. */\n  readonly panelLabel?: string | ConditionalStringValue;\n  /** children of the group */\n  readonly items: ReadonlyArray<ActionButton | GroupButton>; // eslint-disable-line deprecation/deprecation\n}\n\n/** Describes the data needed to insert a custom button into a toolbar.\n * @public\n */\nexport interface CustomButtonDefinition extends ToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\n  readonly label?: string | ConditionalStringValue;\n  /** parameter that marks data as being a custom definition. */\n  readonly isCustom: true;\n}\n\n/** Any Button Type that can be inserted into a toolbar.\n * @public\n */\nexport type CommonToolbarItem = ActionButton | GroupButton | CustomButtonDefinition;\n\n/** Type for Toolbar Item Id\n * @deprecated in 3.6. Please use `ToolbarItem[\"id\"]` from @itwin/appui-react.\n * @public\n */\nexport type ToolbarItemId = CommonToolbarItem[\"id\"]; // eslint-disable-line deprecation/deprecation\n\n/** Helper class to create Abstract StatusBar Item definitions.\n * @public\n */\nexport class ToolbarItemUtilities {\n  /** Creates an Action Button */\n  public static createActionButton = (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, execute: () => void, overrides?: Partial<ActionButton>): ActionButton => ({\n    id, itemPriority,\n    icon, label,\n    execute,\n    ...overrides,\n  });\n\n  /** Creates a Group button. */\n  public static createGroupButton = (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, items: ReadonlyArray<ActionButton | GroupButton>, overrides?: Partial<GroupButton>): GroupButton => ({\n    id, itemPriority,\n    icon, label,\n    items,\n    ...overrides,\n  });\n\n  /** ActionButton type guard. */\n  public static isActionButton(item: CommonToolbarItem): item is ActionButton {\n    return (item as ActionButton).execute !== undefined;\n  }\n\n  /** GroupButton type guard. */\n  public static isGroupButton(item: CommonToolbarItem): item is GroupButton {\n    return (item as GroupButton).items !== undefined;\n  }\n\n  /** CustomButtonDefinition type guard. */\n  public static isCustomDefinition(item: CommonToolbarItem): item is CustomButtonDefinition {\n    return !!(item as CustomButtonDefinition).isCustom;\n  }\n}\n"]}

package/lib/esm/appui-abstract/utils/IconSpecUtilities.d.ts

@@ -10,7 +10,7 @@ export declare class IconSpecUtilities {
     static readonly WEB_COMPONENT_PREFIX = "webSvg:";
     /** Create an IconSpec for an SVG loaded into web component with sprite loader
      * This method is deprecated --  use createWebComponentIconSpec()
-     * @public @deprecated in 3.2.
+     * @public @deprecated in 3.2. Please avoid using the Sprite loader and use IconSpecUtilities.createWebComponentIconSpec() instead.
     */
     static createSvgIconSpec(svgSrc: string): string;
     /** Create an IconSpec for an SVG loaded into web component with svg-loader
@@ -19,7 +19,7 @@ export declare class IconSpecUtilities {
     static createWebComponentIconSpec(srcString: string): string;
     /** Get the SVG Source from an sprite IconSpec
      * This method is deprecated -- use getWebComponentSource()
-     * @public @deprecated in 3.2.
+     * @public @deprecated in 3.2. avoid using the Sprite loader and use IconSpecUtilities.getWebComponentSource() instead.
     */
     static getSvgSource(iconSpec: string): string | undefined;
     /** Get the SVG Source from an svg-loader IconSpec

package/lib/esm/appui-abstract/utils/IconSpecUtilities.js

@@ -11,7 +11,7 @@
 export class IconSpecUtilities {
     /** Create an IconSpec for an SVG loaded into web component with sprite loader
      * This method is deprecated --  use createWebComponentIconSpec()
-     * @public @deprecated in 3.2.
+     * @public @deprecated in 3.2. Please avoid using the Sprite loader and use IconSpecUtilities.createWebComponentIconSpec() instead.
     */
     static createSvgIconSpec(svgSrc) {
         return `${IconSpecUtilities.SVG_PREFIX}${svgSrc}`;
@@ -24,7 +24,7 @@ export class IconSpecUtilities {
     }
     /** Get the SVG Source from an sprite IconSpec
      * This method is deprecated -- use getWebComponentSource()
-     * @public @deprecated in 3.2.
+     * @public @deprecated in 3.2. avoid using the Sprite loader and use IconSpecUtilities.getWebComponentSource() instead.
     */
     static getSvgSource(iconSpec) {
         if (iconSpec.startsWith(IconSpecUtilities.SVG_PREFIX) && iconSpec.length > 4) {

package/lib/esm/appui-abstract/utils/IconSpecUtilities.js.map

@@ -1 +1 @@
-{"version":3,"file":"IconSpecUtilities.js","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/IconSpecUtilities.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;GAEG;AACH,MAAM,OAAO,iBAAiB;IAK5B;;;MAGE;IACK,MAAM,CAAC,iBAAiB,CAAC,MAAc;QAC5C,OAAO,GAAG,iBAAiB,CAAC,UAAU,GAAG,MAAM,EAAE,CAAC;IACpD,CAAC;IACD;;MAEE;IACK,MAAM,CAAC,0BAA0B,CAAC,SAAiB;QACxD,OAAO,GAAG,iBAAiB,CAAC,oBAAoB,GAAG,SAAS,EAAE,CAAC;IACjE,CAAC;IAED;;;MAGE;IACK,MAAM,CAAC,YAAY,CAAC,QAAgB;QACzC,IAAI,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5E,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;MAEE;IAEK,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,IAAI,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACtF,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IAEnB,CAAC;;AAxCD,+DAA+D;AACxC,4BAAU,GAAG,MAAM,CAAC;AACpB,sCAAoB,GAAG,SAAS,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/** Creates an IconSpec with an SVG source and gets the SVG source from an IconSpec.\n * @public\n */\nexport class IconSpecUtilities {\n  /** Prefix for an SVG IconSpec loaded with the Sprite loader */\n  public static readonly SVG_PREFIX = \"svg:\";\n  public static readonly WEB_COMPONENT_PREFIX = \"webSvg:\";\n\n  /** Create an IconSpec for an SVG loaded into web component with sprite loader\n   * This method is deprecated --  use createWebComponentIconSpec()\n   * @public @deprecated in 3.2.\n  */\n  public static createSvgIconSpec(svgSrc: string): string {\n    return `${IconSpecUtilities.SVG_PREFIX}${svgSrc}`;\n  }\n  /** Create an IconSpec for an SVG loaded into web component with svg-loader\n   * @public\n  */\n  public static createWebComponentIconSpec(srcString: string): string {\n    return `${IconSpecUtilities.WEB_COMPONENT_PREFIX}${srcString}`;\n  }\n\n  /** Get the SVG Source from an sprite IconSpec\n   * This method is deprecated -- use getWebComponentSource()\n   * @public @deprecated in 3.2.\n  */\n  public static getSvgSource(iconSpec: string): string | undefined {\n    if (iconSpec.startsWith(IconSpecUtilities.SVG_PREFIX) && iconSpec.length > 4) {\n      return iconSpec.slice(4);\n    }\n\n    return undefined;\n  }\n  /** Get the SVG Source from an svg-loader IconSpec\n   * @public\n  */\n\n  public static getWebComponentSource(iconSpec: string): string | undefined {\n    if (iconSpec.startsWith(IconSpecUtilities.WEB_COMPONENT_PREFIX) && iconSpec.length > 7) {\n      return iconSpec.slice(7);\n    }\n\n    return undefined;\n\n  }\n}\n"]}
+{"version":3,"file":"IconSpecUtilities.js","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/IconSpecUtilities.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;GAEG;AACH,MAAM,OAAO,iBAAiB;IAK5B;;;MAGE;IACK,MAAM,CAAC,iBAAiB,CAAC,MAAc;QAC5C,OAAO,GAAG,iBAAiB,CAAC,UAAU,GAAG,MAAM,EAAE,CAAC;IACpD,CAAC;IACD;;MAEE;IACK,MAAM,CAAC,0BAA0B,CAAC,SAAiB;QACxD,OAAO,GAAG,iBAAiB,CAAC,oBAAoB,GAAG,SAAS,EAAE,CAAC;IACjE,CAAC;IAED;;;MAGE;IACK,MAAM,CAAC,YAAY,CAAC,QAAgB;QACzC,IAAI,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5E,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;MAEE;IAEK,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,IAAI,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACtF,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IAEnB,CAAC;;AAxCD,+DAA+D;AACxC,4BAAU,GAAG,MAAM,CAAC;AACpB,sCAAoB,GAAG,SAAS,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/** Creates an IconSpec with an SVG source and gets the SVG source from an IconSpec.\n * @public\n */\nexport class IconSpecUtilities {\n  /** Prefix for an SVG IconSpec loaded with the Sprite loader */\n  public static readonly SVG_PREFIX = \"svg:\";\n  public static readonly WEB_COMPONENT_PREFIX = \"webSvg:\";\n\n  /** Create an IconSpec for an SVG loaded into web component with sprite loader\n   * This method is deprecated --  use createWebComponentIconSpec()\n   * @public @deprecated in 3.2. Please avoid using the Sprite loader and use IconSpecUtilities.createWebComponentIconSpec() instead.\n  */\n  public static createSvgIconSpec(svgSrc: string): string {\n    return `${IconSpecUtilities.SVG_PREFIX}${svgSrc}`;\n  }\n  /** Create an IconSpec for an SVG loaded into web component with svg-loader\n   * @public\n  */\n  public static createWebComponentIconSpec(srcString: string): string {\n    return `${IconSpecUtilities.WEB_COMPONENT_PREFIX}${srcString}`;\n  }\n\n  /** Get the SVG Source from an sprite IconSpec\n   * This method is deprecated -- use getWebComponentSource()\n   * @public @deprecated in 3.2. avoid using the Sprite loader and use IconSpecUtilities.getWebComponentSource() instead.\n  */\n  public static getSvgSource(iconSpec: string): string | undefined {\n    if (iconSpec.startsWith(IconSpecUtilities.SVG_PREFIX) && iconSpec.length > 4) {\n      return iconSpec.slice(4);\n    }\n\n    return undefined;\n  }\n  /** Get the SVG Source from an svg-loader IconSpec\n   * @public\n  */\n\n  public static getWebComponentSource(iconSpec: string): string | undefined {\n    if (iconSpec.startsWith(IconSpecUtilities.WEB_COMPONENT_PREFIX) && iconSpec.length > 7) {\n      return iconSpec.slice(7);\n    }\n\n    return undefined;\n\n  }\n}\n"]}

package/lib/esm/appui-abstract/widget/AbstractWidgetProps.d.ts

@@ -25,7 +25,7 @@ export interface AbstractWidgetProps extends ProvidedItem {
     /** used to explicitly set the tooltip shown by a component. */
     readonly tooltip?: string | ConditionalStringValue;
     /** Indicates whether the Widget is free-form or rectangular. Defaults to false for rectangular. The default is false.
-     * @deprecated in 3.0.
+     * @deprecated in 3.0. Free-form widgets are obsolete.
      * */
     readonly isFreeform?: boolean;
     /** Application data attached to the Widget. */
@@ -58,7 +58,7 @@ export interface AbstractWidgetProps extends ProvidedItem {
     readonly syncEventIds?: string[];
     /** Function executed to determine the state of the widget.
      *  Used by UI 1.0 widgets ONLY.
-     * @deprecated in 3.3.
+     * @deprecated in 3.3. UI 1.0 support will be removed in AppUi 4.0.
     */
     readonly stateFunc?: (state: Readonly<WidgetState>) => WidgetState;
     /** Badge to be overlaid on the widget tab. */

package/lib/esm/appui-abstract/widget/AbstractWidgetProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractWidgetProps.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 Widget\n */\n\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\nimport { WidgetState } from \"./WidgetState\";\n\n/** Properties for a Widget.\n * @deprecated in 3.6. Use [CommonWidgetProps]($appui-react) instead.\n * @public\n */\nexport interface AbstractWidgetProps extends ProvidedItem { // eslint-disable-line deprecation/deprecation\n  /** Gets the widget content. */\n  readonly getWidgetContent: () => any;\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** Id used to uniquely identify the widget.\n   * @note It is recommended to provide unique widget id to correctly save/restore App layout.\n   */\n  readonly id?: string;\n  /** Default Widget state. Controls how the Widget is initially displayed. Defaults to WidgetState.Unloaded. */\n  readonly defaultState?: WidgetState; // eslint-disable-line deprecation/deprecation\n  /** if set, component will be considered selected but will NOT display an \"active stripe\" - defaults to false. Typically used by buttons that toggle between two states. */\n  readonly label?: string | ConditionalStringValue;\n  /** used to explicitly set the tooltip shown by a component. */\n  readonly tooltip?: string | ConditionalStringValue;\n  /** Indicates whether the Widget is free-form or rectangular. Defaults to false for rectangular. The default is false.\n   * @deprecated in 3.0.\n   * */\n  readonly isFreeform?: boolean;\n  /** Application data attached to the Widget. */\n  readonly applicationData?: any;\n  /** optional data to used by item implementor. */\n  readonly internalData?: Map<string, any>;\n  /** Indicates whether this Widget is for the Tool Settings. */\n  readonly isToolSettings?: boolean;\n  /** Indicates whether this Widget is for the Status Bar. */\n  readonly isStatusBar?: boolean;\n  /** Indicates whether this Widget should fill the available space in the Zone. */\n  readonly fillZone?: boolean;\n  /** Indicates if widget can be popped out to a child window. Defaults to false. */\n  readonly canPopout?: boolean;\n  /** If the widget state is changed to `floating` and the floatingContainerId is defined, the widget will be added to a\n   * floating panel by that name. If no name is specified, a GUID is used. */\n  readonly floatingContainerId?: string;\n  /** Indicates if widget can be in floating state, default to true. */\n  readonly isFloatingStateSupported?: boolean;\n  /** Indicates if floating widget is resizable, defaults to false which caused the widget to be auto-sized.. */\n  readonly isFloatingStateWindowResizable?: boolean;\n  /** Defines that default Top Left position when widget is floated via API calls */\n  readonly defaultFloatingPosition?: { x: number, y: number };\n  /** Widget priority */\n  readonly priority?: number;\n  /** Defines the SyncUi event Ids that will trigger the stateFunc to run to determine the state of the widget. */\n  readonly syncEventIds?: string[];\n  /** Function executed to determine the state of the widget.\n   *  Used by UI 1.0 widgets ONLY.\n   * @deprecated in 3.3.\n  */\n  readonly stateFunc?: (state: Readonly<WidgetState>) => WidgetState; // eslint-disable-line deprecation/deprecation\n  /** Badge to be overlaid on the widget tab. */\n  readonly badgeType?: BadgeType;\n  /** Handler for widget state changed event */\n  readonly onWidgetStateChanged?: () => void;\n  /** Save transient DOM state (i.e. scroll offset). */\n  readonly saveTransientState?: () => void;\n  /** Restore transient DOM state.\n   * @note Return true if the state is restored or the Widget will remount.\n   */\n  readonly restoreTransientState?: () => boolean;\n  /** Optional default size to use when floating a widget. If not specified then the default is to size to content if possible.\n   * Certain widget can't be intrinsically sized and must specify a content. These are typically ones that use a canvas element\n   * internally. */\n  defaultFloatingSize?: { width: number, height: number };\n  /** Optional prop that tells the widget system to fade this widget out with the rest of the UI when it is in floating state */\n  hideWithUiWhenFloating?: boolean;\n  /** Optional prop specifying which Panel sides can be docking targets for this widget. If this prop is not specified, all sides are allowed.\n   *  An empty array is treated the same as an undefined prop, allowing all targets. */\n  readonly allowedPanelTargets?:  ReadonlyArray<\"left\"|\"right\"|\"bottom\"|\"top\">;\n}\n"]}
+{"version":3,"file":"AbstractWidgetProps.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 Widget\n */\n\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\nimport { WidgetState } from \"./WidgetState\";\n\n/** Properties for a Widget.\n * @deprecated in 3.6. Use [CommonWidgetProps]($appui-react) instead.\n * @public\n */\nexport interface AbstractWidgetProps extends ProvidedItem { // eslint-disable-line deprecation/deprecation\n  /** Gets the widget content. */\n  readonly getWidgetContent: () => any;\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** Id used to uniquely identify the widget.\n   * @note It is recommended to provide unique widget id to correctly save/restore App layout.\n   */\n  readonly id?: string;\n  /** Default Widget state. Controls how the Widget is initially displayed. Defaults to WidgetState.Unloaded. */\n  readonly defaultState?: WidgetState; // eslint-disable-line deprecation/deprecation\n  /** if set, component will be considered selected but will NOT display an \"active stripe\" - defaults to false. Typically used by buttons that toggle between two states. */\n  readonly label?: string | ConditionalStringValue;\n  /** used to explicitly set the tooltip shown by a component. */\n  readonly tooltip?: string | ConditionalStringValue;\n  /** Indicates whether the Widget is free-form or rectangular. Defaults to false for rectangular. The default is false.\n   * @deprecated in 3.0. Free-form widgets are obsolete.\n   * */\n  readonly isFreeform?: boolean;\n  /** Application data attached to the Widget. */\n  readonly applicationData?: any;\n  /** optional data to used by item implementor. */\n  readonly internalData?: Map<string, any>;\n  /** Indicates whether this Widget is for the Tool Settings. */\n  readonly isToolSettings?: boolean;\n  /** Indicates whether this Widget is for the Status Bar. */\n  readonly isStatusBar?: boolean;\n  /** Indicates whether this Widget should fill the available space in the Zone. */\n  readonly fillZone?: boolean;\n  /** Indicates if widget can be popped out to a child window. Defaults to false. */\n  readonly canPopout?: boolean;\n  /** If the widget state is changed to `floating` and the floatingContainerId is defined, the widget will be added to a\n   * floating panel by that name. If no name is specified, a GUID is used. */\n  readonly floatingContainerId?: string;\n  /** Indicates if widget can be in floating state, default to true. */\n  readonly isFloatingStateSupported?: boolean;\n  /** Indicates if floating widget is resizable, defaults to false which caused the widget to be auto-sized.. */\n  readonly isFloatingStateWindowResizable?: boolean;\n  /** Defines that default Top Left position when widget is floated via API calls */\n  readonly defaultFloatingPosition?: { x: number, y: number };\n  /** Widget priority */\n  readonly priority?: number;\n  /** Defines the SyncUi event Ids that will trigger the stateFunc to run to determine the state of the widget. */\n  readonly syncEventIds?: string[];\n  /** Function executed to determine the state of the widget.\n   *  Used by UI 1.0 widgets ONLY.\n   * @deprecated in 3.3. UI 1.0 support will be removed in AppUi 4.0.\n  */\n  readonly stateFunc?: (state: Readonly<WidgetState>) => WidgetState; // eslint-disable-line deprecation/deprecation\n  /** Badge to be overlaid on the widget tab. */\n  readonly badgeType?: BadgeType;\n  /** Handler for widget state changed event */\n  readonly onWidgetStateChanged?: () => void;\n  /** Save transient DOM state (i.e. scroll offset). */\n  readonly saveTransientState?: () => void;\n  /** Restore transient DOM state.\n   * @note Return true if the state is restored or the Widget will remount.\n   */\n  readonly restoreTransientState?: () => boolean;\n  /** Optional default size to use when floating a widget. If not specified then the default is to size to content if possible.\n   * Certain widget can't be intrinsically sized and must specify a content. These are typically ones that use a canvas element\n   * internally. */\n  defaultFloatingSize?: { width: number, height: number };\n  /** Optional prop that tells the widget system to fade this widget out with the rest of the UI when it is in floating state */\n  hideWithUiWhenFloating?: boolean;\n  /** Optional prop specifying which Panel sides can be docking targets for this widget. If this prop is not specified, all sides are allowed.\n   *  An empty array is treated the same as an undefined prop, allowing all targets. */\n  readonly allowedPanelTargets?:  ReadonlyArray<\"left\"|\"right\"|\"bottom\"|\"top\">;\n}\n"]}

package/lib/esm/appui-abstract/widget/StagePanel.d.ts

@@ -2,7 +2,7 @@
  * @module Widget
  */
 /** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].
- * @public @deprecated in 3.0.
+ * @public @deprecated in 3.0. UI 1.0 support will be removed in AppUi 4.0.
  */
 export declare enum AbstractZoneLocation {
     CenterLeft = 4,
@@ -16,12 +16,12 @@ export declare enum AbstractZoneLocation {
  */
 export declare enum StagePanelLocation {
     Top = 101,
-    /** @deprecated Used in UI1.0 only. */
+    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
     TopMost = 102,
     Left = 103,
     Right = 104,
     Bottom = 105,
-    /** @deprecated Used in UI1.0 only. */
+    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
     BottomMost = 106
 }
 /** Enum for Stage Panel Sections

package/lib/esm/appui-abstract/widget/StagePanel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StagePanel.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,oBAAY,oBAAoB;IAC9B,UAAU,IAAI;IACd,WAAW,IAAI;IACf,UAAU,IAAI;IACd,WAAW,IAAI;CAChB;AAED;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,GAAG,MAAM;IACT,sCAAsC;IACtC,OAAO,MAAA;IACP,IAAI,MAAA;IACJ,KAAK,MAAA;IACL,MAAM,MAAA;IACN,sCAAsC;IACtC,UAAU,MAAA;CACX;AAED;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,KAAK,IAAA;IACL,mGAAmG;IACnG,MAAM,IAAA;IACN,GAAG,IAAA;CACJ"}
+{"version":3,"file":"StagePanel.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,oBAAY,oBAAoB;IAC9B,UAAU,IAAI;IACd,WAAW,IAAI;IACf,UAAU,IAAI;IACd,WAAW,IAAI;CAChB;AAED;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,GAAG,MAAM;IACT,sEAAsE;IACtE,OAAO,MAAA;IACP,IAAI,MAAA;IACJ,KAAK,MAAA;IACL,MAAM,MAAA;IACN,sEAAsE;IACtE,UAAU,MAAA;CACX;AAED;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,KAAK,IAAA;IACL,mGAAmG;IACnG,MAAM,IAAA;IACN,GAAG,IAAA;CACJ"}

package/lib/esm/appui-abstract/widget/StagePanel.js

@@ -6,7 +6,7 @@
  * @module Widget
  */
 /** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].
- * @public @deprecated in 3.0.
+ * @public @deprecated in 3.0. UI 1.0 support will be removed in AppUi 4.0.
  */
 export var AbstractZoneLocation;
 (function (AbstractZoneLocation) {
@@ -22,12 +22,12 @@ export var AbstractZoneLocation;
 export var StagePanelLocation;
 (function (StagePanelLocation) {
     StagePanelLocation[StagePanelLocation["Top"] = 101] = "Top";
-    /** @deprecated Used in UI1.0 only. */
+    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
     StagePanelLocation[StagePanelLocation["TopMost"] = 102] = "TopMost";
     StagePanelLocation[StagePanelLocation["Left"] = 103] = "Left";
     StagePanelLocation[StagePanelLocation["Right"] = 104] = "Right";
     StagePanelLocation[StagePanelLocation["Bottom"] = 105] = "Bottom";
-    /** @deprecated Used in UI1.0 only. */
+    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
     StagePanelLocation[StagePanelLocation["BottomMost"] = 106] = "BottomMost";
 })(StagePanelLocation || (StagePanelLocation = {}));
 /** Enum for Stage Panel Sections

package/lib/esm/appui-abstract/widget/StagePanel.js.map

@@ -1 +1 @@
-{"version":3,"file":"StagePanel.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,2EAAc,CAAA;IACd,6EAAe,CAAA;IACf,2EAAc,CAAA;IACd,6EAAe,CAAA;AACjB,CAAC,EALW,oBAAoB,KAApB,oBAAoB,QAK/B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B,2DAAS,CAAA;IACT,sCAAsC;IACtC,mEAAO,CAAA;IACP,6DAAI,CAAA;IACJ,+DAAK,CAAA;IACL,iEAAM,CAAA;IACN,sCAAsC;IACtC,yEAAU,CAAA;AACZ,CAAC,EATW,kBAAkB,KAAlB,kBAAkB,QAS7B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,2DAAK,CAAA;IACL,mGAAmG;IACnG,6DAAM,CAAA;IACN,uDAAG,CAAA;AACL,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B","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 Widget\n */\n\n/** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].\n * @public @deprecated in 3.0.\n */\nexport enum AbstractZoneLocation {\n  CenterLeft = 4,\n  CenterRight = 6,\n  BottomLeft = 7,\n  BottomRight = 9,\n}\n\n/** Available Stage Panel locations.\n * @deprecated in 3.6. Use [StagePanelLocation]($appui-react) instead.\n * @public\n */\nexport enum StagePanelLocation {\n  Top = 101,\n  /** @deprecated Used in UI1.0 only. */\n  TopMost,\n  Left,\n  Right,\n  Bottom,\n  /** @deprecated Used in UI1.0 only. */\n  BottomMost,\n}\n\n/** Enum for Stage Panel Sections\n * @deprecated in 3.6. Use [StagePanelSection]($appui-react) instead.\n * @public\n */\nexport enum StagePanelSection {\n  Start,\n  /** @deprecated in 3.2. - all widgets that a targeted for Middle will be placed in `End` section */\n  Middle,\n  End,\n}\n"]}
+{"version":3,"file":"StagePanel.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,2EAAc,CAAA;IACd,6EAAe,CAAA;IACf,2EAAc,CAAA;IACd,6EAAe,CAAA;AACjB,CAAC,EALW,oBAAoB,KAApB,oBAAoB,QAK/B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B,2DAAS,CAAA;IACT,sEAAsE;IACtE,mEAAO,CAAA;IACP,6DAAI,CAAA;IACJ,+DAAK,CAAA;IACL,iEAAM,CAAA;IACN,sEAAsE;IACtE,yEAAU,CAAA;AACZ,CAAC,EATW,kBAAkB,KAAlB,kBAAkB,QAS7B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,2DAAK,CAAA;IACL,mGAAmG;IACnG,6DAAM,CAAA;IACN,uDAAG,CAAA;AACL,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B","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 Widget\n */\n\n/** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].\n * @public @deprecated in 3.0. UI 1.0 support will be removed in AppUi 4.0.\n */\nexport enum AbstractZoneLocation {\n  CenterLeft = 4,\n  CenterRight = 6,\n  BottomLeft = 7,\n  BottomRight = 9,\n}\n\n/** Available Stage Panel locations.\n * @deprecated in 3.6. Use [StagePanelLocation]($appui-react) instead.\n * @public\n */\nexport enum StagePanelLocation {\n  Top = 101,\n  /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */\n  TopMost,\n  Left,\n  Right,\n  Bottom,\n  /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */\n  BottomMost,\n}\n\n/** Enum for Stage Panel Sections\n * @deprecated in 3.6. Use [StagePanelSection]($appui-react) instead.\n * @public\n */\nexport enum StagePanelSection {\n  Start,\n  /** @deprecated in 3.2. - all widgets that a targeted for Middle will be placed in `End` section */\n  Middle,\n  End,\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/appui-abstract",
-  "version": "3.6.1",
+  "version": "3.7.0-dev.2",
   "description": "iTwin.js UI abstractions",
   "main": "lib/cjs/appui-abstract.js",
   "module": "lib/esm/appui-abstract.js",
@@ -21,16 +21,16 @@
     "url": "http://www.bentley.com"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "^3.6.1"
+    "@itwin/core-bentley": "^3.7.0-dev.2"
   },
   "//devDependencies": [
     "NOTE: All peerDependencies should also be listed as devDependencies since peerDependencies are not considered by npm install",
     "NOTE: All tools used by scripts in this package must be listed as devDependencies"
   ],
   "devDependencies": {
-    "@itwin/build-tools": "3.6.1",
-    "@itwin/core-bentley": "3.6.1",
-    "@itwin/eslint-plugin": "3.6.1",
+    "@itwin/build-tools": "3.7.0-dev.2",
+    "@itwin/core-bentley": "3.7.0-dev.2",
+    "@itwin/eslint-plugin": "3.7.0-dev.2",
     "@types/chai": "4.3.1",
     "@types/chai-as-promised": "^7",
     "@types/chai-jest-snapshot": "^1.3.0",