@itwin/appui-react 3.7.0-dev.2 → 3.7.0-dev.5

package/lib/cjs/appui-react/shared/ItemMap.d.ts

@@ -1,22 +1,22 @@
-/** @packageDocumentation
- * @module Item
- */
-import { ItemDefBase } from "./ItemDefBase";
-/** Contains a map of Items.
- * @public
- */
-export declare class ItemMap extends Map<string, ItemDefBase> {
-    constructor(items?: ItemDefBase[]);
-    addItem(item: ItemDefBase): void;
-    addItems(items: ItemDefBase[]): void;
-}
-/** Contains a list of Items.
- * @public
- */
-export declare class ItemList extends Array<ItemDefBase> {
-    constructor(items?: ItemDefBase[]);
-    addItem(item: ItemDefBase): void;
-    addItems(items: ItemDefBase[]): void;
-    get items(): ItemDefBase[];
-}
+/** @packageDocumentation
+ * @module Item
+ */
+import { ItemDefBase } from "./ItemDefBase";
+/** Contains a map of Items.
+ * @public
+ */
+export declare class ItemMap extends Map<string, ItemDefBase> {
+    constructor(items?: ItemDefBase[]);
+    addItem(item: ItemDefBase): void;
+    addItems(items: ItemDefBase[]): void;
+}
+/** Contains a list of Items.
+ * @public
+ */
+export declare class ItemList extends Array<ItemDefBase> {
+    constructor(items?: ItemDefBase[]);
+    addItem(item: ItemDefBase): void;
+    addItems(items: ItemDefBase[]): void;
+    get items(): ItemDefBase[];
+}
 //# sourceMappingURL=ItemMap.d.ts.map

package/lib/cjs/appui-react/shared/ItemMap.js

@@ -1,52 +1,52 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Item
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ItemList = exports.ItemMap = void 0;
-/** Contains a map of Items.
- * @public
- */
-class ItemMap extends Map {
-    constructor(items) {
-        super();
-        if (items && typeof items === "object")
-            this.addItems(items);
-    }
-    addItem(item) {
-        this.set(item.id, item);
-    }
-    addItems(items) {
-        items.forEach((item) => {
-            this.set(item.id, item);
-        });
-    }
-}
-exports.ItemMap = ItemMap;
-/** Contains a list of Items.
- * @public
- */
-class ItemList extends Array {
-    constructor(items) {
-        super();
-        if (items && typeof items === "object")
-            this.addItems(items);
-    }
-    addItem(item) {
-        this.push(item);
-    }
-    addItems(items) {
-        items.forEach((item) => {
-            this.push(item);
-        });
-    }
-    get items() {
-        return this;
-    }
-}
-exports.ItemList = ItemList;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Item
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemList = exports.ItemMap = void 0;
+/** Contains a map of Items.
+ * @public
+ */
+class ItemMap extends Map {
+    constructor(items) {
+        super();
+        if (items && typeof items === "object")
+            this.addItems(items);
+    }
+    addItem(item) {
+        this.set(item.id, item);
+    }
+    addItems(items) {
+        items.forEach((item) => {
+            this.set(item.id, item);
+        });
+    }
+}
+exports.ItemMap = ItemMap;
+/** Contains a list of Items.
+ * @public
+ */
+class ItemList extends Array {
+    constructor(items) {
+        super();
+        if (items && typeof items === "object")
+            this.addItems(items);
+    }
+    addItem(item) {
+        this.push(item);
+    }
+    addItems(items) {
+        items.forEach((item) => {
+            this.push(item);
+        });
+    }
+    get items() {
+        return this;
+    }
+}
+exports.ItemList = ItemList;
 //# sourceMappingURL=ItemMap.js.map

package/lib/cjs/appui-react/shared/ItemMap.js.map

@@ -1 +1 @@
-{"version":3,"file":"ItemMap.js","sourceRoot":"","sources":["../../../../src/appui-react/shared/ItemMap.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;GAEG;AACH,MAAa,OAAQ,SAAQ,GAAwB;IAEnD,YAAY,KAAqB;QAC/B,KAAK,EAAE,CAAC;QAER,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YACpC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAEM,OAAO,CAAC,IAAiB;QAC9B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAC1B,CAAC;IAEM,QAAQ,CAAC,KAAoB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAiB,EAAE,EAAE;YAClC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAlBD,0BAkBC;AAED;;GAEG;AACH,MAAa,QAAS,SAAQ,KAAkB;IAE9C,YAAY,KAAqB;QAC/B,KAAK,EAAE,CAAC;QAER,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YACpC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAEM,OAAO,CAAC,IAAiB;QAC9B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAEM,QAAQ,CAAC,KAAoB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAiB,EAAE,EAAE;YAClC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAtBD,4BAsBC","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 Item\n */\n\nimport { ItemDefBase } from \"./ItemDefBase\";\n\n/** Contains a map of Items.\n * @public\n */\nexport class ItemMap extends Map<string, ItemDefBase> {\n\n  constructor(items?: ItemDefBase[]) {\n    super();\n\n    if (items && typeof items === \"object\")\n      this.addItems(items);\n  }\n\n  public addItem(item: ItemDefBase) {\n    this.set(item.id, item);\n  }\n\n  public addItems(items: ItemDefBase[]) {\n    items.forEach((item: ItemDefBase) => {\n      this.set(item.id, item);\n    });\n  }\n}\n\n/** Contains a list of Items.\n * @public\n */\nexport class ItemList extends Array<ItemDefBase> {\n\n  constructor(items?: ItemDefBase[]) {\n    super();\n\n    if (items && typeof items === \"object\")\n      this.addItems(items);\n  }\n\n  public addItem(item: ItemDefBase) {\n    this.push(item);\n  }\n\n  public addItems(items: ItemDefBase[]) {\n    items.forEach((item: ItemDefBase) => {\n      this.push(item);\n    });\n  }\n\n  public get items(): ItemDefBase[] {\n    return this;\n  }\n}\n"]}
+{"version":3,"file":"ItemMap.js","sourceRoot":"","sources":["../../../../src/appui-react/shared/ItemMap.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;GAEG;AACH,MAAa,OAAQ,SAAQ,GAAwB;IAEnD,YAAY,KAAqB;QAC/B,KAAK,EAAE,CAAC;QAER,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YACpC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAEM,OAAO,CAAC,IAAiB;QAC9B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAC1B,CAAC;IAEM,QAAQ,CAAC,KAAoB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAiB,EAAE,EAAE;YAClC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAlBD,0BAkBC;AAED;;GAEG;AACH,MAAa,QAAS,SAAQ,KAAkB;IAE9C,YAAY,KAAqB;QAC/B,KAAK,EAAE,CAAC;QAER,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YACpC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAEM,OAAO,CAAC,IAAiB;QAC9B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAEM,QAAQ,CAAC,KAAoB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAiB,EAAE,EAAE;YAClC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAtBD,4BAsBC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Item\r\n */\r\n\r\nimport { ItemDefBase } from \"./ItemDefBase\";\r\n\r\n/** Contains a map of Items.\r\n * @public\r\n */\r\nexport class ItemMap extends Map<string, ItemDefBase> {\r\n\r\n  constructor(items?: ItemDefBase[]) {\r\n    super();\r\n\r\n    if (items && typeof items === \"object\")\r\n      this.addItems(items);\r\n  }\r\n\r\n  public addItem(item: ItemDefBase) {\r\n    this.set(item.id, item);\r\n  }\r\n\r\n  public addItems(items: ItemDefBase[]) {\r\n    items.forEach((item: ItemDefBase) => {\r\n      this.set(item.id, item);\r\n    });\r\n  }\r\n}\r\n\r\n/** Contains a list of Items.\r\n * @public\r\n */\r\nexport class ItemList extends Array<ItemDefBase> {\r\n\r\n  constructor(items?: ItemDefBase[]) {\r\n    super();\r\n\r\n    if (items && typeof items === \"object\")\r\n      this.addItems(items);\r\n  }\r\n\r\n  public addItem(item: ItemDefBase) {\r\n    this.push(item);\r\n  }\r\n\r\n  public addItems(items: ItemDefBase[]) {\r\n    items.forEach((item: ItemDefBase) => {\r\n      this.push(item);\r\n    });\r\n  }\r\n\r\n  public get items(): ItemDefBase[] {\r\n    return this;\r\n  }\r\n}\r\n"]}

package/lib/cjs/appui-react/shared/ItemProps.d.ts

@@ -1,66 +1,66 @@
-/** @packageDocumentation
- * @module Item
- */
-import { BadgeType, CommandHandler, ConditionalBooleanValue, ConditionalStringValue, StringGetter } from "@itwin/appui-abstract";
-import { IconProps } from "@itwin/core-react";
-import { BaseItemState } from "./ItemDefBase";
-/** Definition that specifies properties shared between many ConfigurableUi components.
- * @public
- */
-export interface ItemProps extends IconProps {
-    /** if set, component will be visible - defaults to true
-     * @deprecated in 2.x. use isHidden
-     */
-    isVisible?: boolean;
-    /** if set, component will be enabled - defaults to true
-     * @deprecated in 2.x. use isDisabled
-     */
-    isEnabled?: boolean;
-    /** if true component will be hidden - defaults to false */
-    isHidden?: boolean | ConditionalBooleanValue;
-    /** if true component will be disabled - defaults to false */
-    isDisabled?: boolean | ConditionalBooleanValue;
-    /** if set, component will be considered "active" an will display an "active stripe" - defaults to false */
-    isActive?: boolean;
-    /** 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. */
-    isPressed?: boolean;
-    /** can be used by application to store miscellaneous data. */
-    applicationData?: any;
-    /** Badge to be overlaid on the item. */
-    badgeType?: BadgeType;
-    /** abstract icon definition, used when create itemDef from abstract item (ie. MenuItem) */
-    icon?: string | ConditionalStringValue;
-    /** if set, it is used to explicitly set the label shown by a component. */
-    label?: string | StringGetter | ConditionalStringValue;
-    /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */
-    labelKey?: string;
-    /** if set, it is used to explicitly set the description shown by a component. */
-    description?: string | StringGetter | ConditionalStringValue;
-    /** if set, it is used to define a key that is used to look up a localized string. This value is used only if description is not explicitly set. */
-    descriptionKey?: string;
-    /** used to explicitly set the tooltip shown by a component. */
-    tooltip?: string | StringGetter | ConditionalStringValue;
-    /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */
-    tooltipKey?: string;
-    /** Function called to get the new items state
-     * @deprecated in 3.0. Use ConditionalStringValue or ConditionalBooleanValue instead
-     */
-    stateFunc?: (state: Readonly<BaseItemState>) => BaseItemState;
-    /** Synchronize Ids to listen for
-     * @deprecated in 3.0. Use ConditionalStringValue or ConditionalBooleanValue instead
-     */
-    stateSyncIds?: string[];
-}
-/** Properties for a Tool item with a tool id.
- * @public
- */
-export interface ToolItemProps extends ItemProps, CommandHandler {
-    toolId: string;
-}
-/** Properties for a Command item.
- * @public
- */
-export interface CommandItemProps extends ItemProps, CommandHandler {
-    commandId?: string;
-}
+/** @packageDocumentation
+ * @module Item
+ */
+import { BadgeType, CommandHandler, ConditionalBooleanValue, ConditionalStringValue, StringGetter } from "@itwin/appui-abstract";
+import { IconProps } from "@itwin/core-react";
+import { BaseItemState } from "./ItemDefBase";
+/** Definition that specifies properties shared between many ConfigurableUi components.
+ * @public
+ */
+export interface ItemProps extends IconProps {
+    /** if set, component will be visible - defaults to true
+     * @deprecated in 2.x. use isHidden
+     */
+    isVisible?: boolean;
+    /** if set, component will be enabled - defaults to true
+     * @deprecated in 2.x. use isDisabled
+     */
+    isEnabled?: boolean;
+    /** if true component will be hidden - defaults to false */
+    isHidden?: boolean | ConditionalBooleanValue;
+    /** if true component will be disabled - defaults to false */
+    isDisabled?: boolean | ConditionalBooleanValue;
+    /** if set, component will be considered "active" an will display an "active stripe" - defaults to false */
+    isActive?: boolean;
+    /** 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. */
+    isPressed?: boolean;
+    /** can be used by application to store miscellaneous data. */
+    applicationData?: any;
+    /** Badge to be overlaid on the item. */
+    badgeType?: BadgeType;
+    /** abstract icon definition, used when create itemDef from abstract item (ie. MenuItem) */
+    icon?: string | ConditionalStringValue;
+    /** if set, it is used to explicitly set the label shown by a component. */
+    label?: string | StringGetter | ConditionalStringValue;
+    /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */
+    labelKey?: string;
+    /** if set, it is used to explicitly set the description shown by a component. */
+    description?: string | StringGetter | ConditionalStringValue;
+    /** if set, it is used to define a key that is used to look up a localized string. This value is used only if description is not explicitly set. */
+    descriptionKey?: string;
+    /** used to explicitly set the tooltip shown by a component. */
+    tooltip?: string | StringGetter | ConditionalStringValue;
+    /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */
+    tooltipKey?: string;
+    /** Function called to get the new items state
+     * @deprecated in 3.0. Use ConditionalStringValue or ConditionalBooleanValue instead
+     */
+    stateFunc?: (state: Readonly<BaseItemState>) => BaseItemState;
+    /** Synchronize Ids to listen for
+     * @deprecated in 3.0. Use ConditionalStringValue or ConditionalBooleanValue instead
+     */
+    stateSyncIds?: string[];
+}
+/** Properties for a Tool item with a tool id.
+ * @public
+ */
+export interface ToolItemProps extends ItemProps, CommandHandler {
+    toolId: string;
+}
+/** Properties for a Command item.
+ * @public
+ */
+export interface CommandItemProps extends ItemProps, CommandHandler {
+    commandId?: string;
+}
 //# sourceMappingURL=ItemProps.d.ts.map

package/lib/cjs/appui-react/shared/ItemProps.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Item
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Item
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=ItemProps.js.map

package/lib/cjs/appui-react/shared/ItemProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"ItemProps.js","sourceRoot":"","sources":["../../../../src/appui-react/shared/ItemProps.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 Item\n */\n\nimport { BadgeType, CommandHandler, ConditionalBooleanValue, ConditionalStringValue, StringGetter } from \"@itwin/appui-abstract\";\nimport { IconProps } from \"@itwin/core-react\";\nimport { BaseItemState } from \"./ItemDefBase\";\n\n/** Definition that specifies properties shared between many ConfigurableUi components.\n * @public\n */\nexport interface ItemProps extends IconProps {\n  /** if set, component will be visible - defaults to true\n   * @deprecated in 2.x. use isHidden\n   */\n  isVisible?: boolean;\n  /** if set, component will be enabled - defaults to true\n   * @deprecated in 2.x. use isDisabled\n   */\n  isEnabled?: boolean;\n  /** if true component will be hidden - defaults to false */\n  isHidden?: boolean | ConditionalBooleanValue;\n  /** if true component will be disabled - defaults to false */\n  isDisabled?: boolean | ConditionalBooleanValue;\n  /** if set, component will be considered \"active\" an will display an \"active stripe\" - defaults to false */\n  isActive?: boolean;\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  isPressed?: boolean;\n  /** can be used by application to store miscellaneous data. */\n  applicationData?: any;\n  /** Badge to be overlaid on the item. */\n  badgeType?: BadgeType;\n  /** abstract icon definition, used when create itemDef from abstract item (ie. MenuItem) */\n  icon?: string | ConditionalStringValue;\n\n  /** if set, it is used to explicitly set the label shown by a component. */\n  label?: string | StringGetter | ConditionalStringValue;\n  /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */\n  labelKey?: string;\n\n  /** if set, it is used to explicitly set the description shown by a component. */\n  description?: string | StringGetter | ConditionalStringValue;\n  /** if set, it is used to define a key that is used to look up a localized string. This value is used only if description is not explicitly set. */\n  descriptionKey?: string;\n  /** used to explicitly set the tooltip shown by a component. */\n  tooltip?: string | StringGetter | ConditionalStringValue;\n  /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */\n  tooltipKey?: string;\n\n  /** Function called to get the new items state\n   * @deprecated in 3.0. Use ConditionalStringValue or ConditionalBooleanValue instead\n   */\n  stateFunc?: (state: Readonly<BaseItemState>) => BaseItemState;\n  /** Synchronize Ids to listen for\n   * @deprecated in 3.0. Use ConditionalStringValue or ConditionalBooleanValue instead\n   */\n  stateSyncIds?: string[];\n}\n\n/** Properties for a Tool item with a tool id.\n * @public\n */\nexport interface ToolItemProps extends ItemProps, CommandHandler {\n  toolId: string;\n}\n\n/** Properties for a Command item.\n * @public\n */\nexport interface CommandItemProps extends ItemProps, CommandHandler {\n  commandId?: string;\n}\n"]}
+{"version":3,"file":"ItemProps.js","sourceRoot":"","sources":["../../../../src/appui-react/shared/ItemProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Item\r\n */\r\n\r\nimport { BadgeType, CommandHandler, ConditionalBooleanValue, ConditionalStringValue, StringGetter } from \"@itwin/appui-abstract\";\r\nimport { IconProps } from \"@itwin/core-react\";\r\nimport { BaseItemState } from \"./ItemDefBase\";\r\n\r\n/** Definition that specifies properties shared between many ConfigurableUi components.\r\n * @public\r\n */\r\nexport interface ItemProps extends IconProps {\r\n  /** if set, component will be visible - defaults to true\r\n   * @deprecated in 2.x. use isHidden\r\n   */\r\n  isVisible?: boolean;\r\n  /** if set, component will be enabled - defaults to true\r\n   * @deprecated in 2.x. use isDisabled\r\n   */\r\n  isEnabled?: boolean;\r\n  /** if true component will be hidden - defaults to false */\r\n  isHidden?: boolean | ConditionalBooleanValue;\r\n  /** if true component will be disabled - defaults to false */\r\n  isDisabled?: boolean | ConditionalBooleanValue;\r\n  /** if set, component will be considered \"active\" an will display an \"active stripe\" - defaults to false */\r\n  isActive?: boolean;\r\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. */\r\n  isPressed?: boolean;\r\n  /** can be used by application to store miscellaneous data. */\r\n  applicationData?: any;\r\n  /** Badge to be overlaid on the item. */\r\n  badgeType?: BadgeType;\r\n  /** abstract icon definition, used when create itemDef from abstract item (ie. MenuItem) */\r\n  icon?: string | ConditionalStringValue;\r\n\r\n  /** if set, it is used to explicitly set the label shown by a component. */\r\n  label?: string | StringGetter | ConditionalStringValue;\r\n  /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */\r\n  labelKey?: string;\r\n\r\n  /** if set, it is used to explicitly set the description shown by a component. */\r\n  description?: string | StringGetter | ConditionalStringValue;\r\n  /** if set, it is used to define a key that is used to look up a localized string. This value is used only if description is not explicitly set. */\r\n  descriptionKey?: string;\r\n  /** used to explicitly set the tooltip shown by a component. */\r\n  tooltip?: string | StringGetter | ConditionalStringValue;\r\n  /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */\r\n  tooltipKey?: string;\r\n\r\n  /** Function called to get the new items state\r\n   * @deprecated in 3.0. Use ConditionalStringValue or ConditionalBooleanValue instead\r\n   */\r\n  stateFunc?: (state: Readonly<BaseItemState>) => BaseItemState;\r\n  /** Synchronize Ids to listen for\r\n   * @deprecated in 3.0. Use ConditionalStringValue or ConditionalBooleanValue instead\r\n   */\r\n  stateSyncIds?: string[];\r\n}\r\n\r\n/** Properties for a Tool item with a tool id.\r\n * @public\r\n */\r\nexport interface ToolItemProps extends ItemProps, CommandHandler {\r\n  toolId: string;\r\n}\r\n\r\n/** Properties for a Command item.\r\n * @public\r\n */\r\nexport interface CommandItemProps extends ItemProps, CommandHandler {\r\n  commandId?: string;\r\n}\r\n"]}

package/lib/cjs/appui-react/shared/MenuItem.d.ts

@@ -1,37 +1,37 @@
-/** @packageDocumentation
- * @module Item
- */
-import * as React from "react";
-import { AbstractMenuItemProps } from "@itwin/appui-abstract";
-import { IconSpec } from "@itwin/core-react";
-import { ActionButtonItemDef } from "./ActionButtonItemDef";
-import { ItemDefBase } from "./ItemDefBase";
-/** Menu Item Properties
- * @public
- */
-export declare type MenuItemProps = AbstractMenuItemProps;
-/** Menu Item
- * @alpha
- */
-export declare class MenuItem extends ItemDefBase {
-    private _id;
-    private _actionItem?;
-    private _submenu;
-    private _onSelection?;
-    /** onSelection is an optional parameter typically supplied to allow menu parent to close context menu when a menu item is selected. */
-    constructor(props: MenuItemProps, onSelection?: () => void);
-    get id(): string;
-    get submenu(): MenuItem[];
-    get actionItem(): ActionButtonItemDef | undefined;
-    iconRightSpec?: IconSpec;
-    itemPicked(): void;
-}
-/** Menu Item helper methods
- * @alpha
- */
-export declare class MenuItemHelpers {
-    static createMenuItems(itemPropsList: MenuItemProps[], onSelection?: () => void): MenuItem[];
-    static createMenuItemNodes(itemList: MenuItem[]): React.ReactNode[];
-    private static createMenuItemNode;
-}
+/** @packageDocumentation
+ * @module Item
+ */
+import * as React from "react";
+import { AbstractMenuItemProps } from "@itwin/appui-abstract";
+import { IconSpec } from "@itwin/core-react";
+import { ActionButtonItemDef } from "./ActionButtonItemDef";
+import { ItemDefBase } from "./ItemDefBase";
+/** Menu Item Properties
+ * @public
+ */
+export declare type MenuItemProps = AbstractMenuItemProps;
+/** Menu Item
+ * @alpha
+ */
+export declare class MenuItem extends ItemDefBase {
+    private _id;
+    private _actionItem?;
+    private _submenu;
+    private _onSelection?;
+    /** onSelection is an optional parameter typically supplied to allow menu parent to close context menu when a menu item is selected. */
+    constructor(props: MenuItemProps, onSelection?: () => void);
+    get id(): string;
+    get submenu(): MenuItem[];
+    get actionItem(): ActionButtonItemDef | undefined;
+    iconRightSpec?: IconSpec;
+    itemPicked(): void;
+}
+/** Menu Item helper methods
+ * @alpha
+ */
+export declare class MenuItemHelpers {
+    static createMenuItems(itemPropsList: MenuItemProps[], onSelection?: () => void): MenuItem[];
+    static createMenuItemNodes(itemList: MenuItem[]): React.ReactNode[];
+    private static createMenuItemNode;
+}
 //# sourceMappingURL=MenuItem.d.ts.map

package/lib/cjs/appui-react/shared/MenuItem.js

@@ -1,113 +1,113 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Item
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MenuItemHelpers = exports.MenuItem = void 0;
-const React = require("react");
-const appui_abstract_1 = require("@itwin/appui-abstract");
-const core_react_1 = require("@itwin/core-react");
-const UiFramework_1 = require("../UiFramework");
-const CommandItemDef_1 = require("./CommandItemDef");
-const ItemDefBase_1 = require("./ItemDefBase");
-/** Menu Item
- * @alpha
- */
-class MenuItem extends ItemDefBase_1.ItemDefBase {
-    /** onSelection is an optional parameter typically supplied to allow menu parent to close context menu when a menu item is selected. */
-    constructor(props, onSelection) {
-        super(props);
-        this._id = "";
-        this._id = props.id;
-        this._submenu = new Array();
-        this._onSelection = onSelection;
-        if (props.item) {
-            this._actionItem = new CommandItemDef_1.CommandItemDef(props.item);
-            // Copy over icon, label & badgeType from the item
-            if (!this.iconSpec)
-                this.iconSpec = this._actionItem.iconSpec;
-            if (!this.label)
-                this.setLabel(this._actionItem.label);
-            if (!this.badgeType)
-                this.badgeType = this._actionItem.badgeType;
-            if (!this.isDisabled)
-                this.isDisabled = this._actionItem.isDisabled;
-        }
-        else if (props.submenu) {
-            props.submenu.forEach((childProps) => {
-                const childItem = new MenuItem(childProps, onSelection);
-                this._submenu.push(childItem);
-            });
-        }
-        else {
-            throw new appui_abstract_1.UiError(UiFramework_1.UiFramework.loggerCategory(this), `Either 'item' or 'submenu' must be specified for '${props.id}'.`);
-        }
-        this.iconRightSpec = props.iconRight;
-    }
-    get id() { return this._id; }
-    get submenu() {
-        return this._submenu;
-    }
-    get actionItem() {
-        return this._actionItem;
-    }
-    itemPicked() {
-        setTimeout(() => {
-            // istanbul ignore else
-            if (this._actionItem)
-                this._actionItem.execute();
-        });
-        // istanbul ignore else
-        if (this._onSelection)
-            this._onSelection();
-    }
-}
-exports.MenuItem = MenuItem;
-/** Menu Item helper methods
- * @alpha
- */
-class MenuItemHelpers {
-    static createMenuItems(itemPropsList, onSelection) {
-        const menuItems = new Array();
-        itemPropsList.forEach((itemProps) => {
-            menuItems.push(new MenuItem(itemProps, onSelection));
-        });
-        return menuItems;
-    }
-    static createMenuItemNodes(itemList) {
-        const itemNodes = [];
-        itemList.forEach((item, index) => {
-            const reactItem = this.createMenuItemNode(item, index);
-            // istanbul ignore else
-            if (reactItem)
-                itemNodes.push(reactItem);
-        });
-        return itemNodes;
-    }
-    static createMenuItemNode(item, index) {
-        let node = null;
-        const label = item.label;
-        const iconSpec = item.iconSpec;
-        const iconRightSpec = item.iconRightSpec;
-        const badgeType = item.badgeType;
-        const isDisabled = appui_abstract_1.ConditionalBooleanValue.getValue(item.isDisabled);
-        if (item.actionItem) {
-            const sel = () => item.itemPicked();
-            node = (React.createElement(core_react_1.ContextMenuItem, { key: index, onSelect: sel, icon: iconSpec, iconRight: iconRightSpec, badgeType: badgeType, disabled: isDisabled }, label));
-        }
-        else {
-            // istanbul ignore else
-            if (item.submenu && item.submenu.length > 0) {
-                const items = this.createMenuItemNodes(item.submenu);
-                node = (React.createElement(core_react_1.ContextSubMenu, { key: index, icon: iconSpec, label: label, badgeType: badgeType, disabled: isDisabled }, items));
-            }
-        }
-        return node;
-    }
-}
-exports.MenuItemHelpers = MenuItemHelpers;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Item
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MenuItemHelpers = exports.MenuItem = void 0;
+const React = require("react");
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const core_react_1 = require("@itwin/core-react");
+const UiFramework_1 = require("../UiFramework");
+const CommandItemDef_1 = require("./CommandItemDef");
+const ItemDefBase_1 = require("./ItemDefBase");
+/** Menu Item
+ * @alpha
+ */
+class MenuItem extends ItemDefBase_1.ItemDefBase {
+    /** onSelection is an optional parameter typically supplied to allow menu parent to close context menu when a menu item is selected. */
+    constructor(props, onSelection) {
+        super(props);
+        this._id = "";
+        this._id = props.id;
+        this._submenu = new Array();
+        this._onSelection = onSelection;
+        if (props.item) {
+            this._actionItem = new CommandItemDef_1.CommandItemDef(props.item);
+            // Copy over icon, label & badgeType from the item
+            if (!this.iconSpec)
+                this.iconSpec = this._actionItem.iconSpec;
+            if (!this.label)
+                this.setLabel(this._actionItem.label);
+            if (!this.badgeType)
+                this.badgeType = this._actionItem.badgeType;
+            if (!this.isDisabled)
+                this.isDisabled = this._actionItem.isDisabled;
+        }
+        else if (props.submenu) {
+            props.submenu.forEach((childProps) => {
+                const childItem = new MenuItem(childProps, onSelection);
+                this._submenu.push(childItem);
+            });
+        }
+        else {
+            throw new appui_abstract_1.UiError(UiFramework_1.UiFramework.loggerCategory(this), `Either 'item' or 'submenu' must be specified for '${props.id}'.`);
+        }
+        this.iconRightSpec = props.iconRight;
+    }
+    get id() { return this._id; }
+    get submenu() {
+        return this._submenu;
+    }
+    get actionItem() {
+        return this._actionItem;
+    }
+    itemPicked() {
+        setTimeout(() => {
+            // istanbul ignore else
+            if (this._actionItem)
+                this._actionItem.execute();
+        });
+        // istanbul ignore else
+        if (this._onSelection)
+            this._onSelection();
+    }
+}
+exports.MenuItem = MenuItem;
+/** Menu Item helper methods
+ * @alpha
+ */
+class MenuItemHelpers {
+    static createMenuItems(itemPropsList, onSelection) {
+        const menuItems = new Array();
+        itemPropsList.forEach((itemProps) => {
+            menuItems.push(new MenuItem(itemProps, onSelection));
+        });
+        return menuItems;
+    }
+    static createMenuItemNodes(itemList) {
+        const itemNodes = [];
+        itemList.forEach((item, index) => {
+            const reactItem = this.createMenuItemNode(item, index);
+            // istanbul ignore else
+            if (reactItem)
+                itemNodes.push(reactItem);
+        });
+        return itemNodes;
+    }
+    static createMenuItemNode(item, index) {
+        let node = null;
+        const label = item.label;
+        const iconSpec = item.iconSpec;
+        const iconRightSpec = item.iconRightSpec;
+        const badgeType = item.badgeType;
+        const isDisabled = appui_abstract_1.ConditionalBooleanValue.getValue(item.isDisabled);
+        if (item.actionItem) {
+            const sel = () => item.itemPicked();
+            node = (React.createElement(core_react_1.ContextMenuItem, { key: index, onSelect: sel, icon: iconSpec, iconRight: iconRightSpec, badgeType: badgeType, disabled: isDisabled }, label));
+        }
+        else {
+            // istanbul ignore else
+            if (item.submenu && item.submenu.length > 0) {
+                const items = this.createMenuItemNodes(item.submenu);
+                node = (React.createElement(core_react_1.ContextSubMenu, { key: index, icon: iconSpec, label: label, badgeType: badgeType, disabled: isDisabled }, items));
+            }
+        }
+        return node;
+    }
+}
+exports.MenuItemHelpers = MenuItemHelpers;
 //# sourceMappingURL=MenuItem.js.map