@zsviczian/excalidraw 0.17.1-obsidian-38 → 0.17.1-obsidian-39

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