@itwin/appui-abstract 4.0.0-dev.8 → 4.0.0-dev.80

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (267) hide show
  1. package/CHANGELOG.md +45 -1
  2. package/lib/cjs/appui-abstract/BaseUiItemsProvider.d.ts +30 -30
  3. package/lib/cjs/appui-abstract/BaseUiItemsProvider.d.ts.map +1 -1
  4. package/lib/cjs/appui-abstract/BaseUiItemsProvider.js +79 -79
  5. package/lib/cjs/appui-abstract/UiAdmin.d.ts +221 -221
  6. package/lib/cjs/appui-abstract/UiAdmin.js +224 -224
  7. package/lib/cjs/appui-abstract/UiAdmin.js.map +1 -1
  8. package/lib/cjs/appui-abstract/UiItemsManager.d.ts +113 -113
  9. package/lib/cjs/appui-abstract/UiItemsManager.d.ts.map +1 -1
  10. package/lib/cjs/appui-abstract/UiItemsManager.js +193 -199
  11. package/lib/cjs/appui-abstract/UiItemsManager.js.map +1 -1
  12. package/lib/cjs/appui-abstract/UiItemsProvider.d.ts +29 -29
  13. package/lib/cjs/appui-abstract/UiItemsProvider.js +9 -9
  14. package/lib/cjs/appui-abstract/backstage/BackstageItem.d.ts +91 -91
  15. package/lib/cjs/appui-abstract/backstage/BackstageItem.d.ts.map +1 -1
  16. package/lib/cjs/appui-abstract/backstage/BackstageItem.js +70 -70
  17. package/lib/cjs/appui-abstract/backstage/BackstageItem.js.map +1 -1
  18. package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.d.ts +38 -38
  19. package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.js +133 -133
  20. package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.js.map +1 -1
  21. package/lib/cjs/appui-abstract/common/KeyboardKey.d.ts +51 -51
  22. package/lib/cjs/appui-abstract/common/KeyboardKey.js +63 -63
  23. package/lib/cjs/appui-abstract/content/ContentLayoutProps.d.ts +62 -62
  24. package/lib/cjs/appui-abstract/content/ContentLayoutProps.js +9 -9
  25. package/lib/cjs/appui-abstract/content/StandardContentLayouts.d.ts +19 -19
  26. package/lib/cjs/appui-abstract/content/StandardContentLayouts.js +108 -108
  27. package/lib/cjs/appui-abstract/content/StandardContentLayouts.js.map +1 -1
  28. package/lib/cjs/appui-abstract/dialogs/DialogItem.d.ts +76 -76
  29. package/lib/cjs/appui-abstract/dialogs/DialogItem.js +67 -67
  30. package/lib/cjs/appui-abstract/dialogs/DialogItem.js.map +1 -1
  31. package/lib/cjs/appui-abstract/dialogs/UiDataProvider.d.ts +55 -55
  32. package/lib/cjs/appui-abstract/dialogs/UiDataProvider.js +66 -66
  33. package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.d.ts +97 -97
  34. package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.js +175 -175
  35. package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.js.map +1 -1
  36. package/lib/cjs/appui-abstract/items/AbstractItemProps.d.ts +53 -53
  37. package/lib/cjs/appui-abstract/items/AbstractItemProps.d.ts.map +1 -1
  38. package/lib/cjs/appui-abstract/items/AbstractItemProps.js +9 -9
  39. package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.d.ts +20 -20
  40. package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.js +9 -9
  41. package/lib/cjs/appui-abstract/items/AbstractToolbarProps.d.ts +13 -13
  42. package/lib/cjs/appui-abstract/items/AbstractToolbarProps.js +9 -9
  43. package/lib/cjs/appui-abstract/items/BadgeType.d.ts +14 -14
  44. package/lib/cjs/appui-abstract/items/BadgeType.js +22 -22
  45. package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.d.ts +27 -27
  46. package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.js +60 -60
  47. package/lib/cjs/appui-abstract/items/ConditionalStringValue.d.ts +29 -29
  48. package/lib/cjs/appui-abstract/items/ConditionalStringValue.js +62 -62
  49. package/lib/cjs/appui-abstract/items/ProvidedItem.d.ts +11 -11
  50. package/lib/cjs/appui-abstract/items/ProvidedItem.js +9 -9
  51. package/lib/cjs/appui-abstract/items/RelativePosition.d.ts +18 -18
  52. package/lib/cjs/appui-abstract/items/RelativePosition.js +26 -26
  53. package/lib/cjs/appui-abstract/items/StageUsage.d.ts +16 -16
  54. package/lib/cjs/appui-abstract/items/StageUsage.js +24 -24
  55. package/lib/cjs/appui-abstract/notification/MessagePresenter.d.ts +42 -42
  56. package/lib/cjs/appui-abstract/notification/MessagePresenter.js +24 -24
  57. package/lib/cjs/appui-abstract/notification/MessageSeverity.d.ts +15 -15
  58. package/lib/cjs/appui-abstract/notification/MessageSeverity.js +23 -23
  59. package/lib/cjs/appui-abstract/properties/Description.d.ts +124 -127
  60. package/lib/cjs/appui-abstract/properties/Description.d.ts.map +1 -1
  61. package/lib/cjs/appui-abstract/properties/Description.js +196 -196
  62. package/lib/cjs/appui-abstract/properties/Description.js.map +1 -1
  63. package/lib/cjs/appui-abstract/properties/EditorParams.d.ts +260 -260
  64. package/lib/cjs/appui-abstract/properties/EditorParams.d.ts.map +1 -1
  65. package/lib/cjs/appui-abstract/properties/EditorParams.js +106 -106
  66. package/lib/cjs/appui-abstract/properties/PrimitiveTypes.d.ts +60 -60
  67. package/lib/cjs/appui-abstract/properties/PrimitiveTypes.js +9 -9
  68. package/lib/cjs/appui-abstract/properties/Record.d.ts +57 -57
  69. package/lib/cjs/appui-abstract/properties/Record.js +78 -78
  70. package/lib/cjs/appui-abstract/properties/StandardEditorNames.d.ts +22 -22
  71. package/lib/cjs/appui-abstract/properties/StandardEditorNames.js +30 -30
  72. package/lib/cjs/appui-abstract/properties/StandardTypeNames.d.ts +30 -30
  73. package/lib/cjs/appui-abstract/properties/StandardTypeNames.js +39 -39
  74. package/lib/cjs/appui-abstract/properties/Value.d.ts +49 -49
  75. package/lib/cjs/appui-abstract/properties/Value.d.ts.map +1 -1
  76. package/lib/cjs/appui-abstract/properties/Value.js +20 -20
  77. package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.d.ts +22 -22
  78. package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.js +48 -48
  79. package/lib/cjs/appui-abstract/statusbar/StatusBarItem.d.ts +128 -128
  80. package/lib/cjs/appui-abstract/statusbar/StatusBarItem.d.ts.map +1 -1
  81. package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js +87 -87
  82. package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js.map +1 -1
  83. package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.d.ts +39 -39
  84. package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js +135 -135
  85. package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js.map +1 -1
  86. package/lib/cjs/appui-abstract/toolbars/ToolbarItem.d.ts +121 -121
  87. package/lib/cjs/appui-abstract/toolbars/ToolbarItem.d.ts.map +1 -1
  88. package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js +64 -64
  89. package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js.map +1 -1
  90. package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.d.ts +45 -45
  91. package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.js +235 -235
  92. package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.js.map +1 -1
  93. package/lib/cjs/appui-abstract/utils/IconSpecUtilities.d.ts +29 -29
  94. package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js +51 -51
  95. package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js.map +1 -1
  96. package/lib/cjs/appui-abstract/utils/PointProps.d.ts +10 -10
  97. package/lib/cjs/appui-abstract/utils/PointProps.js +9 -9
  98. package/lib/cjs/appui-abstract/utils/UiError.d.ts +12 -12
  99. package/lib/cjs/appui-abstract/utils/UiError.js +22 -22
  100. package/lib/cjs/appui-abstract/utils/UiEvent.d.ts +9 -9
  101. package/lib/cjs/appui-abstract/utils/UiEvent.js +17 -17
  102. package/lib/cjs/appui-abstract/utils/UiEventDispatcher.d.ts +46 -46
  103. package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js +131 -131
  104. package/lib/cjs/appui-abstract/utils/callbacks.d.ts +20 -20
  105. package/lib/cjs/appui-abstract/utils/callbacks.d.ts.map +1 -1
  106. package/lib/cjs/appui-abstract/utils/callbacks.js +9 -9
  107. package/lib/cjs/appui-abstract/utils/filter/charCode.d.ts +416 -416
  108. package/lib/cjs/appui-abstract/utils/filter/charCode.js +6 -6
  109. package/lib/cjs/appui-abstract/utils/filter/filters.d.ts +98 -98
  110. package/lib/cjs/appui-abstract/utils/filter/filters.d.ts.map +1 -1
  111. package/lib/cjs/appui-abstract/utils/filter/filters.js +709 -709
  112. package/lib/cjs/appui-abstract/utils/filter/filters.js.map +1 -1
  113. package/lib/cjs/appui-abstract/utils/filter/map.d.ts +59 -59
  114. package/lib/cjs/appui-abstract/utils/filter/map.js +402 -404
  115. package/lib/cjs/appui-abstract/utils/filter/map.js.map +1 -1
  116. package/lib/cjs/appui-abstract/utils/filter/strings.d.ts +20 -20
  117. package/lib/cjs/appui-abstract/utils/filter/strings.js +78 -78
  118. package/lib/cjs/appui-abstract/utils/filter/strings.js.map +1 -1
  119. package/lib/cjs/appui-abstract/utils/isLetter.d.ts +9 -9
  120. package/lib/cjs/appui-abstract/utils/isLetter.js +19 -19
  121. package/lib/cjs/appui-abstract/utils/misc.d.ts +11 -11
  122. package/lib/cjs/appui-abstract/utils/misc.js +36 -36
  123. package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.d.ts +86 -86
  124. package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js +9 -9
  125. package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js.map +1 -1
  126. package/lib/cjs/appui-abstract/widget/StagePanel.d.ts +36 -36
  127. package/lib/cjs/appui-abstract/widget/StagePanel.d.ts.map +1 -1
  128. package/lib/cjs/appui-abstract/widget/StagePanel.js +46 -46
  129. package/lib/cjs/appui-abstract/widget/StagePanel.js.map +1 -1
  130. package/lib/cjs/appui-abstract/widget/WidgetState.d.ts +19 -19
  131. package/lib/cjs/appui-abstract/widget/WidgetState.js +27 -27
  132. package/lib/cjs/appui-abstract.d.ts +103 -103
  133. package/lib/cjs/appui-abstract.js +123 -119
  134. package/lib/cjs/appui-abstract.js.map +1 -1
  135. package/lib/esm/appui-abstract/BaseUiItemsProvider.d.ts +30 -30
  136. package/lib/esm/appui-abstract/BaseUiItemsProvider.d.ts.map +1 -1
  137. package/lib/esm/appui-abstract/BaseUiItemsProvider.js +75 -75
  138. package/lib/esm/appui-abstract/UiAdmin.d.ts +221 -221
  139. package/lib/esm/appui-abstract/UiAdmin.js +220 -219
  140. package/lib/esm/appui-abstract/UiAdmin.js.map +1 -1
  141. package/lib/esm/appui-abstract/UiItemsManager.d.ts +113 -113
  142. package/lib/esm/appui-abstract/UiItemsManager.d.ts.map +1 -1
  143. package/lib/esm/appui-abstract/UiItemsManager.js +190 -195
  144. package/lib/esm/appui-abstract/UiItemsManager.js.map +1 -1
  145. package/lib/esm/appui-abstract/UiItemsProvider.d.ts +29 -29
  146. package/lib/esm/appui-abstract/UiItemsProvider.js +8 -8
  147. package/lib/esm/appui-abstract/backstage/BackstageItem.d.ts +91 -91
  148. package/lib/esm/appui-abstract/backstage/BackstageItem.d.ts.map +1 -1
  149. package/lib/esm/appui-abstract/backstage/BackstageItem.js +65 -64
  150. package/lib/esm/appui-abstract/backstage/BackstageItem.js.map +1 -1
  151. package/lib/esm/appui-abstract/backstage/BackstageItemsManager.d.ts +38 -38
  152. package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js +129 -129
  153. package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js.map +1 -1
  154. package/lib/esm/appui-abstract/common/KeyboardKey.d.ts +51 -51
  155. package/lib/esm/appui-abstract/common/KeyboardKey.js +59 -59
  156. package/lib/esm/appui-abstract/content/ContentLayoutProps.d.ts +62 -62
  157. package/lib/esm/appui-abstract/content/ContentLayoutProps.js +8 -8
  158. package/lib/esm/appui-abstract/content/StandardContentLayouts.d.ts +19 -19
  159. package/lib/esm/appui-abstract/content/StandardContentLayouts.js +105 -104
  160. package/lib/esm/appui-abstract/content/StandardContentLayouts.js.map +1 -1
  161. package/lib/esm/appui-abstract/dialogs/DialogItem.d.ts +76 -76
  162. package/lib/esm/appui-abstract/dialogs/DialogItem.js +63 -63
  163. package/lib/esm/appui-abstract/dialogs/DialogItem.js.map +1 -1
  164. package/lib/esm/appui-abstract/dialogs/UiDataProvider.d.ts +55 -55
  165. package/lib/esm/appui-abstract/dialogs/UiDataProvider.js +61 -61
  166. package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.d.ts +97 -97
  167. package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js +171 -170
  168. package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js.map +1 -1
  169. package/lib/esm/appui-abstract/items/AbstractItemProps.d.ts +53 -53
  170. package/lib/esm/appui-abstract/items/AbstractItemProps.d.ts.map +1 -1
  171. package/lib/esm/appui-abstract/items/AbstractItemProps.js +8 -8
  172. package/lib/esm/appui-abstract/items/AbstractMenuItemProps.d.ts +20 -20
  173. package/lib/esm/appui-abstract/items/AbstractMenuItemProps.js +8 -8
  174. package/lib/esm/appui-abstract/items/AbstractToolbarProps.d.ts +13 -13
  175. package/lib/esm/appui-abstract/items/AbstractToolbarProps.js +8 -8
  176. package/lib/esm/appui-abstract/items/BadgeType.d.ts +14 -14
  177. package/lib/esm/appui-abstract/items/BadgeType.js +19 -19
  178. package/lib/esm/appui-abstract/items/ConditionalBooleanValue.d.ts +27 -27
  179. package/lib/esm/appui-abstract/items/ConditionalBooleanValue.js +56 -56
  180. package/lib/esm/appui-abstract/items/ConditionalStringValue.d.ts +29 -29
  181. package/lib/esm/appui-abstract/items/ConditionalStringValue.js +58 -58
  182. package/lib/esm/appui-abstract/items/ProvidedItem.d.ts +11 -11
  183. package/lib/esm/appui-abstract/items/ProvidedItem.js +8 -8
  184. package/lib/esm/appui-abstract/items/RelativePosition.d.ts +18 -18
  185. package/lib/esm/appui-abstract/items/RelativePosition.js +23 -23
  186. package/lib/esm/appui-abstract/items/StageUsage.d.ts +16 -16
  187. package/lib/esm/appui-abstract/items/StageUsage.js +21 -21
  188. package/lib/esm/appui-abstract/notification/MessagePresenter.d.ts +42 -42
  189. package/lib/esm/appui-abstract/notification/MessagePresenter.js +21 -21
  190. package/lib/esm/appui-abstract/notification/MessageSeverity.d.ts +15 -15
  191. package/lib/esm/appui-abstract/notification/MessageSeverity.js +20 -20
  192. package/lib/esm/appui-abstract/properties/Description.d.ts +124 -127
  193. package/lib/esm/appui-abstract/properties/Description.d.ts.map +1 -1
  194. package/lib/esm/appui-abstract/properties/Description.js +192 -192
  195. package/lib/esm/appui-abstract/properties/Description.js.map +1 -1
  196. package/lib/esm/appui-abstract/properties/EditorParams.d.ts +260 -260
  197. package/lib/esm/appui-abstract/properties/EditorParams.d.ts.map +1 -1
  198. package/lib/esm/appui-abstract/properties/EditorParams.js +97 -97
  199. package/lib/esm/appui-abstract/properties/PrimitiveTypes.d.ts +60 -60
  200. package/lib/esm/appui-abstract/properties/PrimitiveTypes.js +8 -8
  201. package/lib/esm/appui-abstract/properties/Record.d.ts +57 -57
  202. package/lib/esm/appui-abstract/properties/Record.js +74 -74
  203. package/lib/esm/appui-abstract/properties/StandardEditorNames.d.ts +22 -22
  204. package/lib/esm/appui-abstract/properties/StandardEditorNames.js +27 -27
  205. package/lib/esm/appui-abstract/properties/StandardTypeNames.d.ts +30 -30
  206. package/lib/esm/appui-abstract/properties/StandardTypeNames.js +36 -36
  207. package/lib/esm/appui-abstract/properties/Value.d.ts +49 -49
  208. package/lib/esm/appui-abstract/properties/Value.d.ts.map +1 -1
  209. package/lib/esm/appui-abstract/properties/Value.js +17 -17
  210. package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.d.ts +22 -22
  211. package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.js +44 -44
  212. package/lib/esm/appui-abstract/statusbar/StatusBarItem.d.ts +128 -128
  213. package/lib/esm/appui-abstract/statusbar/StatusBarItem.d.ts.map +1 -1
  214. package/lib/esm/appui-abstract/statusbar/StatusBarItem.js +81 -80
  215. package/lib/esm/appui-abstract/statusbar/StatusBarItem.js.map +1 -1
  216. package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.d.ts +39 -39
  217. package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.js +131 -131
  218. package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.js.map +1 -1
  219. package/lib/esm/appui-abstract/toolbars/ToolbarItem.d.ts +121 -121
  220. package/lib/esm/appui-abstract/toolbars/ToolbarItem.d.ts.map +1 -1
  221. package/lib/esm/appui-abstract/toolbars/ToolbarItem.js +61 -60
  222. package/lib/esm/appui-abstract/toolbars/ToolbarItem.js.map +1 -1
  223. package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.d.ts +45 -45
  224. package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.js +231 -231
  225. package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.js.map +1 -1
  226. package/lib/esm/appui-abstract/utils/IconSpecUtilities.d.ts +29 -29
  227. package/lib/esm/appui-abstract/utils/IconSpecUtilities.js +48 -47
  228. package/lib/esm/appui-abstract/utils/IconSpecUtilities.js.map +1 -1
  229. package/lib/esm/appui-abstract/utils/PointProps.d.ts +10 -10
  230. package/lib/esm/appui-abstract/utils/PointProps.js +8 -8
  231. package/lib/esm/appui-abstract/utils/UiError.d.ts +12 -12
  232. package/lib/esm/appui-abstract/utils/UiError.js +18 -18
  233. package/lib/esm/appui-abstract/utils/UiEvent.d.ts +9 -9
  234. package/lib/esm/appui-abstract/utils/UiEvent.js +13 -13
  235. package/lib/esm/appui-abstract/utils/UiEventDispatcher.d.ts +46 -46
  236. package/lib/esm/appui-abstract/utils/UiEventDispatcher.js +126 -126
  237. package/lib/esm/appui-abstract/utils/callbacks.d.ts +20 -20
  238. package/lib/esm/appui-abstract/utils/callbacks.d.ts.map +1 -1
  239. package/lib/esm/appui-abstract/utils/callbacks.js +8 -8
  240. package/lib/esm/appui-abstract/utils/filter/charCode.d.ts +416 -416
  241. package/lib/esm/appui-abstract/utils/filter/charCode.js +5 -5
  242. package/lib/esm/appui-abstract/utils/filter/filters.d.ts +98 -98
  243. package/lib/esm/appui-abstract/utils/filter/filters.d.ts.map +1 -1
  244. package/lib/esm/appui-abstract/utils/filter/filters.js +694 -694
  245. package/lib/esm/appui-abstract/utils/filter/filters.js.map +1 -1
  246. package/lib/esm/appui-abstract/utils/filter/map.d.ts +59 -59
  247. package/lib/esm/appui-abstract/utils/filter/map.js +397 -399
  248. package/lib/esm/appui-abstract/utils/filter/map.js.map +1 -1
  249. package/lib/esm/appui-abstract/utils/filter/strings.d.ts +20 -20
  250. package/lib/esm/appui-abstract/utils/filter/strings.js +70 -70
  251. package/lib/esm/appui-abstract/utils/filter/strings.js.map +1 -1
  252. package/lib/esm/appui-abstract/utils/isLetter.d.ts +9 -9
  253. package/lib/esm/appui-abstract/utils/isLetter.js +15 -15
  254. package/lib/esm/appui-abstract/utils/misc.d.ts +11 -11
  255. package/lib/esm/appui-abstract/utils/misc.js +31 -31
  256. package/lib/esm/appui-abstract/widget/AbstractWidgetProps.d.ts +86 -86
  257. package/lib/esm/appui-abstract/widget/AbstractWidgetProps.js +8 -8
  258. package/lib/esm/appui-abstract/widget/AbstractWidgetProps.js.map +1 -1
  259. package/lib/esm/appui-abstract/widget/StagePanel.d.ts +36 -36
  260. package/lib/esm/appui-abstract/widget/StagePanel.d.ts.map +1 -1
  261. package/lib/esm/appui-abstract/widget/StagePanel.js +43 -43
  262. package/lib/esm/appui-abstract/widget/StagePanel.js.map +1 -1
  263. package/lib/esm/appui-abstract/widget/WidgetState.d.ts +19 -19
  264. package/lib/esm/appui-abstract/widget/WidgetState.js +24 -24
  265. package/lib/esm/appui-abstract.d.ts +103 -103
  266. package/lib/esm/appui-abstract.js +107 -107
  267. package/package.json +11 -11
@@ -1,92 +1,92 @@
1
- /** @packageDocumentation
2
- * @module Backstage
3
- */
4
- import { BadgeType } from "../items/BadgeType";
5
- import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
6
- import { ConditionalStringValue } from "../items/ConditionalStringValue";
7
- import { ProvidedItem } from "../items/ProvidedItem";
8
- /** Used to specify the item type added to the backstage menu.
9
- * @deprecated in 3.6. Use type guards instead.
10
- * @public
11
- */
12
- export declare enum BackstageItemType {
13
- /** Item that executes an action function */
14
- ActionItem = 1,
15
- /** Item that activate a stage. */
16
- StageLauncher = 2
17
- }
18
- /** Describes the data needed to insert a button into the backstage menu.
19
- * @deprecated in 3.6. Use [CommonBackstageItem]($appui-react) instead.
20
- * @public
21
- */
22
- export interface CommonBackstageItem extends ProvidedItem {
23
- /** can be used by application to store miscellaneous data. */
24
- applicationData?: any;
25
- /** Describes badge. Renders no badge if not specified. */
26
- readonly badgeType?: BadgeType;
27
- /** Specifies the item's grouping value. Items are sorted by group and then item priority. When
28
- * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This
29
- * allows extensions enough gaps to insert their own groups.
30
- */
31
- readonly groupPriority: number;
32
- /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
33
- readonly icon?: string | ConditionalStringValue;
34
- /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */
35
- readonly id: string;
36
- /** optional data to be used by item implementor. */
37
- readonly internalData?: Map<string, any>;
38
- /** Describes if the item is visible or hidden. The default is for the item to be visible. */
39
- readonly isHidden?: boolean | ConditionalBooleanValue;
40
- /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */
41
- readonly isDisabled?: boolean | ConditionalBooleanValue;
42
- /** Priority within a group (recommend using values 1 through 100). */
43
- readonly itemPriority: number;
44
- /** Label. */
45
- readonly label: string | ConditionalStringValue;
46
- /** Subtitle. */
47
- readonly subtitle?: string | ConditionalStringValue;
48
- /** Tooltip. */
49
- readonly tooltip?: string | ConditionalStringValue;
50
- /** Describes if the item is active. The default is for the item to be active if stageId matches activeFrontstageId */
51
- readonly isActive?: boolean | ConditionalBooleanValue;
52
- }
53
- /** Describes the data needed to insert an action button into the backstage menu.
54
- * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.
55
- * @public
56
- */
57
- export interface BackstageActionItem extends CommonBackstageItem {
58
- readonly execute: () => void;
59
- }
60
- /** Describes the data needed to insert an action button into the backstage menu.
61
- * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.
62
- * @public
63
- */
64
- export interface BackstageStageLauncher extends CommonBackstageItem {
65
- readonly stageId: string;
66
- }
67
- /** Describes the data needed to insert a button into the backstage menu.
68
- * @deprecated in 3.6. Use [BackstageItem]($appui-react) instead.
69
- * @public
70
- */
71
- export declare type BackstageItem = BackstageActionItem | BackstageStageLauncher;
72
- /** BackstageActionItem type guard.
73
- * @deprecated in 3.6. Use [isBackstageActionItem]($appui-react) instead.
74
- * @public
75
- */
76
- export declare const isActionItem: (item: BackstageItem) => item is BackstageActionItem;
77
- /** BackstageStageLauncher type guard.
78
- * @deprecated in 3.6. Use [isBackstageStageLauncher]($appui-react) instead.
79
- * @public
80
- */
81
- export declare const isStageLauncher: (item: BackstageItem) => item is BackstageStageLauncher;
82
- /** Utilities for creating and maintaining backstage items
83
- * @deprecated in 3.6. Use [BackstageItemUtilities]($appui-react) instead.
84
- * @public
85
- */
86
- export declare class BackstageItemUtilities {
87
- /** Creates a stage launcher backstage item */
88
- static createStageLauncher: (frontstageId: string, groupPriority: number, itemPriority: number, label: string | ConditionalStringValue, subtitle?: string | ConditionalStringValue | undefined, icon?: string | ConditionalStringValue | undefined, overrides?: Partial<BackstageStageLauncher> | undefined) => BackstageStageLauncher;
89
- /** Creates an action backstage item */
90
- static createActionItem: (itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string | ConditionalStringValue, subtitle?: string | ConditionalStringValue | undefined, icon?: string | ConditionalStringValue | undefined, overrides?: Partial<BackstageActionItem> | undefined) => BackstageActionItem;
91
- }
1
+ /** @packageDocumentation
2
+ * @module Backstage
3
+ */
4
+ import { BadgeType } from "../items/BadgeType";
5
+ import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
6
+ import { ConditionalStringValue } from "../items/ConditionalStringValue";
7
+ import { ProvidedItem } from "../items/ProvidedItem";
8
+ /** Used to specify the item type added to the backstage menu.
9
+ * @deprecated in 3.6. Use type guards instead.
10
+ * @public
11
+ */
12
+ export declare enum BackstageItemType {
13
+ /** Item that executes an action function */
14
+ ActionItem = 1,
15
+ /** Item that activate a stage. */
16
+ StageLauncher = 2
17
+ }
18
+ /** Describes the data needed to insert a button into the backstage menu.
19
+ * @deprecated in 3.6. Use [CommonBackstageItem]($appui-react) instead.
20
+ * @public
21
+ */
22
+ export interface CommonBackstageItem extends ProvidedItem {
23
+ /** can be used by application to store miscellaneous data. */
24
+ applicationData?: any;
25
+ /** Describes badge. Renders no badge if not specified. */
26
+ readonly badgeType?: BadgeType;
27
+ /** Specifies the item's grouping value. Items are sorted by group and then item priority. When
28
+ * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This
29
+ * allows extensions enough gaps to insert their own groups.
30
+ */
31
+ readonly groupPriority: number;
32
+ /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
33
+ readonly icon?: string | ConditionalStringValue;
34
+ /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */
35
+ readonly id: string;
36
+ /** optional data to be used by item implementor. */
37
+ readonly internalData?: Map<string, any>;
38
+ /** Describes if the item is visible or hidden. The default is for the item to be visible. */
39
+ readonly isHidden?: boolean | ConditionalBooleanValue;
40
+ /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */
41
+ readonly isDisabled?: boolean | ConditionalBooleanValue;
42
+ /** Priority within a group (recommend using values 1 through 100). */
43
+ readonly itemPriority: number;
44
+ /** Label. */
45
+ readonly label: string | ConditionalStringValue;
46
+ /** Subtitle. */
47
+ readonly subtitle?: string | ConditionalStringValue;
48
+ /** Tooltip. */
49
+ readonly tooltip?: string | ConditionalStringValue;
50
+ /** Describes if the item is active. The default is for the item to be active if stageId matches activeFrontstageId */
51
+ readonly isActive?: boolean | ConditionalBooleanValue;
52
+ }
53
+ /** Describes the data needed to insert an action button into the backstage menu.
54
+ * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.
55
+ * @public
56
+ */
57
+ export interface BackstageActionItem extends CommonBackstageItem {
58
+ readonly execute: () => void;
59
+ }
60
+ /** Describes the data needed to insert an action button into the backstage menu.
61
+ * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.
62
+ * @public
63
+ */
64
+ export interface BackstageStageLauncher extends CommonBackstageItem {
65
+ readonly stageId: string;
66
+ }
67
+ /** Describes the data needed to insert a button into the backstage menu.
68
+ * @deprecated in 3.6. Use [BackstageItem]($appui-react) instead.
69
+ * @public
70
+ */
71
+ export type BackstageItem = BackstageActionItem | BackstageStageLauncher;
72
+ /** BackstageActionItem type guard.
73
+ * @deprecated in 3.6. Use [isBackstageActionItem]($appui-react) instead.
74
+ * @public
75
+ */
76
+ export declare const isActionItem: (item: BackstageItem) => item is BackstageActionItem;
77
+ /** BackstageStageLauncher type guard.
78
+ * @deprecated in 3.6. Use [isBackstageStageLauncher]($appui-react) instead.
79
+ * @public
80
+ */
81
+ export declare const isStageLauncher: (item: BackstageItem) => item is BackstageStageLauncher;
82
+ /** Utilities for creating and maintaining backstage items
83
+ * @deprecated in 3.6. Use [BackstageItemUtilities]($appui-react) instead.
84
+ * @public
85
+ */
86
+ export declare class BackstageItemUtilities {
87
+ /** Creates a stage launcher backstage item */
88
+ static createStageLauncher: (frontstageId: string, groupPriority: number, itemPriority: number, label: string | ConditionalStringValue, subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageStageLauncher>) => BackstageStageLauncher;
89
+ /** Creates an action backstage item */
90
+ static createActionItem: (itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string | ConditionalStringValue, subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageActionItem>) => BackstageActionItem;
91
+ }
92
92
  //# sourceMappingURL=BackstageItem.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"BackstageItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,UAAU,IAAI;IACd,kCAAkC;IAClC,aAAa,IAAI;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,8DAA8D;IAC9D,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,qHAAqH;IACrH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,kIAAkI;IAClI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,6FAA6F;IAC7F,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACtD,+FAA+F;IAC/F,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACxD,sEAAsE;IACtE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,aAAa;IACb,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,gBAAgB;IAChB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACpD,eAAe;IACf,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACnD,sHAAsH;IACtH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,oBAAY,aAAa,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;AAEzE;;;GAGG;AACH,eAAO,MAAM,YAAY,SAAU,aAAa,gCAE/C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,SAAU,aAAa,mCAElD,CAAC;AAEF;;;GAGG;AACH,qBAAa,sBAAsB;IACjC,8CAA8C;IAC9C,OAAc,mBAAmB,iBACjB,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,SAAS,MAAM,GAAG,sBAAsB,0KAExG,sBAAsB,CAUtB;IAEH,uCAAuC;IACvC,OAAc,gBAAgB,WACpB,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,WAAW,MAAM,IAAI,SAAS,MAAM,GAAG,sBAAsB,uKAEvH,mBAAmB,CAUnB;CACJ"}
1
+ {"version":3,"file":"BackstageItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,UAAU,IAAI;IACd,kCAAkC;IAClC,aAAa,IAAI;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,8DAA8D;IAC9D,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,qHAAqH;IACrH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,kIAAkI;IAClI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,6FAA6F;IAC7F,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACtD,+FAA+F;IAC/F,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACxD,sEAAsE;IACtE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,aAAa;IACb,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,gBAAgB;IAChB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACpD,eAAe;IACf,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACnD,sHAAsH;IACtH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;AAEzE;;;GAGG;AACH,eAAO,MAAM,YAAY,SAAU,aAAa,gCAE/C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,SAAU,aAAa,mCAElD,CAAC;AAEF;;;GAGG;AACH,qBAAa,sBAAsB;IACjC,8CAA8C;IAC9C,OAAc,mBAAmB,iBACjB,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,SAAS,MAAM,GAAG,sBAAsB,aAC9F,MAAM,GAAG,sBAAsB,SAAS,MAAM,GAAG,sBAAsB,cAAc,QAAQ,sBAAsB,CAAC,KAC9H,sBAAsB,CAUtB;IAEH,uCAAuC;IACvC,OAAc,gBAAgB,WACpB,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,WAAW,MAAM,IAAI,SAAS,MAAM,GAAG,sBAAsB,aAC7G,MAAM,GAAG,sBAAsB,SAAS,MAAM,GAAG,sBAAsB,cAAc,QAAQ,mBAAmB,CAAC,KAC3H,mBAAmB,CAUnB;CACJ"}
@@ -1,65 +1,66 @@
1
- /*---------------------------------------------------------------------------------------------
2
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
- * See LICENSE.md in the project root for license terms and full copyright notice.
4
- *--------------------------------------------------------------------------------------------*/
5
- /** @packageDocumentation
6
- * @module Backstage
7
- */
8
- /** Used to specify the item type added to the backstage menu.
9
- * @deprecated in 3.6. Use type guards instead.
10
- * @public
11
- */
12
- export var BackstageItemType;
13
- (function (BackstageItemType) {
14
- /** Item that executes an action function */
15
- BackstageItemType[BackstageItemType["ActionItem"] = 1] = "ActionItem";
16
- /** Item that activate a stage. */
17
- BackstageItemType[BackstageItemType["StageLauncher"] = 2] = "StageLauncher";
18
- })(BackstageItemType || (BackstageItemType = {}));
19
- /** BackstageActionItem type guard.
20
- * @deprecated in 3.6. Use [isBackstageActionItem]($appui-react) instead.
21
- * @public
22
- */
23
- export const isActionItem = (item) => {
24
- return item.execute !== undefined; // eslint-disable-line deprecation/deprecation
25
- };
26
- /** BackstageStageLauncher type guard.
27
- * @deprecated in 3.6. Use [isBackstageStageLauncher]($appui-react) instead.
28
- * @public
29
- */
30
- export const isStageLauncher = (item) => {
31
- return item.stageId !== undefined; // eslint-disable-line deprecation/deprecation
32
- };
33
- /** Utilities for creating and maintaining backstage items
34
- * @deprecated in 3.6. Use [BackstageItemUtilities]($appui-react) instead.
35
- * @public
36
- */
37
- export class BackstageItemUtilities {
38
- }
39
- /** Creates a stage launcher backstage item */
40
- BackstageItemUtilities.createStageLauncher = (frontstageId, groupPriority, itemPriority, label, subtitle, icon, overrides // eslint-disable-line deprecation/deprecation
41
- ) => ({
42
- groupPriority,
43
- icon,
44
- internalData: overrides === null || overrides === void 0 ? void 0 : overrides.internalData,
45
- id: frontstageId,
46
- itemPriority,
47
- label,
48
- stageId: frontstageId,
49
- subtitle,
50
- ...overrides,
51
- });
52
- /** Creates an action backstage item */
53
- BackstageItemUtilities.createActionItem = (itemId, groupPriority, itemPriority, execute, label, subtitle, icon, overrides // eslint-disable-line deprecation/deprecation
54
- ) => ({
55
- execute,
56
- groupPriority,
57
- icon,
58
- internalData: overrides === null || overrides === void 0 ? void 0 : overrides.internalData,
59
- id: itemId,
60
- itemPriority,
61
- label,
62
- subtitle,
63
- ...overrides,
64
- });
1
+ /*---------------------------------------------------------------------------------------------
2
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
+ * See LICENSE.md in the project root for license terms and full copyright notice.
4
+ *--------------------------------------------------------------------------------------------*/
5
+ /** @packageDocumentation
6
+ * @module Backstage
7
+ */
8
+ /** Used to specify the item type added to the backstage menu.
9
+ * @deprecated in 3.6. Use type guards instead.
10
+ * @public
11
+ */
12
+ export var BackstageItemType;
13
+ (function (BackstageItemType) {
14
+ /** Item that executes an action function */
15
+ BackstageItemType[BackstageItemType["ActionItem"] = 1] = "ActionItem";
16
+ /** Item that activate a stage. */
17
+ BackstageItemType[BackstageItemType["StageLauncher"] = 2] = "StageLauncher";
18
+ })(BackstageItemType || (BackstageItemType = {}));
19
+ /** BackstageActionItem type guard.
20
+ * @deprecated in 3.6. Use [isBackstageActionItem]($appui-react) instead.
21
+ * @public
22
+ */
23
+ export const isActionItem = (item) => {
24
+ return item.execute !== undefined; // eslint-disable-line deprecation/deprecation
25
+ };
26
+ /** BackstageStageLauncher type guard.
27
+ * @deprecated in 3.6. Use [isBackstageStageLauncher]($appui-react) instead.
28
+ * @public
29
+ */
30
+ export const isStageLauncher = (item) => {
31
+ return item.stageId !== undefined; // eslint-disable-line deprecation/deprecation
32
+ };
33
+ /** Utilities for creating and maintaining backstage items
34
+ * @deprecated in 3.6. Use [BackstageItemUtilities]($appui-react) instead.
35
+ * @public
36
+ */
37
+ class BackstageItemUtilities {
38
+ }
39
+ /** Creates a stage launcher backstage item */
40
+ BackstageItemUtilities.createStageLauncher = (frontstageId, groupPriority, itemPriority, label, subtitle, icon, overrides // eslint-disable-line deprecation/deprecation
41
+ ) => ({
42
+ groupPriority,
43
+ icon,
44
+ internalData: overrides?.internalData,
45
+ id: frontstageId,
46
+ itemPriority,
47
+ label,
48
+ stageId: frontstageId,
49
+ subtitle,
50
+ ...overrides,
51
+ });
52
+ /** Creates an action backstage item */
53
+ BackstageItemUtilities.createActionItem = (itemId, groupPriority, itemPriority, execute, label, subtitle, icon, overrides // eslint-disable-line deprecation/deprecation
54
+ ) => ({
55
+ execute,
56
+ groupPriority,
57
+ icon,
58
+ internalData: overrides?.internalData,
59
+ id: itemId,
60
+ itemPriority,
61
+ label,
62
+ subtitle,
63
+ ...overrides,
64
+ });
65
+ export { BackstageItemUtilities };
65
66
  //# sourceMappingURL=BackstageItem.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"BackstageItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,qEAAc,CAAA;IACd,kCAAkC;IAClC,2EAAiB,CAAA;AACnB,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AA4DD;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAmB,EAA+B,EAAE;IAC/E,OAAQ,IAA4B,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAC5G,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAmB,EAAkC,EAAE;IACrF,OAAQ,IAA+B,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAC/G,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,sBAAsB;;AACjC,8CAA8C;AAChC,0CAAmB,GAAG,CAClC,YAAoB,EAAE,aAAqB,EAAE,YAAoB,EAAE,KAAsC,EACzG,QAA0C,EAAE,IAAsC,EAAE,SAA2C,CAAC,8CAA8C;EACtJ,EAAE,CAAC,CAAC;IAC5B,aAAa;IACb,IAAI;IACJ,YAAY,EAAE,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,YAAY;IACrC,EAAE,EAAE,YAAY;IAChB,YAAY;IACZ,KAAK;IACL,OAAO,EAAE,YAAY;IACrB,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,uCAAuC;AACzB,uCAAgB,GAAG,CAC/B,MAAc,EAAE,aAAqB,EAAE,YAAoB,EAAE,OAAmB,EAAE,KAAsC,EACxH,QAA0C,EAAE,IAAsC,EAAE,SAAwC,CAAC,8CAA8C;EACtJ,EAAE,CAAC,CAAC;IACzB,OAAO;IACP,aAAa;IACb,IAAI;IACJ,YAAY,EAAE,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,YAAY;IACrC,EAAE,EAAE,MAAM;IACV,YAAY;IACZ,KAAK;IACL,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Backstage\r\n */\r\n\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\n\r\n/** Used to specify the item type added to the backstage menu.\r\n * @deprecated in 3.6. Use type guards instead.\r\n * @public\r\n */\r\nexport enum BackstageItemType {\r\n /** Item that executes an action function */\r\n ActionItem = 1,\r\n /** Item that activate a stage. */\r\n StageLauncher = 2,\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @deprecated in 3.6. Use [CommonBackstageItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface CommonBackstageItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\r\n /** can be used by application to store miscellaneous data. */\r\n applicationData?: any;\r\n /** Describes badge. Renders no badge if not specified. */\r\n readonly badgeType?: BadgeType;\r\n /** Specifies the item's grouping value. Items are sorted by group and then item priority. When\r\n * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\r\n * allows extensions enough gaps to insert their own groups.\r\n */\r\n readonly groupPriority: number;\r\n /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\r\n readonly icon?: string | ConditionalStringValue;\r\n /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\r\n readonly id: string;\r\n /** optional data to be used by item implementor. */\r\n readonly internalData?: Map<string, any>;\r\n /** Describes if the item is visible or hidden. The default is for the item to be visible. */\r\n readonly isHidden?: boolean | ConditionalBooleanValue;\r\n /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\r\n readonly isDisabled?: boolean | ConditionalBooleanValue;\r\n /** Priority within a group (recommend using values 1 through 100). */\r\n readonly itemPriority: number;\r\n /** Label. */\r\n readonly label: string | ConditionalStringValue;\r\n /** Subtitle. */\r\n readonly subtitle?: string | ConditionalStringValue;\r\n /** Tooltip. */\r\n readonly tooltip?: string | ConditionalStringValue;\r\n /** Describes if the item is active. The default is for the item to be active if stageId matches activeFrontstageId */\r\n readonly isActive?: boolean | ConditionalBooleanValue;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface BackstageActionItem extends CommonBackstageItem { // eslint-disable-line deprecation/deprecation\r\n readonly execute: () => void;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface BackstageStageLauncher extends CommonBackstageItem { // eslint-disable-line deprecation/deprecation\r\n readonly stageId: string;\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @deprecated in 3.6. Use [BackstageItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport type BackstageItem = BackstageActionItem | BackstageStageLauncher; // eslint-disable-line deprecation/deprecation\r\n\r\n/** BackstageActionItem type guard.\r\n * @deprecated in 3.6. Use [isBackstageActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isActionItem = (item: BackstageItem): item is BackstageActionItem => { // eslint-disable-line deprecation/deprecation\r\n return (item as BackstageActionItem).execute !== undefined; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** BackstageStageLauncher type guard.\r\n * @deprecated in 3.6. Use [isBackstageStageLauncher]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isStageLauncher = (item: BackstageItem): item is BackstageStageLauncher => { // eslint-disable-line deprecation/deprecation\r\n return (item as BackstageStageLauncher).stageId !== undefined; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** Utilities for creating and maintaining backstage items\r\n * @deprecated in 3.6. Use [BackstageItemUtilities]($appui-react) instead.\r\n * @public\r\n */\r\nexport class BackstageItemUtilities {\r\n /** Creates a stage launcher backstage item */\r\n public static createStageLauncher = (\r\n frontstageId: string, groupPriority: number, itemPriority: number, label: string | ConditionalStringValue,\r\n subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageStageLauncher> // eslint-disable-line deprecation/deprecation\r\n ): BackstageStageLauncher => ({ // eslint-disable-line deprecation/deprecation\r\n groupPriority,\r\n icon,\r\n internalData: overrides?.internalData,\r\n id: frontstageId,\r\n itemPriority,\r\n label,\r\n stageId: frontstageId,\r\n subtitle,\r\n ...overrides,\r\n });\r\n\r\n /** Creates an action backstage item */\r\n public static createActionItem = (\r\n itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string | ConditionalStringValue,\r\n subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageActionItem> // eslint-disable-line deprecation/deprecation\r\n ): BackstageActionItem => ({ // eslint-disable-line deprecation/deprecation\r\n execute,\r\n groupPriority,\r\n icon,\r\n internalData: overrides?.internalData,\r\n id: itemId,\r\n itemPriority,\r\n label,\r\n subtitle,\r\n ...overrides,\r\n });\r\n}\r\n"]}
1
+ {"version":3,"file":"BackstageItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,qEAAc,CAAA;IACd,kCAAkC;IAClC,2EAAiB,CAAA;AACnB,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AA4DD;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAmB,EAA+B,EAAE;IAC/E,OAAQ,IAA4B,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAC5G,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAmB,EAAkC,EAAE;IACrF,OAAQ,IAA+B,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAC/G,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAa,sBAAsB;;AACjC,8CAA8C;AAChC,0CAAmB,GAAG,CAClC,YAAoB,EAAE,aAAqB,EAAE,YAAoB,EAAE,KAAsC,EACzG,QAA0C,EAAE,IAAsC,EAAE,SAA2C,CAAC,8CAA8C;EACtJ,EAAE,CAAC,CAAC;IAC5B,aAAa;IACb,IAAI;IACJ,YAAY,EAAE,SAAS,EAAE,YAAY;IACrC,EAAE,EAAE,YAAY;IAChB,YAAY;IACZ,KAAK;IACL,OAAO,EAAE,YAAY;IACrB,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,uCAAuC;AACzB,uCAAgB,GAAG,CAC/B,MAAc,EAAE,aAAqB,EAAE,YAAoB,EAAE,OAAmB,EAAE,KAAsC,EACxH,QAA0C,EAAE,IAAsC,EAAE,SAAwC,CAAC,8CAA8C;EACtJ,EAAE,CAAC,CAAC;IACzB,OAAO;IACP,aAAa;IACb,IAAI;IACJ,YAAY,EAAE,SAAS,EAAE,YAAY;IACrC,EAAE,EAAE,MAAM;IACV,YAAY;IACZ,KAAK;IACL,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;SA/BQ,sBAAsB","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 Backstage\r\n */\r\n\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\n\r\n/** Used to specify the item type added to the backstage menu.\r\n * @deprecated in 3.6. Use type guards instead.\r\n * @public\r\n */\r\nexport enum BackstageItemType {\r\n /** Item that executes an action function */\r\n ActionItem = 1,\r\n /** Item that activate a stage. */\r\n StageLauncher = 2,\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @deprecated in 3.6. Use [CommonBackstageItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface CommonBackstageItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\r\n /** can be used by application to store miscellaneous data. */\r\n applicationData?: any;\r\n /** Describes badge. Renders no badge if not specified. */\r\n readonly badgeType?: BadgeType;\r\n /** Specifies the item's grouping value. Items are sorted by group and then item priority. When\r\n * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\r\n * allows extensions enough gaps to insert their own groups.\r\n */\r\n readonly groupPriority: number;\r\n /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\r\n readonly icon?: string | ConditionalStringValue;\r\n /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\r\n readonly id: string;\r\n /** optional data to be used by item implementor. */\r\n readonly internalData?: Map<string, any>;\r\n /** Describes if the item is visible or hidden. The default is for the item to be visible. */\r\n readonly isHidden?: boolean | ConditionalBooleanValue;\r\n /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\r\n readonly isDisabled?: boolean | ConditionalBooleanValue;\r\n /** Priority within a group (recommend using values 1 through 100). */\r\n readonly itemPriority: number;\r\n /** Label. */\r\n readonly label: string | ConditionalStringValue;\r\n /** Subtitle. */\r\n readonly subtitle?: string | ConditionalStringValue;\r\n /** Tooltip. */\r\n readonly tooltip?: string | ConditionalStringValue;\r\n /** Describes if the item is active. The default is for the item to be active if stageId matches activeFrontstageId */\r\n readonly isActive?: boolean | ConditionalBooleanValue;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface BackstageActionItem extends CommonBackstageItem { // eslint-disable-line deprecation/deprecation\r\n readonly execute: () => void;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface BackstageStageLauncher extends CommonBackstageItem { // eslint-disable-line deprecation/deprecation\r\n readonly stageId: string;\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @deprecated in 3.6. Use [BackstageItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport type BackstageItem = BackstageActionItem | BackstageStageLauncher; // eslint-disable-line deprecation/deprecation\r\n\r\n/** BackstageActionItem type guard.\r\n * @deprecated in 3.6. Use [isBackstageActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isActionItem = (item: BackstageItem): item is BackstageActionItem => { // eslint-disable-line deprecation/deprecation\r\n return (item as BackstageActionItem).execute !== undefined; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** BackstageStageLauncher type guard.\r\n * @deprecated in 3.6. Use [isBackstageStageLauncher]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isStageLauncher = (item: BackstageItem): item is BackstageStageLauncher => { // eslint-disable-line deprecation/deprecation\r\n return (item as BackstageStageLauncher).stageId !== undefined; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** Utilities for creating and maintaining backstage items\r\n * @deprecated in 3.6. Use [BackstageItemUtilities]($appui-react) instead.\r\n * @public\r\n */\r\nexport class BackstageItemUtilities {\r\n /** Creates a stage launcher backstage item */\r\n public static createStageLauncher = (\r\n frontstageId: string, groupPriority: number, itemPriority: number, label: string | ConditionalStringValue,\r\n subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageStageLauncher> // eslint-disable-line deprecation/deprecation\r\n ): BackstageStageLauncher => ({ // eslint-disable-line deprecation/deprecation\r\n groupPriority,\r\n icon,\r\n internalData: overrides?.internalData,\r\n id: frontstageId,\r\n itemPriority,\r\n label,\r\n stageId: frontstageId,\r\n subtitle,\r\n ...overrides,\r\n });\r\n\r\n /** Creates an action backstage item */\r\n public static createActionItem = (\r\n itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string | ConditionalStringValue,\r\n subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageActionItem> // eslint-disable-line deprecation/deprecation\r\n ): BackstageActionItem => ({ // eslint-disable-line deprecation/deprecation\r\n execute,\r\n groupPriority,\r\n icon,\r\n internalData: overrides?.internalData,\r\n id: itemId,\r\n itemPriority,\r\n label,\r\n subtitle,\r\n ...overrides,\r\n });\r\n}\r\n"]}
@@ -1,39 +1,39 @@
1
- /** @packageDocumentation
2
- * @module Backstage
3
- */
4
- import { BeEvent } from "@itwin/core-bentley";
5
- import { BackstageItem } from "./BackstageItem";
6
- /** Arguments of [[BackstageItemsManager.onChanged]] event.
7
- * @internal
8
- */
9
- export interface BackstageItemsChangedArgs {
10
- readonly items: ReadonlyArray<BackstageItem>;
11
- }
12
- /**
13
- * Controls backstage items.
14
- * @internal
15
- */
16
- export declare class BackstageItemsManager {
17
- private _items;
18
- constructor(items?: ReadonlyArray<BackstageItem>);
19
- private loadItemsInternal;
20
- /** load items but do not fire onItemsChanged
21
- * @internal
22
- */
23
- loadItems(items: ReadonlyArray<BackstageItem>): void;
24
- /** Event raised when backstage items are changed.
25
- * @internal
26
- */
27
- readonly onItemsChanged: BeEvent<(args: BackstageItemsChangedArgs) => void>;
28
- get items(): ReadonlyArray<BackstageItem>;
29
- set items(items: ReadonlyArray<BackstageItem>);
30
- /** @internal */
31
- add(itemOrItems: BackstageItem | ReadonlyArray<BackstageItem>): void;
32
- /** @internal */
33
- remove(itemIdOrItemIds: BackstageItem["id"] | ReadonlyArray<BackstageItem["id"]>): void;
34
- /** @internal */
35
- static getSyncIdsOfInterest(items: readonly BackstageItem[]): string[];
36
- private internalRefreshAffectedItems;
37
- refreshAffectedItems(eventIds: Set<string>): void;
38
- }
1
+ /** @packageDocumentation
2
+ * @module Backstage
3
+ */
4
+ import { BeEvent } from "@itwin/core-bentley";
5
+ import { BackstageItem } from "./BackstageItem";
6
+ /** Arguments of [[BackstageItemsManager.onChanged]] event.
7
+ * @internal
8
+ */
9
+ export interface BackstageItemsChangedArgs {
10
+ readonly items: ReadonlyArray<BackstageItem>;
11
+ }
12
+ /**
13
+ * Controls backstage items.
14
+ * @internal
15
+ */
16
+ export declare class BackstageItemsManager {
17
+ private _items;
18
+ constructor(items?: ReadonlyArray<BackstageItem>);
19
+ private loadItemsInternal;
20
+ /** load items but do not fire onItemsChanged
21
+ * @internal
22
+ */
23
+ loadItems(items: ReadonlyArray<BackstageItem>): void;
24
+ /** Event raised when backstage items are changed.
25
+ * @internal
26
+ */
27
+ readonly onItemsChanged: BeEvent<(args: BackstageItemsChangedArgs) => void>;
28
+ get items(): ReadonlyArray<BackstageItem>;
29
+ set items(items: ReadonlyArray<BackstageItem>);
30
+ /** @internal */
31
+ add(itemOrItems: BackstageItem | ReadonlyArray<BackstageItem>): void;
32
+ /** @internal */
33
+ remove(itemIdOrItemIds: BackstageItem["id"] | ReadonlyArray<BackstageItem["id"]>): void;
34
+ /** @internal */
35
+ static getSyncIdsOfInterest(items: readonly BackstageItem[]): string[];
36
+ private internalRefreshAffectedItems;
37
+ refreshAffectedItems(eventIds: Set<string>): void;
38
+ }
39
39
  //# sourceMappingURL=BackstageItemsManager.d.ts.map