@sheetxl/react 0.8.0-beta.1 → 0.8.0-beta.11

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 (359) hide show
  1. package/browser/esm/1-LEUre9ZLG0OYYB.mjs +197 -0
  2. package/browser/esm/94dxo1A-z8lgiiGw.mjs +128 -0
  3. package/browser/esm/B26QVfjer2oY2ewK.mjs +32 -0
  4. package/browser/esm/B93LSmhnvkxNXTq-.mjs +42 -0
  5. package/browser/esm/BQYS2Yf-EAV_tBLr.mjs +20 -0
  6. package/{node/esm/DAE_NG8D9uT50zUH.mjs → browser/esm/BegvsXeRs7e-9t8k.mjs} +3 -4
  7. package/browser/esm/Bl2BFCQ00fotauKB.mjs +36 -0
  8. package/browser/esm/Bos4Rkp8UTF7QXUB.mjs +31 -0
  9. package/browser/esm/C1pc9F4Rt2C5FKUo.mjs +45 -0
  10. package/browser/esm/CPnnESfZz2jjJd82.mjs +134 -0
  11. package/browser/esm/CRi6DQ3UXmPEv-w_.mjs +729 -0
  12. package/browser/esm/ClAtIfYbsUPA073B.mjs +2706 -0
  13. package/browser/esm/CzRIbc-Lk__VMLKM.mjs +60 -0
  14. package/browser/esm/D2u6THGErqw64KQI.mjs +63 -0
  15. package/browser/esm/DMdsMPT0fWBbTkNn.mjs +67 -0
  16. package/browser/esm/DS66lAIM-9M-YoZQ.mjs +315 -0
  17. package/browser/esm/DgL7Dy-Lqcr1TvW6.mjs +23528 -0
  18. package/browser/esm/Dnh1kpz3v1JKtRD_.mjs +79 -0
  19. package/browser/esm/cQ6xdPFkEcuDlNTN.mjs +75 -0
  20. package/browser/esm/chart.mjs +40 -0
  21. package/browser/esm/control.mjs +216 -0
  22. package/browser/esm/group.mjs +123 -0
  23. package/browser/esm/index.mjs +15460 -8762
  24. package/browser/esm/note.mjs +112 -0
  25. package/browser/esm/picture.mjs +86 -0
  26. package/browser/esm/shape.mjs +7 -0
  27. package/browser/esm/slicer.mjs +276 -0
  28. package/browser/esm/ugfE7YeZALQURDKF.mjs +241 -0
  29. package/licenses/dependencies.txt +319 -600
  30. package/node/esm/6zApGj9DozhFy-bx.mjs +35 -0
  31. package/node/esm/BMVK5plvmBOAIlxP.mjs +80 -0
  32. package/node/esm/BaRfst1euuhquupX.mjs +66 -0
  33. package/node/esm/Be9c1GwQkPo8Piuh.mjs +134 -0
  34. package/node/esm/BiaDWnN3tT7neoRL.mjs +68 -0
  35. package/node/esm/BlxXufqBBg1PtsXd.mjs +8 -0
  36. package/node/esm/C_SNx7TlFEcwbYjx.mjs +2706 -0
  37. package/node/esm/DJPgbB1X22YmhbaR.mjs +242 -0
  38. package/node/esm/DTMTIrYIK1eZswsM.mjs +37 -0
  39. package/node/esm/D_pCpfdQowV_4Aje.mjs +198 -0
  40. package/node/esm/DgGEHydEjD7nfsDB.mjs +76 -0
  41. package/node/esm/Dj5FM7_-YWhCtCCt.mjs +45 -0
  42. package/node/esm/DxQZmb-j4NLUO9Af.mjs +63 -0
  43. package/node/esm/JiQGhLkoL8CJpVvA.mjs +20 -0
  44. package/node/esm/b-XRVRI1fYQQMkTC.mjs +1664 -0
  45. package/node/esm/chart.mjs +40 -0
  46. package/node/esm/control.mjs +216 -0
  47. package/node/esm/gpD-9LDW92phhoma.mjs +32 -0
  48. package/node/esm/group.mjs +123 -0
  49. package/node/esm/index.mjs +15830 -8966
  50. package/node/esm/note.mjs +113 -0
  51. package/node/esm/picture.mjs +86 -0
  52. package/node/esm/shape.mjs +735 -0
  53. package/node/esm/sigD1UFqvPlWUw_9.mjs +128 -0
  54. package/node/esm/slicer.mjs +278 -0
  55. package/node/esm/umljAT66yb3_rURh.mjs +320 -0
  56. package/package.json +55 -14
  57. package/resources/contents.json +24 -0
  58. package/resources/locales/contents.json +56 -0
  59. package/resources/locales/de/chart.cmd.json +82 -0
  60. package/resources/locales/de/movable.cmd.json +154 -0
  61. package/resources/locales/de/picture.cmd.json +31 -0
  62. package/resources/locales/de/selection.cmd.json +8 -0
  63. package/resources/locales/de/shape.cmd.json +17 -0
  64. package/resources/locales/de/sheet.cmd.json +339 -21
  65. package/resources/locales/de/slicer.cmd.json +17 -0
  66. package/resources/locales/de/table.cmd.json +9 -1
  67. package/resources/locales/de/ui.msg.json +321 -3
  68. package/resources/locales/de/workbook.cmd.json +15 -6
  69. package/resources/locales/en/chart.cmd.json +82 -0
  70. package/resources/locales/en/movable.cmd.json +154 -0
  71. package/resources/locales/en/picture.cmd.json +31 -0
  72. package/resources/locales/en/selection.cmd.json +8 -0
  73. package/resources/locales/en/shape.cmd.json +17 -0
  74. package/resources/locales/en/sheet.cmd.json +353 -22
  75. package/resources/locales/en/slicer.cmd.json +17 -0
  76. package/resources/locales/en/table.cmd.json +9 -1
  77. package/resources/locales/en/ui.msg.json +321 -3
  78. package/resources/locales/en/workbook.cmd.json +16 -7
  79. package/types/chart.d.ts +2 -0
  80. package/types/control.d.ts +2 -0
  81. package/types/group.d.ts +2 -0
  82. package/types/note.d.ts +2 -0
  83. package/types/picture.d.ts +2 -0
  84. package/types/shape.d.ts +2 -0
  85. package/types/slicer.d.ts +2 -0
  86. package/types/src/annotation/RangeAnnotations.d.ts +119 -0
  87. package/types/src/annotation/index.d.ts +2 -0
  88. package/types/src/autoFill/AutoFillPresets.d.ts +14 -0
  89. package/types/src/autoFill/FillMenu.d.ts +36 -0
  90. package/types/src/autoFill/FillSeries.d.ts +38 -0
  91. package/types/src/autoFill/index.d.ts +4 -0
  92. package/types/src/border/StaticBorderRenderer.d.ts +19 -2
  93. package/types/src/border/useBorders.d.ts +81 -8
  94. package/types/src/cell/CornerTriangle.d.ts +6 -0
  95. package/types/src/cell/FormulaCellRenderer.d.ts +6 -3
  96. package/types/src/cell/OutlineButton.d.ts +123 -0
  97. package/types/src/cell/SheetCellRenderer.d.ts +2 -2
  98. package/types/src/cell/SheetHeaderRenderer.d.ts +5 -0
  99. package/types/src/cell/StaticCellRenderer.d.ts +57 -0
  100. package/types/src/cell/index.d.ts +2 -0
  101. package/types/src/cell/useFormulaViewAnchor.d.ts +3 -3
  102. package/types/src/chart/ChartCommands.d.ts +15 -0
  103. package/types/src/chart/ChartEditor.d.ts +10 -2
  104. package/types/src/chart/ChartElement.d.ts +111 -0
  105. package/types/src/chart/ChartKind.d.ts +7 -0
  106. package/types/src/chart/PresetChartTypeDescriptors.d.ts +3 -1
  107. package/types/src/chart/index.d.ts +2 -1
  108. package/types/src/chart/paint/_fills.d.ts +24 -0
  109. package/types/src/chart/paint/_graphics.d.ts +46 -0
  110. package/types/src/chart/paint/echarts.d.ts +30 -0
  111. package/types/src/chart/paint/index.d.ts +12 -0
  112. package/types/src/chart/paint/kinds/ChartPaintKind.d.ts +132 -0
  113. package/types/src/chart/paint/kinds/_Area.d.ts +3 -0
  114. package/types/src/chart/paint/kinds/_Bar.d.ts +3 -0
  115. package/types/src/chart/paint/kinds/_BoxWhisker.d.ts +3 -0
  116. package/types/src/chart/paint/kinds/_Bubble.d.ts +3 -0
  117. package/types/src/chart/paint/kinds/_Funnel.d.ts +3 -0
  118. package/types/src/chart/paint/kinds/_Histogram.d.ts +3 -0
  119. package/types/src/chart/paint/kinds/_Line.d.ts +10 -0
  120. package/types/src/chart/paint/kinds/_OfPie.d.ts +3 -0
  121. package/types/src/chart/paint/kinds/_Pie.d.ts +21 -0
  122. package/types/src/chart/paint/kinds/_Placeholder.d.ts +7 -0
  123. package/types/src/chart/paint/kinds/_Radar.d.ts +3 -0
  124. package/types/src/chart/paint/kinds/_Scatter.d.ts +3 -0
  125. package/types/src/chart/paint/kinds/_Sunburst.d.ts +3 -0
  126. package/types/src/chart/paint/kinds/_Surface.d.ts +3 -0
  127. package/types/src/chart/paint/kinds/_Treemap.d.ts +3 -0
  128. package/types/src/chart/paint/kinds/_Waterfall.d.ts +3 -0
  129. package/types/src/chart/paint/kinds/_builtIns.d.ts +12 -0
  130. package/types/src/chart/paint/toEChartsOption.d.ts +31 -0
  131. package/types/src/checklist/ValueChecklist.d.ts +112 -0
  132. package/types/src/checklist/index.d.ts +2 -0
  133. package/types/src/clipboard/ClipboardCommands.d.ts +3 -3
  134. package/types/src/clipboard/SheetClipboardLayer.d.ts +2 -2
  135. package/types/src/commands/ContextualToolbar.d.ts +19 -0
  136. package/types/src/commands/createTransactionalMiddleware.d.ts +4 -1
  137. package/types/src/commands/index.d.ts +1 -0
  138. package/types/src/comment/CommentCardRequest.d.ts +94 -0
  139. package/types/src/comment/CommentUtils.d.ts +43 -0
  140. package/types/src/comment/NoteEditor.d.ts +20 -0
  141. package/types/src/comment/index.d.ts +5 -0
  142. package/types/src/comment/useCommentThread.d.ts +37 -0
  143. package/types/src/comment/useSheetComments.d.ts +28 -0
  144. package/types/src/{sheet → conditionalFormat}/ConditionalFormatPresets.d.ts +6 -6
  145. package/types/src/conditionalFormat/index.d.ts +1 -0
  146. package/types/src/context/WorksheetContext.d.ts +18 -0
  147. package/types/src/context/index.d.ts +1 -1
  148. package/types/src/control/FormControlRenderers.d.ts +22 -0
  149. package/types/src/editor/EditorCommands.d.ts +3 -3
  150. package/types/src/editor/FunctionPreviewPanel.d.ts +15 -1
  151. package/types/src/editor/NamedItemLabel.d.ts +29 -0
  152. package/types/src/editor/NamedItemsPanel.d.ts +13 -2
  153. package/types/src/editor/SheetCellEditorLayer.d.ts +5 -9
  154. package/types/src/editor/SheetCellEditorStartLayer.d.ts +61 -0
  155. package/types/src/editor/SheetCellInput.d.ts +26 -2
  156. package/types/src/editor/SheetEditable.d.ts +14 -8
  157. package/types/src/editor/SheetReferenceLayer.d.ts +4 -4
  158. package/types/src/editor/VirtualKeyboardLayer.d.ts +49 -0
  159. package/types/src/editor/formulaAnchor.d.ts +12 -0
  160. package/types/src/editor/formulaCaret.d.ts +39 -10
  161. package/types/src/editor/formulaEval.d.ts +9 -5
  162. package/types/src/editor/formulaLint.d.ts +36 -0
  163. package/types/src/editor/formulaPresentation.d.ts +7 -0
  164. package/types/src/editor/formulaText.d.ts +17 -5
  165. package/types/src/editor/functionArgs.d.ts +20 -0
  166. package/types/src/editor/index.d.ts +5 -1
  167. package/types/src/editor/pickedReference.d.ts +76 -0
  168. package/types/src/editor/useEditRejectedNotice.d.ts +32 -0
  169. package/types/src/editor/useFormulaHints.d.ts +95 -5
  170. package/types/src/editor/useFormulaInput.d.ts +30 -4
  171. package/types/src/editor/useReferenceMode.d.ts +12 -0
  172. package/types/src/editor/validationAlert.d.ts +24 -0
  173. package/types/src/externalLink/ExternalLinksPaneArgs.d.ts +23 -0
  174. package/types/src/externalLink/index.d.ts +2 -0
  175. package/types/src/form/FormulaInput.d.ts +18 -2
  176. package/types/src/form/FormulaInputParts.d.ts +10 -1
  177. package/types/src/form/useEditCommit.d.ts +23 -3
  178. package/types/src/form/useInputField.d.ts +2 -3
  179. package/types/src/frame/CommandContext.d.ts +189 -7
  180. package/types/src/group/GroupEditor.d.ts +25 -0
  181. package/types/src/index.d.ts +14 -2
  182. package/types/src/io/WorkbookIO.d.ts +2 -0
  183. package/types/src/layer/BorderLayer.d.ts +2 -2
  184. package/types/src/layer/CellErrorLayer.d.ts +26 -9
  185. package/types/src/layer/CellFillLayer.d.ts +2 -2
  186. package/types/src/layer/CellInsertLayer.d.ts +71 -0
  187. package/types/src/layer/CircularIndicatorLayer.d.ts +2 -2
  188. package/types/src/layer/CommentCardLayer.d.ts +43 -0
  189. package/types/src/layer/CommentsLayer.d.ts +35 -0
  190. package/types/src/layer/ConditionalBarLayer.d.ts +2 -2
  191. package/types/src/layer/ConditionalIcons.d.ts +4 -4
  192. package/types/src/layer/ConditionalIconsLayer.d.ts +2 -2
  193. package/types/src/layer/ContextMenuLayer.d.ts +2 -2
  194. package/types/src/layer/FreezeDragLines.d.ts +17 -0
  195. package/types/src/layer/GridFreezeLayer.d.ts +11 -0
  196. package/types/src/layer/HeaderFreezeLayer.d.ts +12 -0
  197. package/types/src/layer/HeaderResizerLayer.d.ts +2 -1
  198. package/types/src/layer/HyperlinkLayer.d.ts +109 -0
  199. package/types/src/layer/MovableKindScope.d.ts +17 -0
  200. package/types/src/layer/ProtectionLayer.d.ts +52 -0
  201. package/types/src/layer/RangeAnnotationLayer.d.ts +71 -0
  202. package/types/src/layer/ResizeIndicator.d.ts +11 -10
  203. package/types/src/layer/ResizeTooltip.d.ts +13 -0
  204. package/types/src/layer/SheetBackgroundLayer.d.ts +3 -3
  205. package/types/src/layer/SheetCellLayer.d.ts +4 -4
  206. package/types/src/layer/SheetColumnButtonLayer.d.ts +2 -2
  207. package/types/src/layer/SheetGridLineLayer.d.ts +11 -13
  208. package/types/src/layer/SheetHeaderCellLayer.d.ts +10 -1
  209. package/types/src/layer/SheetLayers.d.ts +115 -0
  210. package/types/src/layer/SheetMovableLayer.d.ts +2 -2
  211. package/types/src/layer/SheetOutlineLayer.d.ts +40 -0
  212. package/types/src/layer/SheetTableCommandLayer.d.ts +2 -2
  213. package/types/src/layer/SpillLayer.d.ts +2 -2
  214. package/types/src/layer/TableLayer.d.ts +6 -5
  215. package/types/src/layer/TableToolbar.d.ts +42 -0
  216. package/types/src/layer/ValidationDropdownLayer.d.ts +17 -7
  217. package/types/src/layer/ValidationIndicatorLayer.d.ts +11 -5
  218. package/types/src/layer/ValidationPromptLayer.d.ts +65 -0
  219. package/types/src/layer/_tableColor.d.ts +4 -0
  220. package/types/src/layer/cellTip.d.ts +13 -0
  221. package/types/src/layer/freezeDragState.d.ts +21 -0
  222. package/types/src/layer/index.d.ts +14 -1
  223. package/types/src/layer/resizeIndicatorState.d.ts +3 -1
  224. package/types/src/layer/useFreezeDrag.d.ts +22 -0
  225. package/types/src/layer/useNormalBorderLines.d.ts +15 -0
  226. package/types/src/layer/useSheetFeatureRegions.d.ts +2 -2
  227. package/types/src/layer/useSheetVisibleCells.d.ts +2 -2
  228. package/types/src/layer/useSheetVisibleDecorations.d.ts +2 -2
  229. package/types/src/layer/useTableHeaderCells.d.ts +2 -2
  230. package/types/src/layer/useValidationPicker.d.ts +37 -37
  231. package/types/src/layer/useVisibleTables.d.ts +2 -2
  232. package/types/src/layer/validationMark.d.ts +63 -0
  233. package/types/src/listener/index.d.ts +5 -0
  234. package/types/src/listener/useCell.d.ts +29 -0
  235. package/types/src/listener/useCellRange.d.ts +23 -0
  236. package/types/src/listener/useCellValue.d.ts +26 -0
  237. package/types/src/listener/useModelListener.d.ts +8 -8
  238. package/types/src/listener/useRangeSnapshot.d.ts +35 -0
  239. package/types/src/listener/useTable.d.ts +26 -0
  240. package/types/src/movable/ConnectionSites.d.ts +18 -0
  241. package/types/src/movable/DefaultMovable.d.ts +8 -0
  242. package/types/src/movable/IMovableArea.d.ts +56 -0
  243. package/types/src/movable/MovableAdornment.d.ts +26 -0
  244. package/types/src/movable/MovableCommandGroups.d.ts +40 -0
  245. package/types/src/movable/MovableCommands.d.ts +8 -3
  246. package/types/src/movable/MovableControl.d.ts +78 -0
  247. package/types/src/movable/MovableEdit.d.ts +22 -0
  248. package/types/src/movable/MovableFrame.d.ts +16 -13
  249. package/types/src/movable/MovableLayer.d.ts +25 -7
  250. package/types/src/movable/MovableRenderers.d.ts +210 -0
  251. package/types/src/movable/PlaceholderFrames.d.ts +11 -0
  252. package/types/src/movable/RotateHandle.d.ts +37 -0
  253. package/types/src/movable/TextBox.d.ts +34 -0
  254. package/types/src/movable/connect.d.ts +16 -0
  255. package/types/src/movable/framePlacement.d.ts +72 -0
  256. package/types/src/movable/geometry.d.ts +61 -0
  257. package/types/src/movable/index.d.ts +11 -0
  258. package/types/src/movable/pressTarget.d.ts +20 -0
  259. package/types/src/picker/PickerPanel.d.ts +52 -0
  260. package/types/src/picker/cellPickerOpen.d.ts +6 -0
  261. package/types/src/picker/index.d.ts +4 -0
  262. package/types/src/picker/useCellPicker.d.ts +95 -0
  263. package/types/src/picture/PictureCommands.d.ts +12 -0
  264. package/types/src/picture/PictureKind.d.ts +7 -0
  265. package/types/src/picture/index.d.ts +0 -1
  266. package/types/src/protection/ProtectionPaneArgs.d.ts +31 -0
  267. package/types/src/protection/index.d.ts +3 -0
  268. package/types/src/protection/unlockProtectedRanges.d.ts +23 -0
  269. package/types/src/richText/RichTextEditor.d.ts +41 -0
  270. package/types/src/richText/index.d.ts +2 -0
  271. package/types/src/selection/SelectionCommands.d.ts +2 -2
  272. package/types/src/selection/SheetSelectionLayer.d.ts +16 -12
  273. package/types/src/shape/ConnectorControl.d.ts +46 -0
  274. package/types/src/shape/ShapeCommands.d.ts +11 -0
  275. package/types/src/shape/ShapeControl.d.ts +8 -0
  276. package/types/src/shape/ShapeEditor.d.ts +15 -2
  277. package/types/src/shape/ShapeGallery.d.ts +31 -0
  278. package/types/src/shape/ShapeHandles.d.ts +28 -0
  279. package/types/src/shape/ShapeKind.d.ts +7 -0
  280. package/types/src/shape/ShapeSVG.d.ts +22 -0
  281. package/types/src/shape/ShapeText.d.ts +17 -0
  282. package/types/src/shape/icons/ShapeIcons.d.ts +16 -0
  283. package/types/src/shape/icons/_ShapeIconPack.d.ts +4 -0
  284. package/types/src/shape/index.d.ts +3 -1
  285. package/types/src/shape/shapeFrame.d.ts +50 -0
  286. package/types/src/shape/shapeStyle.d.ts +82 -0
  287. package/types/src/sheet/ISheetHeaderElement.d.ts +1 -1
  288. package/types/src/sheet/{ISheetElement.d.ts → IWorksheetElement.d.ts} +107 -77
  289. package/types/src/sheet/OpaqueSheetElement.d.ts +21 -0
  290. package/types/src/sheet/SheetCommandProvider.d.ts +11 -6
  291. package/types/src/sheet/SheetCommands.d.ts +22 -7
  292. package/types/src/sheet/SheetKindIcon.d.ts +14 -0
  293. package/types/src/sheet/SheetOutlineElement.d.ts +70 -0
  294. package/types/src/sheet/SheetPanels.d.ts +11 -0
  295. package/types/src/sheet/SheetScrollbar.d.ts +4 -13
  296. package/types/src/sheet/TopLeftCorner.d.ts +2 -2
  297. package/types/src/sheet/WorksheetElement.d.ts +12 -0
  298. package/types/src/sheet/_freezeAt.d.ts +10 -0
  299. package/types/src/sheet/_useHeaderMetrics.d.ts +11 -0
  300. package/types/src/sheet/circularReferences.d.ts +12 -4
  301. package/types/src/sheet/index.d.ts +6 -3
  302. package/types/src/sheet/useCycleHighlight.d.ts +21 -0
  303. package/types/src/slicer/SlicerCommands.d.ts +10 -0
  304. package/types/src/slicer/SlicerEditor.d.ts +8 -2
  305. package/types/src/slicer/SlicerKind.d.ts +7 -0
  306. package/types/src/slicer/SlicerStylePreview.d.ts +18 -0
  307. package/types/src/slicer/index.d.ts +2 -1
  308. package/types/src/slicer/slicerStyles.d.ts +32 -0
  309. package/types/src/tabStrip/SheetTab.d.ts +1 -1
  310. package/types/src/tabStrip/TabStrip.d.ts +7 -0
  311. package/types/src/table/TableCommands.d.ts +2 -2
  312. package/types/src/taskPane/ITaskPane.d.ts +12 -1
  313. package/types/src/taskPane/MovablePane.d.ts +17 -0
  314. package/types/src/taskPane/TaskPaneArea.d.ts +7 -0
  315. package/types/src/taskPane/index.d.ts +1 -0
  316. package/types/src/theme/ThemeState.d.ts +14 -1
  317. package/types/src/theme/buildOOXMLThemeCSS.d.ts +2 -2
  318. package/types/src/theme/useGridColorScheme.d.ts +2 -2
  319. package/types/src/theme/useSystemColors.d.ts +2 -2
  320. package/types/src/workbook/DefaultMovableRenderers.d.ts +20 -0
  321. package/types/src/workbook/DefaultRenderers.d.ts +3 -2
  322. package/types/src/workbook/IWorkbookElement.d.ts +51 -5
  323. package/types/src/workbook/WorkbookCommands.d.ts +2 -4
  324. package/types/src/workbook/WorkbookStrip.d.ts +9 -0
  325. package/types/src/workbook/_followOrigin.d.ts +9 -0
  326. package/types/src/workbook/useWorkbookFormat.d.ts +3 -3
  327. package/browser/cjs/Bo9Kx3L_XQkGPBJ5.cjs +0 -1
  328. package/browser/cjs/Pl04-kDEQSO8_qFU.cjs +0 -156
  329. package/browser/cjs/index.cjs +0 -35
  330. package/browser/esm/SJMJzBwlXTJ9QIO5.mjs +0 -6286
  331. package/types/src/chart/templates/area-stacked-percent-template.json.d.ts +0 -10
  332. package/types/src/chart/templates/area-stacked-template.json.d.ts +0 -10
  333. package/types/src/chart/templates/area-template.json.d.ts +0 -9
  334. package/types/src/chart/templates/bar-stacked-percent-template.json.d.ts +0 -10
  335. package/types/src/chart/templates/bar-stacked-template.json.d.ts +0 -10
  336. package/types/src/chart/templates/bar-template.json.d.ts +0 -9
  337. package/types/src/chart/templates/column-stacked-percent-template.json.d.ts +0 -10
  338. package/types/src/chart/templates/column-stacked-template.json.d.ts +0 -10
  339. package/types/src/chart/templates/column-template.json.d.ts +0 -9
  340. package/types/src/chart/templates/line-markers-template.json.d.ts +0 -10
  341. package/types/src/chart/templates/line-stacked-markers-template.json.d.ts +0 -11
  342. package/types/src/chart/templates/line-stacked-percent-markers-template.json.d.ts +0 -11
  343. package/types/src/chart/templates/line-stacked-percent-template.json.d.ts +0 -10
  344. package/types/src/chart/templates/line-stacked-template.json.d.ts +0 -10
  345. package/types/src/chart/templates/line-template.json.d.ts +0 -9
  346. package/types/src/chart/templates/pie-doughnut-template.json.d.ts +0 -10
  347. package/types/src/chart/templates/pie-template.json.d.ts +0 -9
  348. package/types/src/chart/templates/scatter-lines-markers-smooth-template.json.d.ts +0 -10
  349. package/types/src/chart/templates/scatter-lines-markers-template.json.d.ts +0 -10
  350. package/types/src/chart/templates/scatter-lines-smooth-template.json.d.ts +0 -10
  351. package/types/src/chart/templates/scatter-lines-template.json.d.ts +0 -10
  352. package/types/src/chart/templates/scatter-markers-template.json.d.ts +0 -10
  353. package/types/src/context/SheetContext.d.ts +0 -18
  354. package/types/src/editor/useProtectedEditNotice.d.ts +0 -14
  355. package/types/src/layer/validationList.d.ts +0 -84
  356. package/types/src/list/SheetValueList.d.ts +0 -93
  357. package/types/src/list/index.d.ts +0 -2
  358. package/types/src/movable/MoveableBundle.d.ts +0 -4
  359. package/types/src/sheet/SheetElement.d.ts +0 -15
@@ -0,0 +1,63 @@
1
+ import { CellCoords, RangeCoords } from '@sheetxl/utils';
2
+ import { IDataValidation, IWorksheet } from '@sheetxl/sdk';
3
+ import { VisibleCell } from '@sheetxl/grid-react';
4
+ /**
5
+ * How a cell's value fails its data validations: `'failed'` when every failing rule raises no
6
+ * alert, otherwise the alert style of the rule that answers for it.
7
+ */
8
+ export type ValidationMarkState = 'failed' | IDataValidation.AlertStyle;
9
+ /**
10
+ * What a cell's invalid-value mark shows.
11
+ */
12
+ export interface ValidationMark {
13
+ /** See {@link ValidationMarkState}. */
14
+ state: ValidationMarkState;
15
+ /** The rule that answers for the cell: the one whose alert typing a value would raise. */
16
+ rule: IDataValidation;
17
+ /** How many other covering rules the value also fails. */
18
+ others: number;
19
+ }
20
+ /**
21
+ * The mark for the cell at `rowIndex`, `columnIndex`, or `null` when its value passes every rule.
22
+ *
23
+ * @param rules The data validations to consider, in priority order. A rule not covering the cell
24
+ * never fails it, so a range's rules can be passed for each of its cells.
25
+ *
26
+ * @remarks
27
+ * The first failing rule that raises an alert answers for the cell, the same rule an entry would be
28
+ * refused or warned by, so the mark previews what typing the value would do. A rule with its alert
29
+ * off still marks the cell, as `'failed'`, when no alerting rule fails it.
30
+ */
31
+ export declare const resolveValidationMark: (rules: readonly IDataValidation[], rowIndex: number, columnIndex: number) => ValidationMark | null;
32
+ /**
33
+ * The marks for the cells of `coords` (the window in view), each at the cell or the merge it anchors.
34
+ *
35
+ * @remarks
36
+ * Every rule reaching into the window applies, in priority order: a cell is marked when ANY rule
37
+ * covering it flags it. Rules are few, so this is a lookup per visited cell against each of them.
38
+ * Only cells holding a value are visited, unless a rule has Ignore blank off: an empty cell can fail
39
+ * that one, so the window's empty cells are visited too — bounded by the window, as painting is.
40
+ */
41
+ export declare const findVisibleValidationMarks: (sheet: IWorksheet, coords: RangeCoords) => VisibleCell[];
42
+ /**
43
+ * What the hover tip over a cell's invalid-value mark says.
44
+ */
45
+ export interface ValidationTip {
46
+ /** The cell, or the merge it anchors: the tip's anchor. */
47
+ range: RangeCoords;
48
+ /** The answering rule's alert title and message, or its condition when it raises none. */
49
+ message: string;
50
+ /** See {@link ValidationMark}. */
51
+ mark: ValidationMark;
52
+ }
53
+ /**
54
+ * The tip for the mark at `coords`, or `null` when there is none to explain: the marks are hidden
55
+ * (Show Invalid off), the value passes, or the cell is the active one and its input prompt is
56
+ * already saying what it wants.
57
+ */
58
+ export declare const findValidationTip: (sheet: IWorksheet, coords: CellCoords) => ValidationTip | null;
59
+ /** The color a mark is drawn in, per state: the theme's severity colors, neutral for no alert. */
60
+ export declare const VALIDATION_MARK_COLORS: Record<ValidationMarkState, string>;
61
+ /** The glyph for each state (the Base icon pack), the same the rule editor shows for a style. */
62
+ export declare const VALIDATION_MARK_ICONS: Record<ValidationMarkState, string>;
63
+ //# sourceMappingURL=validationMark.d.ts.map
@@ -1,3 +1,8 @@
1
1
  export * from './useModelListener';
2
2
  export * from './useRangeListener';
3
+ export * from './useCellRange';
4
+ export * from './useCellValue';
5
+ export * from './useCell';
6
+ export type { CellRangeTarget, CellRangeHookOptions } from './useRangeSnapshot';
7
+ export * from './useTable';
3
8
  //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1,29 @@
1
+ import { ICell, ICellRange } from '@sheetxl/sdk';
2
+ import { CellRangeTarget, CellRangeHookOptions } from './useRangeSnapshot';
3
+ /**
4
+ * Binds a single cell: returns a snapshot of it and an updater, and re-renders with a new snapshot when
5
+ * the cell changes.
6
+ *
7
+ * @param target The workbook or sheet to read from, or `null` while there is none.
8
+ * @param address The cell's address. A larger range binds its top-left cell.
9
+ * @param options Listener options, and an optional `onChange` that receives each change event.
10
+ * @returns The cell, or `null` while `target` is `null`, and an updater that does nothing until there
11
+ * is a target.
12
+ *
13
+ * @remarks
14
+ * The cell is a snapshot: it does not change after it is returned, so it is safe to compare or memoize
15
+ * on. Its formatted text, type, formula, and errors are all available alongside the value.
16
+ *
17
+ * The updater takes anything {@link ICellRange.updateCells} does: a value, a cell, or
18
+ * {@link ICell.Modifiers} such as `{ value, style }`. Text is parsed by default, so `'=SUM(A1:A3)'`
19
+ * becomes a formula; pass `{ textParser: false }` to store it as text. For a plain value, see
20
+ * {@link useCellValue}.
21
+ *
22
+ * @example
23
+ * ```tsx
24
+ * const [total] = useCell(sheet, 'D23');
25
+ * return <output>{total?.getText()}</output>;
26
+ * ```
27
+ */
28
+ export declare const useCell: (target: CellRangeTarget | null | undefined, address: ICellRange.Address, options?: CellRangeHookOptions) => [ICell | null, (update: ICell.Update, options?: ICellRange.UpdateCellsOptions) => void];
29
+ //# sourceMappingURL=useCell.d.ts.map
@@ -0,0 +1,23 @@
1
+ import { ICellRange } from '@sheetxl/sdk';
2
+ import { CellRangeTarget, CellRangeHookOptions } from './useRangeSnapshot';
3
+ /**
4
+ * Returns the range at `address` and re-renders whenever anything in it changes: values (including
5
+ * recalculated formula results), styles, or its address.
6
+ *
7
+ * @param target The workbook or sheet to read from, or `null` while there is none.
8
+ * @param address The range's address. An object address is compared by identity, so keep it stable.
9
+ * @param options Listener options, and an optional `onChange` that receives each change event.
10
+ * @returns The range, or `null` while `target` is `null`.
11
+ *
12
+ * @remarks
13
+ * The returned range is the same object across renders; read from it during render. For a single
14
+ * value use {@link useCellValue}, and for a single cell's full state use {@link useCell}.
15
+ *
16
+ * @example
17
+ * ```tsx
18
+ * const items = useCellRange(sheet, 'A7:C18');
19
+ * const rows = items?.getValues() ?? [];
20
+ * ```
21
+ */
22
+ export declare const useCellRange: (target: CellRangeTarget | null | undefined, address: ICellRange.Address, options?: CellRangeHookOptions) => ICellRange | null;
23
+ //# sourceMappingURL=useCellRange.d.ts.map
@@ -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
@@ -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 renderDefaultMovable: (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,40 @@
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
+ * Adds a button to a kind's ribbon tab, whether the kind brings its own tab or has the default one:
6
+ * the contribution point for whatever adds to a kind it does not own, as a host adds its own widgets
7
+ * to a built-in kind.
8
+ *
9
+ * @param type The content type.
10
+ * @param entry The button: a command key to run (`defaultKey`), or a `render` of its own.
11
+ * @param placement Where in the tab. `{ order: -1, divider: 'after' }` puts it first, set apart.
12
+ * @returns A function that removes it.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * registerMovableToolbarEntry('shape', { key: 'shapeGlow', defaultKey: 'formatShapeGlow' }, { order: -1 });
17
+ * ```
18
+ */
19
+ export declare function registerMovableToolbarEntry(type: string, entry: Command.CommandButtonEntry & {
20
+ key: string;
21
+ }, placement?: Command.Placement): () => void;
22
+ /**
23
+ * The tab a kind of movable content gets when its module brings none: the drawing groups and the
24
+ * format pane, labeled with the kind's name (`IContent.getTypeDescription()`) unless the catalog
25
+ * has a label for `${type}Toolbar`. So a new kind with no commands of its own still gets a working
26
+ * tab.
27
+ *
28
+ * @param type The content type; the tab's key is `${type}Toolbar`.
29
+ * @param label The tab's label when the catalog has none.
30
+ */
31
+ export declare function createDefaultMovableToolbar(type: string, label: string): Command.CommandButtonEntry & {
32
+ key: string;
33
+ };
34
+ /**
35
+ * Registers the drawing button groups shared by every kind's ribbon tab and by a host's drawing
36
+ * right-click menu: z-order, align and distribute, flip, group, anchor sizing, and `arrangeOptions`,
37
+ * which gathers them for the end of a tab. Their chrome is in the `movable` catalog. Idempotent.
38
+ */
39
+ export declare function registerMovableCommandGroups(): void;
40
+ //# 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,78 @@
1
+ import { default as React } from 'react';
2
+ import { IMovable } from '@sheetxl/sdk';
3
+ import { ResizeDirection } from './geometry';
4
+ import { MovablePreview } from './framePlacement';
5
+ /** The resize cursor for a handle on a frame turned `rotation` degrees, so it follows the turn. */
6
+ export declare const resizeCursor: (direction: ResizeDirection, rotation: number) => string;
7
+ export interface MovableControlProps {
8
+ /** Compass names of the handles to draw (`nw`, `n`, … `se`). */
9
+ directions: readonly string[];
10
+ /** Degrees clockwise the frame is turned; only the cursors use it, the box turns itself. */
11
+ rotation: number;
12
+ /**
13
+ * Fade the control, as during a gesture. It stays mounted: the handle being dragged holds the
14
+ * pointer capture.
15
+ */
16
+ isDragging?: boolean;
17
+ /** A press on a handle. Return `false` to refuse the gesture. */
18
+ onResizeStart: () => boolean;
19
+ /**
20
+ * The pointer moved. `delta` is how far it is from the press, in screen pixels; `keepAspect` is
21
+ * whether Shift is held.
22
+ */
23
+ onResize: (direction: ResizeDirection, delta: readonly [number, number], keepAspect: boolean) => void;
24
+ /** The pointer was released. */
25
+ onResizeEnd: () => void;
26
+ /** The gesture was lost (`pointercancel`). */
27
+ onResizeCancel: () => void;
28
+ /**
29
+ * Draw the control as context: the frame of a group a selected member is inside, as Excel draws
30
+ * it (a dotted outline and hollow neutral handles). Its handles still resize that group.
31
+ */
32
+ context?: boolean;
33
+ /**
34
+ * A press on the move grip a frame too small for its handles shows in their place. Omit when the
35
+ * frame cannot be moved.
36
+ */
37
+ onMoveStart?: (e: PointerEvent) => void;
38
+ /** Drawn first in the control, so it hides with the handles and paints under them: the rotate handle. */
39
+ children?: React.ReactNode;
40
+ }
41
+ /**
42
+ * What the layer lets a content's own control do: run a gesture of its own through the layer's
43
+ * preview and commit loop, so it is drawn, cancelled and undone as a move or resize is.
44
+ */
45
+ export interface MovableGestureHost {
46
+ /**
47
+ * Starts a gesture on the control's movable: the layer snapshots it and readies one commit.
48
+ * `onCommit` runs on the movable inside that commit, after the previewed placement is written.
49
+ * Returns `false` when the layer refuses gestures.
50
+ */
51
+ start(description: string, onCommit?: (movable: IMovable) => void): boolean;
52
+ /** Draws the movable at a placement (absolute px) until the gesture ends. */
53
+ preview(preview: MovablePreview): void;
54
+ /** Commits what was previewed. */
55
+ finish(): void;
56
+ /** Drops the gesture with nothing written. */
57
+ cancel(): void;
58
+ }
59
+ /**
60
+ * Props of a control a content kind registers in place of the generic one (see
61
+ * `registerMovableRenderer`): the generic control's, and what a control of its own needs.
62
+ */
63
+ export interface ContentControlProps extends MovableControlProps {
64
+ movable: IMovable;
65
+ /** How the frame is mirrored: the gesture's while one is in flight, else the movable's. */
66
+ flip: IMovable.Flip;
67
+ gesture: MovableGestureHost;
68
+ }
69
+ /**
70
+ * A selected movable's outline and resize handles, drawn in its adornment box so they are placed
71
+ * and turned from the same numbers as the frame. Each handle captures the pointer for its gesture.
72
+ *
73
+ * @remarks
74
+ * A frame too small to show its handles apart (see the layer's stylesheet) hides them, still live,
75
+ * and draws a move grip below it, as Excel does.
76
+ */
77
+ export declare const MovableControl: React.FC<MovableControlProps>;
78
+ //# 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,8 @@
1
1
  import { default as React } from 'react';
2
- import { Bounds } from '@sheetxl/utils';
3
2
  import { IMovable } from '@sheetxl/sdk';
4
3
  import { MovableElementProps } from './IMovableArea';
4
+ import { MovableGestureHost } from './MovableControl';
5
+ import { MovablePreview } from './framePlacement';
5
6
  export interface MovableFrameProps extends React.HTMLAttributes<HTMLElement> {
6
7
  /**
7
8
  * The underlying model for the chart.
@@ -18,24 +19,26 @@ export interface MovableFrameProps extends React.HTMLAttributes<HTMLElement> {
18
19
  onRefUnload: (ref: HTMLElement) => void;
19
20
  onHide: (hide: (movable: IMovable) => boolean | Promise<boolean> | void) => void;
20
21
  onShow: (show: (movable: IMovable) => void) => void;
22
+ /** {@inheritDoc MovableElementProps.adornmentHost} */
23
+ adornmentHost?: HTMLElement | null;
24
+ /** {@inheritDoc MovableElementProps.gesture} */
25
+ gesture?: MovableGestureHost;
21
26
  /**
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.
27
+ * Live drag/resize/rotate preview, or null/undefined when idle. When set, the frame renders with it
28
+ * instead of the model (the model isn't touched until the gesture commits). Surface-scoped in the
29
+ * parent, so it's set in every pane — that's what makes a dragged shape appear, correctly clipped,
30
+ * on both sides of a freeze boundary.
26
31
  */
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;
32
+ preview?: MovablePreview | null;
34
33
  /**
35
34
  * Called when the final movable is unselected.
36
35
  */
37
36
  onUnFocus: () => void;
38
- dragStart(e: MouseEvent | TouchEvent, target?: EventTarget | null): void;
37
+ /**
38
+ * A press that may move the frame, after it selected. Not called for a press outside the
39
+ * content's drag zone or in an editable element.
40
+ */
41
+ dragStart(e: PointerEvent): void;
39
42
  disabled?: boolean;
40
43
  /**
41
44
  * Indicates if the frame is being dragged. Useful for styling.