@sheetxl/react 0.8.0-beta.9 → 1.0.0

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 (398) hide show
  1. package/LICENSE.md +8 -7
  2. package/browser/esm/2YDUWXaXpl9cdsk7.mjs +8 -0
  3. package/browser/esm/64NfoZ1s7Oe3vdpX.mjs +60 -0
  4. package/browser/esm/BJDz5J4gFUEYi1Wz.mjs +36 -0
  5. package/browser/esm/B_CI6xMNropeWGgr.mjs +134 -0
  6. package/browser/esm/BgA4Cz8iMysciFOb.mjs +45 -0
  7. package/browser/esm/BkG6VuJDmu_hfIo6.mjs +31 -0
  8. package/browser/esm/BmO7yh4NjxeJylOD.mjs +14092 -0
  9. package/browser/esm/BwFFSeqtE3TIuvtc.mjs +341 -0
  10. package/browser/esm/CENTtj0PnF_tvpST.mjs +79 -0
  11. package/browser/esm/CVY0-_x6IgpdUVNp.mjs +264 -0
  12. package/browser/esm/CdyivRoMgPXvRiiE.mjs +197 -0
  13. package/browser/esm/CiylJlRA7mt8yjPD.mjs +128 -0
  14. package/browser/esm/D9CTIGFUbVGJkeVE.mjs +401 -0
  15. package/browser/esm/D9NgFucLwPgAQNgf.mjs +19 -0
  16. package/browser/esm/DdFOaG09eksHtKwT.mjs +145 -0
  17. package/browser/esm/DdHdNjRkzo1iShOo.mjs +78 -0
  18. package/browser/esm/DfIvpHB7HDdmIYNm.mjs +9560 -0
  19. package/browser/esm/DfNDtzixfTPjmoW_.mjs +32 -0
  20. package/browser/esm/Dtb9bOBjtPdUAr8x.mjs +20 -0
  21. package/browser/esm/Dz5pGpL4XWXVdntj.mjs +323 -0
  22. package/browser/esm/{Dk6274Lic6AOmEAq.mjs → SJAlYSFKC-5yNZ-C.mjs} +84 -2
  23. package/browser/esm/chart.mjs +41 -0
  24. package/browser/esm/control.mjs +217 -0
  25. package/browser/esm/group.mjs +123 -0
  26. package/browser/esm/index.mjs +21677 -15289
  27. package/browser/esm/jHqSboF5oFvzSM7a.mjs +63 -0
  28. package/browser/esm/note.mjs +112 -0
  29. package/browser/esm/oljQE8EpIzoxUjUz.mjs +323 -0
  30. package/browser/esm/picture.mjs +7 -0
  31. package/browser/esm/shape.mjs +7 -0
  32. package/browser/esm/slicer.mjs +282 -0
  33. package/browser/esm/w8MsScJSe7QxP6jL.mjs +67 -0
  34. package/browser/esm/yRqWQRSVyiR1kYh8.mjs +42 -0
  35. package/licenses/dependencies.txt +327 -53
  36. package/node/esm/1XOgrNXKQF__O9SV.mjs +8 -0
  37. package/node/esm/Aw6aaKE_YOA1Vi_V.mjs +146 -0
  38. package/node/esm/B6Oqu2Gw1pwWPf_N.mjs +328 -0
  39. package/node/esm/BizlElAhqg_Bc624.mjs +198 -0
  40. package/node/esm/C06Y1xPsbxgn3YX7.mjs +128 -0
  41. package/node/esm/C2dHN_gvhBxlFFnJ.mjs +45 -0
  42. package/node/esm/C4_5UcCdys1hzt5E.mjs +68 -0
  43. package/node/esm/CIidiDtqyubz13ys.mjs +80 -0
  44. package/node/esm/CTFb8PjwC1q6yilw.mjs +80 -0
  45. package/node/esm/C_GJPG-BTFhta8GD.mjs +265 -0
  46. package/node/esm/CdTeYrDgGp-s-KNG.mjs +134 -0
  47. package/node/esm/{B-5p0wwNM6Y5jlI2.mjs → CeMKhq6cSxfWzN5H.mjs} +84 -2
  48. package/node/esm/DJIBAu8bEDmlVjtD.mjs +20 -0
  49. package/node/esm/DUQ1PY9P63cTe_Es.mjs +37 -0
  50. package/node/esm/Db8NRp_kZ-FfkZaO.mjs +32 -0
  51. package/node/esm/Dl2kdvb4G_ddqeDN.mjs +19 -0
  52. package/node/esm/DlDr-o5nAZgPbn6R.mjs +1697 -0
  53. package/node/esm/DvRLP1lEBfwHBrEC.mjs +63 -0
  54. package/node/esm/JVlPlE1ys7DM3yCP.mjs +35 -0
  55. package/node/esm/NSddS40Vqf1xKdDd.mjs +406 -0
  56. package/node/esm/QqwCS9GFuDnQausz.mjs +66 -0
  57. package/node/esm/chart.mjs +41 -0
  58. package/node/esm/control.mjs +217 -0
  59. package/node/esm/group.mjs +123 -0
  60. package/node/esm/index.mjs +16970 -10477
  61. package/node/esm/note.mjs +113 -0
  62. package/node/esm/picture.mjs +326 -0
  63. package/node/esm/shape.mjs +342 -0
  64. package/node/esm/slicer.mjs +284 -0
  65. package/package.json +56 -14
  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 +169 -16
  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 +353 -2
  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 +170 -17
  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 +195 -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 +2 -1
  114. package/types/src/cell/OutlineButton.d.ts +4 -4
  115. package/types/src/cell/PivotButton.d.ts +55 -0
  116. package/types/src/cell/SheetHeaderRenderer.d.ts +1 -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 +9 -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 +44 -15
  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 +9 -9
  159. package/types/src/comment/index.d.ts +0 -1
  160. package/types/src/comment/useSheetComments.d.ts +2 -2
  161. package/types/src/conditionalFormat/ConditionalFormatPresets.d.ts +6 -6
  162. package/types/src/context/WorksheetContext.d.ts +18 -0
  163. package/types/src/context/index.d.ts +1 -1
  164. package/types/src/control/FormControlRenderers.d.ts +8 -0
  165. package/types/src/editableLabel/EditableLabel.d.ts +3 -1
  166. package/types/src/editor/EditorCommands.d.ts +3 -3
  167. package/types/src/editor/SheetCellEditorLayer.d.ts +2 -7
  168. package/types/src/editor/SheetCellEditorStartLayer.d.ts +22 -5
  169. package/types/src/editor/SheetCellInput.d.ts +14 -0
  170. package/types/src/editor/SheetEditable.d.ts +6 -6
  171. package/types/src/editor/SheetReferenceHeaderLayer.d.ts +1 -1
  172. package/types/src/editor/SheetReferenceLayer.d.ts +4 -4
  173. package/types/src/editor/VirtualKeyboardLayer.d.ts +50 -0
  174. package/types/src/editor/formulaAnchor.d.ts +12 -0
  175. package/types/src/editor/formulaPresentation.d.ts +4 -3
  176. package/types/src/editor/index.d.ts +2 -0
  177. package/types/src/editor/pickedReference.d.ts +3 -3
  178. package/types/src/editor/useEditRejectedNotice.d.ts +3 -3
  179. package/types/src/editor/useFormulaHints.d.ts +3 -3
  180. package/types/src/editor/useFormulaInput.d.ts +6 -3
  181. package/types/src/editor/validationAlert.d.ts +24 -0
  182. package/types/src/form/FormulaInput.d.ts +5 -2
  183. package/types/src/form/useEditCommit.d.ts +23 -3
  184. package/types/src/form/useInputField.d.ts +2 -3
  185. package/types/src/frame/CommandContext.d.ts +74 -3
  186. package/types/src/group/GroupEditor.d.ts +25 -0
  187. package/types/src/index.d.ts +10 -2
  188. package/types/src/layer/BorderLayer.d.ts +5 -2
  189. package/types/src/layer/CellErrorLayer.d.ts +18 -7
  190. package/types/src/layer/CellFillLayer.d.ts +2 -2
  191. package/types/src/layer/CellIndicatorLayer.d.ts +31 -0
  192. package/types/src/layer/CellInsertLayer.d.ts +71 -0
  193. package/types/src/layer/CircularIndicatorLayer.d.ts +3 -3
  194. package/types/src/layer/CommentCardLayer.d.ts +7 -9
  195. package/types/src/layer/CommentsLayer.d.ts +2 -2
  196. package/types/src/layer/ConditionalBarLayer.d.ts +2 -2
  197. package/types/src/layer/ConditionalIcons.d.ts +4 -4
  198. package/types/src/layer/ConditionalIconsLayer.d.ts +2 -2
  199. package/types/src/layer/ContextMenuLayer.d.ts +2 -2
  200. package/types/src/layer/FreezeDragLines.d.ts +17 -0
  201. package/types/src/layer/GridFreezeLayer.d.ts +11 -0
  202. package/types/src/layer/HeaderFreezeLayer.d.ts +12 -0
  203. package/types/src/layer/HeaderResizerLayer.d.ts +2 -1
  204. package/types/src/layer/HeaderSelectionLayer.d.ts +4 -4
  205. package/types/src/layer/HyperlinkLayer.d.ts +116 -0
  206. package/types/src/layer/MovableKindScope.d.ts +17 -0
  207. package/types/src/layer/PivotLayer.d.ts +47 -0
  208. package/types/src/layer/PivotToolbar.d.ts +29 -0
  209. package/types/src/layer/ProtectionLayer.d.ts +4 -5
  210. package/types/src/layer/RangeToolbar.d.ts +75 -0
  211. package/types/src/layer/ResizeIndicator.d.ts +11 -10
  212. package/types/src/layer/ResizeTooltip.d.ts +13 -0
  213. package/types/src/layer/SheetBackgroundLayer.d.ts +3 -3
  214. package/types/src/layer/SheetCellLayer.d.ts +15 -8
  215. package/types/src/layer/SheetColumnButtonLayer.d.ts +2 -2
  216. package/types/src/layer/SheetGridLineLayer.d.ts +25 -15
  217. package/types/src/layer/SheetHeaderCellLayer.d.ts +1 -1
  218. package/types/src/layer/SheetLayers.d.ts +171 -0
  219. package/types/src/layer/SheetMovableLayer.d.ts +4 -3
  220. package/types/src/layer/SheetOutlineLayer.d.ts +3 -3
  221. package/types/src/layer/SheetPivotCommandLayer.d.ts +13 -0
  222. package/types/src/layer/SheetSparklineCommandLayer.d.ts +14 -0
  223. package/types/src/layer/SheetTableCommandLayer.d.ts +2 -2
  224. package/types/src/layer/SparklineLayer.d.ts +32 -0
  225. package/types/src/layer/SpillLayer.d.ts +2 -2
  226. package/types/src/layer/TableLayer.d.ts +6 -5
  227. package/types/src/layer/TableToolbar.d.ts +23 -0
  228. package/types/src/layer/ValidationDropdownLayer.d.ts +2 -2
  229. package/types/src/layer/ValidationIndicatorLayer.d.ts +2 -2
  230. package/types/src/layer/ValidationPromptLayer.d.ts +47 -16
  231. package/types/src/layer/_sheetBorders.d.ts +6 -0
  232. package/types/src/layer/_tableColor.d.ts +6 -0
  233. package/types/src/layer/_visibleCellFeatures.d.ts +11 -0
  234. package/types/src/layer/cellTip.d.ts +13 -0
  235. package/types/src/layer/freezeDragState.d.ts +21 -0
  236. package/types/src/layer/index.d.ts +14 -0
  237. package/types/src/layer/resizeIndicatorState.d.ts +3 -1
  238. package/types/src/layer/useFreezeDrag.d.ts +22 -0
  239. package/types/src/layer/useNormalBorderLines.d.ts +15 -0
  240. package/types/src/layer/useSheetFeatureRegions.d.ts +2 -2
  241. package/types/src/layer/useSheetVisibleCells.d.ts +5 -6
  242. package/types/src/layer/useSheetVisibleDecorations.d.ts +2 -2
  243. package/types/src/layer/useTableHeaderCells.d.ts +2 -2
  244. package/types/src/layer/useValidationPicker.d.ts +3 -3
  245. package/types/src/layer/useVisibleTables.d.ts +2 -2
  246. package/types/src/layer/validationMark.d.ts +3 -3
  247. package/types/src/listener/index.d.ts +5 -0
  248. package/types/src/listener/useCell.d.ts +29 -0
  249. package/types/src/listener/useCellRange.d.ts +23 -0
  250. package/types/src/listener/useCellValue.d.ts +26 -0
  251. package/types/src/listener/useModelListener.d.ts +4 -4
  252. package/types/src/listener/useRangeListener.d.ts +13 -7
  253. package/types/src/listener/useRangeSnapshot.d.ts +35 -0
  254. package/types/src/listener/useTable.d.ts +26 -0
  255. package/types/src/movable/ConnectionSites.d.ts +18 -0
  256. package/types/src/movable/DefaultMovable.d.ts +8 -0
  257. package/types/src/movable/IMovableArea.d.ts +28 -0
  258. package/types/src/movable/MovableAdornment.d.ts +9 -3
  259. package/types/src/movable/MovableCommandGroups.d.ts +22 -0
  260. package/types/src/movable/MovableCommands.d.ts +8 -3
  261. package/types/src/movable/MovableControl.d.ts +49 -1
  262. package/types/src/movable/MovableFrame.d.ts +5 -1
  263. package/types/src/movable/MovableLayer.d.ts +30 -5
  264. package/types/src/movable/MovableRenderers.d.ts +166 -11
  265. package/types/src/movable/PlaceholderFrames.d.ts +11 -0
  266. package/types/src/movable/RotateHandle.d.ts +12 -4
  267. package/types/src/movable/connect.d.ts +16 -0
  268. package/types/src/movable/framePlacement.d.ts +44 -1
  269. package/types/src/movable/geometry.d.ts +13 -3
  270. package/types/src/movable/index.d.ts +8 -0
  271. package/types/src/movable/pressTarget.d.ts +20 -0
  272. package/types/src/movable/useFramePreview.d.ts +17 -0
  273. package/types/src/picker/cellPickerOpen.d.ts +3 -3
  274. package/types/src/picker/useCellPicker.d.ts +7 -5
  275. package/types/src/picture/PictureCommands.d.ts +20 -0
  276. package/types/src/picture/PictureKind.d.ts +7 -0
  277. package/types/src/picture/_pictureHyperlink.d.ts +13 -0
  278. package/types/src/picture/index.d.ts +0 -1
  279. package/types/src/picture/pictureCrop.d.ts +32 -0
  280. package/types/src/pivot/PivotAreas.d.ts +16 -0
  281. package/types/src/pivot/PivotChip.d.ts +33 -0
  282. package/types/src/pivot/PivotChipMenu.d.ts +74 -0
  283. package/types/src/pivot/PivotCommands.d.ts +24 -0
  284. package/types/src/pivot/PivotFieldList.d.ts +14 -0
  285. package/types/src/pivot/PivotFields.d.ts +47 -0
  286. package/types/src/pivot/PivotFieldsModel.d.ts +143 -0
  287. package/types/src/pivot/PivotTablePane.d.ts +47 -0
  288. package/types/src/pivot/_PivotFieldsContext.d.ts +41 -0
  289. package/types/src/pivot/_pivotNew.d.ts +12 -0
  290. package/types/src/pivot/_pivotRegion.d.ts +14 -0
  291. package/types/src/pivot/index.d.ts +9 -0
  292. package/types/src/pivot/usePivotFields.d.ts +17 -0
  293. package/types/src/presence/PresenceCommands.d.ts +35 -0
  294. package/types/src/presence/PresenceHost.d.ts +58 -0
  295. package/types/src/presence/PresenceMessages.d.ts +42 -0
  296. package/types/src/presence/PresenceStore.d.ts +165 -0
  297. package/types/src/presence/PresenceTypes.d.ts +78 -0
  298. package/types/src/presence/index.d.ts +7 -0
  299. package/types/src/presence/usePresence.d.ts +20 -0
  300. package/types/src/richText/RichTextEditor.d.ts +2 -2
  301. package/types/src/selection/SelectionCommands.d.ts +2 -2
  302. package/types/src/selection/SheetSelectionLayer.d.ts +6 -12
  303. package/types/src/shape/ConnectorControl.d.ts +46 -0
  304. package/types/src/shape/ShapeCommands.d.ts +11 -0
  305. package/types/src/shape/ShapeControl.d.ts +8 -0
  306. package/types/src/shape/ShapeEditor.d.ts +2 -3
  307. package/types/src/shape/ShapeGallery.d.ts +21 -6
  308. package/types/src/shape/ShapeKind.d.ts +7 -0
  309. package/types/src/shape/ShapeSVG.d.ts +6 -8
  310. package/types/src/shape/index.d.ts +0 -1
  311. package/types/src/shape/shapeFrame.d.ts +46 -2
  312. package/types/src/shape/shapeStyle.d.ts +59 -8
  313. package/types/src/sheet/ISheetHeaderElement.d.ts +3 -3
  314. package/types/src/sheet/{ISheetElement.d.ts → IWorksheetElement.d.ts} +110 -86
  315. package/types/src/sheet/OpaqueSheetElement.d.ts +21 -0
  316. package/types/src/sheet/SheetCommandProvider.d.ts +14 -6
  317. package/types/src/sheet/SheetCommands.d.ts +18 -3
  318. package/types/src/sheet/SheetKindIcon.d.ts +14 -0
  319. package/types/src/sheet/SheetOutlineElement.d.ts +6 -6
  320. package/types/src/sheet/SheetPanels.d.ts +11 -0
  321. package/types/src/sheet/SheetScrollbar.d.ts +4 -13
  322. package/types/src/sheet/TopLeftCorner.d.ts +2 -2
  323. package/types/src/sheet/WorksheetElement.d.ts +12 -0
  324. package/types/src/sheet/_freezeAt.d.ts +10 -0
  325. package/types/src/sheet/_hyperlinkEdit.d.ts +7 -0
  326. package/types/src/sheet/_useHeaderMetrics.d.ts +11 -0
  327. package/types/src/sheet/circularReferences.d.ts +4 -4
  328. package/types/src/sheet/index.d.ts +5 -2
  329. package/types/src/sheet/useCycleHighlight.d.ts +2 -2
  330. package/types/src/slicer/SlicerCommands.d.ts +10 -0
  331. package/types/src/slicer/SlicerEditor.d.ts +8 -2
  332. package/types/src/slicer/SlicerKind.d.ts +7 -0
  333. package/types/src/slicer/SlicerStylePreview.d.ts +18 -0
  334. package/types/src/slicer/index.d.ts +2 -1
  335. package/types/src/slicer/slicerStyles.d.ts +32 -0
  336. package/types/src/sparkline/PictureCache.d.ts +37 -0
  337. package/types/src/sparkline/SparklineCommands.d.ts +23 -0
  338. package/types/src/sparkline/SparklinePictures.d.ts +7 -0
  339. package/types/src/sparkline/paint/_drawing.d.ts +24 -0
  340. package/types/src/sparkline/paint/echarts.d.ts +8 -0
  341. package/types/src/sparkline/paint/index.d.ts +8 -0
  342. package/types/src/tabStrip/SheetTab.d.ts +1 -1
  343. package/types/src/tabStrip/Sortable.d.ts +5 -5
  344. package/types/src/tabStrip/TabStrip.d.ts +13 -6
  345. package/types/src/tabStrip/TabStripItem.d.ts +15 -13
  346. package/types/src/table/TableCommands.d.ts +2 -2
  347. package/types/src/taskPane/CellControlPane.d.ts +15 -0
  348. package/types/src/taskPane/MovablePane.d.ts +15 -0
  349. package/types/src/taskPane/TaskPaneArea.d.ts +7 -0
  350. package/types/src/taskPane/TaskPaneFrame.d.ts +4 -4
  351. package/types/src/taskPane/TaskPaneKeys.d.ts +38 -0
  352. package/types/src/taskPane/TaskPaneRegistry.d.ts +32 -12
  353. package/types/src/taskPane/_paneReasons.d.ts +7 -0
  354. package/types/src/taskPane/index.d.ts +3 -0
  355. package/types/src/taskPane/useTaskPane.d.ts +6 -3
  356. package/types/src/theme/ExplicitTokens.d.ts +18 -0
  357. package/types/src/theme/GridColorSchemeContext.d.ts +8 -0
  358. package/types/src/theme/ThemeRootStyles.d.ts +31 -0
  359. package/types/src/theme/ThemeState.d.ts +2 -2
  360. package/types/src/theme/buildDocThemeCSS.d.ts +4 -1
  361. package/types/src/theme/buildOOXMLThemeCSS.d.ts +2 -2
  362. package/types/src/theme/buildTokensCSS.d.ts +15 -0
  363. package/types/src/theme/index.d.ts +2 -4
  364. package/types/src/theme/useAppColorScheme.d.ts +4 -1
  365. package/types/src/theme/useGridColorScheme.d.ts +9 -4
  366. package/types/src/theme/useSystemColors.d.ts +1 -15
  367. package/types/src/workbook/DefaultMovableRenderers.d.ts +19 -1
  368. package/types/src/workbook/DefaultRenderers.d.ts +5 -4
  369. package/types/src/workbook/IWorkbookElement.d.ts +176 -30
  370. package/types/src/workbook/WorkbookCommands.d.ts +6 -1
  371. package/types/src/workbook/WorkbookStrip.d.ts +14 -5
  372. package/browser/cjs/index.cjs +0 -43
  373. package/browser/cjs/xuAfpHmA2W4MFa_0.cjs +0 -1
  374. package/types/src/chart/templates/area-stacked-percent-template.json.d.ts +0 -10
  375. package/types/src/chart/templates/area-stacked-template.json.d.ts +0 -10
  376. package/types/src/chart/templates/area-template.json.d.ts +0 -9
  377. package/types/src/chart/templates/bar-stacked-percent-template.json.d.ts +0 -10
  378. package/types/src/chart/templates/bar-stacked-template.json.d.ts +0 -10
  379. package/types/src/chart/templates/bar-template.json.d.ts +0 -9
  380. package/types/src/chart/templates/column-stacked-percent-template.json.d.ts +0 -10
  381. package/types/src/chart/templates/column-stacked-template.json.d.ts +0 -10
  382. package/types/src/chart/templates/column-template.json.d.ts +0 -9
  383. package/types/src/chart/templates/line-markers-template.json.d.ts +0 -10
  384. package/types/src/chart/templates/line-stacked-markers-template.json.d.ts +0 -11
  385. package/types/src/chart/templates/line-stacked-percent-markers-template.json.d.ts +0 -11
  386. package/types/src/chart/templates/line-stacked-percent-template.json.d.ts +0 -10
  387. package/types/src/chart/templates/line-stacked-template.json.d.ts +0 -10
  388. package/types/src/chart/templates/line-template.json.d.ts +0 -9
  389. package/types/src/chart/templates/pie-doughnut-template.json.d.ts +0 -10
  390. package/types/src/chart/templates/pie-template.json.d.ts +0 -9
  391. package/types/src/chart/templates/scatter-lines-markers-smooth-template.json.d.ts +0 -10
  392. package/types/src/chart/templates/scatter-lines-markers-template.json.d.ts +0 -10
  393. package/types/src/chart/templates/scatter-lines-smooth-template.json.d.ts +0 -10
  394. package/types/src/chart/templates/scatter-lines-template.json.d.ts +0 -10
  395. package/types/src/chart/templates/scatter-markers-template.json.d.ts +0 -10
  396. package/types/src/context/SheetContext.d.ts +0 -18
  397. package/types/src/control/index.d.ts +0 -2
  398. package/types/src/sheet/SheetElement.d.ts +0 -15
@@ -1,4 +1,4 @@
1
- import { ICellRange, ICellRegion, IRange, ISheet } from '@sheetxl/sdk';
1
+ import { ICellRange, ICellRegion, IRange, IWorksheet } from '@sheetxl/sdk';
2
2
  import { IGridPane } from '@sheetxl/grid-react';
3
3
  export interface SheetFeatureRegions {
4
4
  /** The viewport's regions for the feature — engine-merged blocks, ready to place. */
@@ -17,5 +17,5 @@ export interface SheetFeatureRegions {
17
17
  * {@link useSheetVisibleCells}'s shape — per-pane, cached by range key, token-invalidated — so
18
18
  * layers can swap sources without changing their contract.
19
19
  */
20
- export declare const useSheetFeatureRegions: (sheet: ISheet, feature: ICellRange.Feature) => SheetFeatureRegions;
20
+ export declare const useSheetFeatureRegions: (sheet: IWorksheet, feature: ICellRange.Feature) => SheetFeatureRegions;
21
21
  //# sourceMappingURL=useSheetFeatureRegions.d.ts.map
@@ -1,4 +1,4 @@
1
- import { ISheet, ICell, IRange } from '@sheetxl/sdk';
1
+ import { IWorksheet, ICell, IRange } from '@sheetxl/sdk';
2
2
  import { IGridPane } from '@sheetxl/grid-react';
3
3
  export type SheetVisibleCell = {
4
4
  cell: ICell.Coords;
@@ -8,12 +8,12 @@ export type SheetVisibleCell = {
8
8
  /**
9
9
  * What the scan should treat as "worth rendering". Each layer passes ONLY the flags its own output
10
10
  * depends on — a flag change busts this hook's scan cache + token, so an unused flag would rebuild
11
- * the caller for nothing (e.g. gridlines must not rebuild on a show-zeros toggle).
11
+ * the caller for nothing (e.g. a layer that ignores zeros must not rebuild on a show-zeros toggle).
12
12
  */
13
13
  export interface SheetVisibleCellsOptions {
14
14
  /**
15
15
  * Formula view: formula-only cells render (even valueless), and text-overflow extrusions are
16
- * disabled (formulas never overflow-paint). Affects cells AND gridlines (extrusions break lines).
16
+ * disabled (formulas never overflow-paint). Affects the cells and their extrusions.
17
17
  * @defaultValue false
18
18
  */
19
19
  showFormulas?: boolean;
@@ -53,8 +53,7 @@ export interface SheetVisibleCells {
53
53
  * source flags change (e.g. `useModelSync(sheetView, ['onZoomScaleChange'])` — the view's setters all
54
54
  * funnel through `_notifyAll`, which fires that event). Each caller (one per layer per pane) gets its
55
55
  * OWN cache + subscription — the layers are deliberately decoupled, so a value edit re-renders only the
56
- * layer(s) that asked, never the grid above them. Used by {@link SheetCellLayer} and
57
- * {@link SheetGridLineLayer}.
56
+ * layer(s) that asked, never the grid above them. Used by {@link SheetCellLayer}.
58
57
  */
59
- export declare const useSheetVisibleCells: (sheet: ISheet, options?: SheetVisibleCellsOptions) => SheetVisibleCells;
58
+ export declare const useSheetVisibleCells: (sheet: IWorksheet, options?: SheetVisibleCellsOptions) => SheetVisibleCells;
60
59
  //# sourceMappingURL=useSheetVisibleCells.d.ts.map
@@ -1,4 +1,4 @@
1
- import { ISheet, ICell, IRange, IConditionalFormat } from '@sheetxl/sdk';
1
+ import { IWorksheet, ICell, IRange, IConditionalFormat } from '@sheetxl/sdk';
2
2
  import { IGridPane } from '@sheetxl/grid-react';
3
3
  /** One visible cell a conditional-format rule DRAWS in. */
4
4
  export interface SheetDecoratedCell {
@@ -38,5 +38,5 @@ export interface SheetVisibleDecorations {
38
38
  * (`onConditionalFormatsChange`), or a value moves within a rule's range — which can restripe every
39
39
  * cell the rule covers, not just the edited one, because the domain is range-wide.
40
40
  */
41
- export declare const useSheetVisibleDecorations: (sheet: ISheet, kind: SheetDecorationKind) => SheetVisibleDecorations;
41
+ export declare const useSheetVisibleDecorations: (sheet: IWorksheet, kind: SheetDecorationKind) => SheetVisibleDecorations;
42
42
  //# sourceMappingURL=useSheetVisibleDecorations.d.ts.map
@@ -1,4 +1,4 @@
1
- import { ISheet } from '@sheetxl/sdk';
1
+ import { IWorksheet } from '@sheetxl/sdk';
2
2
  import { SheetVisibleCells } from './useSheetVisibleCells';
3
3
  /**
4
4
  * The "which cells host a column (filter/sort) button" source for a single pane, plus
@@ -18,5 +18,5 @@ import { SheetVisibleCells } from './useSheetVisibleCells';
18
18
  * table add/remove/auto-table/layout/undo (sheet events) and hidden-button / show-headers / column
19
19
  * add-remove / resize (which fire `onAnyChange` on the TABLE, so we subscribe to each table too).
20
20
  */
21
- export declare const useTableHeaderCells: (sheet: ISheet) => SheetVisibleCells;
21
+ export declare const useTableHeaderCells: (sheet: IWorksheet) => SheetVisibleCells;
22
22
  //# sourceMappingURL=useTableHeaderCells.d.ts.map
@@ -1,5 +1,5 @@
1
1
  import { CellCoords } from '@sheetxl/utils';
2
- import { ISheet, IDataValidation } from '@sheetxl/sdk';
2
+ import { IWorksheet, IDataValidation } from '@sheetxl/sdk';
3
3
  import { GridAnchor, IEditable } from '@sheetxl/grid-react';
4
4
  import { CellPicker } from '../picker';
5
5
  /**
@@ -8,7 +8,7 @@ import { CellPicker } from '../picker';
8
8
  */
9
9
  export interface ValidationPickerOptions {
10
10
  /** The sheet the chosen value is written to. */
11
- sheet: ISheet;
11
+ sheet: IWorksheet;
12
12
  /**
13
13
  * The editable the pick is entered through — the same path as typing the item's text, so the value
14
14
  * coerces and formats as a typed one does. `null` offers nothing.
@@ -48,7 +48,7 @@ export declare const resolveListPickerItems: (rules: readonly IDataValidation[],
48
48
  *
49
49
  * @remarks
50
50
  * No search field: a validation list is a short set of choices, and narrowing it belongs to the cell
51
- * editor's typing (DESIGN-DV §3.7).
51
+ * editor's typing.
52
52
  */
53
53
  export declare const useValidationPicker: (options: ValidationPickerOptions) => CellPicker;
54
54
  //# sourceMappingURL=useValidationPicker.d.ts.map
@@ -1,4 +1,4 @@
1
- import { ISheet, ITable } from '@sheetxl/sdk';
1
+ import { IWorksheet, ITable } from '@sheetxl/sdk';
2
2
  export interface VisibleTables {
3
3
  /** The tables intersecting this pane's visible range (empty array — stable identity — when none). */
4
4
  visibleTables: readonly ITable[];
@@ -23,5 +23,5 @@ export interface VisibleTables {
23
23
  * PLUS each visible table's `onAnyChange` — table mutations (hidden-button toggle, show-headers, column
24
24
  * add/remove, resize) fire on the TABLE, not the sheet.
25
25
  */
26
- export declare const useVisibleTables: (sheet: ISheet) => VisibleTables;
26
+ export declare const useVisibleTables: (sheet: IWorksheet) => VisibleTables;
27
27
  //# sourceMappingURL=useVisibleTables.d.ts.map
@@ -1,5 +1,5 @@
1
1
  import { CellCoords, RangeCoords } from '@sheetxl/utils';
2
- import { IDataValidation, ISheet } from '@sheetxl/sdk';
2
+ import { IDataValidation, IWorksheet } from '@sheetxl/sdk';
3
3
  import { VisibleCell } from '@sheetxl/grid-react';
4
4
  /**
5
5
  * How a cell's value fails its data validations: `'failed'` when every failing rule raises no
@@ -38,7 +38,7 @@ export declare const resolveValidationMark: (rules: readonly IDataValidation[],
38
38
  * Only cells holding a value are visited, unless a rule has Ignore blank off: an empty cell can fail
39
39
  * that one, so the window's empty cells are visited too — bounded by the window, as painting is.
40
40
  */
41
- export declare const findVisibleValidationMarks: (sheet: ISheet, coords: RangeCoords) => VisibleCell[];
41
+ export declare const findVisibleValidationMarks: (sheet: IWorksheet, coords: RangeCoords) => VisibleCell[];
42
42
  /**
43
43
  * What the hover tip over a cell's invalid-value mark says.
44
44
  */
@@ -55,7 +55,7 @@ export interface ValidationTip {
55
55
  * (Show Invalid off), the value passes, or the cell is the active one and its input prompt is
56
56
  * already saying what it wants.
57
57
  */
58
- export declare const findValidationTip: (sheet: ISheet, coords: CellCoords) => ValidationTip | null;
58
+ export declare const findValidationTip: (sheet: IWorksheet, coords: CellCoords) => ValidationTip | null;
59
59
  /** The color a mark is drawn in, per state: the theme's severity colors, neutral for no alert. */
60
60
  export declare const VALIDATION_MARK_COLORS: Record<ValidationMarkState, string>;
61
61
  /** The glyph for each state (the Base icon pack), the same the rule editor shows for a style. */
@@ -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,8 +25,8 @@ 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
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
@@ -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
  * },
@@ -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,4 +1,5 @@
1
1
  import { IMovable } from '@sheetxl/sdk';
2
+ import { MovableGestureHost } from './MovableControl';
2
3
  /**
3
4
  * Props a movable renderer receives from its frame.
4
5
  *
@@ -24,6 +25,12 @@ export interface MovableElementProps extends React.HTMLAttributes<HTMLElement> {
24
25
  * @defaultValue 1
25
26
  */
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;
27
34
  /**
28
35
  * Called when the movable is hidden from view.
29
36
  *
@@ -47,6 +54,17 @@ export interface MovableElementProps extends React.HTMLAttributes<HTMLElement> {
47
54
  * box can drag from its border and put the caret where its text is pressed.
48
55
  */
49
56
  onDragZone?: (isDragZone: (event: MouseEvent | TouchEvent) => boolean) => void;
57
+ /**
58
+ * Registers what a finger tap does on the movable while it is not selected: answer `true` to take
59
+ * the tap, and the frame leaves the movable unselected. Without one, or on `false`, the tap selects.
60
+ *
61
+ * @remarks
62
+ * A finger pressed on a movable that is not selected may be starting a pan of the sheet, so the
63
+ * content never receives that press: the frame waits for the finger to lift where it went down,
64
+ * the sheet unscrolled, and only then calls this. A link that opens on a tap is the use; the sheet
65
+ * still pans from anywhere on the movable.
66
+ */
67
+ onTap?: (tap: (event: PointerEvent) => boolean) => void;
50
68
  /**
51
69
  * A box above the selection chrome, placed and turned exactly as the frame is, for the content's
52
70
  * own controls (a shape's adjustment handles). `null` when the movable has none.
@@ -55,8 +73,18 @@ export interface MovableElementProps extends React.HTMLAttributes<HTMLElement> {
55
73
  * Render into it with a portal. It fills the frame's box and is pointer-transparent; controls opt
56
74
  * back in. Drawn above the resize handles, so a control on the selection outline wins the press,
57
75
  * as in Excel.
76
+ *
77
+ * While one of the content's controls is being dragged, give it the class `movable-gesture`: every
78
+ * control in the box, the layer's and the content's, hides until the class goes, as they do for a
79
+ * move or resize.
58
80
  */
59
81
  adornmentHost?: HTMLElement | null;
82
+ /**
83
+ * Runs a gesture of the content's own controls (a shape's adjustment handles) through the
84
+ * layer: previewed in every pane with what follows it, such as a connector glued to the shape,
85
+ * and committed as one step. Present while the movable's controls are drawn.
86
+ */
87
+ gesture?: MovableGestureHost;
60
88
  /**
61
89
  * If true then the component is disabled.
62
90
  * @defaultValue false
@@ -1,6 +1,12 @@
1
1
  import { default as React } from 'react';
2
2
  import { IMovable } from '@sheetxl/sdk';
3
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>>;
4
10
  export interface MovableAdornmentProps {
5
11
  movable: IMovable;
6
12
  /** The gesture preview, as the frame is given it. */
@@ -12,9 +18,9 @@ export interface MovableAdornmentProps {
12
18
  }
13
19
  /**
14
20
  * The box a selected movable's controls are drawn in: placed and turned as its frame is, from the
15
- * same numbers. The layer's controls come first and the content renders its own after them (see
16
- * `MovableElementProps.adornmentHost`), so a content control is hit before a resize handle it
17
- * overlaps.
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.
18
24
  */
19
25
  export declare const MovableAdornment: React.FC<MovableAdornmentProps>;
20
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
@@ -1,10 +1,14 @@
1
1
  import { default as React } from 'react';
2
+ import { IMovable } from '@sheetxl/sdk';
2
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';
3
7
  /** The resize cursor for a handle on a frame turned `rotation` degrees, so it follows the turn. */
4
8
  export declare const resizeCursor: (direction: ResizeDirection, rotation: number) => string;
5
9
  export interface MovableControlProps {
6
10
  /** Compass names of the handles to draw (`nw`, `n`, … `se`). */
7
- directions: readonly string[];
11
+ directions: readonly ResizeDirectionName[];
8
12
  /** Degrees clockwise the frame is turned; only the cursors use it, the box turns itself. */
9
13
  rotation: number;
10
14
  /**
@@ -23,10 +27,54 @@ export interface MovableControlProps {
23
27
  onResizeEnd: () => void;
24
28
  /** The gesture was lost (`pointercancel`). */
25
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;
26
70
  }
27
71
  /**
28
72
  * A selected movable's outline and resize handles, drawn in its adornment box so they are placed
29
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.
30
78
  */
31
79
  export declare const MovableControl: React.FC<MovableControlProps>;
32
80
  //# sourceMappingURL=MovableControl.d.ts.map
@@ -1,6 +1,8 @@
1
1
  import { default as React } from 'react';
2
2
  import { IMovable } from '@sheetxl/sdk';
3
+ import { RenderSlotFn } from '@sheetxl/utils-react';
3
4
  import { MovableElementProps } from './IMovableArea';
5
+ import { MovableGestureHost } from './MovableControl';
4
6
  import { MovablePreview } from './framePlacement';
5
7
  export interface MovableFrameProps extends React.HTMLAttributes<HTMLElement> {
6
8
  /**
@@ -13,13 +15,15 @@ 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;
21
23
  /** {@inheritDoc MovableElementProps.adornmentHost} */
22
24
  adornmentHost?: HTMLElement | null;
25
+ /** {@inheritDoc MovableElementProps.gesture} */
26
+ gesture?: MovableGestureHost;
23
27
  /**
24
28
  * Live drag/resize/rotate preview, or null/undefined when idle. When set, the frame renders with it
25
29
  * instead of the model (the model isn't touched until the gesture commits). Surface-scoped in the