@itwin/appui-react 4.0.0-dev.16 → 4.0.0-dev.18

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 (191) hide show
  1. package/CHANGELOG.md +43 -18
  2. package/lib/cjs/appui-react/UiFramework.d.ts +10 -20
  3. package/lib/cjs/appui-react/UiFramework.d.ts.map +1 -1
  4. package/lib/cjs/appui-react/UiFramework.js +12 -24
  5. package/lib/cjs/appui-react/UiFramework.js.map +1 -1
  6. package/lib/cjs/appui-react/childwindow/InternalChildWindowManager.d.ts.map +1 -1
  7. package/lib/cjs/appui-react/childwindow/InternalChildWindowManager.js +4 -4
  8. package/lib/cjs/appui-react/childwindow/InternalChildWindowManager.js.map +1 -1
  9. package/lib/cjs/appui-react/dialog/ContentDialogManager.d.ts +0 -39
  10. package/lib/cjs/appui-react/dialog/ContentDialogManager.d.ts.map +1 -1
  11. package/lib/cjs/appui-react/dialog/ContentDialogManager.js +1 -61
  12. package/lib/cjs/appui-react/dialog/ContentDialogManager.js.map +1 -1
  13. package/lib/cjs/appui-react/dialog/ModalDialogManager.d.ts +0 -30
  14. package/lib/cjs/appui-react/dialog/ModalDialogManager.d.ts.map +1 -1
  15. package/lib/cjs/appui-react/dialog/ModalDialogManager.js +1 -44
  16. package/lib/cjs/appui-react/dialog/ModalDialogManager.js.map +1 -1
  17. package/lib/cjs/appui-react/dialog/ModelessDialogManager.d.ts +0 -39
  18. package/lib/cjs/appui-react/dialog/ModelessDialogManager.d.ts.map +1 -1
  19. package/lib/cjs/appui-react/dialog/ModelessDialogManager.js +1 -60
  20. package/lib/cjs/appui-react/dialog/ModelessDialogManager.js.map +1 -1
  21. package/lib/cjs/appui-react/framework/FrameworkChildWindows.d.ts +1 -1
  22. package/lib/cjs/appui-react/framework/FrameworkChildWindows.js.map +1 -1
  23. package/lib/cjs/appui-react/framework/FrameworkContent.d.ts +2 -2
  24. package/lib/cjs/appui-react/framework/FrameworkContent.js.map +1 -1
  25. package/lib/cjs/appui-react/framework/FrameworkControls.d.ts +1 -1
  26. package/lib/cjs/appui-react/framework/FrameworkControls.js.map +1 -1
  27. package/lib/cjs/appui-react/framework/FrameworkDialogs.d.ts +1 -1
  28. package/lib/cjs/appui-react/framework/FrameworkDialogs.js.map +1 -1
  29. package/lib/cjs/appui-react/framework/FrameworkFrontstages.d.ts +7 -3
  30. package/lib/cjs/appui-react/framework/FrameworkFrontstages.d.ts.map +1 -1
  31. package/lib/cjs/appui-react/framework/FrameworkFrontstages.js.map +1 -1
  32. package/lib/cjs/appui-react/framework/FrameworkKeyboardShortcuts.d.ts +1 -1
  33. package/lib/cjs/appui-react/framework/FrameworkKeyboardShortcuts.js.map +1 -1
  34. package/lib/cjs/appui-react/framework/FrameworkToolSettings.d.ts +1 -1
  35. package/lib/cjs/appui-react/framework/FrameworkToolSettings.js.map +1 -1
  36. package/lib/cjs/appui-react/framework/FrameworkVisibility.d.ts +1 -1
  37. package/lib/cjs/appui-react/framework/FrameworkVisibility.js.map +1 -1
  38. package/lib/cjs/appui-react/frontstage/FrontstageDef.d.ts +1 -1
  39. package/lib/cjs/appui-react/frontstage/FrontstageDef.d.ts.map +1 -1
  40. package/lib/cjs/appui-react/frontstage/FrontstageDef.js +12 -3
  41. package/lib/cjs/appui-react/frontstage/FrontstageDef.js.map +1 -1
  42. package/lib/cjs/appui-react/frontstage/InternalFrontstageManager.d.ts +6 -2
  43. package/lib/cjs/appui-react/frontstage/InternalFrontstageManager.d.ts.map +1 -1
  44. package/lib/cjs/appui-react/frontstage/InternalFrontstageManager.js +5 -1
  45. package/lib/cjs/appui-react/frontstage/InternalFrontstageManager.js.map +1 -1
  46. package/lib/cjs/appui-react/keyboardshortcut/KeyboardShortcut.d.ts +0 -32
  47. package/lib/cjs/appui-react/keyboardshortcut/KeyboardShortcut.d.ts.map +1 -1
  48. package/lib/cjs/appui-react/keyboardshortcut/KeyboardShortcut.js +1 -55
  49. package/lib/cjs/appui-react/keyboardshortcut/KeyboardShortcut.js.map +1 -1
  50. package/lib/cjs/appui-react/messages/MessageManager.js +2 -3
  51. package/lib/cjs/appui-react/messages/MessageManager.js.map +1 -1
  52. package/lib/cjs/appui-react/stagepanels/StagePanelDef.d.ts +13 -197
  53. package/lib/cjs/appui-react/stagepanels/StagePanelDef.d.ts.map +1 -1
  54. package/lib/cjs/appui-react/stagepanels/StagePanelDef.js +32 -4
  55. package/lib/cjs/appui-react/stagepanels/StagePanelDef.js.map +1 -1
  56. package/lib/cjs/appui-react/ui-items-provider/AbstractUiItemsManager.d.ts +34 -0
  57. package/lib/cjs/appui-react/ui-items-provider/AbstractUiItemsManager.d.ts.map +1 -0
  58. package/lib/cjs/appui-react/ui-items-provider/AbstractUiItemsManager.js +500 -0
  59. package/lib/cjs/appui-react/ui-items-provider/AbstractUiItemsManager.js.map +1 -0
  60. package/lib/cjs/appui-react/ui-items-provider/UiItemsManager.d.ts +6 -4
  61. package/lib/cjs/appui-react/ui-items-provider/UiItemsManager.d.ts.map +1 -1
  62. package/lib/cjs/appui-react/ui-items-provider/UiItemsManager.js +33 -6
  63. package/lib/cjs/appui-react/ui-items-provider/UiItemsManager.js.map +1 -1
  64. package/lib/cjs/appui-react.d.ts +0 -7
  65. package/lib/cjs/appui-react.d.ts.map +1 -1
  66. package/lib/cjs/appui-react.js +0 -7
  67. package/lib/cjs/appui-react.js.map +1 -1
  68. package/lib/esm/appui-react/UiFramework.d.ts +10 -20
  69. package/lib/esm/appui-react/UiFramework.d.ts.map +1 -1
  70. package/lib/esm/appui-react/UiFramework.js +12 -24
  71. package/lib/esm/appui-react/UiFramework.js.map +1 -1
  72. package/lib/esm/appui-react/childwindow/InternalChildWindowManager.d.ts.map +1 -1
  73. package/lib/esm/appui-react/childwindow/InternalChildWindowManager.js +4 -4
  74. package/lib/esm/appui-react/childwindow/InternalChildWindowManager.js.map +1 -1
  75. package/lib/esm/appui-react/dialog/ContentDialogManager.d.ts +0 -39
  76. package/lib/esm/appui-react/dialog/ContentDialogManager.d.ts.map +1 -1
  77. package/lib/esm/appui-react/dialog/ContentDialogManager.js +0 -59
  78. package/lib/esm/appui-react/dialog/ContentDialogManager.js.map +1 -1
  79. package/lib/esm/appui-react/dialog/ModalDialogManager.d.ts +0 -30
  80. package/lib/esm/appui-react/dialog/ModalDialogManager.d.ts.map +1 -1
  81. package/lib/esm/appui-react/dialog/ModalDialogManager.js +0 -42
  82. package/lib/esm/appui-react/dialog/ModalDialogManager.js.map +1 -1
  83. package/lib/esm/appui-react/dialog/ModelessDialogManager.d.ts +0 -39
  84. package/lib/esm/appui-react/dialog/ModelessDialogManager.d.ts.map +1 -1
  85. package/lib/esm/appui-react/dialog/ModelessDialogManager.js +0 -58
  86. package/lib/esm/appui-react/dialog/ModelessDialogManager.js.map +1 -1
  87. package/lib/esm/appui-react/framework/FrameworkChildWindows.d.ts +1 -1
  88. package/lib/esm/appui-react/framework/FrameworkChildWindows.js.map +1 -1
  89. package/lib/esm/appui-react/framework/FrameworkContent.d.ts +2 -2
  90. package/lib/esm/appui-react/framework/FrameworkContent.js.map +1 -1
  91. package/lib/esm/appui-react/framework/FrameworkControls.d.ts +1 -1
  92. package/lib/esm/appui-react/framework/FrameworkControls.js.map +1 -1
  93. package/lib/esm/appui-react/framework/FrameworkDialogs.d.ts +1 -1
  94. package/lib/esm/appui-react/framework/FrameworkDialogs.js.map +1 -1
  95. package/lib/esm/appui-react/framework/FrameworkFrontstages.d.ts +7 -3
  96. package/lib/esm/appui-react/framework/FrameworkFrontstages.d.ts.map +1 -1
  97. package/lib/esm/appui-react/framework/FrameworkFrontstages.js.map +1 -1
  98. package/lib/esm/appui-react/framework/FrameworkKeyboardShortcuts.d.ts +1 -1
  99. package/lib/esm/appui-react/framework/FrameworkKeyboardShortcuts.js.map +1 -1
  100. package/lib/esm/appui-react/framework/FrameworkToolSettings.d.ts +1 -1
  101. package/lib/esm/appui-react/framework/FrameworkToolSettings.js.map +1 -1
  102. package/lib/esm/appui-react/framework/FrameworkVisibility.d.ts +1 -1
  103. package/lib/esm/appui-react/framework/FrameworkVisibility.js.map +1 -1
  104. package/lib/esm/appui-react/frontstage/FrontstageDef.d.ts +1 -1
  105. package/lib/esm/appui-react/frontstage/FrontstageDef.d.ts.map +1 -1
  106. package/lib/esm/appui-react/frontstage/FrontstageDef.js +12 -3
  107. package/lib/esm/appui-react/frontstage/FrontstageDef.js.map +1 -1
  108. package/lib/esm/appui-react/frontstage/InternalFrontstageManager.d.ts +6 -2
  109. package/lib/esm/appui-react/frontstage/InternalFrontstageManager.d.ts.map +1 -1
  110. package/lib/esm/appui-react/frontstage/InternalFrontstageManager.js +5 -1
  111. package/lib/esm/appui-react/frontstage/InternalFrontstageManager.js.map +1 -1
  112. package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcut.d.ts +0 -32
  113. package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcut.d.ts.map +1 -1
  114. package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcut.js +0 -53
  115. package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcut.js.map +1 -1
  116. package/lib/esm/appui-react/messages/MessageManager.js +2 -3
  117. package/lib/esm/appui-react/messages/MessageManager.js.map +1 -1
  118. package/lib/esm/appui-react/stagepanels/StagePanelDef.d.ts +13 -197
  119. package/lib/esm/appui-react/stagepanels/StagePanelDef.d.ts.map +1 -1
  120. package/lib/esm/appui-react/stagepanels/StagePanelDef.js +31 -3
  121. package/lib/esm/appui-react/stagepanels/StagePanelDef.js.map +1 -1
  122. package/lib/esm/appui-react/ui-items-provider/AbstractUiItemsManager.d.ts +34 -0
  123. package/lib/esm/appui-react/ui-items-provider/AbstractUiItemsManager.d.ts.map +1 -0
  124. package/lib/esm/appui-react/ui-items-provider/AbstractUiItemsManager.js +496 -0
  125. package/lib/esm/appui-react/ui-items-provider/AbstractUiItemsManager.js.map +1 -0
  126. package/lib/esm/appui-react/ui-items-provider/UiItemsManager.d.ts +6 -4
  127. package/lib/esm/appui-react/ui-items-provider/UiItemsManager.d.ts.map +1 -1
  128. package/lib/esm/appui-react/ui-items-provider/UiItemsManager.js +33 -6
  129. package/lib/esm/appui-react/ui-items-provider/UiItemsManager.js.map +1 -1
  130. package/lib/esm/appui-react.d.ts +0 -7
  131. package/lib/esm/appui-react.d.ts.map +1 -1
  132. package/lib/esm/appui-react.js +0 -7
  133. package/lib/esm/appui-react.js.map +1 -1
  134. package/lib/public/locales/en/UiFramework.json +0 -45
  135. package/package.json +21 -13
  136. package/lib/cjs/appui-react/childwindow/ChildWindowManager.d.ts +0 -74
  137. package/lib/cjs/appui-react/childwindow/ChildWindowManager.d.ts.map +0 -1
  138. package/lib/cjs/appui-react/childwindow/ChildWindowManager.js +0 -107
  139. package/lib/cjs/appui-react/childwindow/ChildWindowManager.js.map +0 -1
  140. package/lib/cjs/appui-react/configurableui/ConfigurableUiManager.d.ts +0 -66
  141. package/lib/cjs/appui-react/configurableui/ConfigurableUiManager.d.ts.map +0 -1
  142. package/lib/cjs/appui-react/configurableui/ConfigurableUiManager.js +0 -93
  143. package/lib/cjs/appui-react/configurableui/ConfigurableUiManager.js.map +0 -1
  144. package/lib/cjs/appui-react/content/ContentLayoutManager.d.ts +0 -48
  145. package/lib/cjs/appui-react/content/ContentLayoutManager.d.ts.map +0 -1
  146. package/lib/cjs/appui-react/content/ContentLayoutManager.js +0 -69
  147. package/lib/cjs/appui-react/content/ContentLayoutManager.js.map +0 -1
  148. package/lib/cjs/appui-react/content/ContentViewManager.d.ts +0 -63
  149. package/lib/cjs/appui-react/content/ContentViewManager.d.ts.map +0 -1
  150. package/lib/cjs/appui-react/content/ContentViewManager.js +0 -96
  151. package/lib/cjs/appui-react/content/ContentViewManager.js.map +0 -1
  152. package/lib/cjs/appui-react/frontstage/FrontstageManager.d.ts +0 -202
  153. package/lib/cjs/appui-react/frontstage/FrontstageManager.d.ts.map +0 -1
  154. package/lib/cjs/appui-react/frontstage/FrontstageManager.js +0 -269
  155. package/lib/cjs/appui-react/frontstage/FrontstageManager.js.map +0 -1
  156. package/lib/cjs/appui-react/toolsettings/ToolSettingsManager.d.ts +0 -44
  157. package/lib/cjs/appui-react/toolsettings/ToolSettingsManager.d.ts.map +0 -1
  158. package/lib/cjs/appui-react/toolsettings/ToolSettingsManager.js +0 -64
  159. package/lib/cjs/appui-react/toolsettings/ToolSettingsManager.js.map +0 -1
  160. package/lib/cjs/appui-react/utils/UiShowHideManager.d.ts +0 -54
  161. package/lib/cjs/appui-react/utils/UiShowHideManager.d.ts.map +0 -1
  162. package/lib/cjs/appui-react/utils/UiShowHideManager.js +0 -108
  163. package/lib/cjs/appui-react/utils/UiShowHideManager.js.map +0 -1
  164. package/lib/esm/appui-react/childwindow/ChildWindowManager.d.ts +0 -74
  165. package/lib/esm/appui-react/childwindow/ChildWindowManager.d.ts.map +0 -1
  166. package/lib/esm/appui-react/childwindow/ChildWindowManager.js +0 -103
  167. package/lib/esm/appui-react/childwindow/ChildWindowManager.js.map +0 -1
  168. package/lib/esm/appui-react/configurableui/ConfigurableUiManager.d.ts +0 -66
  169. package/lib/esm/appui-react/configurableui/ConfigurableUiManager.d.ts.map +0 -1
  170. package/lib/esm/appui-react/configurableui/ConfigurableUiManager.js +0 -89
  171. package/lib/esm/appui-react/configurableui/ConfigurableUiManager.js.map +0 -1
  172. package/lib/esm/appui-react/content/ContentLayoutManager.d.ts +0 -48
  173. package/lib/esm/appui-react/content/ContentLayoutManager.d.ts.map +0 -1
  174. package/lib/esm/appui-react/content/ContentLayoutManager.js +0 -65
  175. package/lib/esm/appui-react/content/ContentLayoutManager.js.map +0 -1
  176. package/lib/esm/appui-react/content/ContentViewManager.d.ts +0 -63
  177. package/lib/esm/appui-react/content/ContentViewManager.d.ts.map +0 -1
  178. package/lib/esm/appui-react/content/ContentViewManager.js +0 -92
  179. package/lib/esm/appui-react/content/ContentViewManager.js.map +0 -1
  180. package/lib/esm/appui-react/frontstage/FrontstageManager.d.ts +0 -202
  181. package/lib/esm/appui-react/frontstage/FrontstageManager.d.ts.map +0 -1
  182. package/lib/esm/appui-react/frontstage/FrontstageManager.js +0 -265
  183. package/lib/esm/appui-react/frontstage/FrontstageManager.js.map +0 -1
  184. package/lib/esm/appui-react/toolsettings/ToolSettingsManager.d.ts +0 -44
  185. package/lib/esm/appui-react/toolsettings/ToolSettingsManager.d.ts.map +0 -1
  186. package/lib/esm/appui-react/toolsettings/ToolSettingsManager.js +0 -60
  187. package/lib/esm/appui-react/toolsettings/ToolSettingsManager.js.map +0 -1
  188. package/lib/esm/appui-react/utils/UiShowHideManager.d.ts +0 -54
  189. package/lib/esm/appui-react/utils/UiShowHideManager.d.ts.map +0 -1
  190. package/lib/esm/appui-react/utils/UiShowHideManager.js +0 -105
  191. package/lib/esm/appui-react/utils/UiShowHideManager.js.map +0 -1
@@ -10,34 +10,4 @@ export declare class ModalDialogRenderer extends React.PureComponent<CommonProps
10
10
  constructor(props: CommonProps);
11
11
  render(): React.ReactNode;
12
12
  }
13
- /** Modal Dialog Manager class displays and manages multiple modal dialogs
14
- * @public
15
- * @deprecated in 3.7. Use `UiFramework.dialogs.modal` property.
16
- */
17
- export declare class ModalDialogManager {
18
- /** Modal Dialog Changed Event */
19
- static get onModalDialogChangedEvent(): import("../framework/FrameworkDialogs").ModalDialogChangedEvent;
20
- /** @internal */
21
- static get dialogManager(): import("./DialogManagerBase").DialogManagerBase;
22
- /** Get the array of modal dialogs */
23
- static get dialogs(): import("./DialogManagerBase").DialogInfo[];
24
- /** Open a modal dialog
25
- * @param dialog The Dialog to open
26
- * @param id The id of the Dialog. If one is not provided, an id is generated.
27
- * @param parentDocument The Document used to determine the owning window.
28
- */
29
- static openDialog(dialog: React.ReactNode, id?: string, parentDocument?: Document): void;
30
- /** Close a modal dialog
31
- * @param dialog The Dialog to open. If one is not specified, the active dialog will be closed.
32
- */
33
- static closeDialog(dialog?: React.ReactNode): void;
34
- /** @internal */
35
- static closeAll(): void;
36
- /** Update the dialogs */
37
- static update(): void;
38
- /** Get the active modal dialog */
39
- static get activeDialog(): React.ReactNode | undefined;
40
- /** Get the count of modal dialogs */
41
- static get dialogCount(): number;
42
- }
43
13
  //# sourceMappingURL=ModalDialogManager.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ModalDialogManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/dialog/ModalDialogManager.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAIhD;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC;gBAE3D,KAAK,EAAE,WAAW;IAId,MAAM,IAAI,KAAK,CAAC,SAAS;CAK1C;AAED;;;GAGG;AACH,qBAAa,kBAAkB;IAC7B,iCAAiC;IACjC,WAAkB,yBAAyB,oEAAiD;IAE5F,gBAAgB;IAChB,WAAkB,aAAa,oDAAqC;IAEpE,qCAAqC;IACrC,WAAkB,OAAO,+CAA+B;IAExD;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,cAAc,WAAW,GAAG,IAAI;IAI/F;;OAEG;WACW,WAAW,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,IAAI;IAIzD,gBAAgB;WACF,QAAQ,IAAI,IAAI;IAI9B,yBAAyB;WACX,MAAM,IAAI,IAAI;IAI5B,kCAAkC;IAClC,WAAkB,YAAY,IAAI,KAAK,CAAC,SAAS,GAAG,SAAS,CAE5D;IAED,qCAAqC;IACrC,WAAkB,WAAW,IAAI,MAAM,CAEtC;CACF"}
1
+ {"version":3,"file":"ModalDialogManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/dialog/ModalDialogManager.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAIhD;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC;gBAE3D,KAAK,EAAE,WAAW;IAId,MAAM,IAAI,KAAK,CAAC,SAAS;CAK1C"}
@@ -19,46 +19,4 @@ export class ModalDialogRenderer extends React.PureComponent {
19
19
  return (React.createElement(DialogRendererBase, { ...this.props, dialogManager: internal.dialogManager }));
20
20
  }
21
21
  }
22
- /** Modal Dialog Manager class displays and manages multiple modal dialogs
23
- * @public
24
- * @deprecated in 3.7. Use `UiFramework.dialogs.modal` property.
25
- */
26
- export class ModalDialogManager {
27
- /** Modal Dialog Changed Event */
28
- static get onModalDialogChangedEvent() { return internal.onModalDialogChangedEvent; }
29
- /** @internal */
30
- static get dialogManager() { return internal.dialogManager; }
31
- /** Get the array of modal dialogs */
32
- static get dialogs() { return internal.dialogs; }
33
- /** Open a modal dialog
34
- * @param dialog The Dialog to open
35
- * @param id The id of the Dialog. If one is not provided, an id is generated.
36
- * @param parentDocument The Document used to determine the owning window.
37
- */
38
- static openDialog(dialog, id, parentDocument = document) {
39
- internal.open(dialog, id, parentDocument);
40
- }
41
- /** Close a modal dialog
42
- * @param dialog The Dialog to open. If one is not specified, the active dialog will be closed.
43
- */
44
- static closeDialog(dialog) {
45
- internal.close(dialog);
46
- }
47
- /** @internal */
48
- static closeAll() {
49
- internal.closeAll();
50
- }
51
- /** Update the dialogs */
52
- static update() {
53
- internal.update();
54
- }
55
- /** Get the active modal dialog */
56
- static get activeDialog() {
57
- return internal.active;
58
- }
59
- /** Get the count of modal dialogs */
60
- static get dialogCount() {
61
- return internal.count;
62
- }
63
- }
64
22
  //# sourceMappingURL=ModalDialogManager.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"ModalDialogManager.js","sourceRoot":"","sources":["../../../../src/appui-react/dialog/ModalDialogManager.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,0BAA0B,IAAI,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAEtF;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK,CAAC,aAA0B;IAEvE,YAAY,KAAkB;QAC5B,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAEe,MAAM;QACpB,OAAO,CACL,oBAAC,kBAAkB,OAAK,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,CAAC,aAAa,GAAI,CAC9E,CAAC;IACJ,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,kBAAkB;IAC7B,iCAAiC;IAC1B,MAAM,KAAK,yBAAyB,KAAK,OAAO,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CAAC;IAE5F,gBAAgB;IACT,MAAM,KAAK,aAAa,KAAK,OAAO,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;IAEpE,qCAAqC;IAC9B,MAAM,KAAK,OAAO,KAAK,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAExD;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAuB,EAAE,EAAW,EAAE,cAAc,GAAG,QAAQ;QACtF,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,WAAW,CAAC,MAAwB;QAChD,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACzB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,QAAQ;QACpB,QAAQ,CAAC,QAAQ,EAAE,CAAC;IACtB,CAAC;IAED,yBAAyB;IAClB,MAAM,CAAC,MAAM;QAClB,QAAQ,CAAC,MAAM,EAAE,CAAC;IACpB,CAAC;IAED,kCAAkC;IAC3B,MAAM,KAAK,YAAY;QAC5B,OAAO,QAAQ,CAAC,MAAM,CAAC;IACzB,CAAC;IAED,qCAAqC;IAC9B,MAAM,KAAK,WAAW;QAC3B,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Dialog\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { CommonProps } from \"@itwin/core-react\";\r\nimport { DialogRendererBase } from \"./DialogManagerBase\";\r\nimport { InternalModalDialogManager as internal } from \"./InternalModalDialogManager\";\r\n\r\n/** ModalDialogRenderer React component renders modal dialogs\r\n * @public\r\n */\r\nexport class ModalDialogRenderer extends React.PureComponent<CommonProps> {\r\n\r\n constructor(props: CommonProps) {\r\n super(props);\r\n }\r\n\r\n public override render(): React.ReactNode {\r\n return (\r\n <DialogRendererBase {...this.props} dialogManager={internal.dialogManager} />\r\n );\r\n }\r\n}\r\n\r\n/** Modal Dialog Manager class displays and manages multiple modal dialogs\r\n * @public\r\n * @deprecated in 3.7. Use `UiFramework.dialogs.modal` property.\r\n */\r\nexport class ModalDialogManager {\r\n /** Modal Dialog Changed Event */\r\n public static get onModalDialogChangedEvent() { return internal.onModalDialogChangedEvent; }\r\n\r\n /** @internal */\r\n public static get dialogManager() { return internal.dialogManager; }\r\n\r\n /** Get the array of modal dialogs */\r\n public static get dialogs() { return internal.dialogs; }\r\n\r\n /** Open a modal dialog\r\n * @param dialog The Dialog to open\r\n * @param id The id of the Dialog. If one is not provided, an id is generated.\r\n * @param parentDocument The Document used to determine the owning window.\r\n */\r\n public static openDialog(dialog: React.ReactNode, id?: string, parentDocument = document): void {\r\n internal.open(dialog, id, parentDocument);\r\n }\r\n\r\n /** Close a modal dialog\r\n * @param dialog The Dialog to open. If one is not specified, the active dialog will be closed.\r\n */\r\n public static closeDialog(dialog?: React.ReactNode): void {\r\n internal.close(dialog);\r\n }\r\n\r\n /** @internal */\r\n public static closeAll(): void {\r\n internal.closeAll();\r\n }\r\n\r\n /** Update the dialogs */\r\n public static update(): void {\r\n internal.update();\r\n }\r\n\r\n /** Get the active modal dialog */\r\n public static get activeDialog(): React.ReactNode | undefined {\r\n return internal.active;\r\n }\r\n\r\n /** Get the count of modal dialogs */\r\n public static get dialogCount(): number {\r\n return internal.count;\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"ModalDialogManager.js","sourceRoot":"","sources":["../../../../src/appui-react/dialog/ModalDialogManager.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,0BAA0B,IAAI,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAEtF;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK,CAAC,aAA0B;IAEvE,YAAY,KAAkB;QAC5B,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAEe,MAAM;QACpB,OAAO,CACL,oBAAC,kBAAkB,OAAK,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,CAAC,aAAa,GAAI,CAC9E,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Dialog\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { CommonProps } from \"@itwin/core-react\";\r\nimport { DialogRendererBase } from \"./DialogManagerBase\";\r\nimport { InternalModalDialogManager as internal } from \"./InternalModalDialogManager\";\r\n\r\n/** ModalDialogRenderer React component renders modal dialogs\r\n * @public\r\n */\r\nexport class ModalDialogRenderer extends React.PureComponent<CommonProps> {\r\n\r\n constructor(props: CommonProps) {\r\n super(props);\r\n }\r\n\r\n public override render(): React.ReactNode {\r\n return (\r\n <DialogRendererBase {...this.props} dialogManager={internal.dialogManager} />\r\n );\r\n }\r\n}\r\n"]}
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as React from "react";
5
5
  import { CommonProps } from "@itwin/core-react";
6
- import { ModelessDialogInfo } from "../framework/FrameworkDialogs";
7
6
  /** ModelessDialogRenderer React component renders modeless dialogs.
8
7
  * @public
9
8
  */
@@ -11,42 +10,4 @@ export declare class ModelessDialogRenderer extends React.PureComponent<CommonPr
11
10
  constructor(props: CommonProps);
12
11
  render(): React.ReactNode;
13
12
  }
14
- /** Modeless Dialog Manager class displays and manages multiple modeless dialogs
15
- * @public
16
- * @deprecated in 3.7. Use `UiFramework.dialogs.modeless` property.
17
- */
18
- export declare class ModelessDialogManager {
19
- /** Initialize the modeless dialog manager
20
- * @deprecated in 3.7. This is called internally.
21
- */
22
- static initialize(): void;
23
- /** Modeless Dialog Changed Event */
24
- static get onModelessDialogChangedEvent(): import("../framework/FrameworkDialogs").ModelessDialogChangedEvent;
25
- /** @internal */
26
- static get dialogManager(): import("./DialogManagerBase").DialogManagerBase;
27
- /** Get the array of modeless dialogs */
28
- static get dialogs(): import("./DialogManagerBase").DialogInfo[];
29
- /** Open a modeless dialog
30
- * @param dialog The Dialog to open
31
- * @param id The id of the Dialog to open
32
- */
33
- static openDialog(dialog: React.ReactNode, id: string, parentDocument?: Document): void;
34
- /** Close a modeless dialog
35
- * @param id The id of the Dialog to close.
36
- */
37
- static closeDialog(id: string): void;
38
- /** @internal */
39
- static closeAll(): void;
40
- /** Update the dialogs */
41
- static update(): void;
42
- /** Get the active modeless dialog */
43
- static get activeDialog(): React.ReactNode | undefined;
44
- /** Get the count of modeless dialogs */
45
- static get dialogCount(): number;
46
- /** Handle a pointer down event on a modeless dialog */
47
- static handlePointerDownEvent(_event: React.PointerEvent, id: string, updateFunc: () => void): void;
48
- /** Get the z-index for a modeless dialog */
49
- static getDialogZIndex(id: string): number;
50
- static getDialogInfo(id: string): ModelessDialogInfo | undefined;
51
- }
52
13
  //# sourceMappingURL=ModelessDialogManager.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ModelessDialogManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/dialog/ModelessDialogManager.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAKnE;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC;gBAE9D,KAAK,EAAE,WAAW;IAId,MAAM,IAAI,KAAK,CAAC,SAAS;CAK1C;AAED;;;GAGG;AACH,qBAAa,qBAAqB;IAChC;;MAEE;WACY,UAAU,IAAI,IAAI;IAIhC,oCAAoC;IACpC,WAAkB,4BAA4B,uEAAoD;IAElG,gBAAgB;IAChB,WAAkB,aAAa,oDAAqC;IAEpE,wCAAwC;IACxC,WAAkB,OAAO,+CAA+B;IAExD;;;SAGK;WACS,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,cAAc,WAAW,GAAG,IAAI;IAI9F;;SAEK;WACS,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAI3C,gBAAgB;WACF,QAAQ,IAAI,IAAI;IAI9B,yBAAyB;WACX,MAAM,IAAI,IAAI;IAI5B,qCAAqC;IACrC,WAAkB,YAAY,IAAI,KAAK,CAAC,SAAS,GAAG,SAAS,CAE5D;IAED,wCAAwC;IACxC,WAAkB,WAAW,IAAI,MAAM,CAEtC;IAED,uDAAuD;WACzC,sBAAsB,CAAC,MAAM,EAAE,KAAK,CAAC,YAAY,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,IAAI,GAAG,IAAI;IAI1G,4CAA4C;WAC9B,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;WAInC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS;CAGxE"}
1
+ {"version":3,"file":"ModelessDialogManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/dialog/ModelessDialogManager.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAMhD;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC;gBAE9D,KAAK,EAAE,WAAW;IAId,MAAM,IAAI,KAAK,CAAC,SAAS;CAK1C"}
@@ -20,62 +20,4 @@ export class ModelessDialogRenderer extends React.PureComponent {
20
20
  return (React.createElement(DialogRendererBase, { ...this.props, dialogManager: internal.dialogManager }));
21
21
  }
22
22
  }
23
- /** Modeless Dialog Manager class displays and manages multiple modeless dialogs
24
- * @public
25
- * @deprecated in 3.7. Use `UiFramework.dialogs.modeless` property.
26
- */
27
- export class ModelessDialogManager {
28
- /** Initialize the modeless dialog manager
29
- * @deprecated in 3.7. This is called internally.
30
- */
31
- static initialize() {
32
- internal.initialize();
33
- }
34
- /** Modeless Dialog Changed Event */
35
- static get onModelessDialogChangedEvent() { return internal.onModelessDialogChangedEvent; }
36
- /** @internal */
37
- static get dialogManager() { return internal.dialogManager; }
38
- /** Get the array of modeless dialogs */
39
- static get dialogs() { return internal.dialogs; }
40
- /** Open a modeless dialog
41
- * @param dialog The Dialog to open
42
- * @param id The id of the Dialog to open
43
- */
44
- static openDialog(dialog, id, parentDocument = document) {
45
- return internal.open(dialog, id, parentDocument);
46
- }
47
- /** Close a modeless dialog
48
- * @param id The id of the Dialog to close.
49
- */
50
- static closeDialog(id) {
51
- return internal.close(id);
52
- }
53
- /** @internal */
54
- static closeAll() {
55
- return internal.closeAll();
56
- }
57
- /** Update the dialogs */
58
- static update() {
59
- return internal.update();
60
- }
61
- /** Get the active modeless dialog */
62
- static get activeDialog() {
63
- return internal.active;
64
- }
65
- /** Get the count of modeless dialogs */
66
- static get dialogCount() {
67
- return internal.count;
68
- }
69
- /** Handle a pointer down event on a modeless dialog */
70
- static handlePointerDownEvent(_event, id, updateFunc) {
71
- return internal.handlePointerDownEvent(_event, id, updateFunc);
72
- }
73
- /** Get the z-index for a modeless dialog */
74
- static getDialogZIndex(id) {
75
- return internal.getZIndex(id);
76
- }
77
- static getDialogInfo(id) {
78
- return internal.getInfo(id);
79
- }
80
- }
81
23
  //# sourceMappingURL=ModelessDialogManager.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"ModelessDialogManager.js","sourceRoot":"","sources":["../../../../src/appui-react/dialog/ModelessDialogManager.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,EAAE,6BAA6B,IAAI,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAE5F,gCAAgC;AAEhC;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,KAAK,CAAC,aAA0B;IAE1E,YAAY,KAAkB;QAC5B,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAEe,MAAM;QACpB,OAAO,CACL,oBAAC,kBAAkB,OAAK,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,CAAC,aAAa,GAAI,CAC9E,CAAC;IACJ,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IAChC;;MAEE;IACK,MAAM,CAAC,UAAU;QACtB,QAAQ,CAAC,UAAU,EAAE,CAAC;IACxB,CAAC;IAED,oCAAoC;IAC7B,MAAM,KAAK,4BAA4B,KAAK,OAAO,QAAQ,CAAC,4BAA4B,CAAC,CAAC,CAAC;IAElG,gBAAgB;IACT,MAAM,KAAK,aAAa,KAAK,OAAO,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;IAEpE,wCAAwC;IACjC,MAAM,KAAK,OAAO,KAAK,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAExD;;;SAGK;IACE,MAAM,CAAC,UAAU,CAAC,MAAuB,EAAE,EAAU,EAAE,cAAc,GAAG,QAAQ;QACrF,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC;IACnD,CAAC;IAED;;SAEK;IACE,MAAM,CAAC,WAAW,CAAC,EAAU;QAClC,OAAO,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC5B,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,QAAQ;QACpB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED,yBAAyB;IAClB,MAAM,CAAC,MAAM;QAClB,OAAO,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC3B,CAAC;IAED,qCAAqC;IAC9B,MAAM,KAAK,YAAY;QAC5B,OAAO,QAAQ,CAAC,MAAM,CAAC;IACzB,CAAC;IAED,wCAAwC;IACjC,MAAM,KAAK,WAAW;QAC3B,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED,uDAAuD;IAChD,MAAM,CAAC,sBAAsB,CAAC,MAA0B,EAAE,EAAU,EAAE,UAAsB;QACjG,OAAO,QAAQ,CAAC,sBAAsB,CAAC,MAAM,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;IACjE,CAAC;IAED,4CAA4C;IACrC,MAAM,CAAC,eAAe,CAAC,EAAU;QACtC,OAAO,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC;IAEM,MAAM,CAAC,aAAa,CAAC,EAAU;QACpC,OAAO,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Dialog\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { CommonProps } from \"@itwin/core-react\";\r\nimport { DialogRendererBase } from \"./DialogManagerBase\";\r\nimport { ModelessDialogInfo } from \"../framework/FrameworkDialogs\";\r\nimport { InternalModelessDialogManager as internal } from \"./InternalModelessDialogManager\";\r\n\r\n// cSpell:ignore ZINDEX modeless\r\n\r\n/** ModelessDialogRenderer React component renders modeless dialogs.\r\n * @public\r\n */\r\nexport class ModelessDialogRenderer extends React.PureComponent<CommonProps> {\r\n\r\n constructor(props: CommonProps) {\r\n super(props);\r\n }\r\n\r\n public override render(): React.ReactNode {\r\n return (\r\n <DialogRendererBase {...this.props} dialogManager={internal.dialogManager} />\r\n );\r\n }\r\n}\r\n\r\n/** Modeless Dialog Manager class displays and manages multiple modeless dialogs\r\n * @public\r\n * @deprecated in 3.7. Use `UiFramework.dialogs.modeless` property.\r\n */\r\nexport class ModelessDialogManager {\r\n /** Initialize the modeless dialog manager\r\n * @deprecated in 3.7. This is called internally.\r\n */\r\n public static initialize(): void {\r\n internal.initialize();\r\n }\r\n\r\n /** Modeless Dialog Changed Event */\r\n public static get onModelessDialogChangedEvent() { return internal.onModelessDialogChangedEvent; }\r\n\r\n /** @internal */\r\n public static get dialogManager() { return internal.dialogManager; }\r\n\r\n /** Get the array of modeless dialogs */\r\n public static get dialogs() { return internal.dialogs; }\r\n\r\n /** Open a modeless dialog\r\n * @param dialog The Dialog to open\r\n * @param id The id of the Dialog to open\r\n */\r\n public static openDialog(dialog: React.ReactNode, id: string, parentDocument = document): void {\r\n return internal.open(dialog, id, parentDocument);\r\n }\r\n\r\n /** Close a modeless dialog\r\n * @param id The id of the Dialog to close.\r\n */\r\n public static closeDialog(id: string): void {\r\n return internal.close(id);\r\n }\r\n\r\n /** @internal */\r\n public static closeAll(): void {\r\n return internal.closeAll();\r\n }\r\n\r\n /** Update the dialogs */\r\n public static update(): void {\r\n return internal.update();\r\n }\r\n\r\n /** Get the active modeless dialog */\r\n public static get activeDialog(): React.ReactNode | undefined {\r\n return internal.active;\r\n }\r\n\r\n /** Get the count of modeless dialogs */\r\n public static get dialogCount(): number {\r\n return internal.count;\r\n }\r\n\r\n /** Handle a pointer down event on a modeless dialog */\r\n public static handlePointerDownEvent(_event: React.PointerEvent, id: string, updateFunc: () => void): void {\r\n return internal.handlePointerDownEvent(_event, id, updateFunc);\r\n }\r\n\r\n /** Get the z-index for a modeless dialog */\r\n public static getDialogZIndex(id: string): number {\r\n return internal.getZIndex(id);\r\n }\r\n\r\n public static getDialogInfo(id: string): ModelessDialogInfo | undefined {\r\n return internal.getInfo(id);\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"ModelessDialogManager.js","sourceRoot":"","sources":["../../../../src/appui-react/dialog/ModelessDialogManager.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,6BAA6B,IAAI,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAE5F,gCAAgC;AAEhC;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,KAAK,CAAC,aAA0B;IAE1E,YAAY,KAAkB;QAC5B,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAEe,MAAM;QACpB,OAAO,CACL,oBAAC,kBAAkB,OAAK,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,CAAC,aAAa,GAAI,CAC9E,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Dialog\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { CommonProps } from \"@itwin/core-react\";\r\nimport { DialogRendererBase } from \"./DialogManagerBase\";\r\nimport { InternalModelessDialogManager as internal } from \"./InternalModelessDialogManager\";\r\n\r\n// cSpell:ignore ZINDEX modeless\r\n\r\n/** ModelessDialogRenderer React component renders modeless dialogs.\r\n * @public\r\n */\r\nexport class ModelessDialogRenderer extends React.PureComponent<CommonProps> {\r\n\r\n constructor(props: CommonProps) {\r\n super(props);\r\n }\r\n\r\n public override render(): React.ReactNode {\r\n return (\r\n <DialogRendererBase {...this.props} dialogManager={internal.dialogManager} />\r\n );\r\n }\r\n}\r\n\r\n"]}
@@ -23,7 +23,7 @@ type CreateRoot = (container: Element | DocumentFragment) => {
23
23
  };
24
24
  /**
25
25
  * [[UiFramework.childWindows]] interface.
26
- * @beta
26
+ * @public
27
27
  */
28
28
  export interface FrameworkChildWindows {
29
29
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"FrameworkChildWindows.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkChildWindows.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 ChildWindowManager\r\n */\r\n\r\n/** @public */\r\nexport interface OpenChildWindowInfo {\r\n childWindowId: string;\r\n window: Window;\r\n parentWindow: Window;\r\n}\r\n\r\n/** @public */\r\nexport interface ChildWindowLocationProps {\r\n width: number;\r\n height: number;\r\n left: number;\r\n top: number;\r\n}\r\n\r\n/**\r\n * Basic recreation of the `createRoot` function type, intentionally not exported.\r\n */\r\ntype CreateRoot = (container: Element | DocumentFragment) => {\r\n render(children: React.ReactNode): void;\r\n};\r\n\r\n/**\r\n * [[UiFramework.childWindows]] interface.\r\n * @beta\r\n */\r\nexport interface FrameworkChildWindows {\r\n /**\r\n * List of currently open child windows;\r\n */\r\n readonly openChildWindows: OpenChildWindowInfo[];\r\n\r\n /**\r\n * When using React18, the `createRoot` function must be provided in order to render Popout content with React18.\r\n * Do not call if using React 17 or before.\r\n *\r\n * Note: The type of the function is intentionally simplified here.\r\n *\r\n * @param createRootFn Function imported from `import { createRoot } from \"react-dom/client\";`\r\n * @beta Will be removed once the transition to react 18 is complete.\r\n */\r\n useCreateRoot(createRootFn: CreateRoot): void;\r\n\r\n /**\r\n * Returns the OpenChildWindowInfo for the related id.\r\n * @param childWindowId Id of the window to retrieve.\r\n * @returns undefined if not found.\r\n */\r\n find(childWindowId: string | undefined): OpenChildWindowInfo | undefined;\r\n\r\n /**\r\n * Return the childWindowId of the provided window.\r\n * @param contentWindow Window element to identify\r\n * @returns undefined if not found\r\n */\r\n findId(contentWindow: Window | undefined | null): string | undefined;\r\n\r\n /** Close all child/pop-out windows. This typically is called when the frontstage is changed. */\r\n closeAll(): void;\r\n\r\n /**\r\n * Close a specific child window.\r\n * @param childWindowId Id of the window to close\r\n * @param processWindowClose should the `close` method be called on the closing window. (defaults to true)\r\n * @returns false if the window could not be found.\r\n */\r\n close(childWindowId: string, processWindowClose?: boolean): boolean;\r\n\r\n /**\r\n * Open a new child window.\r\n * @param childWindowId Id to assign to the newly created window.\r\n * @param title Title to display on the window.\r\n * @param content ReactNode to be rendered in the window.\r\n * @param location Position and size information\r\n * @param useDefaultPopoutUrl use \"/iTwinPopup.html\" as the window Url, \"\" otherwise.\r\n * @returns true if the window is opened successfully.\r\n */\r\n open(childWindowId: string, title: string, content: React.ReactNode, location: ChildWindowLocationProps, useDefaultPopoutUrl?: boolean): boolean;\r\n}\r\n"]}
1
+ {"version":3,"file":"FrameworkChildWindows.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkChildWindows.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 ChildWindowManager\r\n */\r\n\r\n/** @public */\r\nexport interface OpenChildWindowInfo {\r\n childWindowId: string;\r\n window: Window;\r\n parentWindow: Window;\r\n}\r\n\r\n/** @public */\r\nexport interface ChildWindowLocationProps {\r\n width: number;\r\n height: number;\r\n left: number;\r\n top: number;\r\n}\r\n\r\n/**\r\n * Basic recreation of the `createRoot` function type, intentionally not exported.\r\n */\r\ntype CreateRoot = (container: Element | DocumentFragment) => {\r\n render(children: React.ReactNode): void;\r\n};\r\n\r\n/**\r\n * [[UiFramework.childWindows]] interface.\r\n * @public\r\n */\r\nexport interface FrameworkChildWindows {\r\n /**\r\n * List of currently open child windows;\r\n */\r\n readonly openChildWindows: OpenChildWindowInfo[];\r\n\r\n /**\r\n * When using React18, the `createRoot` function must be provided in order to render Popout content with React18.\r\n * Do not call if using React 17 or before.\r\n *\r\n * Note: The type of the function is intentionally simplified here.\r\n *\r\n * @param createRootFn Function imported from `import { createRoot } from \"react-dom/client\";`\r\n * @beta Will be removed once the transition to react 18 is complete.\r\n */\r\n useCreateRoot(createRootFn: CreateRoot): void;\r\n\r\n /**\r\n * Returns the OpenChildWindowInfo for the related id.\r\n * @param childWindowId Id of the window to retrieve.\r\n * @returns undefined if not found.\r\n */\r\n find(childWindowId: string | undefined): OpenChildWindowInfo | undefined;\r\n\r\n /**\r\n * Return the childWindowId of the provided window.\r\n * @param contentWindow Window element to identify\r\n * @returns undefined if not found\r\n */\r\n findId(contentWindow: Window | undefined | null): string | undefined;\r\n\r\n /** Close all child/pop-out windows. This typically is called when the frontstage is changed. */\r\n closeAll(): void;\r\n\r\n /**\r\n * Close a specific child window.\r\n * @param childWindowId Id of the window to close\r\n * @param processWindowClose should the `close` method be called on the closing window. (defaults to true)\r\n * @returns false if the window could not be found.\r\n */\r\n close(childWindowId: string, processWindowClose?: boolean): boolean;\r\n\r\n /**\r\n * Open a new child window.\r\n * @param childWindowId Id to assign to the newly created window.\r\n * @param title Title to display on the window.\r\n * @param content ReactNode to be rendered in the window.\r\n * @param location Position and size information\r\n * @param useDefaultPopoutUrl use \"/iTwinPopup.html\" as the window Url, \"\" otherwise.\r\n * @returns true if the window is opened successfully.\r\n */\r\n open(childWindowId: string, title: string, content: React.ReactNode, location: ChildWindowLocationProps, useDefaultPopoutUrl?: boolean): boolean;\r\n}\r\n"]}
@@ -47,7 +47,7 @@ export interface ContentDialogInfo {
47
47
  }
48
48
  /**
49
49
  * [[UiFramework.content]] interface
50
- * @beta
50
+ * @public
51
51
  */
52
52
  export interface FrameworkContent {
53
53
  /** Gets the [[MouseDownChangedEvent]] */
@@ -104,7 +104,7 @@ export interface FrameworkContent {
104
104
  contentSupportsCamera(content: ContentControl | undefined): boolean;
105
105
  /**
106
106
  * Manage content layouts.
107
- * @beta
107
+ * @public
108
108
  */
109
109
  readonly layouts: {
110
110
  /** build a layout key that is unique for group layout combination */
@@ -1 +1 @@
1
- {"version":3,"file":"FrameworkContent.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkContent.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAsB,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAIpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAWjE;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,OAAkC;CAAI;AAYjF;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,OAAsC;CAAI;AAEzF;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,kBAAkB;CAAI","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 ContentView\r\n */\r\n\r\nimport { ContentLayoutProps, UiEvent } from \"@itwin/appui-abstract\";\r\nimport { ContentControl } from \"../content/ContentControl\";\r\nimport { ContentGroup, ContentGroupProps } from \"../content/ContentGroup\";\r\nimport { ContentLayoutDef } from \"../content/ContentLayout\";\r\nimport { DialogChangedEvent } from \"../dialog/DialogManagerBase\";\r\nimport { FrameworkStackedDialog } from \"./FrameworkDialogs\";\r\n\r\n/** [[MouseDownChangedEvent]] Args interface.\r\n * @public\r\n */\r\nexport interface MouseDownChangedEventArgs {\r\n /** Indicates whether the mouse is down */\r\n mouseDown: boolean;\r\n}\r\n\r\n/** Mouse Down Changed Event class.\r\n * @public\r\n */\r\nexport class MouseDownChangedEvent extends UiEvent<MouseDownChangedEventArgs> { }\r\n\r\n/** [[ActiveContentChangedEvent]] Args interface.\r\n * @public\r\n */\r\nexport interface ActiveContentChangedEventArgs {\r\n /** React node of the old content */\r\n oldContent?: React.ReactNode;\r\n /** React node of the newly active content */\r\n activeContent?: React.ReactNode;\r\n}\r\n\r\n/** Active Content Changed Event class.\r\n * @public\r\n */\r\nexport class ActiveContentChangedEvent extends UiEvent<ActiveContentChangedEventArgs> { }\r\n\r\n/** Content Dialog Changed Event class.\r\n * @public\r\n */\r\nexport class ContentDialogChangedEvent extends DialogChangedEvent { }\r\n\r\n/** @public */\r\nexport interface ContentDialogInfo {\r\n reactNode: React.ReactNode;\r\n zIndex: number;\r\n parentDocument: Document;\r\n}\r\n\r\n/**\r\n * [[UiFramework.content]] interface\r\n * @beta\r\n */\r\nexport interface FrameworkContent {\r\n /** Gets the [[MouseDownChangedEvent]] */\r\n readonly onMouseDownChangedEvent: MouseDownChangedEvent;\r\n\r\n /** Determines if the mouse is down in a content view */\r\n readonly isMouseDown: boolean;\r\n\r\n /** Sets the mouse down status for a content view */\r\n setMouseDown(mouseDown: boolean): void;\r\n\r\n /** Gets the [[ActiveContentChangedEvent]] */\r\n readonly onActiveContentChangedEvent: ActiveContentChangedEvent;\r\n\r\n /** Fires when floating contents are added or removed */\r\n\r\n readonly onAvailableContentChangedEvent: UiEvent<{ contentId: string }>;\r\n\r\n /** Gets the active content as a React.ReactNode. */\r\n getActive(): React.ReactNode | undefined;\r\n\r\n /** Return the active ContentControl. */\r\n getActiveContentControl(): ContentControl | undefined;\r\n\r\n addFloatingContentControl(contentControl?: ContentControl): void;\r\n\r\n dropFloatingContentControl(contentControl?: ContentControl): void;\r\n\r\n /** Sets the active [[ContentControl]] */\r\n setActive(activeContent?: React.ReactNode, forceEventProcessing?: boolean): void;\r\n\r\n /** Refreshes the active [[ContentControl]] */\r\n refreshActive(activeContent: React.ReactNode): void;\r\n\r\n /**\r\n * Determines if content displays a Sheet view.\r\n * @param content ContentControl to check\r\n */\r\n isContentSheetView(content: ContentControl | undefined): boolean;\r\n\r\n /**\r\n * Determines if content displays a Drawing view.\r\n * @param content ContentControl to check\r\n */\r\n isContentDrawingView(content: ContentControl | undefined): boolean;\r\n\r\n /**\r\n * Determines if content displays a Spatial view.\r\n * @param content ContentControl to check\r\n */\r\n isContentSpatialView(content: ContentControl | undefined): boolean;\r\n\r\n /**\r\n * Determines if content displays a Orthographic view.\r\n * @param content ContentControl to check\r\n */\r\n isContentOrthographicView(content: ContentControl | undefined): boolean;\r\n\r\n /**\r\n * Determines if content displays a 3d view.\r\n * @param content ContentControl to check\r\n */\r\n isContent3dView(content: ContentControl | undefined): boolean;\r\n\r\n /**\r\n * Determines if viewport supports use of a camera.\r\n * @param content ContentControl to check\r\n */\r\n contentSupportsCamera(content: ContentControl | undefined): boolean;\r\n\r\n /**\r\n * Manage content layouts.\r\n * @beta\r\n */\r\n readonly layouts: {\r\n /** build a layout key that is unique for group layout combination */\r\n getKey(props: { contentGroupId: string, layoutId: string }): string;\r\n\r\n /** Return a LayoutDef that is specific to a content group.\r\n * @returns the [[ContentLayoutDef]] if found, or undefined otherwise\r\n */\r\n getForGroup(contentGroupProps: ContentGroupProps | ContentGroup, overrideContentLayout?: ContentLayoutProps): ContentLayoutDef;\r\n\r\n /** Finds a Content Layout with a given id.\r\n * @param layoutKey group specific layout id, see `getLayoutKey`\r\n * @returns the [[ContentLayoutDef]] if found, or undefined otherwise\r\n */\r\n find(layoutKey: string): ContentLayoutDef | undefined;\r\n\r\n /** Adds a Content Layout.\r\n * @param layoutId the id of the Content Layout to add\r\n * @param layoutDef the Content Layout definition to add\r\n */\r\n add(layoutId: string, layoutDef: ContentLayoutDef): void;\r\n\r\n /** Gets the active Content Layout */\r\n readonly activeLayout: ContentLayoutDef | undefined;\r\n\r\n /** Gets the active Content Group */\r\n readonly activeContentGroup: ContentGroup | undefined;\r\n\r\n /** Sets the active Content Layout, Content Group and Content Control.\r\n * @param contentLayoutDef Content layout to make active\r\n * @param contentGroup Content Group to make active\r\n */\r\n setActive(contentLayoutDef: ContentLayoutDef, contentGroup: ContentGroup): Promise<void>;\r\n\r\n /** Sets the active Content Group.\r\n * @param contentGroup Content Group to make active\r\n */\r\n setActiveContentGroup(contentGroup: ContentGroup): Promise<void>;\r\n\r\n /** Refreshes the active layout and content group.\r\n */\r\n refreshActive(): void;\r\n };\r\n /**\r\n * Manage dialogs displaying managed content.\r\n * @beta\r\n */\r\n readonly dialogs: FrameworkStackedDialog<ContentDialogInfo> & {\r\n /** Content Dialog Changed Event */\r\n readonly onContentDialogChangedEvent: ContentDialogChangedEvent;\r\n };\r\n}\r\n"]}
1
+ {"version":3,"file":"FrameworkContent.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkContent.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAsB,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAIpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAWjE;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,OAAkC;CAAI;AAYjF;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,OAAsC;CAAI;AAEzF;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,kBAAkB;CAAI","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 ContentView\r\n */\r\n\r\nimport { ContentLayoutProps, UiEvent } from \"@itwin/appui-abstract\";\r\nimport { ContentControl } from \"../content/ContentControl\";\r\nimport { ContentGroup, ContentGroupProps } from \"../content/ContentGroup\";\r\nimport { ContentLayoutDef } from \"../content/ContentLayout\";\r\nimport { DialogChangedEvent } from \"../dialog/DialogManagerBase\";\r\nimport { FrameworkStackedDialog } from \"./FrameworkDialogs\";\r\n\r\n/** [[MouseDownChangedEvent]] Args interface.\r\n * @public\r\n */\r\nexport interface MouseDownChangedEventArgs {\r\n /** Indicates whether the mouse is down */\r\n mouseDown: boolean;\r\n}\r\n\r\n/** Mouse Down Changed Event class.\r\n * @public\r\n */\r\nexport class MouseDownChangedEvent extends UiEvent<MouseDownChangedEventArgs> { }\r\n\r\n/** [[ActiveContentChangedEvent]] Args interface.\r\n * @public\r\n */\r\nexport interface ActiveContentChangedEventArgs {\r\n /** React node of the old content */\r\n oldContent?: React.ReactNode;\r\n /** React node of the newly active content */\r\n activeContent?: React.ReactNode;\r\n}\r\n\r\n/** Active Content Changed Event class.\r\n * @public\r\n */\r\nexport class ActiveContentChangedEvent extends UiEvent<ActiveContentChangedEventArgs> { }\r\n\r\n/** Content Dialog Changed Event class.\r\n * @public\r\n */\r\nexport class ContentDialogChangedEvent extends DialogChangedEvent { }\r\n\r\n/** @public */\r\nexport interface ContentDialogInfo {\r\n reactNode: React.ReactNode;\r\n zIndex: number;\r\n parentDocument: Document;\r\n}\r\n\r\n/**\r\n * [[UiFramework.content]] interface\r\n * @public\r\n */\r\nexport interface FrameworkContent {\r\n /** Gets the [[MouseDownChangedEvent]] */\r\n readonly onMouseDownChangedEvent: MouseDownChangedEvent;\r\n\r\n /** Determines if the mouse is down in a content view */\r\n readonly isMouseDown: boolean;\r\n\r\n /** Sets the mouse down status for a content view */\r\n setMouseDown(mouseDown: boolean): void;\r\n\r\n /** Gets the [[ActiveContentChangedEvent]] */\r\n readonly onActiveContentChangedEvent: ActiveContentChangedEvent;\r\n\r\n /** Fires when floating contents are added or removed */\r\n\r\n readonly onAvailableContentChangedEvent: UiEvent<{ contentId: string }>;\r\n\r\n /** Gets the active content as a React.ReactNode. */\r\n getActive(): React.ReactNode | undefined;\r\n\r\n /** Return the active ContentControl. */\r\n getActiveContentControl(): ContentControl | undefined;\r\n\r\n addFloatingContentControl(contentControl?: ContentControl): void;\r\n\r\n dropFloatingContentControl(contentControl?: ContentControl): void;\r\n\r\n /** Sets the active [[ContentControl]] */\r\n setActive(activeContent?: React.ReactNode, forceEventProcessing?: boolean): void;\r\n\r\n /** Refreshes the active [[ContentControl]] */\r\n refreshActive(activeContent: React.ReactNode): void;\r\n\r\n /**\r\n * Determines if content displays a Sheet view.\r\n * @param content ContentControl to check\r\n */\r\n isContentSheetView(content: ContentControl | undefined): boolean;\r\n\r\n /**\r\n * Determines if content displays a Drawing view.\r\n * @param content ContentControl to check\r\n */\r\n isContentDrawingView(content: ContentControl | undefined): boolean;\r\n\r\n /**\r\n * Determines if content displays a Spatial view.\r\n * @param content ContentControl to check\r\n */\r\n isContentSpatialView(content: ContentControl | undefined): boolean;\r\n\r\n /**\r\n * Determines if content displays a Orthographic view.\r\n * @param content ContentControl to check\r\n */\r\n isContentOrthographicView(content: ContentControl | undefined): boolean;\r\n\r\n /**\r\n * Determines if content displays a 3d view.\r\n * @param content ContentControl to check\r\n */\r\n isContent3dView(content: ContentControl | undefined): boolean;\r\n\r\n /**\r\n * Determines if viewport supports use of a camera.\r\n * @param content ContentControl to check\r\n */\r\n contentSupportsCamera(content: ContentControl | undefined): boolean;\r\n\r\n /**\r\n * Manage content layouts.\r\n * @public\r\n */\r\n readonly layouts: {\r\n /** build a layout key that is unique for group layout combination */\r\n getKey(props: { contentGroupId: string, layoutId: string }): string;\r\n\r\n /** Return a LayoutDef that is specific to a content group.\r\n * @returns the [[ContentLayoutDef]] if found, or undefined otherwise\r\n */\r\n getForGroup(contentGroupProps: ContentGroupProps | ContentGroup, overrideContentLayout?: ContentLayoutProps): ContentLayoutDef;\r\n\r\n /** Finds a Content Layout with a given id.\r\n * @param layoutKey group specific layout id, see `getLayoutKey`\r\n * @returns the [[ContentLayoutDef]] if found, or undefined otherwise\r\n */\r\n find(layoutKey: string): ContentLayoutDef | undefined;\r\n\r\n /** Adds a Content Layout.\r\n * @param layoutId the id of the Content Layout to add\r\n * @param layoutDef the Content Layout definition to add\r\n */\r\n add(layoutId: string, layoutDef: ContentLayoutDef): void;\r\n\r\n /** Gets the active Content Layout */\r\n readonly activeLayout: ContentLayoutDef | undefined;\r\n\r\n /** Gets the active Content Group */\r\n readonly activeContentGroup: ContentGroup | undefined;\r\n\r\n /** Sets the active Content Layout, Content Group and Content Control.\r\n * @param contentLayoutDef Content layout to make active\r\n * @param contentGroup Content Group to make active\r\n */\r\n setActive(contentLayoutDef: ContentLayoutDef, contentGroup: ContentGroup): Promise<void>;\r\n\r\n /** Sets the active Content Group.\r\n * @param contentGroup Content Group to make active\r\n */\r\n setActiveContentGroup(contentGroup: ContentGroup): Promise<void>;\r\n\r\n /** Refreshes the active layout and content group.\r\n */\r\n refreshActive(): void;\r\n };\r\n /**\r\n * Manage dialogs displaying managed content.\r\n * @beta\r\n */\r\n readonly dialogs: FrameworkStackedDialog<ContentDialogInfo> & {\r\n /** Content Dialog Changed Event */\r\n readonly onContentDialogChangedEvent: ContentDialogChangedEvent;\r\n };\r\n}\r\n"]}
@@ -4,7 +4,7 @@
4
4
  import { ConfigurableUiControlConstructor, ConfigurableUiElement } from "../configurableui/ConfigurableUiControl";
5
5
  /**
6
6
  * [[UiFramework.controls]] interface
7
- * @beta
7
+ * @public
8
8
  */
9
9
  export interface FrameworkControls {
10
10
  /** Registers a control implementing the [[ConfigurableUiElement]] interface.
@@ -1 +1 @@
1
- {"version":3,"file":"FrameworkControls.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkControls.ts"],"names":[],"mappings":"","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 ConfigurableUi\r\n */\r\nimport { ConfigurableUiControlConstructor, ConfigurableUiElement } from \"../configurableui/ConfigurableUiControl\";\r\n\r\n/**\r\n * [[UiFramework.controls]] interface\r\n * @beta\r\n */\r\nexport interface FrameworkControls {\r\n\r\n /** Registers a control implementing the [[ConfigurableUiElement]] interface.\r\n * These controls can be a\r\n * [[ContentControl]],\r\n * [[NavigationAidControl]],\r\n * [[StatusBarWidgetControl]],\r\n * [[WidgetControl]] or\r\n * [[ToolUiProvider]].\r\n * @param classId the class id of the control to register\r\n * @param constructor the constructor of the control to register\r\n */\r\n register(classId: string, constructor: ConfigurableUiControlConstructor): void;\r\n\r\n /** Determines if a control has been registered based on its classId.\r\n * @param classId the class id of the control to test\r\n * @returns true if the control is registered or false if not\r\n */\r\n isRegistered(classId: string): boolean;\r\n\r\n /** Unregisters a control that has been registered.\r\n * @param classId the class id of the control to unregister\r\n */\r\n unregister(classId: string): void;\r\n\r\n /** Creates a control registered by calling registerControl.\r\n * @param classId the class id of the control to create\r\n * @param uniqueId a unique id for the control\r\n * @param options options passed to the constructor of the control\r\n * @param controlId controlId which may not be unique across all control instances.\r\n * @returns the created control\r\n */\r\n create(classId: string, uniqueId: string, options?: any, controlId?: string): ConfigurableUiElement | undefined;\r\n\r\n /** Gets the HTML wrapper element for Configurable UI */\r\n getWrapperElement(): HTMLElement;\r\n\r\n /** Closes all UI popups currently open */\r\n closeUi(): void;\r\n\r\n}\r\n"]}
1
+ {"version":3,"file":"FrameworkControls.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkControls.ts"],"names":[],"mappings":"","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 ConfigurableUi\r\n */\r\nimport { ConfigurableUiControlConstructor, ConfigurableUiElement } from \"../configurableui/ConfigurableUiControl\";\r\n\r\n/**\r\n * [[UiFramework.controls]] interface\r\n * @public\r\n */\r\nexport interface FrameworkControls {\r\n\r\n /** Registers a control implementing the [[ConfigurableUiElement]] interface.\r\n * These controls can be a\r\n * [[ContentControl]],\r\n * [[NavigationAidControl]],\r\n * [[StatusBarWidgetControl]],\r\n * [[WidgetControl]] or\r\n * [[ToolUiProvider]].\r\n * @param classId the class id of the control to register\r\n * @param constructor the constructor of the control to register\r\n */\r\n register(classId: string, constructor: ConfigurableUiControlConstructor): void;\r\n\r\n /** Determines if a control has been registered based on its classId.\r\n * @param classId the class id of the control to test\r\n * @returns true if the control is registered or false if not\r\n */\r\n isRegistered(classId: string): boolean;\r\n\r\n /** Unregisters a control that has been registered.\r\n * @param classId the class id of the control to unregister\r\n */\r\n unregister(classId: string): void;\r\n\r\n /** Creates a control registered by calling registerControl.\r\n * @param classId the class id of the control to create\r\n * @param uniqueId a unique id for the control\r\n * @param options options passed to the constructor of the control\r\n * @param controlId controlId which may not be unique across all control instances.\r\n * @returns the created control\r\n */\r\n create(classId: string, uniqueId: string, options?: any, controlId?: string): ConfigurableUiElement | undefined;\r\n\r\n /** Gets the HTML wrapper element for Configurable UI */\r\n getWrapperElement(): HTMLElement;\r\n\r\n /** Closes all UI popups currently open */\r\n closeUi(): void;\r\n\r\n}\r\n"]}
@@ -56,7 +56,7 @@ export interface FrameworkStackedDialog<DialogInfoType> extends FrameworkDialog
56
56
  }
57
57
  /**
58
58
  * [[UiFramework.dialogs]] interface.
59
- * @beta
59
+ * @public
60
60
  */
61
61
  export interface FrameworkDialogs {
62
62
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"FrameworkDialogs.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkDialogs.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,kBAAkB,EAAc,MAAM,6BAA6B,CAAC;AAE7E;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,kBAAkB;CAAI;AAEnE;;GAEG;AACH,MAAM,OAAO,0BAA2B,SAAQ,kBAAkB;CAAI","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 Dialog\r\n */\r\nimport { DialogChangedEvent, DialogInfo } from \"../dialog/DialogManagerBase\";\r\n\r\n/** Modal Dialog Changed Event class.\r\n * @public\r\n */\r\nexport class ModalDialogChangedEvent extends DialogChangedEvent { }\r\n\r\n/** Modeless Dialog Changed Event class.\r\n * @public\r\n */\r\nexport class ModelessDialogChangedEvent extends DialogChangedEvent { }\r\n\r\n/** @public */\r\nexport interface ModelessDialogInfo {\r\n reactNode: React.ReactNode;\r\n zIndex: number;\r\n parentDocument: Document;\r\n}\r\n\r\n/**\r\n * Manages dialog access\r\n * @beta\r\n */\r\nexport interface FrameworkDialog {\r\n /** Get the array of modal dialogs */\r\n readonly dialogs: DialogInfo[];\r\n\r\n /** Open a modal dialog\r\n * @param dialog The Dialog to open\r\n * @param id The id of the Dialog. If one is not provided, an id is generated.\r\n * @param parentDocument The Document used to determine the owning window.\r\n */\r\n open(dialog: React.ReactNode, id?: string, parentDocument?: Document): void;\r\n\r\n /** Close a modal dialog\r\n * @param dialog The Dialog to open. If one is not specified, the active dialog will be closed.\r\n */\r\n close(dialog?: React.ReactNode): void;\r\n\r\n /** Update the dialogs */\r\n update(): void;\r\n\r\n /** Get the active modal dialog */\r\n readonly active: React.ReactNode | undefined;\r\n\r\n /** Get the count of modal dialogs */\r\n readonly count: number;\r\n}\r\n\r\n/**\r\n * FrameworkDialog that manages the top most content.\r\n * @beta\r\n */\r\nexport interface FrameworkStackedDialog<DialogInfoType> extends FrameworkDialog {\r\n /** Handle a pointer down event on a modeless dialog */\r\n handlePointerDownEvent(_event: React.PointerEvent, id: string, updateFunc: () => void): void;\r\n\r\n /** Get the z-index for a modeless dialog */\r\n getZIndex(id: string): number;\r\n\r\n getInfo(id: string): DialogInfoType | undefined;\r\n}\r\n\r\n/**\r\n * [[UiFramework.dialogs]] interface.\r\n * @beta\r\n */\r\nexport interface FrameworkDialogs {\r\n /**\r\n * Manage modal dialogs.\r\n * @beta\r\n */\r\n readonly modal: FrameworkDialog & {\r\n /** Modal Dialog Changed Event */\r\n readonly onModalDialogChangedEvent: ModalDialogChangedEvent;\r\n };\r\n\r\n /**\r\n * Manage modeless dialogs.\r\n * @beta\r\n */\r\n readonly modeless: FrameworkStackedDialog<ModelessDialogInfo> & {\r\n /** Modeless Dialog Changed Event */\r\n readonly onModelessDialogChangedEvent: ModelessDialogChangedEvent;\r\n };\r\n}\r\n"]}
1
+ {"version":3,"file":"FrameworkDialogs.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkDialogs.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,kBAAkB,EAAc,MAAM,6BAA6B,CAAC;AAE7E;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,kBAAkB;CAAI;AAEnE;;GAEG;AACH,MAAM,OAAO,0BAA2B,SAAQ,kBAAkB;CAAI","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 Dialog\r\n */\r\nimport { DialogChangedEvent, DialogInfo } from \"../dialog/DialogManagerBase\";\r\n\r\n/** Modal Dialog Changed Event class.\r\n * @public\r\n */\r\nexport class ModalDialogChangedEvent extends DialogChangedEvent { }\r\n\r\n/** Modeless Dialog Changed Event class.\r\n * @public\r\n */\r\nexport class ModelessDialogChangedEvent extends DialogChangedEvent { }\r\n\r\n/** @public */\r\nexport interface ModelessDialogInfo {\r\n reactNode: React.ReactNode;\r\n zIndex: number;\r\n parentDocument: Document;\r\n}\r\n\r\n/**\r\n * Manages dialog access\r\n * @beta\r\n */\r\nexport interface FrameworkDialog {\r\n /** Get the array of modal dialogs */\r\n readonly dialogs: DialogInfo[];\r\n\r\n /** Open a modal dialog\r\n * @param dialog The Dialog to open\r\n * @param id The id of the Dialog. If one is not provided, an id is generated.\r\n * @param parentDocument The Document used to determine the owning window.\r\n */\r\n open(dialog: React.ReactNode, id?: string, parentDocument?: Document): void;\r\n\r\n /** Close a modal dialog\r\n * @param dialog The Dialog to open. If one is not specified, the active dialog will be closed.\r\n */\r\n close(dialog?: React.ReactNode): void;\r\n\r\n /** Update the dialogs */\r\n update(): void;\r\n\r\n /** Get the active modal dialog */\r\n readonly active: React.ReactNode | undefined;\r\n\r\n /** Get the count of modal dialogs */\r\n readonly count: number;\r\n}\r\n\r\n/**\r\n * FrameworkDialog that manages the top most content.\r\n * @beta\r\n */\r\nexport interface FrameworkStackedDialog<DialogInfoType> extends FrameworkDialog {\r\n /** Handle a pointer down event on a modeless dialog */\r\n handlePointerDownEvent(_event: React.PointerEvent, id: string, updateFunc: () => void): void;\r\n\r\n /** Get the z-index for a modeless dialog */\r\n getZIndex(id: string): number;\r\n\r\n getInfo(id: string): DialogInfoType | undefined;\r\n}\r\n\r\n/**\r\n * [[UiFramework.dialogs]] interface.\r\n * @public\r\n */\r\nexport interface FrameworkDialogs {\r\n /**\r\n * Manage modal dialogs.\r\n * @beta\r\n */\r\n readonly modal: FrameworkDialog & {\r\n /** Modal Dialog Changed Event */\r\n readonly onModalDialogChangedEvent: ModalDialogChangedEvent;\r\n };\r\n\r\n /**\r\n * Manage modeless dialogs.\r\n * @beta\r\n */\r\n readonly modeless: FrameworkStackedDialog<ModelessDialogInfo> & {\r\n /** Modeless Dialog Changed Event */\r\n readonly onModelessDialogChangedEvent: ModelessDialogChangedEvent;\r\n };\r\n}\r\n"]}
@@ -11,7 +11,7 @@ import { ContentLayoutActivatedEvent } from "../content/ContentLayout";
11
11
  import { FrontstageDef } from "../frontstage/FrontstageDef";
12
12
  import { FrontstageProvider } from "../frontstage/FrontstageProvider";
13
13
  import { NavigationAidActivatedEvent } from "../navigationaids/NavigationAidControl";
14
- import { PanelStateChangedEvent } from "../stagepanels/StagePanelDef";
14
+ import { PanelPinnedChangedEventArgs, PanelStateChangedEvent } from "../stagepanels/StagePanelDef";
15
15
  import { WidgetDef, WidgetStateChangedEvent } from "../widgets/WidgetDef";
16
16
  import { WidgetState } from "../widgets/WidgetState";
17
17
  /** Frontstage Activated Event Args interface.
@@ -147,7 +147,7 @@ export interface ModalFrontstageItem {
147
147
  }
148
148
  /**
149
149
  * [[UiFramework.frontstages]] interface
150
- * @beta
150
+ * @public
151
151
  */
152
152
  export interface FrameworkFrontstages {
153
153
  /** Returns true if Frontstage is loading its controls. If false the Frontstage content and controls have been created. */
@@ -180,10 +180,14 @@ export interface FrameworkFrontstages {
180
180
  readonly onNavigationAidActivatedEvent: NavigationAidActivatedEvent;
181
181
  /** Get Widget State Changed event. */
182
182
  readonly onWidgetStateChangedEvent: WidgetStateChangedEvent;
183
- /** Get Widget State Changed event.
183
+ /** Get panel state changed event.
184
184
  * @alpha
185
185
  */
186
186
  readonly onPanelStateChangedEvent: PanelStateChangedEvent;
187
+ /** Get panel pinned changed event.
188
+ * @alpha
189
+ */
190
+ readonly onPanelPinnedChangedEvent: UiEvent<PanelPinnedChangedEventArgs>;
187
191
  /** Clears the Frontstage map.
188
192
  */
189
193
  clearFrontstageDefs(): void;
@@ -1 +1 @@
1
- {"version":3,"file":"FrameworkFrontstages.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkFrontstages.ts"],"names":[],"mappings":";AAIA;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,4BAA4B,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,wCAAwC,CAAC;AACrF,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,wBAAwB,CAAC,EAAE,aAAa,CAAC;IACzC,sBAAsB,EAAE,aAAa,CAAC;CACvC;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,OAAO,CAAC,4BAA4B,CAAC;CAAI;AAEvF;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,mCAAmC;IACnC,wBAAwB,EAAE,aAAa,CAAC;IACxC,iCAAiC;IACjC,sBAAsB,CAAC,EAAE,aAAa,CAAC;IAEvC,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,OAAO,CAAC,8BAA8B,CAAC;CAAI;AAE3F;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,wBAAwB,CAAC;CAAI;AAE/E;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,OAAO,CAAC,+BAA+B,CAAC;CAAI;AAE7F;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,oCAAoC;IACpC,eAAe,EAAE,mBAAmB,CAAC;IAErC,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,qBAAa,kCAAmC,SAAQ,OAAO,CAAC,sCAAsC,CAAC;CAAI;AAE3G;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD,4CAA4C;IAC5C,eAAe,EAAE,mBAAmB,CAAC;IACrC,0CAA0C;IAC1C,cAAc,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,OAAO,CAAC,8BAA8B,CAAC;CAAI;AAE3F;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,OAAO,CAAC,sBAAsB,CAAC;CAAI;AAE3E;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,wBAAwB,CAAC;CAAI;AAE/E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC;IACzB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC9B;;gBAEY;IACZ,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,eAAe,EAAE,mBAAmB,CAAC;IACrC,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,0HAA0H;IAC1H,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,wCAAwC;IACxC,QAAQ,CAAC,4BAA4B,EAAE,0BAA0B,CAAC;IAElE,sCAAsC;IACtC,QAAQ,CAAC,0BAA0B,EAAE,wBAAwB,CAAC;IAE9D,sCAAsC;IACtC,QAAQ,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;IAEtD,0CAA0C;IAC1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,yCAAyC;IACzC,QAAQ,CAAC,4BAA4B,EAAE,0BAA0B,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,oCAAoC,EAAE,kCAAkC,CAAC;IAElF,gCAAgC;IAChC,QAAQ,CAAC,oBAAoB,EAAE,kBAAkB,CAAC;IAElD,oCAAoC;IACpC,QAAQ,CAAC,yBAAyB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD,mCAAmC;IACnC,QAAQ,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;IAEtD,0CAA0C;IAC1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,2CAA2C;IAC3C,QAAQ,CAAC,8BAA8B,EAAE,4BAA4B,CAAC;IAEtE,0CAA0C;IAC1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,sCAAsC;IACtC,QAAQ,CAAC,yBAAyB,EAAE,uBAAuB,CAAC;IAE5D;;OAEG;IACH,QAAQ,CAAC,wBAAwB,EAAE,sBAAsB,CAAC;IAE1D;OACG;IACH,mBAAmB,IAAI,IAAI,CAAC;IAE5B;OACG;IACH,wBAAwB,IAAI,IAAI,CAAC;IAEjC;;OAEG;IACH,qBAAqB,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpE;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,mBAAmB,EAAE,aAAa,GAAG,SAAS,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;IAE7C;;;OAGG;IACH,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD;;;OAGG;IACH,sBAAsB,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhF;OACG;IACH,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B,8BAA8B;IAC9B,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,2BAA2B;IAC3B,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAEhC,iDAAiD;IACjD,QAAQ,CAAC,qBAAqB,EAAE,eAAe,GAAG,SAAS,CAAC;IAE5D;;OAEG;IACH,mBAAmB,CAAC,eAAe,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEhE;OACG;IACH,oBAAoB,IAAI,IAAI,CAAC;IAE7B;OACG;IACH,qBAAqB,IAAI,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAEtC;;;OAGG;IACH,sBAAsB,CAAC,eAAe,EAAE,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE1F;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC;IAE9D;;;OAGG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;IAEpD;;OAEG;IACH,oBAAoB,CAAC,gBAAgB,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE;OACG;IACH,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,aAAa,GAAG,SAAS,CAAC;IAE3D;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;CACxC"}
1
+ {"version":3,"file":"FrameworkFrontstages.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkFrontstages.ts"],"names":[],"mappings":";AAIA;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,4BAA4B,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,wCAAwC,CAAC;AACrF,OAAO,EAAE,2BAA2B,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,wBAAwB,CAAC,EAAE,aAAa,CAAC;IACzC,sBAAsB,EAAE,aAAa,CAAC;CACvC;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,OAAO,CAAC,4BAA4B,CAAC;CAAI;AAEvF;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,mCAAmC;IACnC,wBAAwB,EAAE,aAAa,CAAC;IACxC,iCAAiC;IACjC,sBAAsB,CAAC,EAAE,aAAa,CAAC;IAEvC,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,OAAO,CAAC,8BAA8B,CAAC;CAAI;AAE3F;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,wBAAwB,CAAC;CAAI;AAE/E;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,OAAO,CAAC,+BAA+B,CAAC;CAAI;AAE7F;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,oCAAoC;IACpC,eAAe,EAAE,mBAAmB,CAAC;IAErC,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,qBAAa,kCAAmC,SAAQ,OAAO,CAAC,sCAAsC,CAAC;CAAI;AAE3G;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD,4CAA4C;IAC5C,eAAe,EAAE,mBAAmB,CAAC;IACrC,0CAA0C;IAC1C,cAAc,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,OAAO,CAAC,8BAA8B,CAAC;CAAI;AAE3F;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,OAAO,CAAC,sBAAsB,CAAC;CAAI;AAE3E;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,wBAAwB,CAAC;CAAI;AAE/E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC;IACzB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC9B;;gBAEY;IACZ,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,eAAe,EAAE,mBAAmB,CAAC;IACrC,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,0HAA0H;IAC1H,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,wCAAwC;IACxC,QAAQ,CAAC,4BAA4B,EAAE,0BAA0B,CAAC;IAElE,sCAAsC;IACtC,QAAQ,CAAC,0BAA0B,EAAE,wBAAwB,CAAC;IAE9D,sCAAsC;IACtC,QAAQ,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;IAEtD,0CAA0C;IAC1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,yCAAyC;IACzC,QAAQ,CAAC,4BAA4B,EAAE,0BAA0B,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,oCAAoC,EAAE,kCAAkC,CAAC;IAElF,gCAAgC;IAChC,QAAQ,CAAC,oBAAoB,EAAE,kBAAkB,CAAC;IAElD,oCAAoC;IACpC,QAAQ,CAAC,yBAAyB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD,mCAAmC;IACnC,QAAQ,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;IAEtD,0CAA0C;IAC1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,2CAA2C;IAC3C,QAAQ,CAAC,8BAA8B,EAAE,4BAA4B,CAAC;IAEtE,0CAA0C;IAC1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,sCAAsC;IACtC,QAAQ,CAAC,yBAAyB,EAAE,uBAAuB,CAAC;IAE5D;;OAEG;IACH,QAAQ,CAAC,wBAAwB,EAAE,sBAAsB,CAAC;IAE1D;;OAEG;IACH,QAAQ,CAAC,yBAAyB,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAEzE;OACG;IACH,mBAAmB,IAAI,IAAI,CAAC;IAE5B;OACG;IACH,wBAAwB,IAAI,IAAI,CAAC;IAEjC;;OAEG;IACH,qBAAqB,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpE;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,mBAAmB,EAAE,aAAa,GAAG,SAAS,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;IAE7C;;;OAGG;IACH,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD;;;OAGG;IACH,sBAAsB,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhF;OACG;IACH,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B,8BAA8B;IAC9B,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,2BAA2B;IAC3B,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAEhC,iDAAiD;IACjD,QAAQ,CAAC,qBAAqB,EAAE,eAAe,GAAG,SAAS,CAAC;IAE5D;;OAEG;IACH,mBAAmB,CAAC,eAAe,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEhE;OACG;IACH,oBAAoB,IAAI,IAAI,CAAC;IAE7B;OACG;IACH,qBAAqB,IAAI,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAEtC;;;OAGG;IACH,sBAAsB,CAAC,eAAe,EAAE,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE1F;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC;IAE9D;;;OAGG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;IAEpD;;OAEG;IACH,oBAAoB,CAAC,gBAAgB,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE;OACG;IACH,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,aAAa,GAAG,SAAS,CAAC;IAE3D;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;CACxC"}
@@ -1 +1 @@
1
- {"version":3,"file":"FrameworkFrontstages.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkFrontstages.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAqBhD;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,OAAqC;CAAI;AAmBvF;;GAEG;AACH,MAAM,OAAO,0BAA2B,SAAQ,OAAuC;CAAI;AAS3F;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,OAAiC;CAAI;AAS/E;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,OAAwC;CAAI;AAiB7F;;;;;;GAMG;AACH,MAAM,OAAO,kCAAmC,SAAQ,OAA+C;CAAI;AAY3G;;GAEG;AACH,MAAM,OAAO,0BAA2B,SAAQ,OAAuC;CAAI;AAS3F;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,OAA+B;CAAI;AAS3E;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,OAAiC;CAAI","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 Frontstage\r\n */\r\nimport { UiEvent } from \"@itwin/appui-abstract\";\r\nimport { IModelConnection, Tool } from \"@itwin/core-frontend\";\r\nimport { ToolInformation } from \"../toolsettings/ToolInformation\";\r\nimport { TimeTracker } from \"../configurableui/TimeTracker\";\r\nimport { ContentControlActivatedEvent } from \"../content/ContentControl\";\r\nimport { ContentLayoutActivatedEvent } from \"../content/ContentLayout\";\r\nimport { FrontstageDef } from \"../frontstage/FrontstageDef\";\r\nimport { FrontstageProvider } from \"../frontstage/FrontstageProvider\";\r\nimport { NavigationAidActivatedEvent } from \"../navigationaids/NavigationAidControl\";\r\nimport { PanelStateChangedEvent } from \"../stagepanels/StagePanelDef\";\r\nimport { WidgetDef, WidgetStateChangedEvent } from \"../widgets/WidgetDef\";\r\nimport { WidgetState } from \"../widgets/WidgetState\";\r\n\r\n/** Frontstage Activated Event Args interface.\r\n * @public\r\n */\r\nexport interface FrontstageActivatedEventArgs {\r\n deactivatedFrontstageDef?: FrontstageDef;\r\n activatedFrontstageDef: FrontstageDef;\r\n}\r\n\r\n/** Frontstage Activated Event class.\r\n * @public\r\n */\r\nexport class FrontstageActivatedEvent extends UiEvent<FrontstageActivatedEventArgs> { }\r\n\r\n/** Frontstage Deactivated Event Args interface.\r\n * @public\r\n */\r\nexport interface FrontstageDeactivatedEventArgs {\r\n /** Frontstage being deactivated */\r\n deactivatedFrontstageDef: FrontstageDef;\r\n /** Frontstage being activated */\r\n activatedFrontstageDef?: FrontstageDef;\r\n\r\n /** Total time spent in frontstage */\r\n totalTime: number;\r\n /** Engagement time spent in frontstage */\r\n engagementTime: number;\r\n /** Idle time spent in frontstage */\r\n idleTime: number;\r\n}\r\n\r\n/** Frontstage Deactivated Event class.\r\n * @public\r\n */\r\nexport class FrontstageDeactivatedEvent extends UiEvent<FrontstageDeactivatedEventArgs> { }\r\n\r\n/** Frontstage Ready Event Args interface.\r\n * @public\r\n */\r\nexport interface FrontstageReadyEventArgs {\r\n frontstageDef: FrontstageDef;\r\n}\r\n\r\n/** Frontstage Ready Event class.\r\n * @public\r\n */\r\nexport class FrontstageReadyEvent extends UiEvent<FrontstageReadyEventArgs> { }\r\n\r\n/** Modal Frontstage Changed Event Args interface.\r\n * @public\r\n */\r\nexport interface ModalFrontstageChangedEventArgs {\r\n modalFrontstageCount: number;\r\n}\r\n\r\n/** Modal Frontstage Stack Changed Event class.\r\n * @public\r\n */\r\nexport class ModalFrontstageChangedEvent extends UiEvent<ModalFrontstageChangedEventArgs> { }\r\n\r\n/** Modal Frontstage Closed Event Args interface.\r\n * @public\r\n */\r\nexport interface ModalFrontstageClosedEventArgs {\r\n /** Modal Frontstage being closed */\r\n modalFrontstage: ModalFrontstageInfo;\r\n\r\n /** Total time spent in frontstage */\r\n totalTime: number;\r\n /** Engagement time spent in frontstage */\r\n engagementTime: number;\r\n /** Idle time spent in frontstage */\r\n idleTime: number;\r\n}\r\n\r\n/** Modal Frontstage Requested Close Event class. Notifies the modal stage that the close button was\r\n * pressed and passes the function to actually close the modal stage. This allows stage to do any\r\n * saving of unsaved data prior to closing the stage. If the ModalFrontstageInfo sets notifyCloseRequest\r\n * to true it is up to the stage to register for this event and call the stageCloseFunc once it has saved\r\n * any unsaved data.\r\n * @alpha\r\n */\r\nexport class ModalFrontstageRequestedCloseEvent extends UiEvent<ModalFrontstageRequestedCloseEventArgs> { }\r\n\r\n/** Modal Frontstage RequestedClose Event Args interface.\r\n * @alpha\r\n */\r\nexport interface ModalFrontstageRequestedCloseEventArgs {\r\n /** Modal Frontstage that is to be closed */\r\n modalFrontstage: ModalFrontstageInfo;\r\n /** Function to call to close the stage */\r\n stageCloseFunc: () => void;\r\n}\r\n\r\n/** Modal Frontstage Closed Event class.\r\n * @public\r\n */\r\nexport class ModalFrontstageClosedEvent extends UiEvent<ModalFrontstageClosedEventArgs> { }\r\n\r\n/** Tool Activated Event Args interface.\r\n * @public\r\n */\r\nexport interface ToolActivatedEventArgs {\r\n toolId: string;\r\n}\r\n\r\n/** Tool Activated Event class.\r\n * @public\r\n */\r\nexport class ToolActivatedEvent extends UiEvent<ToolActivatedEventArgs> { }\r\n\r\n/** Tool Icon Changed Event Args interface.\r\n * @public\r\n */\r\nexport interface ToolIconChangedEventArgs {\r\n iconSpec: string;\r\n}\r\n\r\n/** Tool Icon Changed Event class.\r\n * @public\r\n */\r\nexport class ToolIconChangedEvent extends UiEvent<ToolIconChangedEventArgs> { }\r\n\r\n/** Modal Frontstage information interface.\r\n * @public\r\n */\r\nexport interface ModalFrontstageInfo {\r\n title: string;\r\n content: React.ReactNode;\r\n appBarRight?: React.ReactNode;\r\n /** Set notifyCloseRequest to true on stages that register to listen for `onCloseModalFrontstageRequestedEvent` so\r\n * that the stage can save unsaved data before closing. Used by the ModalSettingsStage.\r\n * @alpha */\r\n notifyCloseRequest?: boolean;\r\n}\r\n\r\n/** Modal Frontstage array item interface.\r\n * @internal\r\n */\r\nexport interface ModalFrontstageItem {\r\n modalFrontstage: ModalFrontstageInfo;\r\n timeTracker: TimeTracker;\r\n}\r\n\r\n/**\r\n * [[UiFramework.frontstages]] interface\r\n * @beta\r\n */\r\nexport interface FrameworkFrontstages {\r\n /** Returns true if Frontstage is loading its controls. If false the Frontstage content and controls have been created. */\r\n readonly isLoading: boolean;\r\n\r\n /** Get Frontstage Deactivated event. */\r\n readonly onFrontstageDeactivatedEvent: FrontstageDeactivatedEvent;\r\n\r\n /** Get Frontstage Activated event. */\r\n readonly onFrontstageActivatedEvent: FrontstageActivatedEvent;\r\n\r\n /** Get Frontstage Activated event. */\r\n readonly onFrontstageReadyEvent: FrontstageReadyEvent;\r\n\r\n /** Get Modal Frontstage Changed event. */\r\n readonly onModalFrontstageChangedEvent: ModalFrontstageChangedEvent;\r\n\r\n /** Get Modal Frontstage Closed event. */\r\n readonly onModalFrontstageClosedEvent: ModalFrontstageClosedEvent;\r\n\r\n /** Get Modal Frontstage Requested Closed event.\r\n * @alpha\r\n */\r\n readonly onCloseModalFrontstageRequestedEvent: ModalFrontstageRequestedCloseEvent;\r\n\r\n /** Get Tool Activated event. */\r\n readonly onToolActivatedEvent: ToolActivatedEvent;\r\n\r\n /** Get ToolSetting Reload event. */\r\n readonly onToolSettingsReloadEvent: UiEvent<void>;\r\n\r\n /** Get Tool Icon Changed event. */\r\n readonly onToolIconChangedEvent: ToolIconChangedEvent;\r\n\r\n /** Get Content Layout Activated event. */\r\n readonly onContentLayoutActivatedEvent: ContentLayoutActivatedEvent;\r\n\r\n /** Get Content Control Activated event. */\r\n readonly onContentControlActivatedEvent: ContentControlActivatedEvent;\r\n\r\n /** Get Navigation Aid Activated event. */\r\n readonly onNavigationAidActivatedEvent: NavigationAidActivatedEvent;\r\n\r\n /** Get Widget State Changed event. */\r\n readonly onWidgetStateChangedEvent: WidgetStateChangedEvent;\r\n\r\n /** Get Widget State Changed event.\r\n * @alpha\r\n */\r\n readonly onPanelStateChangedEvent: PanelStateChangedEvent;\r\n\r\n /** Clears the Frontstage map.\r\n */\r\n clearFrontstageDefs(): void;\r\n\r\n /** Clears the Frontstage Providers and the defs that may have been created from them.\r\n */\r\n clearFrontstageProviders(): void;\r\n\r\n /** Add a Frontstage via a [[FrontstageProvider]].\r\n * @param frontstageProvider FrontstageProvider representing the Frontstage to add\r\n */\r\n addFrontstageProvider(frontstageProvider: FrontstageProvider): void;\r\n\r\n /** Find a loaded Frontstage with a given id. If the id is not provided, the active Frontstage is returned. If\r\n * no cached FrontstageDef is found but a FrontstageProvider is registered a FrontstageDef will be created, cached, and\r\n * returned.\r\n * @param id Id of the Frontstage to find\r\n * @returns FrontstageDef with a given id if found, or undefined if not found.\r\n */\r\n getFrontstageDef(id?: string): Promise<FrontstageDef | undefined>;\r\n\r\n /** Gets the active FrontstageDef. If a Frontstage is not active, undefined is returned.\r\n * @return Active FrontstageDef, or undefined if one is not active.\r\n */\r\n readonly activeFrontstageDef: FrontstageDef | undefined;\r\n\r\n /** Gets the Id of the active FrontstageDef. If a Frontstage is not active, blank is returned.\r\n * @return Id of the active FrontstageDef, or blank if one is not active.\r\n */\r\n readonly activeFrontstageId: string;\r\n\r\n hasFrontstage(frontstageId: string): boolean;\r\n\r\n /** Sets the active FrontstageDef give the stageId.\r\n * @param frontstageId Id of the Frontstage to set active.\r\n * @returns A Promise that is fulfilled when the [[Frontstage]] is ready.\r\n */\r\n setActiveFrontstage(frontstageId: string): Promise<void>;\r\n\r\n /** Sets the active FrontstageDef.\r\n * @param frontstageDef FrontstageDef to set active.\r\n * @returns A Promise that is fulfilled when the [[FrontstageDef]] is ready.\r\n */\r\n setActiveFrontstageDef(frontstageDef: FrontstageDef | undefined): Promise<void>;\r\n\r\n /** Deactivates the active FrontstageDef.\r\n */\r\n deactivateFrontstageDef(): Promise<void>;\r\n\r\n /** Gets the Id of the active tool. If a tool is not active, blank is returned.\r\n * @return Id of the active tool, or blank if one is not active.\r\n */\r\n readonly activeToolId: string;\r\n\r\n /** Sets the active tool id */\r\n setActiveToolId(toolId: string): void;\r\n\r\n /** Sets the active tool */\r\n setActiveTool(tool: Tool): void;\r\n\r\n /** Gets the active tool's [[ToolInformation]] */\r\n readonly activeToolInformation: ToolInformation | undefined;\r\n\r\n /** Opens a modal Frontstage. Modal Frontstages can be stacked.\r\n * @param modalFrontstage Information about the modal Frontstage\r\n */\r\n openModalFrontstage(modalFrontstage: ModalFrontstageInfo): void;\r\n\r\n /** Closes the top-most modal Frontstage.\r\n */\r\n closeModalFrontstage(): void;\r\n\r\n /** Updates the top-most modal Frontstage.\r\n */\r\n updateModalFrontstage(): void;\r\n\r\n /** Gets the top-most modal Frontstage.\r\n * @returns Top-most modal Frontstage, or undefined if there is none.\r\n */\r\n readonly activeModalFrontstage: ModalFrontstageInfo | undefined;\r\n\r\n /** Gets the number of modal Frontstages.\r\n * @returns Modal Frontstage count\r\n */\r\n readonly modalFrontstageCount: number;\r\n\r\n /** Sets the active Navigation Aid via its Id.\r\n * @param navigationAidId Id of the Navigation Aid to set as active\r\n * @param iModelConnection IModelConnection to query for view data\r\n */\r\n setActiveNavigationAid(navigationAidId: string, iModelConnection: IModelConnection): void;\r\n\r\n /** Sets the state of the widget with the given id\r\n * @param widgetId Id of the Widget for which to set the state\r\n * @param state New state of the widget\r\n * @returns true if the widget state was set successfully, or false if not.\r\n */\r\n setWidgetState(widgetId: string, state: WidgetState): boolean;\r\n\r\n /** Finds a widget with the given id in the active frontstage\r\n * @param widgetId Id of the Widget to find\r\n * @returns The WidgetDef with the given id, or undefined if not found.\r\n */\r\n findWidget(widgetId: string): WidgetDef | undefined;\r\n\r\n /** Opens a nested Frontstage. Nested Frontstages can be stacked.\r\n * @param nestedFrontstage Information about the nested Frontstage\r\n */\r\n openNestedFrontstage(nestedFrontstage: FrontstageDef): Promise<void>;\r\n\r\n /** Closes the top-most nested Frontstage.\r\n */\r\n closeNestedFrontstage(): Promise<void>;\r\n\r\n /** Gets the top-most nested Frontstage.\r\n * @returns Top-most nested Frontstage, or undefined if there is none.\r\n */\r\n readonly activeNestedFrontstage: FrontstageDef | undefined;\r\n\r\n /** Gets the number of nested Frontstages.\r\n * @returns Nested Frontstage count\r\n */\r\n readonly nestedFrontstageCount: number;\r\n}\r\n"]}
1
+ {"version":3,"file":"FrameworkFrontstages.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkFrontstages.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAqBhD;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,OAAqC;CAAI;AAmBvF;;GAEG;AACH,MAAM,OAAO,0BAA2B,SAAQ,OAAuC;CAAI;AAS3F;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,OAAiC;CAAI;AAS/E;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,OAAwC;CAAI;AAiB7F;;;;;;GAMG;AACH,MAAM,OAAO,kCAAmC,SAAQ,OAA+C;CAAI;AAY3G;;GAEG;AACH,MAAM,OAAO,0BAA2B,SAAQ,OAAuC;CAAI;AAS3F;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,OAA+B;CAAI;AAS3E;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,OAAiC;CAAI","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 Frontstage\r\n */\r\nimport { UiEvent } from \"@itwin/appui-abstract\";\r\nimport { IModelConnection, Tool } from \"@itwin/core-frontend\";\r\nimport { ToolInformation } from \"../toolsettings/ToolInformation\";\r\nimport { TimeTracker } from \"../configurableui/TimeTracker\";\r\nimport { ContentControlActivatedEvent } from \"../content/ContentControl\";\r\nimport { ContentLayoutActivatedEvent } from \"../content/ContentLayout\";\r\nimport { FrontstageDef } from \"../frontstage/FrontstageDef\";\r\nimport { FrontstageProvider } from \"../frontstage/FrontstageProvider\";\r\nimport { NavigationAidActivatedEvent } from \"../navigationaids/NavigationAidControl\";\r\nimport { PanelPinnedChangedEventArgs, PanelStateChangedEvent } from \"../stagepanels/StagePanelDef\";\r\nimport { WidgetDef, WidgetStateChangedEvent } from \"../widgets/WidgetDef\";\r\nimport { WidgetState } from \"../widgets/WidgetState\";\r\n\r\n/** Frontstage Activated Event Args interface.\r\n * @public\r\n */\r\nexport interface FrontstageActivatedEventArgs {\r\n deactivatedFrontstageDef?: FrontstageDef;\r\n activatedFrontstageDef: FrontstageDef;\r\n}\r\n\r\n/** Frontstage Activated Event class.\r\n * @public\r\n */\r\nexport class FrontstageActivatedEvent extends UiEvent<FrontstageActivatedEventArgs> { }\r\n\r\n/** Frontstage Deactivated Event Args interface.\r\n * @public\r\n */\r\nexport interface FrontstageDeactivatedEventArgs {\r\n /** Frontstage being deactivated */\r\n deactivatedFrontstageDef: FrontstageDef;\r\n /** Frontstage being activated */\r\n activatedFrontstageDef?: FrontstageDef;\r\n\r\n /** Total time spent in frontstage */\r\n totalTime: number;\r\n /** Engagement time spent in frontstage */\r\n engagementTime: number;\r\n /** Idle time spent in frontstage */\r\n idleTime: number;\r\n}\r\n\r\n/** Frontstage Deactivated Event class.\r\n * @public\r\n */\r\nexport class FrontstageDeactivatedEvent extends UiEvent<FrontstageDeactivatedEventArgs> { }\r\n\r\n/** Frontstage Ready Event Args interface.\r\n * @public\r\n */\r\nexport interface FrontstageReadyEventArgs {\r\n frontstageDef: FrontstageDef;\r\n}\r\n\r\n/** Frontstage Ready Event class.\r\n * @public\r\n */\r\nexport class FrontstageReadyEvent extends UiEvent<FrontstageReadyEventArgs> { }\r\n\r\n/** Modal Frontstage Changed Event Args interface.\r\n * @public\r\n */\r\nexport interface ModalFrontstageChangedEventArgs {\r\n modalFrontstageCount: number;\r\n}\r\n\r\n/** Modal Frontstage Stack Changed Event class.\r\n * @public\r\n */\r\nexport class ModalFrontstageChangedEvent extends UiEvent<ModalFrontstageChangedEventArgs> { }\r\n\r\n/** Modal Frontstage Closed Event Args interface.\r\n * @public\r\n */\r\nexport interface ModalFrontstageClosedEventArgs {\r\n /** Modal Frontstage being closed */\r\n modalFrontstage: ModalFrontstageInfo;\r\n\r\n /** Total time spent in frontstage */\r\n totalTime: number;\r\n /** Engagement time spent in frontstage */\r\n engagementTime: number;\r\n /** Idle time spent in frontstage */\r\n idleTime: number;\r\n}\r\n\r\n/** Modal Frontstage Requested Close Event class. Notifies the modal stage that the close button was\r\n * pressed and passes the function to actually close the modal stage. This allows stage to do any\r\n * saving of unsaved data prior to closing the stage. If the ModalFrontstageInfo sets notifyCloseRequest\r\n * to true it is up to the stage to register for this event and call the stageCloseFunc once it has saved\r\n * any unsaved data.\r\n * @alpha\r\n */\r\nexport class ModalFrontstageRequestedCloseEvent extends UiEvent<ModalFrontstageRequestedCloseEventArgs> { }\r\n\r\n/** Modal Frontstage RequestedClose Event Args interface.\r\n * @alpha\r\n */\r\nexport interface ModalFrontstageRequestedCloseEventArgs {\r\n /** Modal Frontstage that is to be closed */\r\n modalFrontstage: ModalFrontstageInfo;\r\n /** Function to call to close the stage */\r\n stageCloseFunc: () => void;\r\n}\r\n\r\n/** Modal Frontstage Closed Event class.\r\n * @public\r\n */\r\nexport class ModalFrontstageClosedEvent extends UiEvent<ModalFrontstageClosedEventArgs> { }\r\n\r\n/** Tool Activated Event Args interface.\r\n * @public\r\n */\r\nexport interface ToolActivatedEventArgs {\r\n toolId: string;\r\n}\r\n\r\n/** Tool Activated Event class.\r\n * @public\r\n */\r\nexport class ToolActivatedEvent extends UiEvent<ToolActivatedEventArgs> { }\r\n\r\n/** Tool Icon Changed Event Args interface.\r\n * @public\r\n */\r\nexport interface ToolIconChangedEventArgs {\r\n iconSpec: string;\r\n}\r\n\r\n/** Tool Icon Changed Event class.\r\n * @public\r\n */\r\nexport class ToolIconChangedEvent extends UiEvent<ToolIconChangedEventArgs> { }\r\n\r\n/** Modal Frontstage information interface.\r\n * @public\r\n */\r\nexport interface ModalFrontstageInfo {\r\n title: string;\r\n content: React.ReactNode;\r\n appBarRight?: React.ReactNode;\r\n /** Set notifyCloseRequest to true on stages that register to listen for `onCloseModalFrontstageRequestedEvent` so\r\n * that the stage can save unsaved data before closing. Used by the ModalSettingsStage.\r\n * @alpha */\r\n notifyCloseRequest?: boolean;\r\n}\r\n\r\n/** Modal Frontstage array item interface.\r\n * @internal\r\n */\r\nexport interface ModalFrontstageItem {\r\n modalFrontstage: ModalFrontstageInfo;\r\n timeTracker: TimeTracker;\r\n}\r\n\r\n/**\r\n * [[UiFramework.frontstages]] interface\r\n * @public\r\n */\r\nexport interface FrameworkFrontstages {\r\n /** Returns true if Frontstage is loading its controls. If false the Frontstage content and controls have been created. */\r\n readonly isLoading: boolean;\r\n\r\n /** Get Frontstage Deactivated event. */\r\n readonly onFrontstageDeactivatedEvent: FrontstageDeactivatedEvent;\r\n\r\n /** Get Frontstage Activated event. */\r\n readonly onFrontstageActivatedEvent: FrontstageActivatedEvent;\r\n\r\n /** Get Frontstage Activated event. */\r\n readonly onFrontstageReadyEvent: FrontstageReadyEvent;\r\n\r\n /** Get Modal Frontstage Changed event. */\r\n readonly onModalFrontstageChangedEvent: ModalFrontstageChangedEvent;\r\n\r\n /** Get Modal Frontstage Closed event. */\r\n readonly onModalFrontstageClosedEvent: ModalFrontstageClosedEvent;\r\n\r\n /** Get Modal Frontstage Requested Closed event.\r\n * @alpha\r\n */\r\n readonly onCloseModalFrontstageRequestedEvent: ModalFrontstageRequestedCloseEvent;\r\n\r\n /** Get Tool Activated event. */\r\n readonly onToolActivatedEvent: ToolActivatedEvent;\r\n\r\n /** Get ToolSetting Reload event. */\r\n readonly onToolSettingsReloadEvent: UiEvent<void>;\r\n\r\n /** Get Tool Icon Changed event. */\r\n readonly onToolIconChangedEvent: ToolIconChangedEvent;\r\n\r\n /** Get Content Layout Activated event. */\r\n readonly onContentLayoutActivatedEvent: ContentLayoutActivatedEvent;\r\n\r\n /** Get Content Control Activated event. */\r\n readonly onContentControlActivatedEvent: ContentControlActivatedEvent;\r\n\r\n /** Get Navigation Aid Activated event. */\r\n readonly onNavigationAidActivatedEvent: NavigationAidActivatedEvent;\r\n\r\n /** Get Widget State Changed event. */\r\n readonly onWidgetStateChangedEvent: WidgetStateChangedEvent;\r\n\r\n /** Get panel state changed event.\r\n * @alpha\r\n */\r\n readonly onPanelStateChangedEvent: PanelStateChangedEvent;\r\n\r\n /** Get panel pinned changed event.\r\n * @alpha\r\n */\r\n readonly onPanelPinnedChangedEvent: UiEvent<PanelPinnedChangedEventArgs>;\r\n\r\n /** Clears the Frontstage map.\r\n */\r\n clearFrontstageDefs(): void;\r\n\r\n /** Clears the Frontstage Providers and the defs that may have been created from them.\r\n */\r\n clearFrontstageProviders(): void;\r\n\r\n /** Add a Frontstage via a [[FrontstageProvider]].\r\n * @param frontstageProvider FrontstageProvider representing the Frontstage to add\r\n */\r\n addFrontstageProvider(frontstageProvider: FrontstageProvider): void;\r\n\r\n /** Find a loaded Frontstage with a given id. If the id is not provided, the active Frontstage is returned. If\r\n * no cached FrontstageDef is found but a FrontstageProvider is registered a FrontstageDef will be created, cached, and\r\n * returned.\r\n * @param id Id of the Frontstage to find\r\n * @returns FrontstageDef with a given id if found, or undefined if not found.\r\n */\r\n getFrontstageDef(id?: string): Promise<FrontstageDef | undefined>;\r\n\r\n /** Gets the active FrontstageDef. If a Frontstage is not active, undefined is returned.\r\n * @return Active FrontstageDef, or undefined if one is not active.\r\n */\r\n readonly activeFrontstageDef: FrontstageDef | undefined;\r\n\r\n /** Gets the Id of the active FrontstageDef. If a Frontstage is not active, blank is returned.\r\n * @return Id of the active FrontstageDef, or blank if one is not active.\r\n */\r\n readonly activeFrontstageId: string;\r\n\r\n hasFrontstage(frontstageId: string): boolean;\r\n\r\n /** Sets the active FrontstageDef give the stageId.\r\n * @param frontstageId Id of the Frontstage to set active.\r\n * @returns A Promise that is fulfilled when the [[Frontstage]] is ready.\r\n */\r\n setActiveFrontstage(frontstageId: string): Promise<void>;\r\n\r\n /** Sets the active FrontstageDef.\r\n * @param frontstageDef FrontstageDef to set active.\r\n * @returns A Promise that is fulfilled when the [[FrontstageDef]] is ready.\r\n */\r\n setActiveFrontstageDef(frontstageDef: FrontstageDef | undefined): Promise<void>;\r\n\r\n /** Deactivates the active FrontstageDef.\r\n */\r\n deactivateFrontstageDef(): Promise<void>;\r\n\r\n /** Gets the Id of the active tool. If a tool is not active, blank is returned.\r\n * @return Id of the active tool, or blank if one is not active.\r\n */\r\n readonly activeToolId: string;\r\n\r\n /** Sets the active tool id */\r\n setActiveToolId(toolId: string): void;\r\n\r\n /** Sets the active tool */\r\n setActiveTool(tool: Tool): void;\r\n\r\n /** Gets the active tool's [[ToolInformation]] */\r\n readonly activeToolInformation: ToolInformation | undefined;\r\n\r\n /** Opens a modal Frontstage. Modal Frontstages can be stacked.\r\n * @param modalFrontstage Information about the modal Frontstage\r\n */\r\n openModalFrontstage(modalFrontstage: ModalFrontstageInfo): void;\r\n\r\n /** Closes the top-most modal Frontstage.\r\n */\r\n closeModalFrontstage(): void;\r\n\r\n /** Updates the top-most modal Frontstage.\r\n */\r\n updateModalFrontstage(): void;\r\n\r\n /** Gets the top-most modal Frontstage.\r\n * @returns Top-most modal Frontstage, or undefined if there is none.\r\n */\r\n readonly activeModalFrontstage: ModalFrontstageInfo | undefined;\r\n\r\n /** Gets the number of modal Frontstages.\r\n * @returns Modal Frontstage count\r\n */\r\n readonly modalFrontstageCount: number;\r\n\r\n /** Sets the active Navigation Aid via its Id.\r\n * @param navigationAidId Id of the Navigation Aid to set as active\r\n * @param iModelConnection IModelConnection to query for view data\r\n */\r\n setActiveNavigationAid(navigationAidId: string, iModelConnection: IModelConnection): void;\r\n\r\n /** Sets the state of the widget with the given id\r\n * @param widgetId Id of the Widget for which to set the state\r\n * @param state New state of the widget\r\n * @returns true if the widget state was set successfully, or false if not.\r\n */\r\n setWidgetState(widgetId: string, state: WidgetState): boolean;\r\n\r\n /** Finds a widget with the given id in the active frontstage\r\n * @param widgetId Id of the Widget to find\r\n * @returns The WidgetDef with the given id, or undefined if not found.\r\n */\r\n findWidget(widgetId: string): WidgetDef | undefined;\r\n\r\n /** Opens a nested Frontstage. Nested Frontstages can be stacked.\r\n * @param nestedFrontstage Information about the nested Frontstage\r\n */\r\n openNestedFrontstage(nestedFrontstage: FrontstageDef): Promise<void>;\r\n\r\n /** Closes the top-most nested Frontstage.\r\n */\r\n closeNestedFrontstage(): Promise<void>;\r\n\r\n /** Gets the top-most nested Frontstage.\r\n * @returns Top-most nested Frontstage, or undefined if there is none.\r\n */\r\n readonly activeNestedFrontstage: FrontstageDef | undefined;\r\n\r\n /** Gets the number of nested Frontstages.\r\n * @returns Nested Frontstage count\r\n */\r\n readonly nestedFrontstageCount: number;\r\n}\r\n"]}
@@ -71,7 +71,7 @@ export interface FrameworkKeyboardShortcutContainer {
71
71
  }
72
72
  /**
73
73
  * [[UiFramework.keyboardShortcuts]] interface
74
- * @beta
74
+ * @public
75
75
  */
76
76
  export interface FrameworkKeyboardShortcuts {
77
77
  /** Loads Keyboard Shortcuts into the managed list */
@@ -1 +1 @@
1
- {"version":3,"file":"FrameworkKeyboardShortcuts.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkKeyboardShortcuts.ts"],"names":[],"mappings":"","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 KeyboardShortcut\r\n */\r\nimport { FunctionKey, SpecialKey } from \"@itwin/appui-abstract\";\r\nimport { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\r\nimport { ItemDefBase } from \"../shared/ItemDefBase\";\r\nimport { ItemProps } from \"../shared/ItemProps\";\r\n\r\n/** Properties for a Keyboard Shortcut\r\n * @public\r\n */\r\nexport interface KeyboardShortcutProps extends ItemProps {\r\n /** The key that invokes the shortcut.\r\n * This is either an alphanumeric key, a function key or a special key.\r\n */\r\n key: string | FunctionKey | SpecialKey;\r\n\r\n /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified. */\r\n item?: ActionButtonItemDef;\r\n /** Nested array of shortcut props. Either 'item' or 'shortcuts' must be specified. */\r\n shortcuts?: KeyboardShortcutProps[];\r\n\r\n /** Indicates whether the Alt key required. Default - false */\r\n isAltKeyRequired?: boolean;\r\n /** Indicates whether the Ctrl key required. Default - false */\r\n isCtrlKeyRequired?: boolean;\r\n /** Indicates whether the Shift key required. Default - false */\r\n isShiftKeyRequired?: boolean;\r\n}\r\n\r\n/** Keyboard Shortcut used to execute an action\r\n * @public\r\n */\r\nexport interface FrameworkKeyboardShortcut extends ItemDefBase {\r\n /** Returns the id for this shortcut */\r\n readonly id: string;\r\n\r\n /** Returns the shortcut container */\r\n readonly shortcutContainer: FrameworkKeyboardShortcutContainer;\r\n\r\n /** Finds a shortcut with a given key in the shortcut's container */\r\n getShortcut(mapKey: string): FrameworkKeyboardShortcut | undefined;\r\n\r\n /** Returns the shortcut's key map key used as the id */\r\n readonly keyMapKey: string;\r\n\r\n /** Returns the [[ActionButtonItemDef]] associated with this shortcut */\r\n readonly item: ActionButtonItemDef | undefined;\r\n\r\n /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */\r\n itemPicked(): void;\r\n\r\n /** Gets the keyboard key */\r\n readonly key: string;\r\n /** Gets whether the Alt key required. */\r\n readonly isAltKeyRequired: boolean;\r\n /** Gets whether the Ctrl key required. */\r\n readonly isCtrlKeyRequired: boolean;\r\n /** Gets whether the Shift key required. */\r\n readonly isShiftKeyRequired: boolean;\r\n /** Gets whether this is a Function key. */\r\n readonly isFunctionKey: boolean;\r\n /** Gets whether this is a Special key. */\r\n readonly isSpecialKey: boolean;\r\n\r\n}\r\n\r\n/** Keyboard Shortcut Container\r\n * @public\r\n */\r\nexport interface FrameworkKeyboardShortcutContainer {\r\n /** Registers a Keyboard Shortcut associated with a given key in the managed list */\r\n registerKey(keyMapKey: string, inShortcut: FrameworkKeyboardShortcut): FrameworkKeyboardShortcut | undefined;\r\n\r\n /** Finds a Keyboard Shortcut associated with a given key */\r\n findKey(keyMapKey: string): FrameworkKeyboardShortcut | undefined;\r\n\r\n /** Determines if any Keyboard Shortcuts are available in this container */\r\n areKeyboardShortcutsAvailable(): boolean;\r\n\r\n /** Empties any Keyboard Shortcuts from this container */\r\n emptyData(): void;\r\n\r\n getAvailableKeyboardShortcuts(): FrameworkKeyboardShortcut[];\r\n\r\n /** Displays a menu for the Keyboard Shortcuts in this container */\r\n showShortcutsMenu(): void;\r\n}\r\n\r\n/**\r\n * [[UiFramework.keyboardShortcuts]] interface\r\n * @beta\r\n */\r\nexport interface FrameworkKeyboardShortcuts {\r\n /** Loads Keyboard Shortcuts into the managed list */\r\n loadShortcuts(shortcutList: KeyboardShortcutProps[]): void;\r\n\r\n /** Loads a Keyboard Shortcut into the managed list */\r\n loadShortcut(shortcutProps: KeyboardShortcutProps): void;\r\n\r\n /** Processes a keystroke and invokes a matching Keyboard Shortcut */\r\n processKey(keyboardKey: string, isAltKeyPressed?: boolean, isCtrlKeyPressed?: boolean, isShiftKeyPressed?: boolean): boolean;\r\n\r\n /** Returns the managed list of Keyboard Shortcuts */\r\n readonly shortcutContainer: FrameworkKeyboardShortcutContainer;\r\n\r\n /** Returns a Keyboard Shortcut from the managed lists */\r\n getShortcut(keyMapKey: string): FrameworkKeyboardShortcut | undefined;\r\n\r\n /** Determines if focus is set to Home */\r\n readonly isFocusOnHome: boolean;\r\n\r\n /** Sets focus to Home */\r\n setFocusToHome(): void;\r\n\r\n /** Displays the Keyboard Shortcuts menu at the cursor */\r\n displayMenu(): void;\r\n\r\n /** Closes the Keyboard Shortcuts menu */\r\n closeMenu(): void;\r\n\r\n /** Returns the cursor X position, which is mouseEvent.pageX. */\r\n readonly cursorX: number;\r\n /** Returns the cursor Y position, which is mouseEvent.pageY. */\r\n readonly cursorY: number;\r\n}\r\n"]}
1
+ {"version":3,"file":"FrameworkKeyboardShortcuts.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkKeyboardShortcuts.ts"],"names":[],"mappings":"","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 KeyboardShortcut\r\n */\r\nimport { FunctionKey, SpecialKey } from \"@itwin/appui-abstract\";\r\nimport { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\r\nimport { ItemDefBase } from \"../shared/ItemDefBase\";\r\nimport { ItemProps } from \"../shared/ItemProps\";\r\n\r\n/** Properties for a Keyboard Shortcut\r\n * @public\r\n */\r\nexport interface KeyboardShortcutProps extends ItemProps {\r\n /** The key that invokes the shortcut.\r\n * This is either an alphanumeric key, a function key or a special key.\r\n */\r\n key: string | FunctionKey | SpecialKey;\r\n\r\n /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified. */\r\n item?: ActionButtonItemDef;\r\n /** Nested array of shortcut props. Either 'item' or 'shortcuts' must be specified. */\r\n shortcuts?: KeyboardShortcutProps[];\r\n\r\n /** Indicates whether the Alt key required. Default - false */\r\n isAltKeyRequired?: boolean;\r\n /** Indicates whether the Ctrl key required. Default - false */\r\n isCtrlKeyRequired?: boolean;\r\n /** Indicates whether the Shift key required. Default - false */\r\n isShiftKeyRequired?: boolean;\r\n}\r\n\r\n/** Keyboard Shortcut used to execute an action\r\n * @public\r\n */\r\nexport interface FrameworkKeyboardShortcut extends ItemDefBase {\r\n /** Returns the id for this shortcut */\r\n readonly id: string;\r\n\r\n /** Returns the shortcut container */\r\n readonly shortcutContainer: FrameworkKeyboardShortcutContainer;\r\n\r\n /** Finds a shortcut with a given key in the shortcut's container */\r\n getShortcut(mapKey: string): FrameworkKeyboardShortcut | undefined;\r\n\r\n /** Returns the shortcut's key map key used as the id */\r\n readonly keyMapKey: string;\r\n\r\n /** Returns the [[ActionButtonItemDef]] associated with this shortcut */\r\n readonly item: ActionButtonItemDef | undefined;\r\n\r\n /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */\r\n itemPicked(): void;\r\n\r\n /** Gets the keyboard key */\r\n readonly key: string;\r\n /** Gets whether the Alt key required. */\r\n readonly isAltKeyRequired: boolean;\r\n /** Gets whether the Ctrl key required. */\r\n readonly isCtrlKeyRequired: boolean;\r\n /** Gets whether the Shift key required. */\r\n readonly isShiftKeyRequired: boolean;\r\n /** Gets whether this is a Function key. */\r\n readonly isFunctionKey: boolean;\r\n /** Gets whether this is a Special key. */\r\n readonly isSpecialKey: boolean;\r\n\r\n}\r\n\r\n/** Keyboard Shortcut Container\r\n * @public\r\n */\r\nexport interface FrameworkKeyboardShortcutContainer {\r\n /** Registers a Keyboard Shortcut associated with a given key in the managed list */\r\n registerKey(keyMapKey: string, inShortcut: FrameworkKeyboardShortcut): FrameworkKeyboardShortcut | undefined;\r\n\r\n /** Finds a Keyboard Shortcut associated with a given key */\r\n findKey(keyMapKey: string): FrameworkKeyboardShortcut | undefined;\r\n\r\n /** Determines if any Keyboard Shortcuts are available in this container */\r\n areKeyboardShortcutsAvailable(): boolean;\r\n\r\n /** Empties any Keyboard Shortcuts from this container */\r\n emptyData(): void;\r\n\r\n getAvailableKeyboardShortcuts(): FrameworkKeyboardShortcut[];\r\n\r\n /** Displays a menu for the Keyboard Shortcuts in this container */\r\n showShortcutsMenu(): void;\r\n}\r\n\r\n/**\r\n * [[UiFramework.keyboardShortcuts]] interface\r\n * @public\r\n */\r\nexport interface FrameworkKeyboardShortcuts {\r\n /** Loads Keyboard Shortcuts into the managed list */\r\n loadShortcuts(shortcutList: KeyboardShortcutProps[]): void;\r\n\r\n /** Loads a Keyboard Shortcut into the managed list */\r\n loadShortcut(shortcutProps: KeyboardShortcutProps): void;\r\n\r\n /** Processes a keystroke and invokes a matching Keyboard Shortcut */\r\n processKey(keyboardKey: string, isAltKeyPressed?: boolean, isCtrlKeyPressed?: boolean, isShiftKeyPressed?: boolean): boolean;\r\n\r\n /** Returns the managed list of Keyboard Shortcuts */\r\n readonly shortcutContainer: FrameworkKeyboardShortcutContainer;\r\n\r\n /** Returns a Keyboard Shortcut from the managed lists */\r\n getShortcut(keyMapKey: string): FrameworkKeyboardShortcut | undefined;\r\n\r\n /** Determines if focus is set to Home */\r\n readonly isFocusOnHome: boolean;\r\n\r\n /** Sets focus to Home */\r\n setFocusToHome(): void;\r\n\r\n /** Displays the Keyboard Shortcuts menu at the cursor */\r\n displayMenu(): void;\r\n\r\n /** Closes the Keyboard Shortcuts menu */\r\n closeMenu(): void;\r\n\r\n /** Returns the cursor X position, which is mouseEvent.pageX. */\r\n readonly cursorX: number;\r\n /** Returns the cursor Y position, which is mouseEvent.pageY. */\r\n readonly cursorY: number;\r\n}\r\n"]}
@@ -17,7 +17,7 @@ export declare class SyncToolSettingsPropertiesEvent extends UiEvent<SyncToolSet
17
17
  }
18
18
  /**
19
19
  * [[UiFramework.toolSettings]] interface
20
- * @beta
20
+ * @public
21
21
  */
22
22
  export interface FrameworkToolSettings {
23
23
  /** clear cached Tool Settings properties. */
@@ -1 +1 @@
1
- {"version":3,"file":"FrameworkToolSettings.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkToolSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAsC,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAWpF;;GAEG;AACH,MAAM,OAAO,+BAAgC,SAAQ,OAA4C;CAAI","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 ToolSettings\r\n */\r\nimport { DialogItem, DialogPropertySyncItem, UiEvent } from \"@itwin/appui-abstract\";\r\nimport { InteractiveTool } from \"@itwin/core-frontend\";\r\n\r\n/** Sync Tool Settings Properties Event Args interface.\r\n * @public\r\n */\r\nexport interface SyncToolSettingsPropertiesEventArgs {\r\n toolId: string;\r\n syncProperties: DialogPropertySyncItem[];\r\n}\r\n\r\n/** Sync Tool Settings Properties Event class.\r\n * @public\r\n */\r\nexport class SyncToolSettingsPropertiesEvent extends UiEvent<SyncToolSettingsPropertiesEventArgs> { }\r\n\r\n/**\r\n * [[UiFramework.toolSettings]] interface\r\n * @beta\r\n */\r\nexport interface FrameworkToolSettings {\r\n /** clear cached Tool Settings properties. */\r\n clearToolSettingsData(): void;\r\n\r\n /** Cache Tool Settings properties */\r\n initializeToolSettingsData(toolSettingsProperties: DialogItem[] | undefined, toolId?: string, toolLabel?: string, toolDescription?: string): boolean;\r\n\r\n /** Set of data used in Tool Settings for the specified tool. The tool specified should be the \"active\" tool.\r\n */\r\n initializeDataForTool(tool: InteractiveTool): void;\r\n\r\n /** Returns the toolSettings properties that can be used to populate the tool settings widget. */\r\n readonly toolSettingsProperties: DialogItem[];\r\n\r\n /** Returns true if the Tool Settings are to be auto populated from the toolSettingsProperties.\r\n * The setter is chiefly for testing.\r\n */\r\n useDefaultToolSettingsProvider: boolean;\r\n\r\n /** The name of the active tool. This is typically the flyover text specified for the tool. */\r\n activeToolLabel: string;\r\n\r\n /** Returns the description of the active tool. */\r\n readonly activeToolDescription: string;\r\n\r\n /** Get ToolSettings Properties sync event. */\r\n readonly onSyncToolSettingsProperties: SyncToolSettingsPropertiesEvent;\r\n readonly onReloadToolSettingsProperties: UiEvent<void>;\r\n\r\n /** Gets the Id of the active tool. If a tool is not active, blank is returned.\r\n * @return Id of the active tool, or blank if one is not active.\r\n */\r\n readonly toolIdForToolSettings: string;\r\n\r\n /**\r\n * Sets the focus on the ToolSettings UI element.\r\n */\r\n focusIntoToolSettings(): boolean;\r\n}\r\n"]}
1
+ {"version":3,"file":"FrameworkToolSettings.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkToolSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAsC,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAWpF;;GAEG;AACH,MAAM,OAAO,+BAAgC,SAAQ,OAA4C;CAAI","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 ToolSettings\r\n */\r\nimport { DialogItem, DialogPropertySyncItem, UiEvent } from \"@itwin/appui-abstract\";\r\nimport { InteractiveTool } from \"@itwin/core-frontend\";\r\n\r\n/** Sync Tool Settings Properties Event Args interface.\r\n * @public\r\n */\r\nexport interface SyncToolSettingsPropertiesEventArgs {\r\n toolId: string;\r\n syncProperties: DialogPropertySyncItem[];\r\n}\r\n\r\n/** Sync Tool Settings Properties Event class.\r\n * @public\r\n */\r\nexport class SyncToolSettingsPropertiesEvent extends UiEvent<SyncToolSettingsPropertiesEventArgs> { }\r\n\r\n/**\r\n * [[UiFramework.toolSettings]] interface\r\n * @public\r\n */\r\nexport interface FrameworkToolSettings {\r\n /** clear cached Tool Settings properties. */\r\n clearToolSettingsData(): void;\r\n\r\n /** Cache Tool Settings properties */\r\n initializeToolSettingsData(toolSettingsProperties: DialogItem[] | undefined, toolId?: string, toolLabel?: string, toolDescription?: string): boolean;\r\n\r\n /** Set of data used in Tool Settings for the specified tool. The tool specified should be the \"active\" tool.\r\n */\r\n initializeDataForTool(tool: InteractiveTool): void;\r\n\r\n /** Returns the toolSettings properties that can be used to populate the tool settings widget. */\r\n readonly toolSettingsProperties: DialogItem[];\r\n\r\n /** Returns true if the Tool Settings are to be auto populated from the toolSettingsProperties.\r\n * The setter is chiefly for testing.\r\n */\r\n useDefaultToolSettingsProvider: boolean;\r\n\r\n /** The name of the active tool. This is typically the flyover text specified for the tool. */\r\n activeToolLabel: string;\r\n\r\n /** Returns the description of the active tool. */\r\n readonly activeToolDescription: string;\r\n\r\n /** Get ToolSettings Properties sync event. */\r\n readonly onSyncToolSettingsProperties: SyncToolSettingsPropertiesEvent;\r\n readonly onReloadToolSettingsProperties: UiEvent<void>;\r\n\r\n /** Gets the Id of the active tool. If a tool is not active, blank is returned.\r\n * @return Id of the active tool, or blank if one is not active.\r\n */\r\n readonly toolIdForToolSettings: string;\r\n\r\n /**\r\n * Sets the focus on the ToolSettings UI element.\r\n */\r\n focusIntoToolSettings(): boolean;\r\n}\r\n"]}
@@ -4,7 +4,7 @@
4
4
  */
5
5
  /**
6
6
  * [[UiFramework.visibility]] interface
7
- * @beta
7
+ * @public
8
8
  */
9
9
  export interface FrameworkVisibility {
10
10
  /** Determines if the Ui is visible */