@sheetxl/react 0.8.0-beta.2 → 0.8.0-beta.20

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 (405) hide show
  1. package/LICENSE.md +8 -7
  2. package/browser/esm/B06WJCAWTIB7QYlK.mjs +45 -0
  3. package/browser/esm/B8_6V0LUnuA1dLW6.mjs +20 -0
  4. package/browser/esm/BFjx8_H3wUxrWDq9.mjs +60 -0
  5. package/browser/esm/BGcs5WWx5PpaiJo4.mjs +36 -0
  6. package/browser/esm/BcC6S9k7zkHfCNRX.mjs +42 -0
  7. package/browser/esm/BkBxhk45Iln3h-sG.mjs +67 -0
  8. package/browser/esm/BzZ2vOT8CNsqcL8P.mjs +79 -0
  9. package/browser/esm/C1Qp40Kq88D9nzcX.mjs +19 -0
  10. package/browser/esm/C5RaHvks1HTBfWcr.mjs +14092 -0
  11. package/browser/esm/CM9e6dbkYbw56iFf.mjs +401 -0
  12. package/browser/esm/COn0z_IT5hyEPNfV.mjs +8 -0
  13. package/browser/esm/CPjk4grd05Rp-e3V.mjs +9560 -0
  14. package/browser/esm/CU67T36gmVTq9ZwH.mjs +31 -0
  15. package/browser/esm/CUPlUCBX7owYqDq5.mjs +78 -0
  16. package/browser/esm/Ca_Ki0Si5ozlm1sl.mjs +197 -0
  17. package/browser/esm/CckrsFaUWle82oNL.mjs +63 -0
  18. package/browser/esm/Ch5X-uGft55TOqxa.mjs +262 -0
  19. package/browser/esm/CtbJ8PCap2NGxlu0.mjs +32 -0
  20. package/browser/esm/Cwye4MAU1-EF7Xlv.mjs +341 -0
  21. package/browser/esm/DcEGutcM_5gl0fZm.mjs +145 -0
  22. package/browser/esm/DeOhqQroIiAic6-j.mjs +2706 -0
  23. package/browser/esm/Dkw3FFdQKXZQrkFv.mjs +303 -0
  24. package/browser/esm/QJPDAP6UIHTbY1fM.mjs +134 -0
  25. package/browser/esm/SESUB_fypyWmhCWm.mjs +323 -0
  26. package/browser/esm/chart.mjs +41 -0
  27. package/browser/esm/control.mjs +217 -0
  28. package/browser/esm/group.mjs +123 -0
  29. package/browser/esm/index.mjs +22345 -13175
  30. package/browser/esm/note.mjs +112 -0
  31. package/browser/esm/picture.mjs +7 -0
  32. package/browser/esm/qeb-_mAjUAWD7bo4.mjs +128 -0
  33. package/browser/esm/shape.mjs +7 -0
  34. package/browser/esm/slicer.mjs +277 -0
  35. package/licenses/dependencies.txt +284 -565
  36. package/node/esm/77PQMLXXAN7fjBHS.mjs +8 -0
  37. package/node/esm/7_AWLfp_6MpYBpiV.mjs +32 -0
  38. package/node/esm/BOAB33GIG2M2CWMr.mjs +80 -0
  39. package/node/esm/BbnUYxeK64Fq92Lo.mjs +406 -0
  40. package/node/esm/C7wmHIY8RLeNSX3T.mjs +35 -0
  41. package/node/esm/C9Yq98-vMDznppO2.mjs +134 -0
  42. package/node/esm/CBHY_xaB7ke3yH-f.mjs +66 -0
  43. package/node/esm/CER7_OJffhze14wR.mjs +20 -0
  44. package/node/esm/CWOKAmLpdinc-0TK.mjs +263 -0
  45. package/node/esm/CqnJ_hGK1txHO0j9.mjs +328 -0
  46. package/node/esm/D63HF8XToGXrf7ds.mjs +45 -0
  47. package/node/esm/DmPmSA-2Aha-_6qu.mjs +198 -0
  48. package/node/esm/DrFBSp6XMEAjkdoG.mjs +1697 -0
  49. package/node/esm/DytW9LaLlJGM-6m6.mjs +2706 -0
  50. package/node/esm/Ef8HHL90yLZgk3Gf.mjs +146 -0
  51. package/node/esm/G9tXP39ldfioRVhL.mjs +68 -0
  52. package/node/esm/Jy5x43_CAF31L14-.mjs +37 -0
  53. package/node/esm/Nn0yfoegNHIym4QM.mjs +63 -0
  54. package/node/esm/UBas29HOMjk4p5jo.mjs +19 -0
  55. package/node/esm/c1FOnFN_eCD6KR4l.mjs +80 -0
  56. package/node/esm/chart.mjs +41 -0
  57. package/node/esm/control.mjs +217 -0
  58. package/node/esm/gfwmGAXGhq9IIu1U.mjs +128 -0
  59. package/node/esm/group.mjs +123 -0
  60. package/node/esm/index.mjs +19282 -9996
  61. package/node/esm/note.mjs +113 -0
  62. package/node/esm/picture.mjs +305 -0
  63. package/node/esm/shape.mjs +342 -0
  64. package/node/esm/slicer.mjs +279 -0
  65. package/package.json +56 -15
  66. package/resources/contents.json +36 -0
  67. package/resources/locales/contents.json +84 -0
  68. package/resources/locales/de/chart.cmd.json +82 -0
  69. package/resources/locales/de/movable.cmd.json +68 -0
  70. package/resources/locales/de/picture.cmd.json +188 -0
  71. package/resources/locales/de/pivot.cmd.json +79 -0
  72. package/resources/locales/de/shape.cmd.json +17 -0
  73. package/resources/locales/de/sheet.cmd.json +314 -27
  74. package/resources/locales/de/slicer.cmd.json +17 -0
  75. package/resources/locales/de/sparkline.cmd.json +301 -0
  76. package/resources/locales/de/table.cmd.json +13 -2
  77. package/resources/locales/de/ui.msg.json +367 -3
  78. package/resources/locales/de/workbook.cmd.json +8 -1
  79. package/resources/locales/en/chart.cmd.json +82 -0
  80. package/resources/locales/en/movable.cmd.json +68 -0
  81. package/resources/locales/en/picture.cmd.json +188 -0
  82. package/resources/locales/en/pivot.cmd.json +79 -0
  83. package/resources/locales/en/shape.cmd.json +17 -0
  84. package/resources/locales/en/sheet.cmd.json +328 -29
  85. package/resources/locales/en/slicer.cmd.json +17 -0
  86. package/resources/locales/en/sparkline.cmd.json +301 -0
  87. package/resources/locales/en/table.cmd.json +13 -2
  88. package/resources/locales/en/ui.msg.json +369 -3
  89. package/resources/locales/en/workbook.cmd.json +8 -1
  90. package/types/chart.d.ts +2 -0
  91. package/types/control.d.ts +2 -0
  92. package/types/group.d.ts +2 -0
  93. package/types/note.d.ts +2 -0
  94. package/types/picture.d.ts +2 -0
  95. package/types/shape.d.ts +2 -0
  96. package/types/slicer.d.ts +2 -0
  97. package/types/src/annotation/RangeAnnotationLayer.d.ts +110 -0
  98. package/types/src/annotation/RangeAnnotationTag.d.ts +23 -0
  99. package/types/src/annotation/RangeAnnotations.d.ts +180 -0
  100. package/types/src/annotation/index.d.ts +4 -0
  101. package/types/src/autoFill/FillMenu.d.ts +2 -2
  102. package/types/src/autoFill/FillSeries.d.ts +2 -2
  103. package/types/src/border/StaticBorderRenderer.d.ts +18 -1
  104. package/types/src/border/useBorders.d.ts +95 -3
  105. package/types/src/cell/CellCheckboxRenderer.d.ts +20 -0
  106. package/types/src/cell/CellContent.d.ts +68 -0
  107. package/types/src/cell/CellControlContext.d.ts +37 -0
  108. package/types/src/cell/{FormulaCellRenderer.d.ts → CellFormulaRenderer.d.ts} +10 -7
  109. package/types/src/cell/CellImageRenderer.d.ts +11 -0
  110. package/types/src/cell/CellRenderers.d.ts +190 -0
  111. package/types/src/cell/{SheetCellRenderer.d.ts → CellTextRenderer.d.ts} +11 -8
  112. package/types/src/cell/ColumnButton.d.ts +3 -3
  113. package/types/src/cell/CornerTriangle.d.ts +6 -0
  114. package/types/src/cell/OutlineButton.d.ts +123 -0
  115. package/types/src/cell/PivotButton.d.ts +55 -0
  116. package/types/src/cell/SheetHeaderRenderer.d.ts +6 -1
  117. package/types/src/cell/StaticCellRenderer.d.ts +3 -3
  118. package/types/src/cell/_DropdownFace.d.ts +29 -0
  119. package/types/src/cell/index.d.ts +10 -2
  120. package/types/src/cell/useFormulaViewAnchor.d.ts +3 -3
  121. package/types/src/cell/useInsertableCellControls.d.ts +25 -0
  122. package/types/src/chart/ChartCommands.d.ts +15 -0
  123. package/types/src/chart/ChartEditor.d.ts +12 -2
  124. package/types/src/chart/ChartElement.d.ts +122 -0
  125. package/types/src/chart/ChartKind.d.ts +7 -0
  126. package/types/src/chart/PresetChartTypeDescriptors.d.ts +3 -1
  127. package/types/src/chart/index.d.ts +2 -1
  128. package/types/src/chart/paint/_fills.d.ts +24 -0
  129. package/types/src/chart/paint/_graphics.d.ts +38 -0
  130. package/types/src/chart/paint/_mode.d.ts +6 -0
  131. package/types/src/chart/paint/echarts.d.ts +33 -0
  132. package/types/src/chart/paint/index.d.ts +12 -0
  133. package/types/src/chart/paint/kinds/ChartPaintKind.d.ts +140 -0
  134. package/types/src/chart/paint/kinds/_Area.d.ts +3 -0
  135. package/types/src/chart/paint/kinds/_Bar.d.ts +3 -0
  136. package/types/src/chart/paint/kinds/_BoxWhisker.d.ts +3 -0
  137. package/types/src/chart/paint/kinds/_Bubble.d.ts +3 -0
  138. package/types/src/chart/paint/kinds/_Funnel.d.ts +3 -0
  139. package/types/src/chart/paint/kinds/_Histogram.d.ts +3 -0
  140. package/types/src/chart/paint/kinds/_Line.d.ts +10 -0
  141. package/types/src/chart/paint/kinds/_OfPie.d.ts +3 -0
  142. package/types/src/chart/paint/kinds/_Pie.d.ts +21 -0
  143. package/types/src/chart/paint/kinds/_Placeholder.d.ts +7 -0
  144. package/types/src/chart/paint/kinds/_Radar.d.ts +3 -0
  145. package/types/src/chart/paint/kinds/_Scatter.d.ts +3 -0
  146. package/types/src/chart/paint/kinds/_Sunburst.d.ts +3 -0
  147. package/types/src/chart/paint/kinds/_Surface.d.ts +3 -0
  148. package/types/src/chart/paint/kinds/_Treemap.d.ts +3 -0
  149. package/types/src/chart/paint/kinds/_Waterfall.d.ts +3 -0
  150. package/types/src/chart/paint/kinds/_builtIns.d.ts +3 -0
  151. package/types/src/chart/paint/toEChartsOption.d.ts +42 -0
  152. package/types/src/checklist/ValueChecklist.d.ts +60 -19
  153. package/types/src/clipboard/ClipboardCommands.d.ts +3 -3
  154. package/types/src/clipboard/SheetClipboardLayer.d.ts +2 -2
  155. package/types/src/commands/ContextualToolbar.d.ts +19 -0
  156. package/types/src/commands/createTransactionalMiddleware.d.ts +4 -1
  157. package/types/src/commands/index.d.ts +1 -0
  158. package/types/src/comment/CommentCardRequest.d.ts +94 -0
  159. package/types/src/comment/CommentUtils.d.ts +43 -0
  160. package/types/src/comment/NoteEditor.d.ts +20 -0
  161. package/types/src/comment/index.d.ts +5 -0
  162. package/types/src/comment/useCommentThread.d.ts +37 -0
  163. package/types/src/comment/useSheetComments.d.ts +28 -0
  164. package/types/src/conditionalFormat/ConditionalFormatPresets.d.ts +6 -6
  165. package/types/src/context/WorksheetContext.d.ts +18 -0
  166. package/types/src/context/index.d.ts +1 -1
  167. package/types/src/control/FormControlRenderers.d.ts +22 -0
  168. package/types/src/editableLabel/EditableLabel.d.ts +3 -1
  169. package/types/src/editor/EditorCommands.d.ts +3 -3
  170. package/types/src/editor/FunctionPreviewPanel.d.ts +1 -1
  171. package/types/src/editor/SheetCellEditorLayer.d.ts +2 -10
  172. package/types/src/editor/SheetCellEditorStartLayer.d.ts +61 -0
  173. package/types/src/editor/SheetCellInput.d.ts +14 -0
  174. package/types/src/editor/SheetEditable.d.ts +6 -6
  175. package/types/src/editor/SheetReferenceHeaderLayer.d.ts +1 -1
  176. package/types/src/editor/SheetReferenceLayer.d.ts +4 -4
  177. package/types/src/editor/VirtualKeyboardLayer.d.ts +50 -0
  178. package/types/src/editor/formulaAnchor.d.ts +12 -0
  179. package/types/src/editor/index.d.ts +3 -0
  180. package/types/src/editor/pickedReference.d.ts +3 -3
  181. package/types/src/editor/useEditRejectedNotice.d.ts +3 -3
  182. package/types/src/editor/useFormulaHints.d.ts +3 -3
  183. package/types/src/editor/useFormulaInput.d.ts +15 -3
  184. package/types/src/editor/validationAlert.d.ts +24 -0
  185. package/types/src/form/FormulaInput.d.ts +5 -2
  186. package/types/src/form/useEditCommit.d.ts +23 -3
  187. package/types/src/form/useInputField.d.ts +2 -3
  188. package/types/src/frame/CommandContext.d.ts +101 -3
  189. package/types/src/group/GroupEditor.d.ts +25 -0
  190. package/types/src/index.d.ts +12 -1
  191. package/types/src/layer/BorderLayer.d.ts +5 -2
  192. package/types/src/layer/CellErrorLayer.d.ts +18 -7
  193. package/types/src/layer/CellFillLayer.d.ts +2 -2
  194. package/types/src/layer/CellIndicatorLayer.d.ts +31 -0
  195. package/types/src/layer/CellInsertLayer.d.ts +71 -0
  196. package/types/src/layer/CircularIndicatorLayer.d.ts +3 -3
  197. package/types/src/layer/CommentCardLayer.d.ts +43 -0
  198. package/types/src/layer/CommentsLayer.d.ts +35 -0
  199. package/types/src/layer/ConditionalBarLayer.d.ts +2 -2
  200. package/types/src/layer/ConditionalIcons.d.ts +4 -4
  201. package/types/src/layer/ConditionalIconsLayer.d.ts +2 -2
  202. package/types/src/layer/ContextMenuLayer.d.ts +2 -2
  203. package/types/src/layer/FreezeDragLines.d.ts +17 -0
  204. package/types/src/layer/GridFreezeLayer.d.ts +11 -0
  205. package/types/src/layer/HeaderFreezeLayer.d.ts +12 -0
  206. package/types/src/layer/HeaderResizerLayer.d.ts +2 -1
  207. package/types/src/layer/HeaderSelectionLayer.d.ts +4 -4
  208. package/types/src/layer/HyperlinkLayer.d.ts +116 -0
  209. package/types/src/layer/MovableKindScope.d.ts +17 -0
  210. package/types/src/layer/PivotLayer.d.ts +47 -0
  211. package/types/src/layer/PivotToolbar.d.ts +29 -0
  212. package/types/src/layer/ProtectionLayer.d.ts +4 -5
  213. package/types/src/layer/RangeToolbar.d.ts +75 -0
  214. package/types/src/layer/ResizeIndicator.d.ts +11 -10
  215. package/types/src/layer/ResizeTooltip.d.ts +13 -0
  216. package/types/src/layer/SheetBackgroundLayer.d.ts +3 -3
  217. package/types/src/layer/SheetCellLayer.d.ts +15 -8
  218. package/types/src/layer/SheetColumnButtonLayer.d.ts +2 -2
  219. package/types/src/layer/SheetGridLineLayer.d.ts +25 -15
  220. package/types/src/layer/SheetHeaderCellLayer.d.ts +10 -1
  221. package/types/src/layer/SheetLayers.d.ts +171 -0
  222. package/types/src/layer/SheetMovableLayer.d.ts +4 -3
  223. package/types/src/layer/SheetOutlineLayer.d.ts +40 -0
  224. package/types/src/layer/SheetPivotCommandLayer.d.ts +13 -0
  225. package/types/src/layer/SheetSparklineCommandLayer.d.ts +14 -0
  226. package/types/src/layer/SheetTableCommandLayer.d.ts +2 -2
  227. package/types/src/layer/SparklineLayer.d.ts +32 -0
  228. package/types/src/layer/SpillLayer.d.ts +2 -2
  229. package/types/src/layer/TableLayer.d.ts +6 -5
  230. package/types/src/layer/TableToolbar.d.ts +23 -0
  231. package/types/src/layer/ValidationDropdownLayer.d.ts +2 -2
  232. package/types/src/layer/ValidationIndicatorLayer.d.ts +2 -2
  233. package/types/src/layer/ValidationPromptLayer.d.ts +47 -16
  234. package/types/src/layer/_sheetBorders.d.ts +6 -0
  235. package/types/src/layer/_tableColor.d.ts +6 -0
  236. package/types/src/layer/_visibleCellFeatures.d.ts +11 -0
  237. package/types/src/layer/cellTip.d.ts +13 -0
  238. package/types/src/layer/freezeDragState.d.ts +21 -0
  239. package/types/src/layer/index.d.ts +17 -0
  240. package/types/src/layer/resizeIndicatorState.d.ts +3 -1
  241. package/types/src/layer/useFreezeDrag.d.ts +22 -0
  242. package/types/src/layer/useNormalBorderLines.d.ts +15 -0
  243. package/types/src/layer/useSheetFeatureRegions.d.ts +2 -2
  244. package/types/src/layer/useSheetVisibleCells.d.ts +5 -6
  245. package/types/src/layer/useSheetVisibleDecorations.d.ts +2 -2
  246. package/types/src/layer/useTableHeaderCells.d.ts +2 -2
  247. package/types/src/layer/useValidationPicker.d.ts +3 -3
  248. package/types/src/layer/useVisibleTables.d.ts +2 -2
  249. package/types/src/layer/validationMark.d.ts +3 -3
  250. package/types/src/listener/index.d.ts +5 -0
  251. package/types/src/listener/useCell.d.ts +29 -0
  252. package/types/src/listener/useCellRange.d.ts +23 -0
  253. package/types/src/listener/useCellValue.d.ts +26 -0
  254. package/types/src/listener/useModelListener.d.ts +8 -8
  255. package/types/src/listener/useRangeListener.d.ts +13 -7
  256. package/types/src/listener/useRangeSnapshot.d.ts +35 -0
  257. package/types/src/listener/useTable.d.ts +26 -0
  258. package/types/src/movable/ConnectionSites.d.ts +18 -0
  259. package/types/src/movable/DefaultMovable.d.ts +8 -0
  260. package/types/src/movable/IMovableArea.d.ts +56 -0
  261. package/types/src/movable/MovableAdornment.d.ts +26 -0
  262. package/types/src/movable/MovableCommandGroups.d.ts +22 -0
  263. package/types/src/movable/MovableCommands.d.ts +8 -3
  264. package/types/src/movable/MovableControl.d.ts +80 -0
  265. package/types/src/movable/MovableEdit.d.ts +22 -0
  266. package/types/src/movable/MovableFrame.d.ts +18 -14
  267. package/types/src/movable/MovableLayer.d.ts +30 -5
  268. package/types/src/movable/MovableRenderers.d.ts +210 -0
  269. package/types/src/movable/PlaceholderFrames.d.ts +11 -0
  270. package/types/src/movable/RotateHandle.d.ts +37 -0
  271. package/types/src/movable/TextBox.d.ts +34 -0
  272. package/types/src/movable/connect.d.ts +16 -0
  273. package/types/src/movable/framePlacement.d.ts +72 -0
  274. package/types/src/movable/geometry.d.ts +61 -0
  275. package/types/src/movable/index.d.ts +11 -0
  276. package/types/src/movable/pressTarget.d.ts +20 -0
  277. package/types/src/movable/useFramePreview.d.ts +17 -0
  278. package/types/src/picker/cellPickerOpen.d.ts +3 -3
  279. package/types/src/picker/useCellPicker.d.ts +7 -5
  280. package/types/src/picture/PictureCommands.d.ts +20 -0
  281. package/types/src/picture/PictureKind.d.ts +7 -0
  282. package/types/src/picture/_pictureHyperlink.d.ts +13 -0
  283. package/types/src/picture/index.d.ts +0 -1
  284. package/types/src/picture/pictureCrop.d.ts +32 -0
  285. package/types/src/pivot/PivotAreas.d.ts +16 -0
  286. package/types/src/pivot/PivotChip.d.ts +33 -0
  287. package/types/src/pivot/PivotChipMenu.d.ts +74 -0
  288. package/types/src/pivot/PivotCommands.d.ts +24 -0
  289. package/types/src/pivot/PivotFieldList.d.ts +14 -0
  290. package/types/src/pivot/PivotFields.d.ts +47 -0
  291. package/types/src/pivot/PivotFieldsModel.d.ts +143 -0
  292. package/types/src/pivot/PivotTablePane.d.ts +47 -0
  293. package/types/src/pivot/_PivotFieldsContext.d.ts +41 -0
  294. package/types/src/pivot/_pivotNew.d.ts +12 -0
  295. package/types/src/pivot/_pivotRegion.d.ts +14 -0
  296. package/types/src/pivot/index.d.ts +9 -0
  297. package/types/src/pivot/usePivotFields.d.ts +17 -0
  298. package/types/src/presence/PresenceCommands.d.ts +35 -0
  299. package/types/src/presence/PresenceHost.d.ts +58 -0
  300. package/types/src/presence/PresenceMessages.d.ts +42 -0
  301. package/types/src/presence/PresenceStore.d.ts +165 -0
  302. package/types/src/presence/PresenceTypes.d.ts +78 -0
  303. package/types/src/presence/index.d.ts +7 -0
  304. package/types/src/presence/usePresence.d.ts +20 -0
  305. package/types/src/richText/RichTextEditor.d.ts +41 -0
  306. package/types/src/richText/index.d.ts +2 -0
  307. package/types/src/selection/SelectionCommands.d.ts +2 -2
  308. package/types/src/selection/SheetSelectionLayer.d.ts +6 -12
  309. package/types/src/shape/ConnectorControl.d.ts +46 -0
  310. package/types/src/shape/ShapeCommands.d.ts +11 -0
  311. package/types/src/shape/ShapeControl.d.ts +8 -0
  312. package/types/src/shape/ShapeEditor.d.ts +15 -2
  313. package/types/src/shape/ShapeGallery.d.ts +31 -0
  314. package/types/src/shape/ShapeHandles.d.ts +28 -0
  315. package/types/src/shape/ShapeKind.d.ts +7 -0
  316. package/types/src/shape/ShapeSVG.d.ts +22 -0
  317. package/types/src/shape/ShapeText.d.ts +17 -0
  318. package/types/src/shape/icons/ShapeIcons.d.ts +16 -0
  319. package/types/src/shape/icons/_ShapeIconPack.d.ts +4 -0
  320. package/types/src/shape/index.d.ts +3 -1
  321. package/types/src/shape/shapeFrame.d.ts +50 -0
  322. package/types/src/shape/shapeStyle.d.ts +82 -0
  323. package/types/src/sheet/ISheetHeaderElement.d.ts +3 -3
  324. package/types/src/sheet/{ISheetElement.d.ts → IWorksheetElement.d.ts} +111 -81
  325. package/types/src/sheet/OpaqueSheetElement.d.ts +21 -0
  326. package/types/src/sheet/SheetCommandProvider.d.ts +14 -6
  327. package/types/src/sheet/SheetCommands.d.ts +20 -5
  328. package/types/src/sheet/SheetKindIcon.d.ts +14 -0
  329. package/types/src/sheet/SheetOutlineElement.d.ts +70 -0
  330. package/types/src/sheet/SheetPanels.d.ts +11 -0
  331. package/types/src/sheet/SheetScrollbar.d.ts +4 -13
  332. package/types/src/sheet/TopLeftCorner.d.ts +2 -2
  333. package/types/src/sheet/WorksheetElement.d.ts +12 -0
  334. package/types/src/sheet/_freezeAt.d.ts +10 -0
  335. package/types/src/sheet/_hyperlinkEdit.d.ts +7 -0
  336. package/types/src/sheet/_useHeaderMetrics.d.ts +11 -0
  337. package/types/src/sheet/circularReferences.d.ts +4 -4
  338. package/types/src/sheet/index.d.ts +5 -2
  339. package/types/src/sheet/useCycleHighlight.d.ts +2 -2
  340. package/types/src/slicer/SlicerCommands.d.ts +10 -0
  341. package/types/src/slicer/SlicerEditor.d.ts +8 -2
  342. package/types/src/slicer/SlicerKind.d.ts +7 -0
  343. package/types/src/slicer/SlicerStylePreview.d.ts +18 -0
  344. package/types/src/slicer/index.d.ts +2 -1
  345. package/types/src/slicer/slicerStyles.d.ts +32 -0
  346. package/types/src/sparkline/PictureCache.d.ts +37 -0
  347. package/types/src/sparkline/SparklineCommands.d.ts +23 -0
  348. package/types/src/sparkline/SparklinePictures.d.ts +7 -0
  349. package/types/src/sparkline/paint/_drawing.d.ts +24 -0
  350. package/types/src/sparkline/paint/echarts.d.ts +8 -0
  351. package/types/src/sparkline/paint/index.d.ts +8 -0
  352. package/types/src/tabStrip/SheetTab.d.ts +1 -1
  353. package/types/src/tabStrip/Sortable.d.ts +5 -5
  354. package/types/src/tabStrip/TabStrip.d.ts +13 -6
  355. package/types/src/tabStrip/TabStripItem.d.ts +15 -13
  356. package/types/src/table/TableCommands.d.ts +2 -2
  357. package/types/src/taskPane/CellControlPane.d.ts +15 -0
  358. package/types/src/taskPane/MovablePane.d.ts +15 -0
  359. package/types/src/taskPane/TaskPaneArea.d.ts +7 -0
  360. package/types/src/taskPane/TaskPaneFrame.d.ts +4 -4
  361. package/types/src/taskPane/TaskPaneKeys.d.ts +38 -0
  362. package/types/src/taskPane/TaskPaneRegistry.d.ts +32 -12
  363. package/types/src/taskPane/_paneReasons.d.ts +7 -0
  364. package/types/src/taskPane/index.d.ts +3 -0
  365. package/types/src/taskPane/useTaskPane.d.ts +6 -3
  366. package/types/src/theme/ThemeState.d.ts +15 -2
  367. package/types/src/theme/buildDocThemeCSS.d.ts +4 -1
  368. package/types/src/theme/buildOOXMLThemeCSS.d.ts +2 -2
  369. package/types/src/theme/useGridColorScheme.d.ts +3 -3
  370. package/types/src/theme/useSystemColors.d.ts +2 -2
  371. package/types/src/workbook/DefaultMovableRenderers.d.ts +20 -0
  372. package/types/src/workbook/DefaultRenderers.d.ts +5 -4
  373. package/types/src/workbook/IWorkbookElement.d.ts +108 -23
  374. package/types/src/workbook/WorkbookCommands.d.ts +8 -3
  375. package/types/src/workbook/WorkbookStrip.d.ts +14 -5
  376. package/browser/cjs/Bo9Kx3L_XQkGPBJ5.cjs +0 -1
  377. package/browser/cjs/Pl04-kDEQSO8_qFU.cjs +0 -156
  378. package/browser/cjs/index.cjs +0 -41
  379. package/browser/esm/Dsn3z1hmkv-bWGVr.mjs +0 -6286
  380. package/node/esm/CyU4sKDpHyc6kF7j.mjs +0 -9
  381. package/types/src/chart/templates/area-stacked-percent-template.json.d.ts +0 -10
  382. package/types/src/chart/templates/area-stacked-template.json.d.ts +0 -10
  383. package/types/src/chart/templates/area-template.json.d.ts +0 -9
  384. package/types/src/chart/templates/bar-stacked-percent-template.json.d.ts +0 -10
  385. package/types/src/chart/templates/bar-stacked-template.json.d.ts +0 -10
  386. package/types/src/chart/templates/bar-template.json.d.ts +0 -9
  387. package/types/src/chart/templates/column-stacked-percent-template.json.d.ts +0 -10
  388. package/types/src/chart/templates/column-stacked-template.json.d.ts +0 -10
  389. package/types/src/chart/templates/column-template.json.d.ts +0 -9
  390. package/types/src/chart/templates/line-markers-template.json.d.ts +0 -10
  391. package/types/src/chart/templates/line-stacked-markers-template.json.d.ts +0 -11
  392. package/types/src/chart/templates/line-stacked-percent-markers-template.json.d.ts +0 -11
  393. package/types/src/chart/templates/line-stacked-percent-template.json.d.ts +0 -10
  394. package/types/src/chart/templates/line-stacked-template.json.d.ts +0 -10
  395. package/types/src/chart/templates/line-template.json.d.ts +0 -9
  396. package/types/src/chart/templates/pie-doughnut-template.json.d.ts +0 -10
  397. package/types/src/chart/templates/pie-template.json.d.ts +0 -9
  398. package/types/src/chart/templates/scatter-lines-markers-smooth-template.json.d.ts +0 -10
  399. package/types/src/chart/templates/scatter-lines-markers-template.json.d.ts +0 -10
  400. package/types/src/chart/templates/scatter-lines-smooth-template.json.d.ts +0 -10
  401. package/types/src/chart/templates/scatter-lines-template.json.d.ts +0 -10
  402. package/types/src/chart/templates/scatter-markers-template.json.d.ts +0 -10
  403. package/types/src/context/SheetContext.d.ts +0 -18
  404. package/types/src/movable/MoveableBundle.d.ts +0 -4
  405. package/types/src/sheet/SheetElement.d.ts +0 -15
@@ -0,0 +1,26 @@
1
+ import { ICellRange, Scalar } from '@sheetxl/sdk';
2
+ import { CellRangeTarget, CellRangeHookOptions } from './useRangeSnapshot';
3
+ /**
4
+ * Binds a cell's value like `useState`: returns the value and a setter, and re-renders when the value
5
+ * changes, whether from the setter, the grid, or a recalculation.
6
+ *
7
+ * @template T The expected value type. This is not checked or converted: an empty cell is `null`, and a
8
+ * cell can hold any type.
9
+ * @param target The workbook or sheet to read from, or `null` while there is none.
10
+ * @param address The cell's address. A larger range binds its top-left cell.
11
+ * @param options Listener options, and an optional `onChange` that receives each change event.
12
+ * @returns The value, or `null` while `target` is `null`, and a setter that does nothing until there
13
+ * is a target.
14
+ *
15
+ * @remarks
16
+ * The setter writes the value as-is: text is never parsed, so `'=1+1'` is stored as text rather than as
17
+ * a formula. To write formulas or styles, use {@link useCell}.
18
+ *
19
+ * @example
20
+ * ```tsx
21
+ * const [customer, setCustomer] = useCellValue<string>(sheet, 'A4');
22
+ * return <input value={customer ?? ''} onChange={(e) => setCustomer(e.target.value)} />;
23
+ * ```
24
+ */
25
+ export declare const useCellValue: <T extends Scalar = Scalar>(target: CellRangeTarget | null | undefined, address: ICellRange.Address, options?: CellRangeHookOptions) => [T | null, (value: T | null) => void];
26
+ //# sourceMappingURL=useCellValue.d.ts.map
@@ -25,10 +25,10 @@ export interface ModelListenerOptions extends Omit<IListener.Options, 'once'> {
25
25
  /**
26
26
  * React hook for subscribing to model-level events (workbooks, sheets, etc.).
27
27
  *
28
- * @template SOURCE - The model type (e.g., IWorkbook, ISheet)
29
- * @template EVENTS - The listener interface type (e.g., ISheet.IListeners)
28
+ * @template SOURCE - The model type (e.g., IWorkbook, IWorksheet)
29
+ * @template EVENTS - The listener interface type (e.g., IWorksheet.IListeners)
30
30
  *
31
- * @param source - The model instance to listen to
31
+ * @param source - The model instance to listen to, or `null` to listen to nothing
32
32
  * @param listeners - Object containing listener callbacks for various events
33
33
  * @param options - Optional configuration
34
34
  *
@@ -45,8 +45,8 @@ export interface ModelListenerOptions extends Omit<IListener.Options, 'once'> {
45
45
  *
46
46
  * @example
47
47
  * ```tsx
48
- * function SheetComponent({ sheet }: { sheet: ISheet }) {
49
- * useModelListener<ISheet, ISheet.IListeners>(sheet, {
48
+ * function SheetComponent({ sheet }: { sheet: IWorksheet }) {
49
+ * useModelListener<IWorksheet, IWorksheet.IListeners>(sheet, {
50
50
  * onSave(source, json) {
51
51
  * console.log('Sheet saved:', json);
52
52
  * },
@@ -56,12 +56,12 @@ export interface ModelListenerOptions extends Omit<IListener.Options, 'once'> {
56
56
  * }
57
57
  * ```
58
58
  */
59
- export declare const useModelListener: <SOURCE, EVENTS>(source: IListener.ISource<SOURCE>, listeners: IListener.Callbacks<SOURCE, EVENTS>, options?: ModelListenerOptions) => void;
59
+ export declare const useModelListener: <SOURCE, EVENTS>(source: IListener.ISource<SOURCE> | null | undefined, listeners: IListener.Callbacks<SOURCE, EVENTS>, options?: ModelListenerOptions) => void;
60
60
  /**
61
61
  * Used for syncing with model state that causes a rerenders.
62
62
  *
63
- * @param source The source of the model
63
+ * @param source The source of the model, or `null` to listen to nothing.
64
64
  * @param eventNames The name of the event or events to listen for.
65
65
  */
66
- export declare function useModelSync<EVENTS>(source: IListener.ISource<any>, eventNames: keyof EVENTS | Array<keyof EVENTS>): void;
66
+ export declare function useModelSync<EVENTS>(source: IListener.ISource<any> | null | undefined, eventNames: keyof EVENTS | Array<keyof EVENTS>): void;
67
67
  //# sourceMappingURL=useModelListener.d.ts.map
@@ -1,15 +1,21 @@
1
1
  import { ICellRange } from '@sheetxl/sdk';
2
- export interface useRangeListenerOptions extends ICellRange.ListenerOptions {
3
- fireOnAddressChange: boolean;
4
- }
2
+ export type useRangeListenerOptions = ICellRange.ListenerOptions;
5
3
  export interface RangeContainer {
6
4
  getRange(address: ICellRange.Address, options?: ICellRange.GetRangeOptions): ICellRange;
7
5
  }
8
6
  /**
9
- * This hook delegates to the an model that contains a getRange(address) method.
7
+ * Listen to a range of `model` for as long as the component is mounted.
8
+ *
9
+ * @param model What the range is read from: a workbook or a sheet.
10
+ * @param address The range to listen to. Nothing is listened to while it is `null`.
11
+ * @param listener Called with each {@link ICellRange.Event}. The latest render's listener is the
12
+ * one called, so it may close over state without re-subscribing.
13
+ * @param options Which events to hear and how the range follows inserts and deletes
14
+ * ({@link ICellRange.ListenerOptions}). Read once per subscription.
10
15
  *
11
- * @param model
12
- * @param listener
16
+ * @remarks
17
+ * The subscription is renewed when `model` or `address` changes. Nothing is delivered for that
18
+ * renewal: the listener only hears what the range itself reports.
13
19
  */
14
- export declare const useRangeListener: (model: RangeContainer, address: ICellRange.Address, listener: ICellRange.Listener, options?: useRangeListenerOptions) => void;
20
+ export declare const useRangeListener: (model: RangeContainer | null | undefined, address: ICellRange.Address | null | undefined, listener: ICellRange.Listener, options?: useRangeListenerOptions) => void;
15
21
  //# sourceMappingURL=useRangeListener.d.ts.map
@@ -0,0 +1,35 @@
1
+ import { ICellRange, IWorkbook, IWorksheet } from '@sheetxl/sdk';
2
+ /**
3
+ * A workbook or a sheet: anything a range can be read from. A workbook address may be sheet-qualified
4
+ * (`'Invoice!A4'`); an unqualified one reads from the selected sheet.
5
+ */
6
+ export type CellRangeTarget = IWorkbook | IWorksheet;
7
+ /**
8
+ * Options shared by the cell-binding hooks.
9
+ */
10
+ export interface CellRangeHookOptions extends Omit<ICellRange.ListenerOptions, 'transactional'> {
11
+ /**
12
+ * Called with every change event the hook receives, before it re-renders.
13
+ *
14
+ * @remarks
15
+ * Uses the hook's own subscription. To receive events without re-rendering, use
16
+ * {@link useRangeListener} instead.
17
+ */
18
+ onChange?: ICellRange.Listener;
19
+ }
20
+ /**
21
+ * Resolves `address` against `target` and returns the range with a value read from it. Both are
22
+ * re-read only after the range reports a change, so they are stable between changes, as
23
+ * `useSyncExternalStore` requires.
24
+ *
25
+ * @param topLeft Narrow the range to its top-left cell.
26
+ *
27
+ * @remarks
28
+ * The range follows its cells: when rows or columns are inserted or deleted around it (or undone),
29
+ * the returned range is the one at the new address, so a write goes where the cells went.
30
+ */
31
+ export declare const useRangeSnapshot: <T>(target: CellRangeTarget | null | undefined, address: ICellRange.Address, topLeft: boolean, read: (range: ICellRange) => T, options?: CellRangeHookOptions) => {
32
+ range: ICellRange | null;
33
+ snapshot: T | null;
34
+ };
35
+ //# sourceMappingURL=useRangeSnapshot.d.ts.map
@@ -0,0 +1,26 @@
1
+ import { ITable } from '@sheetxl/sdk';
2
+ import { CellRangeTarget, CellRangeHookOptions } from './useRangeSnapshot';
3
+ /**
4
+ * Returns the table named `name` and re-renders when it changes: rows added or removed, its cells
5
+ * edited, or its settings changed.
6
+ *
7
+ * @param target The workbook or sheet to find the table in, or `null` while there is none. A workbook
8
+ * looks in each of its sheets.
9
+ * @param name The table's name.
10
+ * @param options Listener options for its cells, and an optional `onChange` that receives each change
11
+ * event in them.
12
+ * @returns The table, or `null` while `target` is `null` or has no table of that name.
13
+ *
14
+ * @remarks
15
+ * The returned table is the same object across renders; read from it during render, and change it
16
+ * through its own methods, such as {@link ITable.addRow} and {@link ITable.deleteRowsAt}.
17
+ *
18
+ * @example
19
+ * ```tsx
20
+ * const items = useTable(workbook, 'Items');
21
+ * const rows = items?.getDataRange().getValues() ?? [];
22
+ * return <button onClick={() => items?.addRow()}>Add</button>;
23
+ * ```
24
+ */
25
+ export declare const useTable: (target: CellRangeTarget | null | undefined, name: string, options?: CellRangeHookOptions) => ITable | null;
26
+ //# sourceMappingURL=useTable.d.ts.map
@@ -0,0 +1,18 @@
1
+ import { default as React } from 'react';
2
+ import { IMovableCollection } from '@sheetxl/sdk';
3
+ export interface ConnectionSitesProps {
4
+ /** The sheet's movables, every one of which may offer sites. */
5
+ movables: IMovableCollection;
6
+ /** The layer's extent, in pane px. */
7
+ width: number;
8
+ height: number;
9
+ }
10
+ /**
11
+ * The connection sites a dragged connector end may glue to, drawn over every movable on the
12
+ * sheet while an end is held (`movable-connect` surface state); the site the end would take is
13
+ * filled. Which movables offer sites, and where, is the model's (`IMovable.getConnectionSites`):
14
+ * a picture or a chart its four edges, a shape its geometry's, a group none. Drawn by the layer,
15
+ * not by each content's editor, so a content kind needs nothing of its own to be glued to.
16
+ */
17
+ export declare const ConnectionSites: React.FC<ConnectionSitesProps>;
18
+ //# sourceMappingURL=ConnectionSites.d.ts.map
@@ -0,0 +1,8 @@
1
+ import { default as React } from 'react';
2
+ import { MovableElementProps } from './IMovableArea';
3
+ /**
4
+ * Renders a movable with the renderer for its kind of content, or a placeholder for a kind with
5
+ * none. The default `renderMovable` of a sheet element.
6
+ */
7
+ export declare const defaultRenderMovable: (props: MovableElementProps) => React.ReactElement;
8
+ //# sourceMappingURL=DefaultMovable.d.ts.map
@@ -1,9 +1,36 @@
1
1
  import { IMovable } from '@sheetxl/sdk';
2
+ import { MovableGestureHost } from './MovableControl';
3
+ /**
4
+ * Props a movable renderer receives from its frame.
5
+ *
6
+ * @remarks
7
+ * Spread `style` onto the root element. It fills the frame, which owns the drawing's bounds (zoom
8
+ * included), AND carries its hit-testing: the frame itself is pointer-transparent, so
9
+ * `style.pointerEvents` (`'auto'` by default, `'none'` while the frame is hidden) is what makes the
10
+ * drawing clickable. A drawing that is not solid — a no-fill shape — overrides it with `'none'` on
11
+ * its root and sets `pointerEvents` back on its painted parts only (e.g. `visibleStroke` on an SVG
12
+ * path), so a click in its unfilled interior reaches the cell beneath, exactly as in Excel.
13
+ *
14
+ * The drawing never sizes itself. `zoom` is given only so that it can scale what it draws inside
15
+ * the frame (text, borders, padding), for example with the CSS `zoom` property; a drawing that
16
+ * stretches to its box, such as a picture, ignores it.
17
+ */
2
18
  export interface MovableElementProps extends React.HTMLAttributes<HTMLElement> {
3
19
  /**
4
20
  * The movable associated with this element.
5
21
  */
6
22
  movable?: IMovable;
23
+ /**
24
+ * The scale of the view the movable is drawn in, where `1` is unscaled.
25
+ * @defaultValue 1
26
+ */
27
+ zoom?: number;
28
+ /**
29
+ * How to mirror the drawing within the frame: the gesture's while one is in flight, else the
30
+ * movable's own. The frame does not mirror the drawing itself, since what a mirror means is the
31
+ * drawing's (a shape keeps its text readable); content that cannot be mirrored ignores it.
32
+ */
33
+ flip?: IMovable.Flip;
7
34
  /**
8
35
  * Called when the movable is hidden from view.
9
36
  *
@@ -18,6 +45,35 @@ export interface MovableElementProps extends React.HTMLAttributes<HTMLElement> {
18
45
  * Call when the movable is returned to the view.
19
46
  */
20
47
  onShow?: (show: (movable: IMovable) => void) => void;
48
+ /**
49
+ * Registers where a press starts a drag: the test answers `true` for a press that should move the
50
+ * movable. Without one, a press anywhere in the frame drags.
51
+ *
52
+ * @remarks
53
+ * A press outside the drag zone still selects the movable but is left to the content, so a text
54
+ * box can drag from its border and put the caret where its text is pressed.
55
+ */
56
+ onDragZone?: (isDragZone: (event: MouseEvent | TouchEvent) => boolean) => void;
57
+ /**
58
+ * A box above the selection chrome, placed and turned exactly as the frame is, for the content's
59
+ * own controls (a shape's adjustment handles). `null` when the movable has none.
60
+ *
61
+ * @remarks
62
+ * Render into it with a portal. It fills the frame's box and is pointer-transparent; controls opt
63
+ * back in. Drawn above the resize handles, so a control on the selection outline wins the press,
64
+ * as in Excel.
65
+ *
66
+ * While one of the content's controls is being dragged, give it the class `movable-gesture`: every
67
+ * control in the box, the layer's and the content's, hides until the class goes, as they do for a
68
+ * move or resize.
69
+ */
70
+ adornmentHost?: HTMLElement | null;
71
+ /**
72
+ * Runs a gesture of the content's own controls (a shape's adjustment handles) through the
73
+ * layer: previewed in every pane with what follows it, such as a connector glued to the shape,
74
+ * and committed as one step. Present while the movable's controls are drawn.
75
+ */
76
+ gesture?: MovableGestureHost;
21
77
  /**
22
78
  * If true then the component is disabled.
23
79
  * @defaultValue false
@@ -0,0 +1,26 @@
1
+ import { default as React } from 'react';
2
+ import { IMovable } from '@sheetxl/sdk';
3
+ import { MovablePreview } from './framePlacement';
4
+ /**
5
+ * Each adorned movable's adornment box, by movable, as the layer holds them. A container renderer
6
+ * reads it to hand each member its own box (`MovableElementProps.adornmentHost`), since a member
7
+ * has no frame of its own to be handed one through.
8
+ */
9
+ export declare const AdornmentHostsContext: React.Context<ReadonlyMap<IMovable, HTMLElement>>;
10
+ export interface MovableAdornmentProps {
11
+ movable: IMovable;
12
+ /** The gesture preview, as the frame is given it. */
13
+ preview?: MovablePreview | null;
14
+ /** Receives the box once mounted and `null` when it unmounts; the layer hands it to the content. */
15
+ onHost: (movable: IMovable, host: HTMLElement | null) => void;
16
+ /** The layer's own controls for the movable: its outline, resize and rotate handles. */
17
+ children?: React.ReactNode;
18
+ }
19
+ /**
20
+ * The box a selected movable's controls are drawn in: placed and turned as its frame is, from the
21
+ * same numbers. Its children stack in order, with no z-index of their own: the layer's controls
22
+ * come first and the content renders its own after them (see `MovableElementProps.adornmentHost`),
23
+ * so a content control paints over, and is hit before, a resize handle or outline it overlaps.
24
+ */
25
+ export declare const MovableAdornment: React.FC<MovableAdornmentProps>;
26
+ //# sourceMappingURL=MovableAdornment.d.ts.map
@@ -0,0 +1,22 @@
1
+ import { Command } from '@sheetxl/utils-react';
2
+ /** The key of a kind's ribbon tab: what a kind's own `toolbar` and the default tab are registered as. */
3
+ export declare const movableToolbarKey: (type: string) => string;
4
+ /**
5
+ * The tab a kind of movable content gets when its module brings none: the drawing groups and the
6
+ * format pane, labeled with the kind's name (`IContent.getTypeDescription()`) unless the catalog
7
+ * has a label for `${type}Toolbar`. So a new kind with no commands of its own still gets a working
8
+ * tab.
9
+ *
10
+ * @param type The content type; the tab's key is `${type}Toolbar`.
11
+ * @param label The tab's label when the catalog has none.
12
+ */
13
+ export declare function createDefaultMovableToolbar(type: string, label: string): Command.CommandButtonEntry & {
14
+ key: string;
15
+ };
16
+ /**
17
+ * Registers the drawing button groups shared by every kind's ribbon tab and by a host's drawing
18
+ * right-click menu: z-order, align and distribute, flip, group, anchor sizing, and `arrangeOptions`,
19
+ * which gathers them for the end of a tab. Their chrome is in the `movable` catalog. Idempotent.
20
+ */
21
+ export declare function registerMovableCommandGroups(): void;
22
+ //# sourceMappingURL=MovableCommandGroups.d.ts.map
@@ -1,22 +1,27 @@
1
1
  import { RemoveListener, EditModeHandler } from '@sheetxl/utils';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { Command, IReactNotifier } from '@sheetxl/utils-react';
4
+ import { ActivateFrameOptions, ITaskPaneArea } from '../taskPane';
4
5
  /** Options for {@link contributeMovableCommands}. */
5
6
  export interface ContributeMovableCommandsOptions {
6
7
  /** Error reporting. */
7
8
  notifier?: IReactNotifier;
8
9
  /** Cleared after a drawing op. From `useEditMode()`. */
9
10
  editModeHandler?: EditModeHandler;
11
+ /** Opens a task pane; `formatMovable` opens the format pane with it. */
12
+ activateTaskPane?: (key: string, options?: ActivateFrameOptions) => void;
13
+ /** Read for whether the format pane is showing, the `formatMovable` state. */
14
+ taskPaneArea?: ITaskPaneArea;
10
15
  }
11
16
  /**
12
17
  * Contribute the movable **behavior** over `sheet`'s drawings. Each op runs `update` across the selected
13
- * movables inside one `doBatch`; the anchor/lock `state` re-contributes on selection change. Contribute on
18
+ * movables inside one `doBatch`; the anchor/lock/flip `state` follows the active movable. Contribute on
14
19
  * the **movable scope** (re-run per active sheet); tagged `noTransaction` since we own the `doBatch`, and
15
20
  * `noRepeat`. Returns a disposer.
16
21
  */
17
22
  /** The single `data` bundle {@link contributeMovableCommands} takes (the `DynamicCommandContributor` shape). */
18
23
  export interface MovableCommandData extends ContributeMovableCommandsOptions {
19
- sheet: ISheet | null;
24
+ sheet: IWorksheet | null;
20
25
  }
21
26
  export declare function contributeMovableCommands(contribution: Command.CommandContribution, data: MovableCommandData): RemoveListener;
22
27
  //# sourceMappingURL=MovableCommands.d.ts.map
@@ -0,0 +1,80 @@
1
+ import { default as React } from 'react';
2
+ import { IMovable } from '@sheetxl/sdk';
3
+ import { ResizeDirection } from './geometry';
4
+ import { MovablePreview } from './framePlacement';
5
+ /** A resize handle by its compass name, as `MovableLayerProps.resizeDirections` lists them. */
6
+ export type ResizeDirectionName = 'nw' | 'n' | 'ne' | 'w' | 'e' | 'sw' | 's' | 'se';
7
+ /** The resize cursor for a handle on a frame turned `rotation` degrees, so it follows the turn. */
8
+ export declare const resizeCursor: (direction: ResizeDirection, rotation: number) => string;
9
+ export interface MovableControlProps {
10
+ /** Compass names of the handles to draw (`nw`, `n`, … `se`). */
11
+ directions: readonly ResizeDirectionName[];
12
+ /** Degrees clockwise the frame is turned; only the cursors use it, the box turns itself. */
13
+ rotation: number;
14
+ /**
15
+ * Fade the control, as during a gesture. It stays mounted: the handle being dragged holds the
16
+ * pointer capture.
17
+ */
18
+ isDragging?: boolean;
19
+ /** A press on a handle. Return `false` to refuse the gesture. */
20
+ onResizeStart: () => boolean;
21
+ /**
22
+ * The pointer moved. `delta` is how far it is from the press, in screen pixels; `keepAspect` is
23
+ * whether Shift is held.
24
+ */
25
+ onResize: (direction: ResizeDirection, delta: readonly [number, number], keepAspect: boolean) => void;
26
+ /** The pointer was released. */
27
+ onResizeEnd: () => void;
28
+ /** The gesture was lost (`pointercancel`). */
29
+ onResizeCancel: () => void;
30
+ /**
31
+ * Draw the control as context: the frame of a group a selected member is inside, as Excel draws
32
+ * it (a dotted outline and hollow neutral handles). Its handles still resize that group.
33
+ */
34
+ context?: boolean;
35
+ /**
36
+ * A press on the move grip a frame too small for its handles shows in their place. Omit when the
37
+ * frame cannot be moved.
38
+ */
39
+ onMoveStart?: (e: PointerEvent) => void;
40
+ /** Drawn first in the control, so it hides with the handles and paints under them: the rotate handle. */
41
+ children?: React.ReactNode;
42
+ }
43
+ /**
44
+ * What the layer lets a content's own control do: run a gesture of its own through the layer's
45
+ * preview and commit loop, so it is drawn, cancelled and undone as a move or resize is.
46
+ */
47
+ export interface MovableGestureHost {
48
+ /**
49
+ * Starts a gesture on the control's movable: the layer snapshots it and readies one commit.
50
+ * `onCommit` runs on the movable inside that commit, after the previewed placement is written.
51
+ * Returns `false` when the layer refuses gestures.
52
+ */
53
+ start(description: string, onCommit?: (movable: IMovable) => void): boolean;
54
+ /** Draws the movable at a placement (absolute px) until the gesture ends. */
55
+ preview(preview: MovablePreview): void;
56
+ /** Commits what was previewed. */
57
+ finish(): void;
58
+ /** Drops the gesture with nothing written. */
59
+ cancel(): void;
60
+ }
61
+ /**
62
+ * Props of a control a content kind registers in place of the generic one (see
63
+ * `registerMovableRenderer`): the generic control's, and what a control of its own needs.
64
+ */
65
+ export interface ContentControlProps extends MovableControlProps {
66
+ movable: IMovable;
67
+ /** How the frame is mirrored: the gesture's while one is in flight, else the movable's. */
68
+ flip: IMovable.Flip;
69
+ gesture: MovableGestureHost;
70
+ }
71
+ /**
72
+ * A selected movable's outline and resize handles, drawn in its adornment box so they are placed
73
+ * and turned from the same numbers as the frame. Each handle captures the pointer for its gesture.
74
+ *
75
+ * @remarks
76
+ * A frame too small to show its handles apart (see the layer's stylesheet) hides them, still live,
77
+ * and draws a move grip below it, as Excel does.
78
+ */
79
+ export declare const MovableControl: React.FC<MovableControlProps>;
80
+ //# sourceMappingURL=MovableControl.d.ts.map
@@ -0,0 +1,22 @@
1
+ import { IMovable } from '@sheetxl/sdk';
2
+ /**
3
+ * Starts an edit of a movable's content, answering `true` if it took the caret.
4
+ */
5
+ export type MovableEditStarter = () => boolean;
6
+ /**
7
+ * Asks a movable's content to start editing: a text box puts the caret in its text.
8
+ *
9
+ * @remarks
10
+ * This is how a command reaches a content component it cannot see. A movable that is not drawn yet
11
+ * — a note that only shows while selected or pointed at — starts editing when its content mounts,
12
+ * as long as it is still selected then.
13
+ *
14
+ * @returns `true` if the edit started now, `false` if it waits for the content.
15
+ */
16
+ export declare const requestMovableEdit: (movable: IMovable) => boolean;
17
+ /**
18
+ * Registers how a movable's content starts an edit. Called by the content component; the returned
19
+ * function unregisters it.
20
+ */
21
+ export declare const registerMovableEdit: (movable: IMovable, starter: MovableEditStarter) => (() => void);
22
+ //# sourceMappingURL=MovableEdit.d.ts.map
@@ -1,7 +1,9 @@
1
1
  import { default as React } from 'react';
2
- import { Bounds } from '@sheetxl/utils';
3
2
  import { IMovable } from '@sheetxl/sdk';
3
+ import { RenderSlotFn } from '@sheetxl/utils-react';
4
4
  import { MovableElementProps } from './IMovableArea';
5
+ import { MovableGestureHost } from './MovableControl';
6
+ import { MovablePreview } from './framePlacement';
5
7
  export interface MovableFrameProps extends React.HTMLAttributes<HTMLElement> {
6
8
  /**
7
9
  * The underlying model for the chart.
@@ -13,29 +15,31 @@ export interface MovableFrameProps extends React.HTMLAttributes<HTMLElement> {
13
15
  * @param props - {@link MovableElementProps}
14
16
  * @returns A React Element representing the IMovable.
15
17
  */
16
- renderMovable: (props: MovableElementProps) => React.ReactElement;
18
+ renderMovable: RenderSlotFn<MovableElementProps>;
17
19
  onRefLoad: (ref: HTMLElement) => void;
18
20
  onRefUnload: (ref: HTMLElement) => void;
19
21
  onHide: (hide: (movable: IMovable) => boolean | Promise<boolean> | void) => void;
20
22
  onShow: (show: (movable: IMovable) => void) => void;
23
+ /** {@inheritDoc MovableElementProps.adornmentHost} */
24
+ adornmentHost?: HTMLElement | null;
25
+ /** {@inheritDoc MovableElementProps.gesture} */
26
+ gesture?: MovableGestureHost;
21
27
  /**
22
- * Live drag/resize preview bounds (absolute), or null/undefined when idle. When set, the frame
23
- * renders HERE instead of at the model bounds (the model isn't touched until the gesture commits).
24
- * Surface-scoped in the parent, so it's set in every pane — that's what makes a dragged shape appear,
25
- * correctly clipped, on both sides of a freeze boundary.
28
+ * Live drag/resize/rotate preview, or null/undefined when idle. When set, the frame renders with it
29
+ * instead of the model (the model isn't touched until the gesture commits). Surface-scoped in the
30
+ * parent, so it's set in every pane — that's what makes a dragged shape appear, correctly clipped,
31
+ * on both sides of a freeze boundary.
26
32
  */
27
- overrideBounds?: Bounds | null;
28
- /**
29
- * Called after the frame repositions (scroll, keyboard nudge, drag preview, resize). The parent uses
30
- * it to re-sync the Moveable control box to the frame's new DOM rect — a nudge re-renders only this
31
- * frame, not the parent, so the parent can't detect the move on its own.
32
- */
33
- onReposition?: () => void;
33
+ preview?: MovablePreview | null;
34
34
  /**
35
35
  * Called when the final movable is unselected.
36
36
  */
37
37
  onUnFocus: () => void;
38
- dragStart(e: MouseEvent | TouchEvent, target?: EventTarget | null): void;
38
+ /**
39
+ * A press that may move the frame, after it selected. Not called for a press outside the
40
+ * content's drag zone or in an editable element.
41
+ */
42
+ dragStart(e: PointerEvent): void;
39
43
  disabled?: boolean;
40
44
  /**
41
45
  * Indicates if the frame is being dragged. Useful for styling.
@@ -1,6 +1,9 @@
1
1
  import { default as React } from 'react';
2
+ import { Bounds } from '@sheetxl/utils';
2
3
  import { IMovableCollection, IMovableSelection, IMovable } from '@sheetxl/sdk';
4
+ import { RenderSlotFn } from '@sheetxl/utils-react';
3
5
  import { MovableElementProps } from './IMovableArea';
6
+ import { ResizeDirectionName } from './MovableControl';
4
7
  export interface MovableLayerAttributes {
5
8
  /**
6
9
  * Will put focus on the the movable object.
@@ -15,22 +18,36 @@ export interface MovableLayerAttributes {
15
18
  }
16
19
  export interface IMovableLayerElement extends HTMLDivElement, MovableLayerAttributes {
17
20
  }
21
+ /**
22
+ * The in-flight frame gesture passed to {@link MovableLayerProps.renderTip}: what the frame would be
23
+ * if released now.
24
+ */
25
+ export interface MovableGesture {
26
+ /** `move` keeps the size, `resize` changes it, `rotate` turns the frame. */
27
+ kind: 'move' | 'resize' | 'rotate';
28
+ /** The grabbed movable (the first selected one when several move together). */
29
+ movable: IMovable;
30
+ /** The unrotated frame, absolute. */
31
+ bounds: Bounds;
32
+ /** Degrees, clockwise. */
33
+ rotation: number;
34
+ }
18
35
  export interface MovableLayerProps extends React.HTMLAttributes<HTMLDivElement> {
19
36
  /**
20
37
  * The container to retrieve movable objects
21
38
  */
22
39
  movables: IMovableCollection;
23
40
  /**
24
- * The container view to retrieve selection information about the movables.
41
+ * The selection of the movables.
25
42
  */
26
- movablesView: IMovableSelection;
43
+ movableSelection: IMovableSelection;
27
44
  /**
28
45
  * Callback to render the movable.
29
46
  *
30
47
  * @param props MovableElementProps
31
48
  * @returns A React Element representing the IMovable.
32
49
  */
33
- renderMovable: (props: MovableElementProps) => React.ReactElement;
50
+ renderMovable: RenderSlotFn<MovableElementProps>;
34
51
  /**
35
52
  * Called when the final movable is unselected.
36
53
  */
@@ -57,17 +74,25 @@ export interface MovableLayerProps extends React.HTMLAttributes<HTMLDivElement>
57
74
  */
58
75
  disableResize?: boolean;
59
76
  /**
60
- * Provider the anchor element to render.
77
+ * The resize handles to show, by compass name.
78
+ * @defaultValue all eight
61
79
  */
62
- renderDirections?: string[];
80
+ resizeDirections?: ResizeDirectionName[];
63
81
  /**
64
82
  * Called after the first render of a movable.
65
83
  */
66
84
  onFirstRender?: () => void;
85
+ /**
86
+ * Render a readout while a frame is moved, resized or rotated — a {@link GestureTip} under the frame.
87
+ * Return an empty node for none.
88
+ */
89
+ renderTip?: (gesture: MovableGesture) => React.ReactNode;
67
90
  /**
68
91
  * Forwards the ref to the underlying element.
69
92
  */
70
93
  ref?: React.Ref<IMovableLayerElement>;
71
94
  }
95
+ /** The shadow under a selected movable's frame; content that shades itself draws the same along its outline. */
96
+ export declare const SELECTION_SHADOW = "1px 1px 2px 2px rgba(0,0,0,.15)";
72
97
  export declare const MovableLayer: React.NamedExoticComponent<Omit<MovableLayerProps, "ref"> & React.RefAttributes<IMovableLayerElement>>;
73
98
  //# sourceMappingURL=MovableLayer.d.ts.map