@itwin/appui-react 5.3.0 → 5.4.0

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

@@ -1 +1 @@
-{"version":3,"file":"MenuItem.js","sourceRoot":"","sources":["../../../src/appui-react/shared/MenuItem.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAK/B,OAAO,EAAE,uBAAuB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAGzE,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAkF/C;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IAOvC,uIAAuI;IACvI,YAAY,KAA0B,EAAE,WAAwB;QAC9D,KAAK,CAAC,KAAK,CAAC,CAAC;QARP,QAAG,GAAG,EAAE,CAAC;QAUf,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,EAAE,CAAC;QACpB,IAAI,CAAC,QAAQ,GAAG,IAAI,KAAK,EAAY,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAEhC,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,WAAW,GAAG,IAAI,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAElD,kDAAkD;YAClD,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC;YAC9D,IAAI,CAAC,IAAI,CAAC,KAAK;gBAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YACvD,IAAI,CAAC,IAAI,CAAC,SAAS;gBAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;YACjE,IAAI,CAAC,IAAI,CAAC,SAAS;gBAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;YACjE,IAAI,CAAC,IAAI,CAAC,UAAU;gBAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;QACtE,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAChC,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACzB,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,UAA+B,EAAE,EAAE;gBACxD,MAAM,SAAS,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;gBACxD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,4DAA4D;YAC5D,MAAM,IAAI,OAAO,CACf,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,EACtC,gEAAgE,KAAK,CAAC,EAAE,IAAI,CAC7E,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,SAAS,CAAC;IACvC,CAAC;IAED,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAIM,UAAU;QACf,UAAU,CAAC,GAAG,EAAE;YACd,IAAI,IAAI,CAAC,WAAW;gBAAE,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;iBAC5C,IAAI,IAAI,CAAC,QAAQ;gBAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,YAAY;YAAE,IAAI,CAAC,YAAY,EAAE,CAAC;IAC7C,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,eAAe;IACnB,MAAM,CAAC,eAAe,CAC3B,aAAoC,EACpC,WAAwB;QAExB,MAAM,SAAS,GAAG,IAAI,KAAK,EAAY,CAAC;QACxC,aAAa,CAAC,OAAO,CAAC,CAAC,SAA8B,EAAE,EAAE;YACvD,SAAS,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QACH,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,mBAAmB,CAAC,QAAoB;QACpD,MAAM,SAAS,GAAsB,EAAE,CAAC;QAExC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAc,EAAE,KAAa,EAAE,EAAE;YACjD,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YACvD,IAAI,SAAS;gBAAE,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,MAAM,CAAC,kBAAkB,CAC/B,IAAc,EACd,KAAa;QAEb,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,MAAM,UAAU,GAAY,uBAAuB,CAAC,QAAQ,CAC1D,IAAI,CAAC,UAAU,CAChB,CAAC;QAEF,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAErD,OAAO,CACL,oBAAC,cAAc,IACb,GAAG,EAAE,KAAK,EACV,IAAI,EAAE,QAAQ,EACd,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,UAAU,IAEnB,KAAK,CACS,CAClB,CAAC;QACJ,CAAC;QAED,OAAO,CACL,oBAAC,eAAe,IACd,GAAG,EAAE,KAAK,EACV,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,EACjC,IAAI,EAAE,QAAQ,EACd,SAAS,EAAE,aAAa,EACxB,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,UAAU,IAEnB,KAAK,CACU,CACnB,CAAC;IACJ,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 Item\n */\n\nimport * as React from \"react\";\nimport type {\n  AbstractMenuItemProps,\n  StringGetter,\n} from \"@itwin/appui-abstract\";\nimport { ConditionalBooleanValue, UiError } from \"@itwin/appui-abstract\";\nimport type { BadgeType, CommonProps, IconSpec } from \"@itwin/core-react\";\nimport type { BadgeKind } from \"@itwin/core-react/internal\";\nimport { ContextMenuItem, ContextSubMenu } from \"@itwin/core-react\";\nimport { UiFramework } from \"../UiFramework.js\";\nimport type { ActionButtonItemDef } from \"./ActionButtonItemDef.js\";\nimport { CommandItemDef } from \"./CommandItemDef.js\";\nimport { ItemDefBase } from \"./ItemDefBase.js\";\nimport type { CommandItemProps } from \"./ItemProps.js\";\nimport type { ConditionalStringValue } from \"./ConditionalValue.js\";\n\n/** Properties for context menu items.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/no-deprecated\nexport interface CursorMenuItemProps extends CommonProps {\n  /** The id for the menu item. */\n  id: string;\n  /** Icon to display. */\n  iconNode?: React.ReactNode;\n  /** Icon to display.\n   * @deprecated in 4.16.0. Use {@link CursorMenuItemProps.iconNode} instead.\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  iconSpec?: IconSpec;\n  /** The item to execute when this item is invoked. Either 'item', 'submenu' or `execute` must be specified.\n   * @deprecated in 4.15.0. Use properties of this object instead.\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  item?: CommandItemProps;\n  /** Function to execute. */\n  execute?: () => any;\n  /** Nested array of item props. Either 'item', 'submenu' or 'execute' must be specified. */\n  submenu?: CursorMenuItemProps[];\n  /** Icon to display on right side of the menu item.\n   * Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id.\n   */\n  iconRight?: string | ConditionalStringValue;\n\n  // #region \"ItemProps\" properties previously extended from deprecated type.\n\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   * @deprecated in 4.16.0. Use `badgeKind` property instead.\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  badgeType?: BadgeType;\n  /** Specifies the kind of badge, if any, to be overlaid on the item. */\n  badgeKind?: BadgeKind;\n  /** Abstract icon definition. Used when creating itemDef from abstract item (ie. MenuItem).\n   * @deprecated in 4.16.0. Use {@link CursorMenuItemProps.iconNode} instead.\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  icon?: IconSpec;\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  // #endregion \"ItemProps\"\n}\n\n/* eslint-disable @typescript-eslint/no-deprecated */\n\n/** Menu Item Properties\n * @public\n * @deprecated in 4.11.0. Please use {@link CursorMenuItemProps}.\n */\nexport type MenuItemProps = AbstractMenuItemProps;\n\n/** Menu Item\n * @alpha\n * @deprecated in 4.15.0. Used in a deprecated class {@link MenuItemHelpers}.\n */\nexport class MenuItem extends ItemDefBase {\n  private _id = \"\";\n  private _actionItem?: ActionButtonItemDef;\n  private _submenu: MenuItem[];\n  private _onSelection?: () => void;\n  private _execute?: () => void;\n\n  /** onSelection is an optional parameter typically supplied to allow menu parent to close context menu when a menu item is selected. */\n  constructor(props: CursorMenuItemProps, onSelection?: () => void) {\n    super(props);\n\n    this._id = props.id;\n    this._submenu = new Array<MenuItem>();\n    this._onSelection = onSelection;\n\n    if (props.item) {\n      this._actionItem = new CommandItemDef(props.item);\n\n      // Copy over icon, label & badgeType from the item\n      if (!this.iconSpec) this.iconSpec = this._actionItem.iconSpec;\n      if (!this.label) this.setLabel(this._actionItem.label);\n      if (!this.badgeType) this.badgeType = this._actionItem.badgeType;\n      if (!this.badgeKind) this.badgeKind = this._actionItem.badgeKind;\n      if (!this.isDisabled) this.isDisabled = this._actionItem.isDisabled;\n    } else if (props.execute) {\n      this._execute = props.execute;\n    } else if (props.submenu) {\n      props.submenu.forEach((childProps: CursorMenuItemProps) => {\n        const childItem = new MenuItem(childProps, onSelection);\n        this._submenu.push(childItem);\n      });\n    } else {\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      throw new UiError(\n        UiFramework.loggerCategory(\"MenuItem\"),\n        `Either 'item', 'execute' or 'submenu' must be specified for '${props.id}'.`\n      );\n    }\n\n    this.iconRightSpec = props.iconRight;\n  }\n\n  public get id(): string {\n    return this._id;\n  }\n\n  public get submenu(): MenuItem[] {\n    return this._submenu;\n  }\n\n  public get actionItem(): ActionButtonItemDef | undefined {\n    return this._actionItem;\n  }\n\n  public iconRightSpec?: IconSpec;\n\n  public itemPicked(): void {\n    setTimeout(() => {\n      if (this._actionItem) this._actionItem.execute();\n      else if (this._execute) this._execute();\n    });\n\n    if (this._onSelection) this._onSelection();\n  }\n}\n\n/** Menu Item helper methods\n * @alpha\n * @deprecated in 4.15.0. Use {@link @itwin/core-react#ContextMenuItem} and {@link @itwin/core-react#ContextSubMenu} components.\n */\nexport class MenuItemHelpers {\n  public static createMenuItems(\n    itemPropsList: CursorMenuItemProps[],\n    onSelection?: () => void\n  ): MenuItem[] {\n    const menuItems = new Array<MenuItem>();\n    itemPropsList.forEach((itemProps: CursorMenuItemProps) => {\n      menuItems.push(new MenuItem(itemProps, onSelection));\n    });\n    return menuItems;\n  }\n\n  public static createMenuItemNodes(itemList: MenuItem[]): React.ReactNode[] {\n    const itemNodes: React.ReactNode[] = [];\n\n    itemList.forEach((item: MenuItem, index: number) => {\n      const reactItem = this.createMenuItemNode(item, index);\n      if (reactItem) itemNodes.push(reactItem);\n    });\n\n    return itemNodes;\n  }\n\n  private static createMenuItemNode(\n    item: MenuItem,\n    index: number\n  ): React.ReactNode {\n    const label = item.label;\n    const iconSpec = item.iconSpec;\n    const iconRightSpec = item.iconRightSpec;\n    const badgeType = item.badgeType;\n    const badgeKind = item.badgeKind;\n    const isDisabled: boolean = ConditionalBooleanValue.getValue(\n      item.isDisabled\n    );\n\n    if (item.submenu && item.submenu.length > 0) {\n      const items = this.createMenuItemNodes(item.submenu);\n\n      return (\n        <ContextSubMenu\n          key={index}\n          icon={iconSpec}\n          label={label}\n          badgeType={badgeType}\n          badgeKind={badgeKind}\n          disabled={isDisabled}\n        >\n          {items}\n        </ContextSubMenu>\n      );\n    }\n\n    return (\n      <ContextMenuItem\n        key={index}\n        onSelect={() => item.itemPicked()}\n        icon={iconSpec}\n        iconRight={iconRightSpec}\n        badgeType={badgeType}\n        badgeKind={badgeKind}\n        disabled={isDisabled}\n      >\n        {label}\n      </ContextMenuItem>\n    );\n  }\n}\n"]}
+{"version":3,"file":"MenuItem.js","sourceRoot":"","sources":["../../../src/appui-react/shared/MenuItem.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAK/B,OAAO,EAAE,uBAAuB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAGzE,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAqF/C;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IAOvC,uIAAuI;IACvI,YAAY,KAA0B,EAAE,WAAwB;QAC9D,KAAK,CAAC,KAAK,CAAC,CAAC;QARP,QAAG,GAAG,EAAE,CAAC;QAUf,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,EAAE,CAAC;QACpB,IAAI,CAAC,QAAQ,GAAG,IAAI,KAAK,EAAY,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAEhC,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,WAAW,GAAG,IAAI,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAElD,kDAAkD;YAClD,IAAI,CAAC,IAAI,CAAC,KAAK;gBAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YACvD,IAAI,CAAC,IAAI,CAAC,SAAS;gBAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;YACjE,IAAI,CAAC,IAAI,CAAC,SAAS;gBAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;YACjE,IAAI,CAAC,IAAI,CAAC,UAAU;gBAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;QACtE,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAChC,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACzB,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBACnC,MAAM,SAAS,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;gBACxD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,4DAA4D;YAC5D,MAAM,IAAI,OAAO,CACf,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,EACtC,gEAAgE,KAAK,CAAC,EAAE,IAAI,CAC7E,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;QAC3E,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,SAAS,CAAC;IAC9D,CAAC;IAED,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAIM,UAAU;QACf,UAAU,CAAC,GAAG,EAAE;YACd,IAAI,IAAI,CAAC,WAAW;gBAAE,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;iBAC5C,IAAI,IAAI,CAAC,QAAQ;gBAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,YAAY;YAAE,IAAI,CAAC,YAAY,EAAE,CAAC;IAC7C,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,eAAe;IACnB,MAAM,CAAC,eAAe,CAC3B,aAAoC,EACpC,WAAwB;QAExB,MAAM,SAAS,GAAG,IAAI,KAAK,EAAY,CAAC;QACxC,aAAa,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAClC,SAAS,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QACH,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,mBAAmB,CAAC,QAAoB;QACpD,MAAM,SAAS,GAAsB,EAAE,CAAC;QAExC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAc,EAAE,KAAa,EAAE,EAAE;YACjD,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YACvD,IAAI,SAAS;gBAAE,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,MAAM,CAAC,kBAAkB,CAC/B,IAAc,EACd,KAAa;QAEb,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,MAAM,UAAU,GAAY,uBAAuB,CAAC,QAAQ,CAC1D,IAAI,CAAC,UAAU,CAChB,CAAC;QAEF,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAErD,OAAO,CACL,oBAAC,cAAc,IACb,GAAG,EAAE,KAAK,EACV,IAAI,EAAE,QAAQ,EACd,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,UAAU,IAEnB,KAAK,CACS,CAClB,CAAC;QACJ,CAAC;QAED,OAAO,CACL,oBAAC,eAAe,IACd,GAAG,EAAE,KAAK,EACV,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,EACjC,IAAI,EAAE,QAAQ,EACd,SAAS,EAAE,aAAa,EACxB,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,UAAU,IAEnB,KAAK,CACU,CACnB,CAAC;IACJ,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 Item\n */\n\nimport * as React from \"react\";\nimport type {\n  AbstractMenuItemProps,\n  StringGetter,\n} from \"@itwin/appui-abstract\";\nimport { ConditionalBooleanValue, UiError } from \"@itwin/appui-abstract\";\nimport type { BadgeType, CommonProps, IconSpec } from \"@itwin/core-react\";\nimport type { BadgeKind } from \"@itwin/core-react/internal\";\nimport { ContextMenuItem, ContextSubMenu } from \"@itwin/core-react\";\nimport { UiFramework } from \"../UiFramework.js\";\nimport type { ActionButtonItemDef } from \"./ActionButtonItemDef.js\";\nimport { CommandItemDef } from \"./CommandItemDef.js\";\nimport { ItemDefBase } from \"./ItemDefBase.js\";\nimport type { CommandItemProps } from \"./ItemProps.js\";\nimport type { ConditionalStringValue } from \"./ConditionalValue.js\";\n\n/** Properties for context menu items.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/no-deprecated\nexport interface CursorMenuItemProps extends CommonProps {\n  /** The id for the menu item. */\n  id: string;\n  /** Icon to display. */\n  iconNode?: React.ReactNode;\n  /** Icon to display.\n   * @deprecated in 4.16.0. Use {@link CursorMenuItemProps.iconNode} instead.\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  iconSpec?: IconSpec;\n  /** The item to execute when this item is invoked. Either 'item', 'submenu' or `execute` must be specified.\n   * @deprecated in 4.15.0. Use properties of this object instead.\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  item?: CommandItemProps;\n  /** Function to execute. */\n  execute?: () => any;\n  /** Nested array of item props. Either 'item', 'submenu' or 'execute' must be specified. */\n  submenu?: CursorMenuItemProps[];\n  /** Icon to display on right side of the menu item.\n   * Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id.\n   * @deprecated in 5.4.0. Use {@link CursorMenuItemProps.iconRightNode} instead.\n   */\n  iconRight?: string | ConditionalStringValue;\n  /** Icon to display on right side of the menu item. */\n  iconRightNode?: React.ReactNode;\n\n  // #region \"ItemProps\" properties previously extended from deprecated type.\n\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   * @deprecated in 4.16.0. Use `badgeKind` property instead.\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  badgeType?: BadgeType;\n  /** Specifies the kind of badge, if any, to be overlaid on the item. */\n  badgeKind?: BadgeKind;\n  /** Abstract icon definition. Used when creating itemDef from abstract item (ie. MenuItem).\n   * @deprecated in 4.16.0. Use {@link CursorMenuItemProps.iconNode} instead.\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  icon?: IconSpec;\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  // #endregion \"ItemProps\"\n}\n\n/* eslint-disable @typescript-eslint/no-deprecated */\n\n/** Menu Item Properties\n * @public\n * @deprecated in 4.11.0. Please use {@link CursorMenuItemProps}.\n */\nexport type MenuItemProps = AbstractMenuItemProps;\n\n/** Menu Item\n * @alpha\n * @deprecated in 4.15.0. Used in a deprecated class {@link MenuItemHelpers}.\n */\nexport class MenuItem extends ItemDefBase {\n  private _id = \"\";\n  private _actionItem?: ActionButtonItemDef;\n  private _submenu: MenuItem[];\n  private _onSelection?: () => void;\n  private _execute?: () => void;\n\n  /** onSelection is an optional parameter typically supplied to allow menu parent to close context menu when a menu item is selected. */\n  constructor(props: CursorMenuItemProps, onSelection?: () => void) {\n    super(props);\n\n    this._id = props.id;\n    this._submenu = new Array<MenuItem>();\n    this._onSelection = onSelection;\n\n    if (props.item) {\n      this._actionItem = new CommandItemDef(props.item);\n\n      // Copy over icon, label & badgeType from the item\n      if (!this.label) this.setLabel(this._actionItem.label);\n      if (!this.badgeType) this.badgeType = this._actionItem.badgeType;\n      if (!this.badgeKind) this.badgeKind = this._actionItem.badgeKind;\n      if (!this.isDisabled) this.isDisabled = this._actionItem.isDisabled;\n    } else if (props.execute) {\n      this._execute = props.execute;\n    } else if (props.submenu) {\n      props.submenu.forEach((childProps) => {\n        const childItem = new MenuItem(childProps, onSelection);\n        this._submenu.push(childItem);\n      });\n    } else {\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      throw new UiError(\n        UiFramework.loggerCategory(\"MenuItem\"),\n        `Either 'item', 'execute' or 'submenu' must be specified for '${props.id}'.`\n      );\n    }\n\n    this.iconSpec = props.iconNode ?? props.icon ?? this._actionItem?.iconSpec;\n    this.iconRightSpec = props.iconRightNode ?? props.iconRight;\n  }\n\n  public get id(): string {\n    return this._id;\n  }\n\n  public get submenu(): MenuItem[] {\n    return this._submenu;\n  }\n\n  public get actionItem(): ActionButtonItemDef | undefined {\n    return this._actionItem;\n  }\n\n  public iconRightSpec?: IconSpec;\n\n  public itemPicked(): void {\n    setTimeout(() => {\n      if (this._actionItem) this._actionItem.execute();\n      else if (this._execute) this._execute();\n    });\n\n    if (this._onSelection) this._onSelection();\n  }\n}\n\n/** Menu Item helper methods\n * @alpha\n * @deprecated in 4.15.0. Use {@link @itwin/core-react#ContextMenuItem} and {@link @itwin/core-react#ContextSubMenu} components.\n */\nexport class MenuItemHelpers {\n  public static createMenuItems(\n    itemPropsList: CursorMenuItemProps[],\n    onSelection?: () => void\n  ): MenuItem[] {\n    const menuItems = new Array<MenuItem>();\n    itemPropsList.forEach((itemProps) => {\n      menuItems.push(new MenuItem(itemProps, onSelection));\n    });\n    return menuItems;\n  }\n\n  public static createMenuItemNodes(itemList: MenuItem[]): React.ReactNode[] {\n    const itemNodes: React.ReactNode[] = [];\n\n    itemList.forEach((item: MenuItem, index: number) => {\n      const reactItem = this.createMenuItemNode(item, index);\n      if (reactItem) itemNodes.push(reactItem);\n    });\n\n    return itemNodes;\n  }\n\n  private static createMenuItemNode(\n    item: MenuItem,\n    index: number\n  ): React.ReactNode {\n    const label = item.label;\n    const iconSpec = item.iconSpec;\n    const iconRightSpec = item.iconRightSpec;\n    const badgeType = item.badgeType;\n    const badgeKind = item.badgeKind;\n    const isDisabled: boolean = ConditionalBooleanValue.getValue(\n      item.isDisabled\n    );\n\n    if (item.submenu && item.submenu.length > 0) {\n      const items = this.createMenuItemNodes(item.submenu);\n\n      return (\n        <ContextSubMenu\n          key={index}\n          icon={iconSpec}\n          label={label}\n          badgeType={badgeType}\n          badgeKind={badgeKind}\n          disabled={isDisabled}\n        >\n          {items}\n        </ContextSubMenu>\n      );\n    }\n\n    return (\n      <ContextMenuItem\n        key={index}\n        onSelect={() => item.itemPicked()}\n        icon={iconSpec}\n        iconRight={iconRightSpec}\n        badgeType={badgeType}\n        badgeKind={badgeKind}\n        disabled={isDisabled}\n      >\n        {label}\n      </ContextMenuItem>\n    );\n  }\n}\n"]}

package/lib/appui-react/statusfields/toolassistance/ToolAssistanceField.d.ts

@@ -1,10 +1,8 @@
 /** @packageDocumentation
  * @module Notification
  */
-import type { ToolAssistanceInstruction, ToolAssistanceInstructions } from "@itwin/core-frontend";
 import type { CommonProps } from "@itwin/core-react";
 import * as React from "react";
-import { UiStateStorageContext } from "../../uistate/useUiStateStorage.js";
 import "./ToolAssistanceField.scss";
 import { type UiStateStorage } from "../../uistate/UiStateStorage.js";
 /** Properties of [[ToolAssistanceField]] component.
@@ -26,63 +24,12 @@ export interface ToolAssistanceFieldProps extends CommonProps {
     /** When set to `true` will show prompt at cursor only when the content area is hovered. */
     promptAtContent?: boolean;
 }
-interface ToolAssistanceFieldState {
-    instructions: ToolAssistanceInstructions | undefined;
-    toolIconSpec: string;
-    showPromptAtCursor: boolean;
-    includeMouseInstructions: boolean;
-    includeTouchInstructions: boolean;
-    showMouseTouchTabs: boolean;
-    showMouseInstructions: boolean;
-    showTouchInstructions: boolean;
-    mouseTouchTabIndex: number;
-    isPinned: boolean;
-    isOpen: boolean;
+interface Props extends Omit<ToolAssistanceFieldProps, "includePromptAtCursor" | "cursorPromptTimeout" | "fadeOutCursorPrompt" | "defaultPromptAtCursor">, Partial<Pick<ToolAssistanceFieldProps, "includePromptAtCursor" | "cursorPromptTimeout" | "fadeOutCursorPrompt" | "defaultPromptAtCursor">> {
 }
 /** Tool Assistance Field React component.
  * @public
  * @note Tool assistance field will only display 30 characters in the status bar. Any additional text will be hidden. The full text will always be shown in the opened popover.
  */
-export declare class ToolAssistanceField extends React.Component<ToolAssistanceFieldProps, ToolAssistanceFieldState> {
-    /** @internal */
-    static contextType: React.Context<import("@itwin/core-react").UiStateStorage>;
-    /** @internal */
-    context: React.ContextType<typeof UiStateStorageContext>;
-    private static _toolAssistanceKey;
-    private static _showPromptAtCursorKey;
-    private static _mouseTouchTabIndexKey;
-    private _showPromptAtCursorSetting;
-    private _mouseTouchTabIndexSetting;
-    private _indicator;
-    private _cursorPrompt;
-    private _isMounted;
-    private _uiSettingsStorage;
-    static readonly defaultProps: Pick<ToolAssistanceFieldProps, "includePromptAtCursor" | "uiStateStorage" | "cursorPromptTimeout" | "fadeOutCursorPrompt" | "defaultPromptAtCursor">;
-    constructor(p: ToolAssistanceFieldProps);
-    componentDidMount(): Promise<void>;
-    /** @internal */
-    componentDidUpdate(): void;
-    componentWillUnmount(): void;
-    private restoreSettings;
-    private _handleToolAssistanceChangedEvent;
-    private _isBothInstruction;
-    private _isMouseInstruction;
-    private _isTouchInstruction;
-    private _handleToolIconChangedEvent;
-    private _showCursorPrompt;
-    private _sectionHasDisplayableInstructions;
-    private _getDisplayableInstructions;
-    private _handleMouseTouchTab;
-    render(): React.ReactNode;
-    private _onPromptAtCursorChange;
-    private _handlePinButtonClick;
-    private _handleCloseButtonClick;
-    private setIsOpen;
-    /** @internal */
-    static getInstructionImage(instruction: ToolAssistanceInstruction): React.ReactNode;
-    private static getInstructionSvgImage;
-    private static getInstructionKeyboardImage;
-    private static getKeyNode;
-}
+export declare function ToolAssistanceField(props: Props): React.JSX.Element;
 export {};
 //# sourceMappingURL=ToolAssistanceField.d.ts.map

package/lib/appui-react/statusfields/toolassistance/ToolAssistanceField.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ToolAssistanceField.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/statusfields/toolassistance/ToolAssistanceField.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,KAAK,EACV,yBAAyB,EACzB,0BAA0B,EAG3B,MAAM,sBAAsB,CAAC;AAM9B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAKrD,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAI/B,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,4BAA4B,CAAC;AA0BpC,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,iCAAiC,CAAC;AAGzC;;GAEG;AAEH,MAAM,WAAW,wBAAyB,SAAQ,WAAW;IAC3D,gFAAgF;IAChF,qBAAqB,EAAE,OAAO,CAAC;IAC/B,0FAA0F;IAC1F,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B,8CAA8C;IAC9C,mBAAmB,EAAE,OAAO,CAAC;IAC7B,gFAAgF;IAChF,qBAAqB,EAAE,OAAO,CAAC;IAC/B,2FAA2F;IAC3F,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,UAAU,wBAAwB;IAChC,YAAY,EAAE,0BAA0B,GAAG,SAAS,CAAC;IACrD,YAAY,EAAE,MAAM,CAAC;IACrB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,wBAAwB,EAAE,OAAO,CAAC;IAClC,wBAAwB,EAAE,OAAO,CAAC;IAClC,kBAAkB,EAAE,OAAO,CAAC;IAC5B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,KAAK,CAAC,SAAS,CACtD,wBAAwB,EACxB,wBAAwB,CACzB;IACC,gBAAgB;IAChB,OAAuB,WAAW,4DAAyB;IAC3D,gBAAgB;IACD,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,qBAAqB,CAAC,CAAC;IAExE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAoB;IACrD,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAwB;IAC7D,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAwB;IAE7D,OAAO,CAAC,0BAA0B,CAAwB;IAE1D,OAAO,CAAC,0BAA0B,CAAuB;IACzD,OAAO,CAAC,UAAU,CAAwC;IAC1D,OAAO,CAAC,aAAa,CAAe;IACpC,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,kBAAkB,CAAiB;IAE3C,gBAAuB,YAAY,EAAE,IAAI,CACvC,wBAAwB,EACtB,uBAAuB,GACvB,gBAAgB,GAChB,qBAAqB,GACrB,qBAAqB,GACrB,uBAAuB,CAC1B,CAKC;gBAEU,CAAC,EAAE,wBAAwB;IAmCjB,iBAAiB;IAgBvC,gBAAgB;IACA,kBAAkB;IAKlB,oBAAoB;YAWtB,eAAe;IA2B7B,OAAO,CAAC,iCAAiC,CAsDvC;IAEF,OAAO,CAAC,kBAAkB,CAKxB;IAEF,OAAO,CAAC,mBAAmB,CACmC;IAE9D,OAAO,CAAC,mBAAmB,CACmC;IAE9D,OAAO,CAAC,2BAA2B,CAYjC;IAEF,OAAO,CAAC,iBAAiB;IAgBzB,OAAO,CAAC,kCAAkC;IAO1C,OAAO,CAAC,2BAA2B;IAiBnC,OAAO,CAAC,oBAAoB,CAiB1B;IAEc,MAAM,IAAI,KAAK,CAAC,SAAS;IA4KzC,OAAO,CAAC,uBAAuB,CAc7B;IAEF,OAAO,CAAC,qBAAqB,CAE3B;IAEF,OAAO,CAAC,uBAAuB,CAE7B;IAEF,OAAO,CAAC,SAAS;IAUjB,gBAAgB;WACF,mBAAmB,CAC/B,WAAW,EAAE,yBAAyB,GACrC,KAAK,CAAC,SAAS;IAwElB,OAAO,CAAC,MAAM,CAAC,sBAAsB;IA0FrC,OAAO,CAAC,MAAM,CAAC,2BAA2B;IA0D1C,OAAO,CAAC,MAAM,CAAC,UAAU;CAe1B"}
+{"version":3,"file":"ToolAssistanceField.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/statusfields/toolassistance/ToolAssistanceField.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAaH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAIrD,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAK/B,OAAO,4BAA4B,CAAC;AAuBpC,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,iCAAiC,CAAC;AASzC;;GAEG;AAEH,MAAM,WAAW,wBAAyB,SAAQ,WAAW;IAC3D,gFAAgF;IAChF,qBAAqB,EAAE,OAAO,CAAC;IAC/B,0FAA0F;IAC1F,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B,8CAA8C;IAC9C,mBAAmB,EAAE,OAAO,CAAC;IAC7B,gFAAgF;IAChF,qBAAqB,EAAE,OAAO,CAAC;IAC/B,2FAA2F;IAC3F,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,UAAU,KACR,SAAQ,IAAI,CACR,wBAAwB,EACtB,uBAAuB,GACvB,qBAAqB,GACrB,qBAAqB,GACrB,uBAAuB,CAC1B,EACD,OAAO,CACL,IAAI,CACF,wBAAwB,EACtB,uBAAuB,GACvB,qBAAqB,GACrB,qBAAqB,GACrB,uBAAuB,CAC1B,CACF;CAAG;AAeR;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,KAAK,qBAmT/C"}