@zsviczian/excalidraw 0.17.1-obsidian-55 → 0.17.1-obsidian-56

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 (367) hide show
  1. package/dist/excalidraw.development.js +86 -86
  2. package/dist/excalidraw.production.min.js +1 -1
  3. package/package.json +1 -1
  4. package/types/excalidraw/actions/actionAddToLibrary.d.ts +605 -605
  5. package/types/excalidraw/actions/actionAlign.d.ts +108 -108
  6. package/types/excalidraw/actions/actionBoundText.d.ts +440 -440
  7. package/types/excalidraw/actions/actionCanvas.d.ts +2958 -2958
  8. package/types/excalidraw/actions/actionClipboard.d.ts +1507 -1507
  9. package/types/excalidraw/actions/actionDeleteSelected.d.ts +640 -640
  10. package/types/excalidraw/actions/actionDistribute.d.ts +34 -34
  11. package/types/excalidraw/actions/actionDuplicateSelection.d.ts +21 -21
  12. package/types/excalidraw/actions/actionElementLock.d.ts +428 -428
  13. package/types/excalidraw/actions/actionExport.d.ts +1884 -1884
  14. package/types/excalidraw/actions/actionFinalize.d.ts +409 -409
  15. package/types/excalidraw/actions/actionFlip.d.ts +34 -34
  16. package/types/excalidraw/actions/actionFrame.d.ts +855 -855
  17. package/types/excalidraw/actions/actionGroup.d.ts +438 -438
  18. package/types/excalidraw/actions/actionHistory.d.ts +7 -7
  19. package/types/excalidraw/actions/actionLinearEditor.d.ts +215 -215
  20. package/types/excalidraw/actions/actionLink.d.ts +215 -215
  21. package/types/excalidraw/actions/actionMenu.d.ts +628 -628
  22. package/types/excalidraw/actions/actionNavigate.d.ts +414 -414
  23. package/types/excalidraw/actions/actionProperties.d.ts +3156 -3156
  24. package/types/excalidraw/actions/actionSelectAll.d.ts +214 -214
  25. package/types/excalidraw/actions/actionStyles.d.ts +228 -228
  26. package/types/excalidraw/actions/actionTextAutoResize.d.ts +17 -17
  27. package/types/excalidraw/actions/actionToggleGridMode.d.ts +217 -217
  28. package/types/excalidraw/actions/actionToggleObjectsSnapMode.d.ts +215 -215
  29. package/types/excalidraw/actions/actionToggleSearchMenu.d.ts +407 -407
  30. package/types/excalidraw/actions/actionToggleStats.d.ts +215 -215
  31. package/types/excalidraw/actions/actionToggleViewMode.d.ts +216 -216
  32. package/types/excalidraw/actions/actionToggleZenMode.d.ts +216 -216
  33. package/types/excalidraw/actions/actionZindex.d.ts +74 -74
  34. package/types/excalidraw/actions/index.d.ts +26 -26
  35. package/types/excalidraw/actions/manager.d.ts +21 -21
  36. package/types/excalidraw/actions/register.d.ts +5 -5
  37. package/types/excalidraw/actions/shortcuts.d.ts +4 -4
  38. package/types/excalidraw/actions/types.d.ts +47 -47
  39. package/types/excalidraw/align.d.ts +6 -6
  40. package/types/excalidraw/analytics.d.ts +1 -1
  41. package/types/excalidraw/animated-trail.d.ts +33 -33
  42. package/types/excalidraw/animation-frame-handler.d.ts +16 -16
  43. package/types/excalidraw/appState.d.ts +89 -89
  44. package/types/excalidraw/binaryheap.d.ts +12 -12
  45. package/types/excalidraw/change.d.ts +191 -191
  46. package/types/excalidraw/charts.d.ts +27 -27
  47. package/types/excalidraw/clients.d.ts +14 -14
  48. package/types/excalidraw/clipboard.d.ts +44 -44
  49. package/types/excalidraw/colors.d.ts +61 -61
  50. package/types/excalidraw/components/Actions.d.ts +34 -34
  51. package/types/excalidraw/components/ActiveConfirmDialog.d.ts +4 -4
  52. package/types/excalidraw/components/App.d.ts +535 -535
  53. package/types/excalidraw/components/Avatar.d.ts +11 -11
  54. package/types/excalidraw/components/BraveMeasureTextError.d.ts +2 -2
  55. package/types/excalidraw/components/Button.d.ts +17 -17
  56. package/types/excalidraw/components/ButtonIcon.d.ts +14 -14
  57. package/types/excalidraw/components/ButtonIconCycle.d.ts +10 -10
  58. package/types/excalidraw/components/ButtonIconSelect.d.ts +19 -19
  59. package/types/excalidraw/components/ButtonSelect.d.ts +9 -9
  60. package/types/excalidraw/components/ButtonSeparator.d.ts +1 -1
  61. package/types/excalidraw/components/Card.d.ts +6 -6
  62. package/types/excalidraw/components/CheckboxItem.d.ts +8 -8
  63. package/types/excalidraw/components/ColorPicker/ColorInput.d.ts +9 -9
  64. package/types/excalidraw/components/ColorPicker/ColorPicker.d.ts +19 -19
  65. package/types/excalidraw/components/ColorPicker/CustomColorList.d.ts +8 -8
  66. package/types/excalidraw/components/ColorPicker/HotkeyLabel.d.ts +8 -8
  67. package/types/excalidraw/components/ColorPicker/Picker.d.ts +18 -18
  68. package/types/excalidraw/components/ColorPicker/PickerColorList.d.ts +10 -10
  69. package/types/excalidraw/components/ColorPicker/PickerHeading.d.ts +5 -5
  70. package/types/excalidraw/components/ColorPicker/ShadeList.d.ts +8 -8
  71. package/types/excalidraw/components/ColorPicker/TopPicks.d.ts +9 -9
  72. package/types/excalidraw/components/ColorPicker/colorPickerUtils.d.ts +21 -21
  73. package/types/excalidraw/components/ColorPicker/keyboardNavHandlers.d.ts +20 -20
  74. package/types/excalidraw/components/CommandPalette/CommandPalette.d.ts +18 -18
  75. package/types/excalidraw/components/CommandPalette/defaultCommandPaletteItems.d.ts +2 -2
  76. package/types/excalidraw/components/CommandPalette/types.d.ts +25 -25
  77. package/types/excalidraw/components/ConfirmDialog.d.ts +10 -10
  78. package/types/excalidraw/components/ContextMenu.d.ts +16 -16
  79. package/types/excalidraw/components/DarkModeToggle.d.ts +7 -7
  80. package/types/excalidraw/components/DefaultSidebar.d.ts +30 -30
  81. package/types/excalidraw/components/DiagramToCodePlugin/DiagramToCodePlugin.d.ts +4 -4
  82. package/types/excalidraw/components/Dialog.d.ts +13 -13
  83. package/types/excalidraw/components/DialogActionButton.d.ts +10 -10
  84. package/types/excalidraw/components/ErrorDialog.d.ts +5 -5
  85. package/types/excalidraw/components/ExcalidrawLogo.d.ts +15 -15
  86. package/types/excalidraw/components/EyeDropper.d.ts +27 -27
  87. package/types/excalidraw/components/FilledButton.d.ts +18 -18
  88. package/types/excalidraw/components/FixedSideContainer.d.ts +9 -9
  89. package/types/excalidraw/components/FollowMode/FollowMode.d.ts +10 -10
  90. package/types/excalidraw/components/FontPicker/FontPicker.d.ts +21 -21
  91. package/types/excalidraw/components/FontPicker/FontPickerList.d.ts +25 -25
  92. package/types/excalidraw/components/FontPicker/FontPickerTrigger.d.ts +6 -6
  93. package/types/excalidraw/components/FontPicker/keyboardNavHandlers.d.ts +13 -13
  94. package/types/excalidraw/components/HandButton.d.ts +10 -10
  95. package/types/excalidraw/components/HelpButton.d.ts +7 -7
  96. package/types/excalidraw/components/HelpDialog.d.ts +4 -4
  97. package/types/excalidraw/components/HintViewer.d.ts +10 -10
  98. package/types/excalidraw/components/IconPicker.d.ts +14 -14
  99. package/types/excalidraw/components/ImageExportDialog.d.ts +14 -14
  100. package/types/excalidraw/components/InitializeApp.d.ts +10 -10
  101. package/types/excalidraw/components/InlineIcon.d.ts +3 -3
  102. package/types/excalidraw/components/Island.d.ts +10 -10
  103. package/types/excalidraw/components/JSONExportDialog.d.ts +15 -15
  104. package/types/excalidraw/components/LaserPointerButton.d.ts +10 -10
  105. package/types/excalidraw/components/LayerUI.d.ts +30 -30
  106. package/types/excalidraw/components/LibraryMenu.d.ts +24 -24
  107. package/types/excalidraw/components/LibraryMenuBrowseButton.d.ts +7 -7
  108. package/types/excalidraw/components/LibraryMenuControlButtons.d.ts +9 -9
  109. package/types/excalidraw/components/LibraryMenuHeaderContent.d.ts +17 -17
  110. package/types/excalidraw/components/LibraryMenuItems.d.ts +14 -14
  111. package/types/excalidraw/components/LibraryMenuSection.d.ts +23 -23
  112. package/types/excalidraw/components/LibraryUnit.d.ts +14 -14
  113. package/types/excalidraw/components/LoadingMessage.d.ts +5 -5
  114. package/types/excalidraw/components/LockButton.d.ts +10 -10
  115. package/types/excalidraw/components/MagicButton.d.ts +9 -9
  116. package/types/excalidraw/components/MagicSettings.d.ts +8 -0
  117. package/types/excalidraw/components/MobileMenu.d.ts +24 -24
  118. package/types/excalidraw/components/Modal.d.ts +14 -14
  119. package/types/excalidraw/components/OverwriteConfirm/OverwriteConfirm.d.ts +17 -17
  120. package/types/excalidraw/components/OverwriteConfirm/OverwriteConfirmActions.d.ts +17 -17
  121. package/types/excalidraw/components/OverwriteConfirm/OverwriteConfirmState.d.ts +22 -22
  122. package/types/excalidraw/components/Paragraph.d.ts +4 -4
  123. package/types/excalidraw/components/PasteChartDialog.d.ts +8 -8
  124. package/types/excalidraw/components/PenModeButton.d.ts +12 -12
  125. package/types/excalidraw/components/Popover.d.ts +15 -15
  126. package/types/excalidraw/components/ProjectName.d.ts +10 -10
  127. package/types/excalidraw/components/PropertiesPopover.d.ts +15 -15
  128. package/types/excalidraw/components/PublishLibrary.d.ts +16 -16
  129. package/types/excalidraw/components/QuickSearch.d.ts +9 -9
  130. package/types/excalidraw/components/RadioGroup.d.ts +13 -13
  131. package/types/excalidraw/components/SVGLayer.d.ts +7 -7
  132. package/types/excalidraw/components/ScrollableList.d.ts +8 -8
  133. package/types/excalidraw/components/SearchMenu.d.ts +5 -5
  134. package/types/excalidraw/components/Section.d.ts +6 -6
  135. package/types/excalidraw/components/ShareableLinkDialog.d.ts +7 -7
  136. package/types/excalidraw/components/Sidebar/Sidebar.d.ts +76 -76
  137. package/types/excalidraw/components/Sidebar/SidebarHeader.d.ts +7 -7
  138. package/types/excalidraw/components/Sidebar/SidebarTab.d.ts +8 -8
  139. package/types/excalidraw/components/Sidebar/SidebarTabTrigger.d.ts +9 -9
  140. package/types/excalidraw/components/Sidebar/SidebarTabTriggers.d.ts +6 -6
  141. package/types/excalidraw/components/Sidebar/SidebarTabs.d.ts +6 -6
  142. package/types/excalidraw/components/Sidebar/SidebarTrigger.d.ts +6 -6
  143. package/types/excalidraw/components/Sidebar/common.d.ts +33 -33
  144. package/types/excalidraw/components/Spinner.d.ts +8 -8
  145. package/types/excalidraw/components/Stack.d.ts +16 -16
  146. package/types/excalidraw/components/Stats/Angle.d.ts +11 -11
  147. package/types/excalidraw/components/Stats/CanvasGrid.d.ts +10 -10
  148. package/types/excalidraw/components/Stats/CanvasGridSize.d.ts +10 -10
  149. package/types/excalidraw/components/Stats/Collapsible.d.ts +8 -8
  150. package/types/excalidraw/components/Stats/Dimension.d.ts +11 -11
  151. package/types/excalidraw/components/Stats/DragInput.d.ts +34 -34
  152. package/types/excalidraw/components/Stats/FontSize.d.ts +11 -11
  153. package/types/excalidraw/components/Stats/MultiAngle.d.ts +11 -11
  154. package/types/excalidraw/components/Stats/MultiDimension.d.ts +14 -14
  155. package/types/excalidraw/components/Stats/MultiFontSize.d.ts +12 -12
  156. package/types/excalidraw/components/Stats/MultiPosition.d.ts +14 -14
  157. package/types/excalidraw/components/Stats/Position.d.ts +12 -12
  158. package/types/excalidraw/components/Stats/index.d.ts +35 -35
  159. package/types/excalidraw/components/Stats/utils.d.ts +26 -26
  160. package/types/excalidraw/components/Stats.d.ts +11 -0
  161. package/types/excalidraw/components/Switch.d.ts +9 -9
  162. package/types/excalidraw/components/TTDDialog/MermaidToExcalidraw.d.ts +14 -14
  163. package/types/excalidraw/components/TTDDialog/TTDDialog.d.ts +29 -29
  164. package/types/excalidraw/components/TTDDialog/TTDDialogInput.d.ts +9 -9
  165. package/types/excalidraw/components/TTDDialog/TTDDialogOutput.d.ts +7 -7
  166. package/types/excalidraw/components/TTDDialog/TTDDialogPanel.d.ts +17 -17
  167. package/types/excalidraw/components/TTDDialog/TTDDialogPanels.d.ts +4 -4
  168. package/types/excalidraw/components/TTDDialog/TTDDialogSubmitShortcut.d.ts +1 -1
  169. package/types/excalidraw/components/TTDDialog/TTDDialogTab.d.ts +7 -7
  170. package/types/excalidraw/components/TTDDialog/TTDDialogTabTrigger.d.ts +8 -8
  171. package/types/excalidraw/components/TTDDialog/TTDDialogTabTriggers.d.ts +6 -6
  172. package/types/excalidraw/components/TTDDialog/TTDDialogTabs.d.ts +11 -11
  173. package/types/excalidraw/components/TTDDialog/TTDDialogTrigger.d.ts +8 -8
  174. package/types/excalidraw/components/TTDDialog/common.d.ts +32 -32
  175. package/types/excalidraw/components/TextField.d.ts +21 -21
  176. package/types/excalidraw/components/Toast.d.ts +9 -9
  177. package/types/excalidraw/components/ToolButton.d.ts +49 -49
  178. package/types/excalidraw/components/Tooltip.d.ts +18 -18
  179. package/types/excalidraw/components/Trans.d.ts +9 -9
  180. package/types/excalidraw/components/UserList.d.ts +18 -18
  181. package/types/excalidraw/components/canvases/InteractiveCanvas.d.ts +29 -29
  182. package/types/excalidraw/components/canvases/NewElementCanvas.d.ts +14 -14
  183. package/types/excalidraw/components/canvases/StaticCanvas.d.ts +19 -19
  184. package/types/excalidraw/components/canvases/index.d.ts +3 -3
  185. package/types/excalidraw/components/dropdownMenu/DropdownMenu.d.ts +86 -86
  186. package/types/excalidraw/components/dropdownMenu/DropdownMenuContent.d.ts +15 -15
  187. package/types/excalidraw/components/dropdownMenu/DropdownMenuGroup.d.ts +11 -11
  188. package/types/excalidraw/components/dropdownMenu/DropdownMenuItem.d.ts +45 -45
  189. package/types/excalidraw/components/dropdownMenu/DropdownMenuItemContent.d.ts +7 -7
  190. package/types/excalidraw/components/dropdownMenu/DropdownMenuItemContentRadio.d.ts +17 -17
  191. package/types/excalidraw/components/dropdownMenu/DropdownMenuItemCustom.d.ts +7 -7
  192. package/types/excalidraw/components/dropdownMenu/DropdownMenuItemLink.d.ts +15 -15
  193. package/types/excalidraw/components/dropdownMenu/DropdownMenuSeparator.d.ts +5 -5
  194. package/types/excalidraw/components/dropdownMenu/DropdownMenuTrigger.d.ts +10 -10
  195. package/types/excalidraw/components/dropdownMenu/common.d.ts +6 -6
  196. package/types/excalidraw/components/dropdownMenu/dropdownMenuUtils.d.ts +3 -3
  197. package/types/excalidraw/components/footer/Footer.d.ts +12 -12
  198. package/types/excalidraw/components/footer/FooterCenter.d.ts +8 -8
  199. package/types/excalidraw/components/hoc/withInternalFallback.d.ts +4 -4
  200. package/types/excalidraw/components/hyperlink/Hyperlink.d.ts +18 -18
  201. package/types/excalidraw/components/hyperlink/helpers.d.ts +8 -8
  202. package/types/excalidraw/components/icons.d.ts +212 -212
  203. package/types/excalidraw/components/live-collaboration/LiveCollaborationTrigger.d.ts +9 -9
  204. package/types/excalidraw/components/main-menu/DefaultItems.d.ts +64 -64
  205. package/types/excalidraw/components/main-menu/MainMenu.d.ts +80 -80
  206. package/types/excalidraw/components/welcome-screen/WelcomeScreen.Center.d.ts +59 -59
  207. package/types/excalidraw/components/welcome-screen/WelcomeScreen.Hints.d.ts +19 -19
  208. package/types/excalidraw/components/welcome-screen/WelcomeScreen.d.ts +86 -86
  209. package/types/excalidraw/constants.d.ts +316 -316
  210. package/types/excalidraw/context/tunnels.d.ts +20 -20
  211. package/types/excalidraw/context/ui-appState.d.ts +4 -4
  212. package/types/excalidraw/cursor.d.ts +6 -6
  213. package/types/excalidraw/data/EditorLocalStorage.d.ts +8 -8
  214. package/types/excalidraw/data/ai/types.d.ts +242 -242
  215. package/types/excalidraw/data/blob.d.ts +49 -49
  216. package/types/excalidraw/data/encode.d.ts +54 -54
  217. package/types/excalidraw/data/encryption.d.ts +9 -9
  218. package/types/excalidraw/data/filesystem.d.ts +20 -20
  219. package/types/excalidraw/data/image.d.ts +15 -15
  220. package/types/excalidraw/data/index.d.ts +22 -22
  221. package/types/excalidraw/data/json.d.ts +16 -16
  222. package/types/excalidraw/data/library.d.ts +106 -106
  223. package/types/excalidraw/data/magic.d.ts +23 -0
  224. package/types/excalidraw/data/reconcile.d.ts +6 -6
  225. package/types/excalidraw/data/resave.d.ts +5 -5
  226. package/types/excalidraw/data/restore.d.ts +21 -21
  227. package/types/excalidraw/data/transform.d.ts +81 -81
  228. package/types/excalidraw/data/types.d.ts +45 -45
  229. package/types/excalidraw/data/url.d.ts +8 -8
  230. package/types/excalidraw/deburr.d.ts +1 -1
  231. package/types/excalidraw/dist/excalidraw.development.d.ts +2 -2
  232. package/types/excalidraw/dist/excalidraw.production.min.d.ts +1 -1
  233. package/types/excalidraw/distribute.d.ts +6 -6
  234. package/types/excalidraw/element/ElementCanvasButtons.d.ts +7 -7
  235. package/types/excalidraw/element/binding.d.ts +99 -99
  236. package/types/excalidraw/element/bounds.d.ts +76 -76
  237. package/types/excalidraw/element/collision.d.ts +17 -17
  238. package/types/excalidraw/element/containerCache.d.ts +11 -11
  239. package/types/excalidraw/element/dragElements.d.ts +32 -32
  240. package/types/excalidraw/element/embeddable.d.ts +221 -221
  241. package/types/excalidraw/element/flowchart.d.ts +25 -25
  242. package/types/excalidraw/element/heading.d.ts +12 -12
  243. package/types/excalidraw/element/image.d.ts +32 -32
  244. package/types/excalidraw/element/index.d.ts +26 -26
  245. package/types/excalidraw/element/linearElementEditor.d.ts +128 -128
  246. package/types/excalidraw/element/mutateElement.d.ts +11 -11
  247. package/types/excalidraw/element/newElement.d.ts +105 -105
  248. package/types/excalidraw/element/resizeElements.d.ts +16 -16
  249. package/types/excalidraw/element/resizeTest.d.ts +15 -15
  250. package/types/excalidraw/element/routing.d.ts +12 -12
  251. package/types/excalidraw/element/showSelectedShapeActions.d.ts +3 -3
  252. package/types/excalidraw/element/sizeHelpers.d.ts +35 -35
  253. package/types/excalidraw/element/sortElements.d.ts +2 -2
  254. package/types/excalidraw/element/textElement.d.ts +70 -70
  255. package/types/excalidraw/element/textWysiwyg.d.ts +22 -22
  256. package/types/excalidraw/element/transformHandles.d.ts +55 -55
  257. package/types/excalidraw/element/typeChecks.d.ts +39 -39
  258. package/types/excalidraw/element/types.d.ts +253 -253
  259. package/types/excalidraw/emitter.d.ts +16 -16
  260. package/types/excalidraw/entry.d.ts +1 -1
  261. package/types/excalidraw/env.d.cts +1 -1
  262. package/types/excalidraw/env.d.ts +1 -1
  263. package/types/excalidraw/errors.d.ts +16 -16
  264. package/types/excalidraw/fonts/ExcalidrawFont.d.ts +37 -37
  265. package/types/excalidraw/fonts/index.d.ts +83 -83
  266. package/types/excalidraw/fonts/metadata.d.ts +35 -35
  267. package/types/excalidraw/fonts/wasm/hb-subset.bindings.d.ts +45 -45
  268. package/types/excalidraw/fonts/wasm/hb-subset.loader.d.ts +5 -5
  269. package/types/excalidraw/fonts/wasm/hb-subset.wasm.d.ts +2 -2
  270. package/types/excalidraw/fonts/wasm/woff2.bindings.d.ts +31 -31
  271. package/types/excalidraw/fonts/wasm/woff2.loader.d.ts +6 -6
  272. package/types/excalidraw/fonts/wasm/woff2.wasm.d.ts +2 -2
  273. package/types/excalidraw/fractionalIndex.d.ts +48 -48
  274. package/types/excalidraw/frame.d.ts +63 -63
  275. package/types/excalidraw/ga.d.ts +63 -63
  276. package/types/excalidraw/gadirections.d.ts +8 -8
  277. package/types/excalidraw/galines.d.ts +22 -22
  278. package/types/excalidraw/gapoints.d.ts +7 -7
  279. package/types/excalidraw/gatransforms.d.ts +10 -10
  280. package/types/excalidraw/gesture.d.ts +6 -6
  281. package/types/excalidraw/groups.d.ts +33 -33
  282. package/types/excalidraw/history.d.ts +40 -40
  283. package/types/excalidraw/hooks/useCallbackRefState.d.ts +1 -1
  284. package/types/excalidraw/hooks/useCopiedIndicator.d.ts +5 -5
  285. package/types/excalidraw/hooks/useCreatePortalContainer.d.ts +7 -7
  286. package/types/excalidraw/hooks/useEmitter.d.ts +2 -2
  287. package/types/excalidraw/hooks/useLibraryItemSvg.d.ts +11 -11
  288. package/types/excalidraw/hooks/useOutsideClick.d.ts +19 -19
  289. package/types/excalidraw/hooks/useScrollPosition.d.ts +1 -1
  290. package/types/excalidraw/hooks/useStable.d.ts +1 -1
  291. package/types/excalidraw/hooks/useStableCallback.d.ts +4 -4
  292. package/types/excalidraw/hooks/useTransition.d.ts +2 -2
  293. package/types/excalidraw/i18n.d.ts +24 -24
  294. package/types/excalidraw/index-node.d.ts +1 -1
  295. package/types/excalidraw/index.d.ts +61 -61
  296. package/types/excalidraw/jotai.d.ts +34 -34
  297. package/types/excalidraw/keys.d.ts +82 -82
  298. package/types/excalidraw/laser-trails.d.ts +20 -20
  299. package/types/excalidraw/main.d.ts +2 -2
  300. package/types/excalidraw/math.d.ts +79 -79
  301. package/types/excalidraw/mermaid.d.ts +2 -2
  302. package/types/excalidraw/obsidianUtils.d.ts +18 -17
  303. package/types/excalidraw/points.d.ts +7 -7
  304. package/types/excalidraw/polyfill.d.ts +2 -2
  305. package/types/excalidraw/publicPath.d.ts +1 -1
  306. package/types/excalidraw/queue.d.ts +9 -9
  307. package/types/excalidraw/random.d.ts +4 -4
  308. package/types/excalidraw/reactUtils.d.ts +14 -14
  309. package/types/excalidraw/renderer/easingFunctions.d.ts +6 -6
  310. package/types/excalidraw/renderer/helpers.d.ts +13 -13
  311. package/types/excalidraw/renderer/interactiveScene.d.ts +20 -20
  312. package/types/excalidraw/renderer/renderElement.d.ts +27 -27
  313. package/types/excalidraw/renderer/renderNewElementScene.d.ts +7 -7
  314. package/types/excalidraw/renderer/renderSnaps.d.ts +2 -2
  315. package/types/excalidraw/renderer/roundRect.d.ts +11 -11
  316. package/types/excalidraw/renderer/staticScene.d.ts +11 -11
  317. package/types/excalidraw/renderer/staticSvgScene.d.ts +5 -5
  318. package/types/excalidraw/scene/Fonts.d.ts +19 -0
  319. package/types/excalidraw/scene/Renderer.d.ts +28 -28
  320. package/types/excalidraw/scene/Scene.d.ts +78 -78
  321. package/types/excalidraw/scene/Shape.d.ts +17 -17
  322. package/types/excalidraw/scene/ShapeCache.d.ts +25 -25
  323. package/types/excalidraw/scene/comparisons.d.ts +487 -487
  324. package/types/excalidraw/scene/export.d.ts +29 -29
  325. package/types/excalidraw/scene/index.d.ts +4 -4
  326. package/types/excalidraw/scene/normalize.d.ts +4 -4
  327. package/types/excalidraw/scene/scroll.d.ts +23 -23
  328. package/types/excalidraw/scene/scrollbars.d.ts +12 -12
  329. package/types/excalidraw/scene/selection.d.ts +32 -32
  330. package/types/excalidraw/scene/types.d.ts +112 -112
  331. package/types/excalidraw/scene/zoom.d.ts +12 -12
  332. package/types/excalidraw/shapes.d.ts +85 -85
  333. package/types/excalidraw/snapping.d.ts +112 -112
  334. package/types/excalidraw/store.d.ts +129 -129
  335. package/types/excalidraw/types.d.ts +719 -719
  336. package/types/excalidraw/utility-types.d.ts +31 -31
  337. package/types/excalidraw/utils.d.ts +242 -242
  338. package/types/excalidraw/visualdebug.d.ts +35 -35
  339. package/types/excalidraw/webpack.dev.config.d.ts +81 -81
  340. package/types/excalidraw/webpack.prod.config.d.ts +97 -97
  341. package/types/excalidraw/zindex.d.ts +6 -6
  342. package/types/math/angle.d.ts +17 -17
  343. package/types/math/arc.d.ts +6 -6
  344. package/types/math/curve.d.ts +32 -32
  345. package/types/math/ga/ga.d.ts +63 -63
  346. package/types/math/ga/gadirections.d.ts +8 -8
  347. package/types/math/ga/galines.d.ts +22 -22
  348. package/types/math/ga/gapoints.d.ts +7 -7
  349. package/types/math/ga/gatransforms.d.ts +10 -10
  350. package/types/math/index.d.ts +12 -12
  351. package/types/math/line.d.ts +26 -26
  352. package/types/math/point.d.ts +140 -140
  353. package/types/math/polygon.d.ts +5 -5
  354. package/types/math/range.d.ts +44 -44
  355. package/types/math/segment.d.ts +32 -32
  356. package/types/math/triangle.d.ts +11 -11
  357. package/types/math/types.d.ts +96 -96
  358. package/types/math/utils.d.ts +6 -6
  359. package/types/math/vector.d.ts +88 -88
  360. package/types/utils/bbox.d.ts +9 -9
  361. package/types/utils/collision.d.ts +9 -9
  362. package/types/utils/export.d.ts +44 -44
  363. package/types/utils/geometry/geometry.d.ts +89 -89
  364. package/types/utils/geometry/shape.d.ts +71 -71
  365. package/types/utils/index.d.ts +4 -4
  366. package/types/utils/withinBounds.d.ts +19 -19
  367. package/types/excalidraw/components/SearchSidebar.d.ts +0 -1
@@ -1,719 +1,719 @@
1
- import type React from "react";
2
- import type { PointerType, ExcalidrawLinearElement, NonDeletedExcalidrawElement, NonDeleted, TextAlign, ExcalidrawElement, GroupId, ExcalidrawBindableElement, Arrowhead, ChartType, FontFamilyValues, ExcalidrawTextElement, FileId, ExcalidrawImageElement, Theme, StrokeRoundness, ExcalidrawEmbeddableElement, ExcalidrawMagicFrameElement, ExcalidrawFrameLikeElement, ExcalidrawElementType, ExcalidrawIframeLikeElement, OrderedExcalidrawElement, ExcalidrawNonSelectionElement } from "./element/types";
3
- import type { Action } from "./actions/types";
4
- import type { LinearElementEditor } from "./element/linearElementEditor";
5
- import type { SuggestedBinding } from "./element/binding";
6
- import type { ImportedDataState } from "./data/types";
7
- import type App from "./components/App";
8
- import type { throttleRAF } from "./utils";
9
- import type { Spreadsheet } from "./charts";
10
- import type { Language } from "./i18n";
11
- import type { ClipboardData } from "./clipboard";
12
- import type { isOverScrollBars } from "./scene/scrollbars";
13
- import type { MaybeTransformHandleType } from "./element/transformHandles";
14
- import type Library from "./data/library";
15
- import type { FileSystemHandle } from "./data/filesystem";
16
- import type { IMAGE_MIME_TYPES, MIME_TYPES } from "./constants";
17
- import type { ContextMenuItems } from "./components/ContextMenu";
18
- import type { SnapLine } from "./snapping";
19
- import type { Merge, MaybePromise, ValueOf, MakeBrand } from "./utility-types";
20
- import type { ColorPaletteCustom } from "./colors";
21
- import type { StoreActionType } from "./store";
22
- export type SocketId = string & {
23
- _brand: "SocketId";
24
- };
25
- export type Collaborator = Readonly<{
26
- pointer?: CollaboratorPointer;
27
- button?: "up" | "down";
28
- selectedElementIds?: AppState["selectedElementIds"];
29
- username?: string | null;
30
- userState?: UserIdleState;
31
- color?: {
32
- background: string;
33
- stroke: string;
34
- };
35
- avatarUrl?: string;
36
- id?: string;
37
- socketId?: SocketId;
38
- isCurrentUser?: boolean;
39
- isInCall?: boolean;
40
- isSpeaking?: boolean;
41
- isMuted?: boolean;
42
- }>;
43
- export type CollaboratorPointer = {
44
- x: number;
45
- y: number;
46
- tool: "pointer" | "laser";
47
- /**
48
- * Whether to render cursor + username. Useful when you only want to render
49
- * laser trail.
50
- *
51
- * @default true
52
- */
53
- renderCursor?: boolean;
54
- /**
55
- * Explicit laser color.
56
- *
57
- * @default string collaborator's cursor color
58
- */
59
- laserColor?: string;
60
- };
61
- export type DataURL = string & {
62
- _brand: "DataURL";
63
- };
64
- export type BinaryFileData = {
65
- mimeType: ValueOf<typeof IMAGE_MIME_TYPES> | typeof MIME_TYPES.binary;
66
- id: FileId;
67
- dataURL: DataURL;
68
- /**
69
- * Epoch timestamp in milliseconds
70
- */
71
- created: number;
72
- /**
73
- * Indicates when the file was last retrieved from storage to be loaded
74
- * onto the scene. We use this flag to determine whether to delete unused
75
- * files from storage.
76
- *
77
- * Epoch timestamp in milliseconds.
78
- */
79
- lastRetrieved?: number;
80
- };
81
- export type BinaryFileMetadata = Omit<BinaryFileData, "dataURL">;
82
- export type BinaryFiles = Record<ExcalidrawElement["id"], BinaryFileData>;
83
- export type ToolType = "selection" | "rectangle" | "diamond" | "ellipse" | "arrow" | "line" | "freedraw" | "text" | "image" | "eraser" | "hand" | "frame" | "magicframe" | "embeddable" | "laser" | "mermaid";
84
- export type ElementOrToolType = ExcalidrawElementType | ToolType | "custom";
85
- export type ActiveTool = {
86
- type: ToolType;
87
- customType: null;
88
- } | {
89
- type: "custom";
90
- customType: string;
91
- };
92
- export type SidebarName = string;
93
- export type SidebarTabName = string;
94
- export type UserToFollow = {
95
- socketId: SocketId;
96
- username: string;
97
- };
98
- type _CommonCanvasAppState = {
99
- zoom: AppState["zoom"];
100
- scrollX: AppState["scrollX"];
101
- scrollY: AppState["scrollY"];
102
- width: AppState["width"];
103
- height: AppState["height"];
104
- viewModeEnabled: AppState["viewModeEnabled"];
105
- editingGroupId: AppState["editingGroupId"];
106
- selectedElementIds: AppState["selectedElementIds"];
107
- frameToHighlight: AppState["frameToHighlight"];
108
- offsetLeft: AppState["offsetLeft"];
109
- offsetTop: AppState["offsetTop"];
110
- theme: AppState["theme"];
111
- pendingImageElementId: AppState["pendingImageElementId"];
112
- };
113
- export type StaticCanvasAppState = Readonly<_CommonCanvasAppState & {
114
- shouldCacheIgnoreZoom: AppState["shouldCacheIgnoreZoom"];
115
- /** null indicates transparent bg */
116
- viewBackgroundColor: AppState["viewBackgroundColor"] | null;
117
- exportScale: AppState["exportScale"];
118
- selectedElementsAreBeingDragged: AppState["selectedElementsAreBeingDragged"];
119
- gridSize: AppState["gridSize"];
120
- gridStep: AppState["gridStep"];
121
- frameRendering: AppState["frameRendering"];
122
- linkOpacity: AppState["linkOpacity"];
123
- gridColor: AppState["gridColor"];
124
- frameColor: AppState["frameColor"];
125
- currentHoveredFontFamily: AppState["currentHoveredFontFamily"];
126
- }>;
127
- export type InteractiveCanvasAppState = Readonly<_CommonCanvasAppState & {
128
- activeEmbeddable: AppState["activeEmbeddable"];
129
- editingLinearElement: AppState["editingLinearElement"];
130
- selectionElement: AppState["selectionElement"];
131
- selectedGroupIds: AppState["selectedGroupIds"];
132
- selectedLinearElement: AppState["selectedLinearElement"];
133
- multiElement: AppState["multiElement"];
134
- isBindingEnabled: AppState["isBindingEnabled"];
135
- suggestedBindings: AppState["suggestedBindings"];
136
- isRotating: AppState["isRotating"];
137
- elementsToHighlight: AppState["elementsToHighlight"];
138
- collaborators: AppState["collaborators"];
139
- snapLines: AppState["snapLines"];
140
- zenModeEnabled: AppState["zenModeEnabled"];
141
- editingTextElement: AppState["editingTextElement"];
142
- gridColor: AppState["gridColor"];
143
- highlightSearchResult: AppState["highlightSearchResult"];
144
- searchMatches: AppState["searchMatches"];
145
- }>;
146
- export type ObservedAppState = ObservedStandaloneAppState & ObservedElementsAppState;
147
- export type ObservedStandaloneAppState = {
148
- name: AppState["name"];
149
- viewBackgroundColor: AppState["viewBackgroundColor"];
150
- };
151
- export type ObservedElementsAppState = {
152
- editingGroupId: AppState["editingGroupId"];
153
- selectedElementIds: AppState["selectedElementIds"];
154
- selectedGroupIds: AppState["selectedGroupIds"];
155
- editingLinearElementId: LinearElementEditor["elementId"] | null;
156
- selectedLinearElementId: LinearElementEditor["elementId"] | null;
157
- };
158
- export interface AppState {
159
- contextMenu: {
160
- items: ContextMenuItems;
161
- top: number;
162
- left: number;
163
- } | null;
164
- showWelcomeScreen: boolean;
165
- isLoading: boolean;
166
- errorMessage: React.ReactNode;
167
- activeEmbeddable: {
168
- element: NonDeletedExcalidrawElement;
169
- state: "hover" | "active";
170
- } | null;
171
- /**
172
- * for a newly created element
173
- * - set on pointer down, updated during pointer move, used on pointer up
174
- */
175
- newElement: NonDeleted<ExcalidrawNonSelectionElement> | null;
176
- /**
177
- * for a single element that's being resized
178
- * - set on pointer down when it's selected and the active tool is selection
179
- */
180
- resizingElement: NonDeletedExcalidrawElement | null;
181
- /**
182
- * multiElement is for multi-point linear element that's created by clicking as opposed to dragging
183
- * - when set and present, the editor will handle linear element creation logic accordingly
184
- */
185
- multiElement: NonDeleted<ExcalidrawLinearElement> | null;
186
- /**
187
- * decoupled from newElement, dragging selection only creates selectionElement
188
- * - set on pointer down, updated during pointer move
189
- */
190
- selectionElement: NonDeletedExcalidrawElement | null;
191
- isBindingEnabled: boolean;
192
- startBoundElement: NonDeleted<ExcalidrawBindableElement> | null;
193
- suggestedBindings: SuggestedBinding[];
194
- frameToHighlight: NonDeleted<ExcalidrawFrameLikeElement> | null;
195
- frameRendering: {
196
- enabled: boolean;
197
- name: boolean;
198
- outline: boolean;
199
- clip: boolean;
200
- };
201
- editingFrame: string | null;
202
- elementsToHighlight: NonDeleted<ExcalidrawElement>[] | null;
203
- /**
204
- * set when a new text is created or when an existing text is being edited
205
- */
206
- editingTextElement: NonDeletedExcalidrawElement | null;
207
- editingLinearElement: LinearElementEditor | null;
208
- activeTool: {
209
- /**
210
- * indicates a previous tool we should revert back to if we deselect the
211
- * currently active tool. At the moment applies to `eraser` and `hand` tool.
212
- */
213
- lastActiveTool: ActiveTool | null;
214
- locked: boolean;
215
- } & ActiveTool;
216
- penMode: boolean;
217
- penDetected: boolean;
218
- exportBackground: boolean;
219
- exportEmbedScene: boolean;
220
- exportWithDarkMode: boolean;
221
- exportScale: number;
222
- currentItemStrokeColor: string;
223
- currentItemBackgroundColor: string;
224
- currentItemFillStyle: ExcalidrawElement["fillStyle"];
225
- currentItemStrokeWidth: number;
226
- currentItemStrokeStyle: ExcalidrawElement["strokeStyle"];
227
- currentItemRoughness: number;
228
- currentItemOpacity: number;
229
- currentItemFontFamily: FontFamilyValues;
230
- currentItemFontSize: number;
231
- currentItemTextAlign: TextAlign;
232
- currentItemStartArrowhead: Arrowhead | null;
233
- currentItemEndArrowhead: Arrowhead | null;
234
- currentHoveredFontFamily: FontFamilyValues | null;
235
- currentItemRoundness: StrokeRoundness;
236
- currentItemArrowType: "sharp" | "round" | "elbow";
237
- viewBackgroundColor: string;
238
- scrollX: number;
239
- scrollY: number;
240
- cursorButton: "up" | "down";
241
- scrolledOutside: boolean;
242
- name: string | null;
243
- isResizing: boolean;
244
- isRotating: boolean;
245
- zoom: Zoom;
246
- openMenu: "canvas" | "shape" | null;
247
- openPopup: "canvasBackground" | "elementBackground" | "elementStroke" | "fontFamily" | null;
248
- openSidebar: {
249
- name: SidebarName;
250
- tab?: SidebarTabName;
251
- } | null;
252
- openDialog: null | {
253
- name: "imageExport" | "help" | "jsonExport";
254
- } | {
255
- name: "ttd";
256
- tab: "text-to-diagram" | "mermaid";
257
- } | {
258
- name: "commandPalette";
259
- };
260
- /**
261
- * Reflects user preference for whether the default sidebar should be docked.
262
- *
263
- * NOTE this is only a user preference and does not reflect the actual docked
264
- * state of the sidebar, because the host apps can override this through
265
- * a DefaultSidebar prop, which is not reflected back to the appState.
266
- */
267
- defaultSidebarDockedPreference: boolean;
268
- lastPointerDownWith: PointerType;
269
- selectedElementIds: Readonly<{
270
- [id: string]: true;
271
- }>;
272
- previousSelectedElementIds: {
273
- [id: string]: true;
274
- };
275
- selectedElementsAreBeingDragged: boolean;
276
- shouldCacheIgnoreZoom: boolean;
277
- toast: {
278
- message: string;
279
- closable?: boolean;
280
- duration?: number;
281
- } | null;
282
- zenModeEnabled: boolean;
283
- theme: Theme;
284
- /** grid cell px size */
285
- gridSize: number;
286
- gridStep: number;
287
- gridModeEnabled: boolean;
288
- viewModeEnabled: boolean;
289
- /** top-most selected groups (i.e. does not include nested groups) */
290
- selectedGroupIds: {
291
- [groupId: string]: boolean;
292
- };
293
- /** group being edited when you drill down to its constituent element
294
- (e.g. when you double-click on a group's element) */
295
- editingGroupId: GroupId | null;
296
- width: number;
297
- height: number;
298
- offsetTop: number;
299
- offsetLeft: number;
300
- fileHandle: FileSystemHandle | null;
301
- collaborators: Map<SocketId, Collaborator>;
302
- stats: {
303
- open: boolean;
304
- /** bitmap. Use `STATS_PANELS` bit values */
305
- panels: number;
306
- };
307
- currentChartType: ChartType;
308
- pasteDialog: {
309
- shown: false;
310
- data: null;
311
- } | {
312
- shown: true;
313
- data: Spreadsheet;
314
- };
315
- /** imageElement waiting to be placed on canvas */
316
- pendingImageElementId: ExcalidrawImageElement["id"] | null;
317
- showHyperlinkPopup: false | "info" | "editor";
318
- linkOpacity: number;
319
- trayModeEnabled: boolean;
320
- colorPalette?: {
321
- canvasBackground: ColorPaletteCustom;
322
- elementBackground: ColorPaletteCustom;
323
- elementStroke: ColorPaletteCustom;
324
- topPicks: {
325
- canvasBackground: [string, string, string, string, string];
326
- elementStroke: [string, string, string, string, string];
327
- elementBackground: [string, string, string, string, string];
328
- };
329
- };
330
- allowWheelZoom?: boolean;
331
- allowPinchZoom?: boolean;
332
- pinnedScripts?: string[];
333
- customPens?: any[];
334
- currentStrokeOptions?: any;
335
- resetCustomPen?: any;
336
- gridColor: {
337
- Bold: string;
338
- Regular: string;
339
- };
340
- highlightSearchResult: boolean;
341
- dynamicStyle: {
342
- [x: string]: string;
343
- };
344
- frameColor: {
345
- stroke: string;
346
- fill: string;
347
- nameColor: string;
348
- };
349
- invertBindingBehaviour: boolean;
350
- selectedLinearElement: LinearElementEditor | null;
351
- snapLines: readonly SnapLine[];
352
- originSnapOffset: {
353
- x: number;
354
- y: number;
355
- } | null;
356
- objectsSnapModeEnabled: boolean;
357
- /** the user's socket id & username who is being followed on the canvas */
358
- userToFollow: UserToFollow | null;
359
- /** the socket ids of the users following the current user */
360
- followedBy: Set<SocketId>;
361
- searchMatches: readonly SearchMatch[];
362
- }
363
- type SearchMatch = {
364
- id: string;
365
- focus: boolean;
366
- matchedLines: {
367
- offsetX: number;
368
- offsetY: number;
369
- width: number;
370
- height: number;
371
- }[];
372
- };
373
- export type UIAppState = Omit<AppState, "suggestedBindings" | "startBoundElement" | "cursorButton" | "scrollX" | "scrollY">;
374
- export type NormalizedZoomValue = number & {
375
- _brand: "normalizedZoom";
376
- };
377
- export type Zoom = Readonly<{
378
- value: NormalizedZoomValue;
379
- }>;
380
- export type PointerCoords = Readonly<{
381
- x: number;
382
- y: number;
383
- }>;
384
- export type Gesture = {
385
- pointers: Map<number, PointerCoords>;
386
- lastCenter: {
387
- x: number;
388
- y: number;
389
- } | null;
390
- initialDistance: number | null;
391
- initialScale: number | null;
392
- };
393
- export declare class GestureEvent extends UIEvent {
394
- readonly rotation: number;
395
- readonly scale: number;
396
- }
397
- /** @deprecated legacy: do not use outside of migration paths */
398
- export type LibraryItem_v1 = readonly NonDeleted<ExcalidrawElement>[];
399
- /** @deprecated legacy: do not use outside of migration paths */
400
- type LibraryItems_v1 = readonly LibraryItem_v1[];
401
- /** v2 library item */
402
- export type LibraryItem = {
403
- id: string;
404
- status: "published" | "unpublished";
405
- elements: readonly NonDeleted<ExcalidrawElement>[];
406
- /** timestamp in epoch (ms) */
407
- created: number;
408
- name?: string;
409
- error?: string;
410
- };
411
- export type LibraryItems = readonly LibraryItem[];
412
- export type LibraryItems_anyVersion = LibraryItems | LibraryItems_v1;
413
- export type LibraryItemsSource = ((currentLibraryItems: LibraryItems) => MaybePromise<LibraryItems_anyVersion | Blob>) | MaybePromise<LibraryItems_anyVersion | Blob>;
414
- export type ExcalidrawInitialDataState = Merge<ImportedDataState, {
415
- libraryItems?: MaybePromise<Required<ImportedDataState>["libraryItems"]>;
416
- }>;
417
- export type OnUserFollowedPayload = {
418
- userToFollow: UserToFollow;
419
- action: "FOLLOW" | "UNFOLLOW";
420
- };
421
- export interface ExcalidrawProps {
422
- onChange?: (elements: readonly OrderedExcalidrawElement[], appState: AppState, files: BinaryFiles) => void;
423
- initialData?: (() => MaybePromise<ExcalidrawInitialDataState | null>) | MaybePromise<ExcalidrawInitialDataState | null>;
424
- excalidrawAPI?: (api: ExcalidrawImperativeAPI) => void;
425
- isCollaborating?: boolean;
426
- onPointerUpdate?: (payload: {
427
- pointer: {
428
- x: number;
429
- y: number;
430
- tool: "pointer" | "laser";
431
- };
432
- button: "down" | "up";
433
- pointersMap: Gesture["pointers"];
434
- }) => void;
435
- onPaste?: (data: ClipboardData, event: ClipboardEvent | null) => Promise<boolean> | boolean;
436
- onDrop?: (event: React.DragEvent<HTMLDivElement>) => Promise<boolean> | boolean;
437
- renderTopRightUI?: (isMobile: boolean, appState: UIAppState) => JSX.Element | null;
438
- langCode?: Language["code"];
439
- viewModeEnabled?: boolean;
440
- zenModeEnabled?: boolean;
441
- gridModeEnabled?: boolean;
442
- objectsSnapModeEnabled?: boolean;
443
- libraryReturnUrl?: string;
444
- initState?: AppState;
445
- theme?: Theme;
446
- name?: string;
447
- renderCustomStats?: (elements: readonly NonDeletedExcalidrawElement[], appState: UIAppState) => JSX.Element;
448
- UIOptions?: Partial<UIOptions>;
449
- detectScroll?: boolean;
450
- handleKeyboardGlobally?: boolean;
451
- onLibraryChange?: (libraryItems: LibraryItems) => void | Promise<any>;
452
- autoFocus?: boolean;
453
- onBeforeTextEdit?: (textElement: ExcalidrawTextElement) => string;
454
- onBeforeTextSubmit?: (textElement: ExcalidrawTextElement, nextText: string, //wrapped
455
- nextOriginalText: string, isDeleted: boolean) => {
456
- updatedNextOriginalText: string;
457
- nextLink: string;
458
- };
459
- generateIdForFile?: (file: File) => string | Promise<string>;
460
- onThemeChange?: (newTheme: string) => void;
461
- onViewModeChange?: (isViewModeEnabled: boolean) => void;
462
- onLinkOpen?: (element: NonDeletedExcalidrawElement, event: CustomEvent<{
463
- nativeEvent: MouseEvent | React.PointerEvent<HTMLCanvasElement>;
464
- }>) => void;
465
- onLinkHover?: (element: NonDeletedExcalidrawElement, event: React.PointerEvent<HTMLCanvasElement>) => void;
466
- onPointerDown?: (activeTool: AppState["activeTool"], pointerDownState: PointerDownState) => void;
467
- onPointerUp?: (activeTool: AppState["activeTool"], pointerDownState: PointerDownState) => void;
468
- onScrollChange?: (scrollX: number, scrollY: number, zoom: Zoom) => void;
469
- onUserFollow?: (payload: OnUserFollowedPayload) => void;
470
- children?: React.ReactNode;
471
- validateEmbeddable?: boolean | string[] | RegExp | RegExp[] | ((link: string) => boolean | undefined);
472
- renderEmbeddable?: (element: NonDeleted<ExcalidrawEmbeddableElement>, appState: AppState) => JSX.Element | null;
473
- renderWebview?: boolean;
474
- renderEmbeddableMenu?: (appState: AppState) => JSX.Element | null;
475
- renderMermaid?: boolean;
476
- onContextMenu?: (element: readonly NonDeletedExcalidrawElement[], appState: AppState, onClose: (callback?: () => void) => void) => JSX.Element | null;
477
- aiEnabled?: boolean;
478
- obsidianHostPlugin: WeakRef<any>;
479
- showDeprecatedFonts?: boolean;
480
- }
481
- export type SceneData = {
482
- elements?: ImportedDataState["elements"];
483
- appState?: ImportedDataState["appState"];
484
- collaborators?: Map<SocketId, Collaborator>;
485
- storeAction?: StoreActionType;
486
- };
487
- export declare enum UserIdleState {
488
- ACTIVE = "active",
489
- AWAY = "away",
490
- IDLE = "idle"
491
- }
492
- export type ExportOpts = {
493
- saveFileToDisk?: boolean;
494
- onExportToBackend?: (exportedElements: readonly NonDeletedExcalidrawElement[], appState: UIAppState, files: BinaryFiles) => void;
495
- renderCustomUI?: (exportedElements: readonly NonDeletedExcalidrawElement[], appState: UIAppState, files: BinaryFiles, canvas: HTMLCanvasElement) => JSX.Element;
496
- };
497
- export type CanvasActions = Partial<{
498
- changeViewBackgroundColor: boolean;
499
- clearCanvas: boolean;
500
- export: false | ExportOpts;
501
- loadScene: boolean;
502
- saveToActiveFile: boolean;
503
- toggleTheme: boolean | null;
504
- saveAsImage: boolean;
505
- }>;
506
- export type UIOptions = Partial<{
507
- dockedSidebarBreakpoint: number;
508
- canvasActions: CanvasActions;
509
- tools: {
510
- image: boolean;
511
- };
512
- /** @deprecated does nothing. Will be removed in 0.15 */
513
- welcomeScreen?: boolean;
514
- }>;
515
- export type AppProps = Merge<ExcalidrawProps, {
516
- UIOptions: Merge<UIOptions, {
517
- canvasActions: Required<CanvasActions> & {
518
- export: ExportOpts;
519
- };
520
- }>;
521
- detectScroll: boolean;
522
- handleKeyboardGlobally: boolean;
523
- isCollaborating: boolean;
524
- children?: React.ReactNode;
525
- aiEnabled: boolean;
526
- }>;
527
- /** A subset of App class properties that we need to use elsewhere
528
- * in the app, eg Manager. Factored out into a separate type to keep DRY. */
529
- export type AppClassProperties = {
530
- props: AppProps;
531
- state: AppState;
532
- interactiveCanvas: HTMLCanvasElement | null;
533
- /** static canvas */
534
- canvas: HTMLCanvasElement;
535
- focusContainer(): void;
536
- library: Library;
537
- imageCache: Map<FileId, {
538
- image: HTMLImageElement | Promise<HTMLImageElement>;
539
- mimeType: ValueOf<typeof IMAGE_MIME_TYPES>;
540
- }>;
541
- files: BinaryFiles;
542
- device: App["device"];
543
- scene: App["scene"];
544
- syncActionResult: App["syncActionResult"];
545
- fonts: App["fonts"];
546
- pasteFromClipboard: App["pasteFromClipboard"];
547
- id: App["id"];
548
- onInsertElements: App["onInsertElements"];
549
- onExportImage: App["onExportImage"];
550
- lastViewportPosition: App["lastViewportPosition"];
551
- scrollToContent: App["scrollToContent"];
552
- addFiles: App["addFiles"];
553
- addElementsFromPasteOrLibrary: App["addElementsFromPasteOrLibrary"];
554
- setSelection: App["setSelection"];
555
- togglePenMode: App["togglePenMode"];
556
- toggleLock: App["toggleLock"];
557
- setActiveTool: App["setActiveTool"];
558
- setOpenDialog: App["setOpenDialog"];
559
- insertEmbeddableElement: App["insertEmbeddableElement"];
560
- onMagicframeToolSelect: App["onMagicframeToolSelect"];
561
- getName: App["getName"];
562
- dismissLinearEditor: App["dismissLinearEditor"];
563
- flowChartCreator: App["flowChartCreator"];
564
- getEffectiveGridSize: App["getEffectiveGridSize"];
565
- setPlugins: App["setPlugins"];
566
- plugins: App["plugins"];
567
- getEditorUIOffsets: App["getEditorUIOffsets"];
568
- visibleElements: App["visibleElements"];
569
- excalidrawContainerValue: App["excalidrawContainerValue"];
570
- };
571
- export type PointerDownState = Readonly<{
572
- origin: Readonly<{
573
- x: number;
574
- y: number;
575
- }>;
576
- originInGrid: Readonly<{
577
- x: number;
578
- y: number;
579
- }>;
580
- scrollbars: ReturnType<typeof isOverScrollBars>;
581
- lastCoords: {
582
- x: number;
583
- y: number;
584
- };
585
- originalElements: Map<string, NonDeleted<ExcalidrawElement>>;
586
- resize: {
587
- handleType: MaybeTransformHandleType;
588
- isResizing: boolean;
589
- offset: {
590
- x: number;
591
- y: number;
592
- };
593
- arrowDirection: "origin" | "end";
594
- center: {
595
- x: number;
596
- y: number;
597
- };
598
- };
599
- hit: {
600
- element: NonDeleted<ExcalidrawElement> | null;
601
- allHitElements: NonDeleted<ExcalidrawElement>[];
602
- wasAddedToSelection: boolean;
603
- hasBeenDuplicated: boolean;
604
- hasHitCommonBoundingBoxOfSelectedElements: boolean;
605
- };
606
- withCmdOrCtrl: boolean;
607
- drag: {
608
- hasOccurred: boolean;
609
- offset: {
610
- x: number;
611
- y: number;
612
- } | null;
613
- };
614
- eventListeners: {
615
- onMove: null | ReturnType<typeof throttleRAF>;
616
- onUp: null | ((event: PointerEvent) => void);
617
- onKeyDown: null | ((event: KeyboardEvent) => void);
618
- onKeyUp: null | ((event: KeyboardEvent) => void);
619
- };
620
- boxSelection: {
621
- hasOccurred: boolean;
622
- };
623
- }>;
624
- export type UnsubscribeCallback = () => void;
625
- export interface ExcalidrawImperativeAPI {
626
- updateScene: InstanceType<typeof App>["updateScene"];
627
- updateLibrary: InstanceType<typeof Library>["updateLibrary"];
628
- resetScene: InstanceType<typeof App>["resetScene"];
629
- getSceneElementsIncludingDeleted: InstanceType<typeof App>["getSceneElementsIncludingDeleted"];
630
- history: {
631
- clear: InstanceType<typeof App>["resetHistory"];
632
- };
633
- zoomToFit: InstanceType<typeof App>["zoomToFit"];
634
- startLineEditor: InstanceType<typeof App>["startLineEditor"];
635
- getSceneElements: InstanceType<typeof App>["getSceneElements"];
636
- getAppState: () => InstanceType<typeof App>["state"];
637
- getFiles: () => InstanceType<typeof App>["files"];
638
- getName: InstanceType<typeof App>["getName"];
639
- scrollToContent: InstanceType<typeof App>["scrollToContent"];
640
- registerAction: (action: Action) => void;
641
- refresh: InstanceType<typeof App>["refresh"];
642
- setToast: InstanceType<typeof App>["setToast"];
643
- addFiles: (data: BinaryFileData[]) => void;
644
- updateContainerSize: InstanceType<typeof App>["updateContainerSize"];
645
- id: string;
646
- selectElements: (elements: readonly ExcalidrawElement[], highlightSearchResult?: boolean) => void;
647
- sendBackward: (elements: readonly ExcalidrawElement[]) => void;
648
- bringForward: (elements: readonly ExcalidrawElement[]) => void;
649
- sendToBack: (elements: readonly ExcalidrawElement[]) => void;
650
- bringToFront: (elements: readonly ExcalidrawElement[]) => void;
651
- setMobileModeAllowed: (allow: boolean) => void;
652
- setActiveTool: InstanceType<typeof App>["setActiveTool"];
653
- setCursor: InstanceType<typeof App>["setCursor"];
654
- resetCursor: InstanceType<typeof App>["resetCursor"];
655
- toggleSidebar: InstanceType<typeof App>["toggleSidebar"];
656
- getHTMLIFrameElement: InstanceType<typeof App>["getHTMLIFrameElement"];
657
- /**
658
- * Disables rendering of frames (including element clipping), but currently
659
- * the frames are still interactive in edit mode. As such, this API should be
660
- * used in conjunction with view mode (props.viewModeEnabled).
661
- */
662
- updateFrameRendering: InstanceType<typeof App>["updateFrameRendering"];
663
- onChange: (callback: (elements: readonly ExcalidrawElement[], appState: AppState, files: BinaryFiles) => void) => UnsubscribeCallback;
664
- onPointerDown: (callback: (activeTool: AppState["activeTool"], pointerDownState: PointerDownState, event: React.PointerEvent<HTMLElement>) => void) => UnsubscribeCallback;
665
- onPointerUp: (callback: (activeTool: AppState["activeTool"], pointerDownState: PointerDownState, event: PointerEvent) => void) => UnsubscribeCallback;
666
- onScrollChange: (callback: (scrollX: number, scrollY: number, zoom: Zoom) => void) => UnsubscribeCallback;
667
- onUserFollow: (callback: (payload: OnUserFollowedPayload) => void) => UnsubscribeCallback;
668
- }
669
- export type Device = Readonly<{
670
- viewport: {
671
- isMobile: boolean;
672
- isLandscape: boolean;
673
- };
674
- editor: {
675
- isMobile: boolean;
676
- canFitSidebar: boolean;
677
- };
678
- isTouchScreen: boolean;
679
- }>;
680
- export type FrameNameBounds = {
681
- x: number;
682
- y: number;
683
- width: number;
684
- height: number;
685
- angle: number;
686
- };
687
- export type FrameNameBoundsCache = {
688
- get: (frameElement: ExcalidrawFrameLikeElement | ExcalidrawMagicFrameElement) => FrameNameBounds | null;
689
- _cache: Map<string, FrameNameBounds & {
690
- zoom: AppState["zoom"]["value"];
691
- versionNonce: ExcalidrawFrameLikeElement["versionNonce"];
692
- }>;
693
- };
694
- export type KeyboardModifiersObject = {
695
- ctrlKey: boolean;
696
- shiftKey: boolean;
697
- altKey: boolean;
698
- metaKey: boolean;
699
- };
700
- export type Primitive = number | string | boolean | bigint | symbol | null | undefined;
701
- export type JSONValue = string | number | boolean | null | object;
702
- export type EmbedsValidationStatus = Map<ExcalidrawIframeLikeElement["id"], boolean>;
703
- export type ElementsPendingErasure = Set<ExcalidrawElement["id"]>;
704
- export type PendingExcalidrawElements = ExcalidrawElement[];
705
- /** Runtime gridSize value. Null indicates disabled grid. */
706
- export type NullableGridSize = (AppState["gridSize"] & MakeBrand<"NullableGridSize">) | null;
707
- export type GenerateDiagramToCode = (props: {
708
- frame: ExcalidrawMagicFrameElement;
709
- children: readonly ExcalidrawElement[];
710
- }) => MaybePromise<{
711
- html: string;
712
- }>;
713
- export type Offsets = Partial<{
714
- top: number;
715
- right: number;
716
- bottom: number;
717
- left: number;
718
- }>;
719
- export {};
1
+ import type React from "react";
2
+ import type { PointerType, ExcalidrawLinearElement, NonDeletedExcalidrawElement, NonDeleted, TextAlign, ExcalidrawElement, GroupId, ExcalidrawBindableElement, Arrowhead, ChartType, FontFamilyValues, ExcalidrawTextElement, FileId, ExcalidrawImageElement, Theme, StrokeRoundness, ExcalidrawEmbeddableElement, ExcalidrawMagicFrameElement, ExcalidrawFrameLikeElement, ExcalidrawElementType, ExcalidrawIframeLikeElement, OrderedExcalidrawElement, ExcalidrawNonSelectionElement } from "./element/types";
3
+ import type { Action } from "./actions/types";
4
+ import type { LinearElementEditor } from "./element/linearElementEditor";
5
+ import type { SuggestedBinding } from "./element/binding";
6
+ import type { ImportedDataState } from "./data/types";
7
+ import type App from "./components/App";
8
+ import type { throttleRAF } from "./utils";
9
+ import type { Spreadsheet } from "./charts";
10
+ import type { Language } from "./i18n";
11
+ import type { ClipboardData } from "./clipboard";
12
+ import type { isOverScrollBars } from "./scene/scrollbars";
13
+ import type { MaybeTransformHandleType } from "./element/transformHandles";
14
+ import type Library from "./data/library";
15
+ import type { FileSystemHandle } from "./data/filesystem";
16
+ import type { IMAGE_MIME_TYPES, MIME_TYPES } from "./constants";
17
+ import type { ContextMenuItems } from "./components/ContextMenu";
18
+ import type { SnapLine } from "./snapping";
19
+ import type { Merge, MaybePromise, ValueOf, MakeBrand } from "./utility-types";
20
+ import type { ColorPaletteCustom } from "./colors";
21
+ import type { StoreActionType } from "./store";
22
+ export type SocketId = string & {
23
+ _brand: "SocketId";
24
+ };
25
+ export type Collaborator = Readonly<{
26
+ pointer?: CollaboratorPointer;
27
+ button?: "up" | "down";
28
+ selectedElementIds?: AppState["selectedElementIds"];
29
+ username?: string | null;
30
+ userState?: UserIdleState;
31
+ color?: {
32
+ background: string;
33
+ stroke: string;
34
+ };
35
+ avatarUrl?: string;
36
+ id?: string;
37
+ socketId?: SocketId;
38
+ isCurrentUser?: boolean;
39
+ isInCall?: boolean;
40
+ isSpeaking?: boolean;
41
+ isMuted?: boolean;
42
+ }>;
43
+ export type CollaboratorPointer = {
44
+ x: number;
45
+ y: number;
46
+ tool: "pointer" | "laser";
47
+ /**
48
+ * Whether to render cursor + username. Useful when you only want to render
49
+ * laser trail.
50
+ *
51
+ * @default true
52
+ */
53
+ renderCursor?: boolean;
54
+ /**
55
+ * Explicit laser color.
56
+ *
57
+ * @default string collaborator's cursor color
58
+ */
59
+ laserColor?: string;
60
+ };
61
+ export type DataURL = string & {
62
+ _brand: "DataURL";
63
+ };
64
+ export type BinaryFileData = {
65
+ mimeType: ValueOf<typeof IMAGE_MIME_TYPES> | typeof MIME_TYPES.binary;
66
+ id: FileId;
67
+ dataURL: DataURL;
68
+ /**
69
+ * Epoch timestamp in milliseconds
70
+ */
71
+ created: number;
72
+ /**
73
+ * Indicates when the file was last retrieved from storage to be loaded
74
+ * onto the scene. We use this flag to determine whether to delete unused
75
+ * files from storage.
76
+ *
77
+ * Epoch timestamp in milliseconds.
78
+ */
79
+ lastRetrieved?: number;
80
+ };
81
+ export type BinaryFileMetadata = Omit<BinaryFileData, "dataURL">;
82
+ export type BinaryFiles = Record<ExcalidrawElement["id"], BinaryFileData>;
83
+ export type ToolType = "selection" | "rectangle" | "diamond" | "ellipse" | "arrow" | "line" | "freedraw" | "text" | "image" | "eraser" | "hand" | "frame" | "magicframe" | "embeddable" | "laser" | "mermaid";
84
+ export type ElementOrToolType = ExcalidrawElementType | ToolType | "custom";
85
+ export type ActiveTool = {
86
+ type: ToolType;
87
+ customType: null;
88
+ } | {
89
+ type: "custom";
90
+ customType: string;
91
+ };
92
+ export type SidebarName = string;
93
+ export type SidebarTabName = string;
94
+ export type UserToFollow = {
95
+ socketId: SocketId;
96
+ username: string;
97
+ };
98
+ type _CommonCanvasAppState = {
99
+ zoom: AppState["zoom"];
100
+ scrollX: AppState["scrollX"];
101
+ scrollY: AppState["scrollY"];
102
+ width: AppState["width"];
103
+ height: AppState["height"];
104
+ viewModeEnabled: AppState["viewModeEnabled"];
105
+ editingGroupId: AppState["editingGroupId"];
106
+ selectedElementIds: AppState["selectedElementIds"];
107
+ frameToHighlight: AppState["frameToHighlight"];
108
+ offsetLeft: AppState["offsetLeft"];
109
+ offsetTop: AppState["offsetTop"];
110
+ theme: AppState["theme"];
111
+ pendingImageElementId: AppState["pendingImageElementId"];
112
+ };
113
+ export type StaticCanvasAppState = Readonly<_CommonCanvasAppState & {
114
+ shouldCacheIgnoreZoom: AppState["shouldCacheIgnoreZoom"];
115
+ /** null indicates transparent bg */
116
+ viewBackgroundColor: AppState["viewBackgroundColor"] | null;
117
+ exportScale: AppState["exportScale"];
118
+ selectedElementsAreBeingDragged: AppState["selectedElementsAreBeingDragged"];
119
+ gridSize: AppState["gridSize"];
120
+ gridStep: AppState["gridStep"];
121
+ frameRendering: AppState["frameRendering"];
122
+ linkOpacity: AppState["linkOpacity"];
123
+ gridColor: AppState["gridColor"];
124
+ frameColor: AppState["frameColor"];
125
+ currentHoveredFontFamily: AppState["currentHoveredFontFamily"];
126
+ }>;
127
+ export type InteractiveCanvasAppState = Readonly<_CommonCanvasAppState & {
128
+ activeEmbeddable: AppState["activeEmbeddable"];
129
+ editingLinearElement: AppState["editingLinearElement"];
130
+ selectionElement: AppState["selectionElement"];
131
+ selectedGroupIds: AppState["selectedGroupIds"];
132
+ selectedLinearElement: AppState["selectedLinearElement"];
133
+ multiElement: AppState["multiElement"];
134
+ isBindingEnabled: AppState["isBindingEnabled"];
135
+ suggestedBindings: AppState["suggestedBindings"];
136
+ isRotating: AppState["isRotating"];
137
+ elementsToHighlight: AppState["elementsToHighlight"];
138
+ collaborators: AppState["collaborators"];
139
+ snapLines: AppState["snapLines"];
140
+ zenModeEnabled: AppState["zenModeEnabled"];
141
+ editingTextElement: AppState["editingTextElement"];
142
+ gridColor: AppState["gridColor"];
143
+ highlightSearchResult: AppState["highlightSearchResult"];
144
+ searchMatches: AppState["searchMatches"];
145
+ }>;
146
+ export type ObservedAppState = ObservedStandaloneAppState & ObservedElementsAppState;
147
+ export type ObservedStandaloneAppState = {
148
+ name: AppState["name"];
149
+ viewBackgroundColor: AppState["viewBackgroundColor"];
150
+ };
151
+ export type ObservedElementsAppState = {
152
+ editingGroupId: AppState["editingGroupId"];
153
+ selectedElementIds: AppState["selectedElementIds"];
154
+ selectedGroupIds: AppState["selectedGroupIds"];
155
+ editingLinearElementId: LinearElementEditor["elementId"] | null;
156
+ selectedLinearElementId: LinearElementEditor["elementId"] | null;
157
+ };
158
+ export interface AppState {
159
+ contextMenu: {
160
+ items: ContextMenuItems;
161
+ top: number;
162
+ left: number;
163
+ } | null;
164
+ showWelcomeScreen: boolean;
165
+ isLoading: boolean;
166
+ errorMessage: React.ReactNode;
167
+ activeEmbeddable: {
168
+ element: NonDeletedExcalidrawElement;
169
+ state: "hover" | "active";
170
+ } | null;
171
+ /**
172
+ * for a newly created element
173
+ * - set on pointer down, updated during pointer move, used on pointer up
174
+ */
175
+ newElement: NonDeleted<ExcalidrawNonSelectionElement> | null;
176
+ /**
177
+ * for a single element that's being resized
178
+ * - set on pointer down when it's selected and the active tool is selection
179
+ */
180
+ resizingElement: NonDeletedExcalidrawElement | null;
181
+ /**
182
+ * multiElement is for multi-point linear element that's created by clicking as opposed to dragging
183
+ * - when set and present, the editor will handle linear element creation logic accordingly
184
+ */
185
+ multiElement: NonDeleted<ExcalidrawLinearElement> | null;
186
+ /**
187
+ * decoupled from newElement, dragging selection only creates selectionElement
188
+ * - set on pointer down, updated during pointer move
189
+ */
190
+ selectionElement: NonDeletedExcalidrawElement | null;
191
+ isBindingEnabled: boolean;
192
+ startBoundElement: NonDeleted<ExcalidrawBindableElement> | null;
193
+ suggestedBindings: SuggestedBinding[];
194
+ frameToHighlight: NonDeleted<ExcalidrawFrameLikeElement> | null;
195
+ frameRendering: {
196
+ enabled: boolean;
197
+ name: boolean;
198
+ outline: boolean;
199
+ clip: boolean;
200
+ };
201
+ editingFrame: string | null;
202
+ elementsToHighlight: NonDeleted<ExcalidrawElement>[] | null;
203
+ /**
204
+ * set when a new text is created or when an existing text is being edited
205
+ */
206
+ editingTextElement: NonDeletedExcalidrawElement | null;
207
+ editingLinearElement: LinearElementEditor | null;
208
+ activeTool: {
209
+ /**
210
+ * indicates a previous tool we should revert back to if we deselect the
211
+ * currently active tool. At the moment applies to `eraser` and `hand` tool.
212
+ */
213
+ lastActiveTool: ActiveTool | null;
214
+ locked: boolean;
215
+ } & ActiveTool;
216
+ penMode: boolean;
217
+ penDetected: boolean;
218
+ exportBackground: boolean;
219
+ exportEmbedScene: boolean;
220
+ exportWithDarkMode: boolean;
221
+ exportScale: number;
222
+ currentItemStrokeColor: string;
223
+ currentItemBackgroundColor: string;
224
+ currentItemFillStyle: ExcalidrawElement["fillStyle"];
225
+ currentItemStrokeWidth: number;
226
+ currentItemStrokeStyle: ExcalidrawElement["strokeStyle"];
227
+ currentItemRoughness: number;
228
+ currentItemOpacity: number;
229
+ currentItemFontFamily: FontFamilyValues;
230
+ currentItemFontSize: number;
231
+ currentItemTextAlign: TextAlign;
232
+ currentItemStartArrowhead: Arrowhead | null;
233
+ currentItemEndArrowhead: Arrowhead | null;
234
+ currentHoveredFontFamily: FontFamilyValues | null;
235
+ currentItemRoundness: StrokeRoundness;
236
+ currentItemArrowType: "sharp" | "round" | "elbow";
237
+ viewBackgroundColor: string;
238
+ scrollX: number;
239
+ scrollY: number;
240
+ cursorButton: "up" | "down";
241
+ scrolledOutside: boolean;
242
+ name: string | null;
243
+ isResizing: boolean;
244
+ isRotating: boolean;
245
+ zoom: Zoom;
246
+ openMenu: "canvas" | "shape" | null;
247
+ openPopup: "canvasBackground" | "elementBackground" | "elementStroke" | "fontFamily" | null;
248
+ openSidebar: {
249
+ name: SidebarName;
250
+ tab?: SidebarTabName;
251
+ } | null;
252
+ openDialog: null | {
253
+ name: "imageExport" | "help" | "jsonExport";
254
+ } | {
255
+ name: "ttd";
256
+ tab: "text-to-diagram" | "mermaid";
257
+ } | {
258
+ name: "commandPalette";
259
+ };
260
+ /**
261
+ * Reflects user preference for whether the default sidebar should be docked.
262
+ *
263
+ * NOTE this is only a user preference and does not reflect the actual docked
264
+ * state of the sidebar, because the host apps can override this through
265
+ * a DefaultSidebar prop, which is not reflected back to the appState.
266
+ */
267
+ defaultSidebarDockedPreference: boolean;
268
+ lastPointerDownWith: PointerType;
269
+ selectedElementIds: Readonly<{
270
+ [id: string]: true;
271
+ }>;
272
+ previousSelectedElementIds: {
273
+ [id: string]: true;
274
+ };
275
+ selectedElementsAreBeingDragged: boolean;
276
+ shouldCacheIgnoreZoom: boolean;
277
+ toast: {
278
+ message: string;
279
+ closable?: boolean;
280
+ duration?: number;
281
+ } | null;
282
+ zenModeEnabled: boolean;
283
+ theme: Theme;
284
+ /** grid cell px size */
285
+ gridSize: number;
286
+ gridStep: number;
287
+ gridModeEnabled: boolean;
288
+ viewModeEnabled: boolean;
289
+ /** top-most selected groups (i.e. does not include nested groups) */
290
+ selectedGroupIds: {
291
+ [groupId: string]: boolean;
292
+ };
293
+ /** group being edited when you drill down to its constituent element
294
+ (e.g. when you double-click on a group's element) */
295
+ editingGroupId: GroupId | null;
296
+ width: number;
297
+ height: number;
298
+ offsetTop: number;
299
+ offsetLeft: number;
300
+ fileHandle: FileSystemHandle | null;
301
+ collaborators: Map<SocketId, Collaborator>;
302
+ stats: {
303
+ open: boolean;
304
+ /** bitmap. Use `STATS_PANELS` bit values */
305
+ panels: number;
306
+ };
307
+ currentChartType: ChartType;
308
+ pasteDialog: {
309
+ shown: false;
310
+ data: null;
311
+ } | {
312
+ shown: true;
313
+ data: Spreadsheet;
314
+ };
315
+ /** imageElement waiting to be placed on canvas */
316
+ pendingImageElementId: ExcalidrawImageElement["id"] | null;
317
+ showHyperlinkPopup: false | "info" | "editor";
318
+ linkOpacity: number;
319
+ trayModeEnabled: boolean;
320
+ colorPalette?: {
321
+ canvasBackground: ColorPaletteCustom;
322
+ elementBackground: ColorPaletteCustom;
323
+ elementStroke: ColorPaletteCustom;
324
+ topPicks: {
325
+ canvasBackground: [string, string, string, string, string];
326
+ elementStroke: [string, string, string, string, string];
327
+ elementBackground: [string, string, string, string, string];
328
+ };
329
+ };
330
+ allowWheelZoom?: boolean;
331
+ allowPinchZoom?: boolean;
332
+ pinnedScripts?: string[];
333
+ customPens?: any[];
334
+ currentStrokeOptions?: any;
335
+ resetCustomPen?: any;
336
+ gridColor: {
337
+ Bold: string;
338
+ Regular: string;
339
+ };
340
+ highlightSearchResult: boolean;
341
+ dynamicStyle: {
342
+ [x: string]: string;
343
+ };
344
+ frameColor: {
345
+ stroke: string;
346
+ fill: string;
347
+ nameColor: string;
348
+ };
349
+ invertBindingBehaviour: boolean;
350
+ selectedLinearElement: LinearElementEditor | null;
351
+ snapLines: readonly SnapLine[];
352
+ originSnapOffset: {
353
+ x: number;
354
+ y: number;
355
+ } | null;
356
+ objectsSnapModeEnabled: boolean;
357
+ /** the user's socket id & username who is being followed on the canvas */
358
+ userToFollow: UserToFollow | null;
359
+ /** the socket ids of the users following the current user */
360
+ followedBy: Set<SocketId>;
361
+ searchMatches: readonly SearchMatch[];
362
+ }
363
+ type SearchMatch = {
364
+ id: string;
365
+ focus: boolean;
366
+ matchedLines: {
367
+ offsetX: number;
368
+ offsetY: number;
369
+ width: number;
370
+ height: number;
371
+ }[];
372
+ };
373
+ export type UIAppState = Omit<AppState, "suggestedBindings" | "startBoundElement" | "cursorButton" | "scrollX" | "scrollY">;
374
+ export type NormalizedZoomValue = number & {
375
+ _brand: "normalizedZoom";
376
+ };
377
+ export type Zoom = Readonly<{
378
+ value: NormalizedZoomValue;
379
+ }>;
380
+ export type PointerCoords = Readonly<{
381
+ x: number;
382
+ y: number;
383
+ }>;
384
+ export type Gesture = {
385
+ pointers: Map<number, PointerCoords>;
386
+ lastCenter: {
387
+ x: number;
388
+ y: number;
389
+ } | null;
390
+ initialDistance: number | null;
391
+ initialScale: number | null;
392
+ };
393
+ export declare class GestureEvent extends UIEvent {
394
+ readonly rotation: number;
395
+ readonly scale: number;
396
+ }
397
+ /** @deprecated legacy: do not use outside of migration paths */
398
+ export type LibraryItem_v1 = readonly NonDeleted<ExcalidrawElement>[];
399
+ /** @deprecated legacy: do not use outside of migration paths */
400
+ type LibraryItems_v1 = readonly LibraryItem_v1[];
401
+ /** v2 library item */
402
+ export type LibraryItem = {
403
+ id: string;
404
+ status: "published" | "unpublished";
405
+ elements: readonly NonDeleted<ExcalidrawElement>[];
406
+ /** timestamp in epoch (ms) */
407
+ created: number;
408
+ name?: string;
409
+ error?: string;
410
+ };
411
+ export type LibraryItems = readonly LibraryItem[];
412
+ export type LibraryItems_anyVersion = LibraryItems | LibraryItems_v1;
413
+ export type LibraryItemsSource = ((currentLibraryItems: LibraryItems) => MaybePromise<LibraryItems_anyVersion | Blob>) | MaybePromise<LibraryItems_anyVersion | Blob>;
414
+ export type ExcalidrawInitialDataState = Merge<ImportedDataState, {
415
+ libraryItems?: MaybePromise<Required<ImportedDataState>["libraryItems"]>;
416
+ }>;
417
+ export type OnUserFollowedPayload = {
418
+ userToFollow: UserToFollow;
419
+ action: "FOLLOW" | "UNFOLLOW";
420
+ };
421
+ export interface ExcalidrawProps {
422
+ onChange?: (elements: readonly OrderedExcalidrawElement[], appState: AppState, files: BinaryFiles) => void;
423
+ initialData?: (() => MaybePromise<ExcalidrawInitialDataState | null>) | MaybePromise<ExcalidrawInitialDataState | null>;
424
+ excalidrawAPI?: (api: ExcalidrawImperativeAPI) => void;
425
+ isCollaborating?: boolean;
426
+ onPointerUpdate?: (payload: {
427
+ pointer: {
428
+ x: number;
429
+ y: number;
430
+ tool: "pointer" | "laser";
431
+ };
432
+ button: "down" | "up";
433
+ pointersMap: Gesture["pointers"];
434
+ }) => void;
435
+ onPaste?: (data: ClipboardData, event: ClipboardEvent | null) => Promise<boolean> | boolean;
436
+ onDrop?: (event: React.DragEvent<HTMLDivElement>) => Promise<boolean> | boolean;
437
+ renderTopRightUI?: (isMobile: boolean, appState: UIAppState) => JSX.Element | null;
438
+ langCode?: Language["code"];
439
+ viewModeEnabled?: boolean;
440
+ zenModeEnabled?: boolean;
441
+ gridModeEnabled?: boolean;
442
+ objectsSnapModeEnabled?: boolean;
443
+ libraryReturnUrl?: string;
444
+ initState?: AppState;
445
+ theme?: Theme;
446
+ name?: string;
447
+ renderCustomStats?: (elements: readonly NonDeletedExcalidrawElement[], appState: UIAppState) => JSX.Element;
448
+ UIOptions?: Partial<UIOptions>;
449
+ detectScroll?: boolean;
450
+ handleKeyboardGlobally?: boolean;
451
+ onLibraryChange?: (libraryItems: LibraryItems) => void | Promise<any>;
452
+ autoFocus?: boolean;
453
+ onBeforeTextEdit?: (textElement: ExcalidrawTextElement) => string;
454
+ onBeforeTextSubmit?: (textElement: ExcalidrawTextElement, nextText: string, //wrapped
455
+ nextOriginalText: string, isDeleted: boolean) => {
456
+ updatedNextOriginalText: string;
457
+ nextLink: string;
458
+ };
459
+ generateIdForFile?: (file: File) => string | Promise<string>;
460
+ onThemeChange?: (newTheme: string) => void;
461
+ onViewModeChange?: (isViewModeEnabled: boolean) => void;
462
+ onLinkOpen?: (element: NonDeletedExcalidrawElement, event: CustomEvent<{
463
+ nativeEvent: MouseEvent | React.PointerEvent<HTMLCanvasElement>;
464
+ }>) => void;
465
+ onLinkHover?: (element: NonDeletedExcalidrawElement, event: React.PointerEvent<HTMLCanvasElement>) => void;
466
+ onPointerDown?: (activeTool: AppState["activeTool"], pointerDownState: PointerDownState) => void;
467
+ onPointerUp?: (activeTool: AppState["activeTool"], pointerDownState: PointerDownState) => void;
468
+ onScrollChange?: (scrollX: number, scrollY: number, zoom: Zoom) => void;
469
+ onUserFollow?: (payload: OnUserFollowedPayload) => void;
470
+ children?: React.ReactNode;
471
+ validateEmbeddable?: boolean | string[] | RegExp | RegExp[] | ((link: string) => boolean | undefined);
472
+ renderEmbeddable?: (element: NonDeleted<ExcalidrawEmbeddableElement>, appState: AppState) => JSX.Element | null;
473
+ renderWebview?: boolean;
474
+ renderEmbeddableMenu?: (appState: AppState) => JSX.Element | null;
475
+ renderMermaid?: boolean;
476
+ onContextMenu?: (element: readonly NonDeletedExcalidrawElement[], appState: AppState, onClose: (callback?: () => void) => void) => JSX.Element | null;
477
+ aiEnabled?: boolean;
478
+ obsidianHostPlugin: WeakRef<any>;
479
+ showDeprecatedFonts?: boolean;
480
+ }
481
+ export type SceneData = {
482
+ elements?: ImportedDataState["elements"];
483
+ appState?: ImportedDataState["appState"];
484
+ collaborators?: Map<SocketId, Collaborator>;
485
+ storeAction?: StoreActionType;
486
+ };
487
+ export declare enum UserIdleState {
488
+ ACTIVE = "active",
489
+ AWAY = "away",
490
+ IDLE = "idle"
491
+ }
492
+ export type ExportOpts = {
493
+ saveFileToDisk?: boolean;
494
+ onExportToBackend?: (exportedElements: readonly NonDeletedExcalidrawElement[], appState: UIAppState, files: BinaryFiles) => void;
495
+ renderCustomUI?: (exportedElements: readonly NonDeletedExcalidrawElement[], appState: UIAppState, files: BinaryFiles, canvas: HTMLCanvasElement) => JSX.Element;
496
+ };
497
+ export type CanvasActions = Partial<{
498
+ changeViewBackgroundColor: boolean;
499
+ clearCanvas: boolean;
500
+ export: false | ExportOpts;
501
+ loadScene: boolean;
502
+ saveToActiveFile: boolean;
503
+ toggleTheme: boolean | null;
504
+ saveAsImage: boolean;
505
+ }>;
506
+ export type UIOptions = Partial<{
507
+ dockedSidebarBreakpoint: number;
508
+ canvasActions: CanvasActions;
509
+ tools: {
510
+ image: boolean;
511
+ };
512
+ /** @deprecated does nothing. Will be removed in 0.15 */
513
+ welcomeScreen?: boolean;
514
+ }>;
515
+ export type AppProps = Merge<ExcalidrawProps, {
516
+ UIOptions: Merge<UIOptions, {
517
+ canvasActions: Required<CanvasActions> & {
518
+ export: ExportOpts;
519
+ };
520
+ }>;
521
+ detectScroll: boolean;
522
+ handleKeyboardGlobally: boolean;
523
+ isCollaborating: boolean;
524
+ children?: React.ReactNode;
525
+ aiEnabled: boolean;
526
+ }>;
527
+ /** A subset of App class properties that we need to use elsewhere
528
+ * in the app, eg Manager. Factored out into a separate type to keep DRY. */
529
+ export type AppClassProperties = {
530
+ props: AppProps;
531
+ state: AppState;
532
+ interactiveCanvas: HTMLCanvasElement | null;
533
+ /** static canvas */
534
+ canvas: HTMLCanvasElement;
535
+ focusContainer(): void;
536
+ library: Library;
537
+ imageCache: Map<FileId, {
538
+ image: HTMLImageElement | Promise<HTMLImageElement>;
539
+ mimeType: ValueOf<typeof IMAGE_MIME_TYPES>;
540
+ }>;
541
+ files: BinaryFiles;
542
+ device: App["device"];
543
+ scene: App["scene"];
544
+ syncActionResult: App["syncActionResult"];
545
+ fonts: App["fonts"];
546
+ pasteFromClipboard: App["pasteFromClipboard"];
547
+ id: App["id"];
548
+ onInsertElements: App["onInsertElements"];
549
+ onExportImage: App["onExportImage"];
550
+ lastViewportPosition: App["lastViewportPosition"];
551
+ scrollToContent: App["scrollToContent"];
552
+ addFiles: App["addFiles"];
553
+ addElementsFromPasteOrLibrary: App["addElementsFromPasteOrLibrary"];
554
+ setSelection: App["setSelection"];
555
+ togglePenMode: App["togglePenMode"];
556
+ toggleLock: App["toggleLock"];
557
+ setActiveTool: App["setActiveTool"];
558
+ setOpenDialog: App["setOpenDialog"];
559
+ insertEmbeddableElement: App["insertEmbeddableElement"];
560
+ onMagicframeToolSelect: App["onMagicframeToolSelect"];
561
+ getName: App["getName"];
562
+ dismissLinearEditor: App["dismissLinearEditor"];
563
+ flowChartCreator: App["flowChartCreator"];
564
+ getEffectiveGridSize: App["getEffectiveGridSize"];
565
+ setPlugins: App["setPlugins"];
566
+ plugins: App["plugins"];
567
+ getEditorUIOffsets: App["getEditorUIOffsets"];
568
+ visibleElements: App["visibleElements"];
569
+ excalidrawContainerValue: App["excalidrawContainerValue"];
570
+ };
571
+ export type PointerDownState = Readonly<{
572
+ origin: Readonly<{
573
+ x: number;
574
+ y: number;
575
+ }>;
576
+ originInGrid: Readonly<{
577
+ x: number;
578
+ y: number;
579
+ }>;
580
+ scrollbars: ReturnType<typeof isOverScrollBars>;
581
+ lastCoords: {
582
+ x: number;
583
+ y: number;
584
+ };
585
+ originalElements: Map<string, NonDeleted<ExcalidrawElement>>;
586
+ resize: {
587
+ handleType: MaybeTransformHandleType;
588
+ isResizing: boolean;
589
+ offset: {
590
+ x: number;
591
+ y: number;
592
+ };
593
+ arrowDirection: "origin" | "end";
594
+ center: {
595
+ x: number;
596
+ y: number;
597
+ };
598
+ };
599
+ hit: {
600
+ element: NonDeleted<ExcalidrawElement> | null;
601
+ allHitElements: NonDeleted<ExcalidrawElement>[];
602
+ wasAddedToSelection: boolean;
603
+ hasBeenDuplicated: boolean;
604
+ hasHitCommonBoundingBoxOfSelectedElements: boolean;
605
+ };
606
+ withCmdOrCtrl: boolean;
607
+ drag: {
608
+ hasOccurred: boolean;
609
+ offset: {
610
+ x: number;
611
+ y: number;
612
+ } | null;
613
+ };
614
+ eventListeners: {
615
+ onMove: null | ReturnType<typeof throttleRAF>;
616
+ onUp: null | ((event: PointerEvent) => void);
617
+ onKeyDown: null | ((event: KeyboardEvent) => void);
618
+ onKeyUp: null | ((event: KeyboardEvent) => void);
619
+ };
620
+ boxSelection: {
621
+ hasOccurred: boolean;
622
+ };
623
+ }>;
624
+ export type UnsubscribeCallback = () => void;
625
+ export interface ExcalidrawImperativeAPI {
626
+ updateScene: InstanceType<typeof App>["updateScene"];
627
+ updateLibrary: InstanceType<typeof Library>["updateLibrary"];
628
+ resetScene: InstanceType<typeof App>["resetScene"];
629
+ getSceneElementsIncludingDeleted: InstanceType<typeof App>["getSceneElementsIncludingDeleted"];
630
+ history: {
631
+ clear: InstanceType<typeof App>["resetHistory"];
632
+ };
633
+ zoomToFit: InstanceType<typeof App>["zoomToFit"];
634
+ startLineEditor: InstanceType<typeof App>["startLineEditor"];
635
+ getSceneElements: InstanceType<typeof App>["getSceneElements"];
636
+ getAppState: () => InstanceType<typeof App>["state"];
637
+ getFiles: () => InstanceType<typeof App>["files"];
638
+ getName: InstanceType<typeof App>["getName"];
639
+ scrollToContent: InstanceType<typeof App>["scrollToContent"];
640
+ registerAction: (action: Action) => void;
641
+ refresh: InstanceType<typeof App>["refresh"];
642
+ setToast: InstanceType<typeof App>["setToast"];
643
+ addFiles: (data: BinaryFileData[]) => void;
644
+ updateContainerSize: InstanceType<typeof App>["updateContainerSize"];
645
+ id: string;
646
+ selectElements: (elements: readonly ExcalidrawElement[], highlightSearchResult?: boolean) => void;
647
+ sendBackward: (elements: readonly ExcalidrawElement[]) => void;
648
+ bringForward: (elements: readonly ExcalidrawElement[]) => void;
649
+ sendToBack: (elements: readonly ExcalidrawElement[]) => void;
650
+ bringToFront: (elements: readonly ExcalidrawElement[]) => void;
651
+ setMobileModeAllowed: (allow: boolean) => void;
652
+ setActiveTool: InstanceType<typeof App>["setActiveTool"];
653
+ setCursor: InstanceType<typeof App>["setCursor"];
654
+ resetCursor: InstanceType<typeof App>["resetCursor"];
655
+ toggleSidebar: InstanceType<typeof App>["toggleSidebar"];
656
+ getHTMLIFrameElement: InstanceType<typeof App>["getHTMLIFrameElement"];
657
+ /**
658
+ * Disables rendering of frames (including element clipping), but currently
659
+ * the frames are still interactive in edit mode. As such, this API should be
660
+ * used in conjunction with view mode (props.viewModeEnabled).
661
+ */
662
+ updateFrameRendering: InstanceType<typeof App>["updateFrameRendering"];
663
+ onChange: (callback: (elements: readonly ExcalidrawElement[], appState: AppState, files: BinaryFiles) => void) => UnsubscribeCallback;
664
+ onPointerDown: (callback: (activeTool: AppState["activeTool"], pointerDownState: PointerDownState, event: React.PointerEvent<HTMLElement>) => void) => UnsubscribeCallback;
665
+ onPointerUp: (callback: (activeTool: AppState["activeTool"], pointerDownState: PointerDownState, event: PointerEvent) => void) => UnsubscribeCallback;
666
+ onScrollChange: (callback: (scrollX: number, scrollY: number, zoom: Zoom) => void) => UnsubscribeCallback;
667
+ onUserFollow: (callback: (payload: OnUserFollowedPayload) => void) => UnsubscribeCallback;
668
+ }
669
+ export type Device = Readonly<{
670
+ viewport: {
671
+ isMobile: boolean;
672
+ isLandscape: boolean;
673
+ };
674
+ editor: {
675
+ isMobile: boolean;
676
+ canFitSidebar: boolean;
677
+ };
678
+ isTouchScreen: boolean;
679
+ }>;
680
+ export type FrameNameBounds = {
681
+ x: number;
682
+ y: number;
683
+ width: number;
684
+ height: number;
685
+ angle: number;
686
+ };
687
+ export type FrameNameBoundsCache = {
688
+ get: (frameElement: ExcalidrawFrameLikeElement | ExcalidrawMagicFrameElement) => FrameNameBounds | null;
689
+ _cache: Map<string, FrameNameBounds & {
690
+ zoom: AppState["zoom"]["value"];
691
+ versionNonce: ExcalidrawFrameLikeElement["versionNonce"];
692
+ }>;
693
+ };
694
+ export type KeyboardModifiersObject = {
695
+ ctrlKey: boolean;
696
+ shiftKey: boolean;
697
+ altKey: boolean;
698
+ metaKey: boolean;
699
+ };
700
+ export type Primitive = number | string | boolean | bigint | symbol | null | undefined;
701
+ export type JSONValue = string | number | boolean | null | object;
702
+ export type EmbedsValidationStatus = Map<ExcalidrawIframeLikeElement["id"], boolean>;
703
+ export type ElementsPendingErasure = Set<ExcalidrawElement["id"]>;
704
+ export type PendingExcalidrawElements = ExcalidrawElement[];
705
+ /** Runtime gridSize value. Null indicates disabled grid. */
706
+ export type NullableGridSize = (AppState["gridSize"] & MakeBrand<"NullableGridSize">) | null;
707
+ export type GenerateDiagramToCode = (props: {
708
+ frame: ExcalidrawMagicFrameElement;
709
+ children: readonly ExcalidrawElement[];
710
+ }) => MaybePromise<{
711
+ html: string;
712
+ }>;
713
+ export type Offsets = Partial<{
714
+ top: number;
715
+ right: number;
716
+ bottom: number;
717
+ left: number;
718
+ }>;
719
+ export {};