@sheetxl/react 0.8.0-beta.9 → 1.0.2

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/5B9ljQwRo4GZv5e3.mjs +264 -0
  3. package/browser/esm/B7K16Rzv-QXeNhTf.mjs +197 -0
  4. package/browser/esm/BD3e6d1xxwWiZvhM.mjs +78 -0
  5. package/browser/esm/{Dk6274Lic6AOmEAq.mjs → BIlvSwHzLhtyrkCm.mjs} +84 -2
  6. package/browser/esm/BTkVpKUjjBXs7S4h.mjs +128 -0
  7. package/browser/esm/B_X-eExTurXNj2s6.mjs +134 -0
  8. package/browser/esm/BaXKIZ-EbNXalsn9.mjs +32 -0
  9. package/browser/esm/ByiwVTu3Ax65JzsV.mjs +36 -0
  10. package/browser/esm/CBwGe_8NQ_Zwkd9c.mjs +67 -0
  11. package/browser/esm/CLM5O7S-zDkLuyx4.mjs +323 -0
  12. package/browser/esm/CN3fS0Je4N_gmPLR.mjs +145 -0
  13. package/browser/esm/Cb3fQ74AG3ha3Lbb.mjs +31 -0
  14. package/browser/esm/CyK8M1od0A1rs3IZ.mjs +14092 -0
  15. package/browser/esm/D-wXCKrEuZsj9YPV.mjs +60 -0
  16. package/browser/esm/D3h177x5aS9wsvay.mjs +8 -0
  17. package/browser/esm/DIle1Uzx1TRzW_kQ.mjs +42 -0
  18. package/browser/esm/DLCK6iNnpw8XUOy8.mjs +79 -0
  19. package/browser/esm/DS_YUf92NUAjr5M9.mjs +9560 -0
  20. package/browser/esm/DYLAfjgirgwGJkJo.mjs +20 -0
  21. package/browser/esm/D_KHWbW4C9PQ7G8l.mjs +401 -0
  22. package/browser/esm/DclFKNTfrIjTUqZW.mjs +341 -0
  23. package/browser/esm/DeZNNHG8-BP0qop0.mjs +323 -0
  24. package/browser/esm/WUqAXqTxytEPWXNZ.mjs +63 -0
  25. package/browser/esm/Xab6qjmPHkjnBlcs.mjs +45 -0
  26. package/browser/esm/chart.mjs +41 -0
  27. package/browser/esm/control.mjs +217 -0
  28. package/browser/esm/group.mjs +123 -0
  29. package/browser/esm/index.mjs +21677 -15289
  30. package/browser/esm/note.mjs +112 -0
  31. package/browser/esm/picture.mjs +7 -0
  32. package/browser/esm/shape.mjs +7 -0
  33. package/browser/esm/slicer.mjs +282 -0
  34. package/browser/esm/xismu7oIPMRpfRZN.mjs +19 -0
  35. package/licenses/dependencies.txt +327 -53
  36. package/node/esm/3O4W5uO7Ei1RSamd.mjs +328 -0
  37. package/node/esm/BEmcxv9Cg5uinTCr.mjs +80 -0
  38. package/node/esm/BWuHuJ2nm8MKaUpL.mjs +1697 -0
  39. package/node/esm/Bb39ZMFsvPRb6_sU.mjs +20 -0
  40. package/node/esm/Btwf2pH6R5DrzLlO.mjs +32 -0
  41. package/node/esm/C3_B2QUtmUAAoAbQ.mjs +37 -0
  42. package/node/esm/CIHXrDGerZpH_kWI.mjs +19 -0
  43. package/node/esm/CbEtd-l94dqcicGz.mjs +66 -0
  44. package/node/esm/D06Yw2XsMkKhhpbZ.mjs +406 -0
  45. package/node/esm/D6pwBrfHwDwzCkt6.mjs +128 -0
  46. package/node/esm/DKBxWraRN4fQGsFy.mjs +63 -0
  47. package/node/esm/DPp00qgyktTqWeEp.mjs +68 -0
  48. package/node/esm/Ddz6TmyZPfCk-PXM.mjs +134 -0
  49. package/node/esm/Djwke9rsxOR1tTNb.mjs +8 -0
  50. package/node/esm/DmdPWNpf3d05AFgU.mjs +80 -0
  51. package/node/esm/DsUEK1CBM3dZfY2X.mjs +198 -0
  52. package/node/esm/{B-5p0wwNM6Y5jlI2.mjs → DsgT7qY3nHxDGSws.mjs} +84 -2
  53. package/node/esm/L7XZPzd6aXI7OzdI.mjs +146 -0
  54. package/node/esm/X9lgoicxH_z9hlaw.mjs +45 -0
  55. package/node/esm/chart.mjs +41 -0
  56. package/node/esm/control.mjs +217 -0
  57. package/node/esm/group.mjs +123 -0
  58. package/node/esm/index.mjs +16970 -10477
  59. package/node/esm/note.mjs +113 -0
  60. package/node/esm/oliuGGZGkPQdm6vE.mjs +35 -0
  61. package/node/esm/picture.mjs +326 -0
  62. package/node/esm/s7q4H_VlspTpP2kg.mjs +265 -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,31 +1,82 @@
1
- import { IFill, IResource, IShape, IStyleCollection } from '@sheetxl/sdk';
1
+ import { IFill, IResource, IShape, IStyleCollection, ShapeStyleUtils } from '@sheetxl/sdk';
2
+ /** A color stop as the renderer draws it. */
3
+ export interface ResolvedGradientStop {
4
+ /** `0…1` along the gradient. */
5
+ offset: number;
6
+ /** CSS color. */
7
+ color: string;
8
+ }
9
+ /**
10
+ * A gradient as the renderer draws it over the shape's frame: resolved colors at `0…1` offsets,
11
+ * and the line or the ellipse they run along, in terms of the frame.
12
+ */
13
+ export type ResolvedGradient = {
14
+ kind: 'linear';
15
+ /**
16
+ * Degrees clockwise from left-to-right, DrawingML's measure (the model's is the CSS angle).
17
+ * With `scaled`, the direction is taken in a square and stretched to the frame, so 45° runs
18
+ * corner to corner (DrawingML `lin/@scaled`).
19
+ */
20
+ angle: number;
21
+ scaled: boolean;
22
+ stops: ResolvedGradientStop[];
23
+ } | {
24
+ kind: 'radial';
25
+ /** The focus, as fractions of the frame's width and height. */
26
+ cx: number;
27
+ cy: number;
28
+ /** The radius to the farthest corner, as a fraction of the frame (an ellipse once stretched). */
29
+ r: number;
30
+ stops: ResolvedGradientStop[];
31
+ };
2
32
  /**
3
33
  * What a shape draws with, resolved to CSS: the colors a `<path>` can take and the line
4
- * properties SVG strokes natively. Gradients and patterns are reduced to a solid color for now
5
- * (SHAPES-PLAN phase e draws them properly). Which fill and line apply is the model's call
6
- * (`ShapeStyleUtils`); this turns its answer into what the renderer sets.
34
+ * properties SVG strokes natively. A gradient is resolved to its stops and its line; a pattern is
35
+ * reduced to its foreground for now (SHAPES-PLAN, styling depth). Which fill and line apply is the
36
+ * model's call (`ShapeStyleUtils`); this turns its answer into what the renderer sets.
7
37
  */
8
38
  export interface ResolvedShapeStyle {
9
- /** CSS color, or `null` for no fill (also when the fill is an image, see `image`). */
39
+ /**
40
+ * CSS color, or `null` for no fill (also when the fill is an image, see `image`). For a gradient,
41
+ * its first stop: what draws where a gradient cannot (see `gradient`).
42
+ */
10
43
  fill: string | null;
44
+ /** A gradient fill, when the fill is one the renderer can draw as such. */
45
+ gradient?: ResolvedGradient;
11
46
  /** An image fill: the resource to draw and how, when the shape holds the image. */
12
47
  image?: {
13
48
  resource: IResource;
14
49
  fill: IFill.ImageJSON;
15
50
  };
16
- /** CSS color, or `null` for no line. */
51
+ /** CSS color, or `null` for no line. For a gradient line, its first stop (see `strokeGradient`). */
17
52
  stroke: string | null;
53
+ /** A gradient line, when the line's fill is one the renderer can draw as such. */
54
+ strokeGradient?: ResolvedGradient;
18
55
  /** In shape-local px (points in the model). */
19
56
  strokeWidth: number;
20
57
  lineJoin: 'miter' | 'round' | 'bevel';
21
58
  lineCap: 'butt' | 'round' | 'square';
22
59
  miterLimit: number;
60
+ /**
61
+ * Alternating dash and space lengths in line widths, or `null` for a solid line. Caps are not
62
+ * accounted for; see {@link toDashArray}.
63
+ */
64
+ dash: readonly number[] | null;
23
65
  /** The text color the theme style gives, or `null` when nothing says. */
24
66
  textColor: string | null;
25
67
  }
68
+ /**
69
+ * A dash as an SVG `stroke-dasharray` for a line `strokeWidth` wide, or `undefined` for solid.
70
+ * A round or square cap is drawn inside the dash, as Office draws it: each dash gives up a width
71
+ * to its caps and each space takes it, so a round-capped dot is a circle a width across.
72
+ */
73
+ export declare const toDashArray: (dash: readonly number[] | null, strokeWidth: number, lineCap: ResolvedShapeStyle["lineCap"]) => string | undefined;
74
+ /** {@inheritDoc ShapeStyleUtils.inheritedGroupFill} */
75
+ export declare const inheritedGroupFill: typeof ShapeStyleUtils.inheritedGroupFill;
26
76
  /**
27
77
  * Resolves a shape's fill, line and text color to CSS: what it states itself over what its
28
- * theme style gives, over Excel's defaults for a new shape.
78
+ * theme style gives, over Excel's defaults for a new shape. A member that takes its group's fill
79
+ * draws with `groupFill`.
29
80
  */
30
- export declare const resolveShapeStyle: (json: IShape.JSON | null | undefined, styles: IStyleCollection | null, getResource?: (resourceId: number) => IResource | null) => ResolvedShapeStyle;
81
+ export declare const resolveShapeStyle: (json: IShape.JSON | null | undefined, styles: IStyleCollection | null, getResource?: (resourceId: number) => IResource | null, groupFill?: IFill.JSON | null) => ResolvedShapeStyle;
31
82
  //# sourceMappingURL=shapeStyle.d.ts.map
@@ -3,8 +3,8 @@ import { FixedEdge } from '@sheetxl/utils';
3
3
  import { ISheetHeader } from '@sheetxl/sdk';
4
4
  import { Viewport, ThemeMode } from '@sheetxl/utils-react';
5
5
  import { IGridSurface } from '@sheetxl/grid-react';
6
- import { SheetCellRendererProps, ColumnButtonConfigProps } from '../cell';
7
- import { SheetLocation } from './ISheetElement';
6
+ import { CellTextRendererProps, ColumnButtonConfigProps } from '../cell';
7
+ import { SheetLocation } from './IWorksheetElement';
8
8
  /**
9
9
  * Props for the SheetHeaderElement component.
10
10
  */
@@ -108,7 +108,7 @@ export interface SheetHeaderProps extends React.HTMLAttributes<HTMLDivElement> {
108
108
  * This is used to customize columnButton popup action and any other customizations desired.
109
109
  * This does not invalidate the rendering.
110
110
  */
111
- propsCellRender?: Partial<SheetCellRendererProps> & ColumnButtonConfigProps;
111
+ propsCellRender?: Partial<CellTextRendererProps> & ColumnButtonConfigProps;
112
112
  /**
113
113
  * Ref for the HTMLDivElement.
114
114
  */
@@ -1,82 +1,84 @@
1
- import { ISheet, ICell, IMovable } from '@sheetxl/sdk';
2
- import { CellCoords } from '@sheetxl/utils';
3
- import { ViewportMetrics, IShowToolTipProperties, ScrollPaneProps, Viewport, ThemeMode } from '@sheetxl/utils-react';
1
+ import { IWorksheet, ICell, IMovable } from '@sheetxl/sdk';
2
+ import { ViewportMetrics, ScrollPaneProps, Viewport, ThemeMode, LoadingPanelProps, ErrorPanelProps, RenderSlotFn } from '@sheetxl/utils-react';
4
3
  import { GridSurfaceProps, IGridSurface, IEditable, LayerNode } from '@sheetxl/grid-react';
5
- import { SheetCellRendererProps, ColumnButtonConfigProps, OutlineProps } from '../cell';
4
+ import { CellTextRendererProps, ColumnButtonConfigProps, PivotButtonConfigProps, OutlineProps } from '../cell';
6
5
  import { MovableElementProps } from '../movable';
7
6
  import { CommentCardRenderProps } from '../comment';
7
+ import { HyperlinkCardRenderProps, HyperlinkLayerProps } from '../layer/HyperlinkLayer';
8
+ import { CellErrorTip } from '../layer/CellErrorLayer';
9
+ import { ValidationPromptRenderProps, ValidationAlertRenderProps } from '../layer/ValidationPromptLayer';
10
+ import { TableToolbarRenderProps } from '../layer/TableToolbar';
11
+ import { PivotToolbarRenderProps } from '../layer/PivotToolbar';
8
12
  import { CommandContext } from '../frame';
13
+ import { ExplicitTokens } from '../theme';
9
14
  import { ISheetHeaderElement, SheetHeaderProps } from './ISheetHeaderElement';
15
+ export interface SheetLocation {
16
+ clientX: number;
17
+ clientY: number;
18
+ originalEvent?: React.MouseEvent<Element>;
19
+ clientWidth?: number;
20
+ clientHeight?: number;
21
+ rowIndex?: number;
22
+ colIndex?: number;
23
+ }
10
24
  /**
11
- * Describes how to begin an edit — the imperative "start editing" request the sheet element exposes
12
- * ({@link ISheetElement.startEdit}), e.g. from a command or the formula bar. The element maps it onto
13
- * the shared editable's start options.
14
- *
15
- * @remarks
16
- * Lives here (the host that owns the request) — grid-react's editor API takes `StartEditOptions`
17
- * directly and does not carry this shape.
25
+ * Props for the WorksheetElement component.
18
26
  */
19
- export interface StartEditEvent {
27
+ export interface WorksheetElementProps extends React.HTMLAttributes<HTMLDivElement>, React.Attributes {
20
28
  /**
21
- * Edit text. If this is null or undefined then this will not replace the text.
22
- *
23
- * @defaultValue null
24
- *
25
- * @remarks
26
- * * A '' will clear the text.
29
+ * The sheet to render, or a `Promise` for one. The element is empty until the sheet resolves and
30
+ * its text can be measured; a later input keeps the current sheet showing until it resolves.
27
31
  */
28
- text?: string;
32
+ sheet: IWorksheet | Promise<IWorksheet>;
29
33
  /**
30
- * Is editor starting in edit mode.
34
+ * Called with the sheet once {@link WorksheetElementProps.sheet} resolves, and again whenever a new
35
+ * input resolves to a different one. Until the first input resolves, or if an input fails, the
36
+ * sheet is `null`.
37
+ *
38
+ * @remarks
39
+ * Lets an app pass a `Promise` here and hold the live sheet in its own state, without awaiting or
40
+ * suspending.
31
41
  *
32
- * @defaultValue false
42
+ * @example
43
+ * ```tsx
44
+ * const [pending] = useState(() => createInvoice());
45
+ * const [sheet, setSheet] = useState<IWorksheet | null>(null);
46
+ * const [total] = useCellValue<number>(sheet, 'D23');
47
+ * return <WorksheetElement sheet={pending} onSheetChange={setSheet} />;
48
+ * ```
33
49
  */
34
- editMode?: boolean;
50
+ onSheetChange?: (sheet: IWorksheet | null) => void;
35
51
  /**
36
- * Allows the initial selection position to be overridden. By default it's at the end
52
+ * Props passed to the loading panel.
37
53
  */
38
- initialSelection?: {
39
- start: number;
40
- end: number;
41
- direction?: "forward" | "backward" | "none";
42
- };
54
+ propsSheetLoading?: Partial<LoadingPanelProps>;
43
55
  /**
44
- * Should the editor take focus when the edit starts.
45
- *
46
- * @defaultValue true
56
+ * Custom loading panel, shown while a `Promise` {@link WorksheetElementProps.sheet} resolves or the
57
+ * text engine loads. Defaults to a spinner.
47
58
  */
48
- autoFocus?: boolean;
59
+ renderSheetLoading?: RenderSlotFn<LoadingPanelProps> | null;
49
60
  /**
50
- * The cell that should be edited
61
+ * Custom error panel, shown when a `Promise` {@link WorksheetElementProps.sheet} fails to resolve.
62
+ * Defaults to a minimal message.
51
63
  */
52
- cell?: CellCoords;
53
- }
54
- export interface SheetLocation {
55
- clientX: number;
56
- clientY: number;
57
- originalEvent?: React.MouseEvent<Element>;
58
- clientWidth?: number;
59
- clientHeight?: number;
60
- rowIndex?: number;
61
- colIndex?: number;
62
- }
63
- /**
64
- * Props for the SheetElement component.
65
- */
66
- export interface SheetElementProps extends React.HTMLAttributes<HTMLDivElement>, React.Attributes {
64
+ renderSheetError?: RenderSlotFn<ErrorPanelProps> | null;
67
65
  /**
68
- * The `ISheet` to render.
66
+ * The app (chrome / header) color scheme — selects the header/app surface mode. `'auto'` follows the
67
+ * page: a `dark`/`light` class on `<html>`/`<body>`, else the OS.
69
68
  */
70
- sheet: ISheet;
69
+ colorScheme?: ThemeMode | 'auto';
71
70
  /**
72
- * The app (chrome / header) color scheme — selects the header/app surface mode.
71
+ * The grid-body color scheme (stays light in a dark app when *Enable Dark Grid* is off) — drives the grid
72
+ * `darkMode` rendering intent and the grid surface mode. `'auto'` follows the page as
73
+ * {@link colorScheme} does.
73
74
  */
74
- colorScheme?: ThemeMode;
75
+ gridColorScheme?: ThemeMode | 'auto';
75
76
  /**
76
- * The grid-body color scheme (stays light in a dark app when *Enable Dark Grid* is off) — drives the grid
77
- * `darkMode` rendering intent and the grid surface mode.
77
+ * Token values for this sheet, per mode and surface: the React form of a stylesheet in
78
+ * `@layer sxl-overrides`, scoped to this instance. Same shape as the workbook's `tokens`; inside a
79
+ * workbook, set them there instead.
78
80
  */
79
- gridColorScheme?: ThemeMode;
81
+ tokens?: ExplicitTokens;
80
82
  /**
81
83
  * Show the column headers
82
84
  */
@@ -146,7 +148,7 @@ export interface SheetElementProps extends React.HTMLAttributes<HTMLDivElement>,
146
148
  /**
147
149
  * The app-created editor for the always-mounted cell editor. When provided, the grid edits through
148
150
  * this shared {@link IEditable}; pass the SAME instance to the formula bar for free two-way sync. A
149
- * stable reference. If omitted, a standalone SheetElement makes its own.
151
+ * stable reference. If omitted, a standalone WorksheetElement makes its own.
150
152
  */
151
153
  editable?: IEditable<() => ICell, string>;
152
154
  /**
@@ -156,32 +158,65 @@ export interface SheetElementProps extends React.HTMLAttributes<HTMLDivElement>,
156
158
  */
157
159
  viewportComponent?: React.ReactNode;
158
160
  /**
159
- * Render components for movable elements.
161
+ * Render a movable element (a chart, shape or picture).
160
162
  *
161
163
  * @param props - {@link MovableElementProps}
162
- * @returns A React Element representing the IMovable.
163
164
  */
164
- renderMovable?: (props: MovableElementProps) => React.ReactElement;
165
+ renderMovable?: RenderSlotFn<MovableElementProps>;
165
166
  /**
166
167
  * Renders the card of a threaded comment beside its cell: on hover, on selection, and as a draft
167
- * when a command asks for one. Omit to show no card; the indicators are drawn either way.
168
+ * when a command asks for one. The default shows no card; the indicators are drawn either way.
168
169
  *
169
170
  * @param props - {@link CommentCardRenderProps}
170
171
  */
171
- renderCommentCard?: (props: CommentCardRenderProps) => React.ReactNode;
172
+ renderCommentCard?: RenderSlotFn<CommentCardRenderProps> | null;
173
+ /**
174
+ * Renders the card beside a hovered hyperlink cell: its address, copy, edit and remove. Omit for the
175
+ * plain default card; `null` for none.
176
+ *
177
+ * @param props - {@link HyperlinkCardRenderProps}
178
+ */
179
+ renderHyperlinkCard?: RenderSlotFn<HyperlinkCardRenderProps> | null;
180
+ /** The hyperlink card's options — e.g. `preview` to show a picture of the linked page. */
181
+ propsHyperlink?: Omit<HyperlinkLayerProps, 'sheet' | 'renderCard'>;
182
+ /**
183
+ * Renders the tip beside a hovered cell that carries an error, a warning, a reference cycle or a
184
+ * failed validation. Omit for the plain default tip; `null` for none.
185
+ *
186
+ * @param tip - {@link CellErrorTip}
187
+ */
188
+ renderCellErrorTip?: RenderSlotFn<CellErrorTip> | null;
189
+ /**
190
+ * Renders the input prompt of a data validation under the selected cell. Spread `floatProps` on
191
+ * the returned element. Omit for the plain default box: the title in bold over the message; `null`
192
+ * for none.
193
+ */
194
+ renderValidationPrompt?: RenderSlotFn<ValidationPromptRenderProps> | null;
195
+ /**
196
+ * Renders the alert a refused or questioned entry raises in the prompt's place. Spread `floatProps`
197
+ * on the returned element. Omit for the plain default card; `null` for none.
198
+ */
199
+ renderValidationAlert?: RenderSlotFn<ValidationAlertRenderProps> | null;
200
+ /**
201
+ * Renders the toolbar that floats at a hovered table's top-right corner: a quick action and a
202
+ * dropdown of the table's commands. Omit for the plain default split button; `null` for none.
203
+ *
204
+ * @param props - {@link TableToolbarRenderProps}
205
+ */
206
+ renderTableToolbar?: RenderSlotFn<TableToolbarRenderProps> | null;
207
+ /**
208
+ * Renders the toolbar that floats at a hovered pivot table's top-right corner: a quick action and a
209
+ * dropdown of the pivot table's commands. Omit for the plain default split button; `null` for none.
210
+ *
211
+ * @param props - {@link PivotToolbarRenderProps}
212
+ */
213
+ renderPivotToolbar?: RenderSlotFn<PivotToolbarRenderProps> | null;
172
214
  /**
173
215
  * Render element(s) directly onto the `GridSurface`, bottom → top — the same {@link LayerNode} the
174
216
  * grid takes for its children (a node or an array of them). Each layer reads its pane from context
175
217
  * ({@link useGridPane}); for a layer that must be built from the pane, call it in a small wrapper.
176
218
  */
177
219
  layers?: LayerNode;
178
- /**
179
- * To show the tooltip
180
- *
181
- * @param props
182
- */
183
- onShowTooltip?: (props: IShowToolTipProperties) => void;
184
- onCloseTooltip?: () => void;
185
220
  /**
186
221
  * Customize the grid.
187
222
  *
@@ -196,7 +231,7 @@ export interface SheetElementProps extends React.HTMLAttributes<HTMLDivElement>,
196
231
  * This is used to customize columnButton popup action and any other customizations desired.
197
232
  * This does not invalidate the rendering
198
233
  */
199
- propsCellRender?: Partial<SheetCellRendererProps> & ColumnButtonConfigProps;
234
+ propsCellRender?: Partial<CellTextRendererProps> & ColumnButtonConfigProps & PivotButtonConfigProps;
200
235
  /**
201
236
  * Props for the outline: the gutters that show row and column groups, and their level buttons.
202
237
  *
@@ -207,21 +242,15 @@ export interface SheetElementProps extends React.HTMLAttributes<HTMLDivElement>,
207
242
  /**
208
243
  * Ref to the sheet element.
209
244
  */
210
- ref?: React.Ref<ISheetElement>;
245
+ ref?: React.Ref<IWorksheetElement>;
211
246
  }
212
247
  /**
213
248
  * Attributes and methods available on the sheet element beyond the HTMLDivElement.
214
249
  */
215
- export type ISheetAttributes = {
250
+ export type IWorksheetAttributes = {
216
251
  getGridSurface: () => IGridSurface;
217
252
  getRowHeaderElement: () => ISheetHeaderElement;
218
253
  getColumnHeaderElement: () => ISheetHeaderElement;
219
- rowHeaderHeight: () => number;
220
- colHeaderWidth: () => number;
221
- startEdit(event?: StartEditEvent): void;
222
- submitEdit(): void;
223
- cancelEdit(): void;
224
- isEditing: boolean;
225
254
  contains(element: Node | null): boolean;
226
255
  invalidate: (coords?: ICell.Coords | null) => void;
227
256
  /**
@@ -244,14 +273,9 @@ export type ISheetAttributes = {
244
273
  */
245
274
  focusMovable(movable?: IMovable): Promise<boolean>;
246
275
  /**
247
- * Returns the attached `ISheet`.
248
- */
249
- getSheet: () => ISheet;
250
- /**
251
- * Wheel intercept (ctrl/⌘+wheel ⇒ zoom). Return `false` to consume the event. Exposed so an outer
252
- * scroll wrapper can route wheel through the sheet's zoom handling.
276
+ * Returns the attached `IWorksheet`.
253
277
  */
254
- onWheelScroll: (event: globalThis.WheelEvent) => boolean | void;
278
+ getWorksheet: () => IWorksheet;
255
279
  /**
256
280
  * For runtime introspection.
257
281
  */
@@ -260,6 +284,6 @@ export type ISheetAttributes = {
260
284
  /**
261
285
  * Type returned via ref property
262
286
  */
263
- export interface ISheetElement extends HTMLDivElement, ISheetAttributes {
287
+ export interface IWorksheetElement extends HTMLDivElement, IWorksheetAttributes {
264
288
  }
265
- //# sourceMappingURL=ISheetElement.d.ts.map
289
+ //# sourceMappingURL=IWorksheetElement.d.ts.map
@@ -0,0 +1,21 @@
1
+ import { default as React } from 'react';
2
+ import { IOpaqueSheet } from '@sheetxl/sdk';
3
+ export interface OpaqueSheetElementProps extends React.HTMLAttributes<HTMLDivElement> {
4
+ /**
5
+ * The sheet.
6
+ */
7
+ sheet: IOpaqueSheet;
8
+ /**
9
+ * Called once the pane has rendered, as a worksheet's grid calls it once it has.
10
+ */
11
+ onFirstRender?: () => void;
12
+ }
13
+ /**
14
+ * The pane shown for a chart sheet, a macro sheet or a dialog sheet while it is the active tab.
15
+ *
16
+ * @remarks
17
+ * Such a sheet is carried as read and saved unchanged; this names its kind and says so. A chart
18
+ * sheet's chart is drawn here once chart sheets have their chart.
19
+ */
20
+ export declare const OpaqueSheetElement: React.FC<OpaqueSheetElementProps>;
21
+ //# sourceMappingURL=OpaqueSheetElement.d.ts.map
@@ -1,12 +1,15 @@
1
1
  import { ReactNode } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
3
- import { Command } from '@sheetxl/utils-react';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
+ import { Command, IViewport } from '@sheetxl/utils-react';
4
4
  import { SheetEditable } from '../editor';
5
5
  import { SheetCommandData } from './SheetCommands';
6
6
  /** The `data` bundle for the sheet contributor — the sheet-command data plus the shared editable (for the
7
7
  * ready-mode `'startEdit'` insert commands). */
8
8
  export interface SheetCommandContributorData extends SheetCommandData {
9
9
  editable?: SheetEditable | null;
10
+ /** Set when the sheet owns `manager` (no workbook above publishes one): the sheet then also contributes
11
+ * `undo`/`redo`, which a workbook otherwise authors. */
12
+ ownsUndo?: boolean;
10
13
  }
11
14
  /**
12
15
  * The `sheet` feature's command contributor: `static` seeds the catalog presentation; `dynamic` attaches the
@@ -16,12 +19,12 @@ export interface SheetCommandContributorData extends SheetCommandData {
16
19
  export declare const SheetCommandContributor: Command.CommandContributor<SheetCommandContributorData>;
17
20
  interface SheetCommandProviderProps {
18
21
  /** The active sheet the cell/format commands operate on. */
19
- sheet: ISheet | null;
22
+ sheet: IWorksheet | null;
20
23
  /** The shared cell editable — the **ready-mode** insert commands (`insertCurrent*`/`insertFunction*`) seed
21
24
  * an edit through it. `undefined` on a bare grid ⇒ those commands stay chrome-only (disabled). */
22
25
  editable?: SheetEditable | null;
23
- /** Hand the created `sheet` scope back to the parent (see {@link CommandScopeProvider.scopeRef}) — so
24
- * `SheetElement` can hold it for the direct-execute zoom gesture without a provide/consume wrapper split. */
26
+ /** Hand the created `sheet` scope back to the parent (see {@link CommandScopeProvider.scopeRef}), for a
27
+ * host that executes sheet commands directly without a provide/consume wrapper split. */
25
28
  scopeRef?: {
26
29
  current: Command.CommandScope | null;
27
30
  };
@@ -38,6 +41,11 @@ interface SheetCommandProviderProps {
38
41
  elementRef?: {
39
42
  readonly current: Element | null;
40
43
  };
44
+ /**
45
+ * The sheet's scroll controller. Zoom to Selection fits the selection into its client size (the
46
+ * model has no viewport size). Omitted ⇒ that command is a no-op.
47
+ */
48
+ viewport?: IViewport;
41
49
  children: ReactNode;
42
50
  }
43
51
  /**
@@ -52,6 +60,6 @@ interface SheetCommandProviderProps {
52
60
  * Only the grid consumes the `sheet` scope, so it lives here (inside the workbook) rather than at studio
53
61
  * level. Without an ambient command scope (a bare chromeless grid), this is a pass-through.
54
62
  */
55
- export declare const SheetCommandProvider: ({ sheet, editable, scopeRef, elementRef, children }: SheetCommandProviderProps) => ReactNode;
63
+ export declare const SheetCommandProvider: ({ sheet, editable, scopeRef, elementRef, viewport, children }: SheetCommandProviderProps) => ReactNode;
56
64
  export {};
57
65
  //# sourceMappingURL=SheetCommandProvider.d.ts.map
@@ -1,6 +1,6 @@
1
1
  import { EditModeHandler, ReferenceableClipboard, RemoveListener, UndoManager } from '@sheetxl/utils';
2
- import { IBorders, ISheet, IColor } from '@sheetxl/sdk';
3
- import { Command, IReactNotifier } from '@sheetxl/utils-react';
2
+ import { IBorders, IRange, IColor, IWorksheet } from '@sheetxl/sdk';
3
+ import { Command, IReactNotifier, IViewport } from '@sheetxl/utils-react';
4
4
  import { ActivateFrameOptions, ITaskPaneArea } from '../taskPane';
5
5
  /** Minimal shape of the global clipboard handle the insert-copied-cells path reads. */
6
6
  interface GlobalClipboardLike {
@@ -33,13 +33,28 @@ export interface ContributeSheetCommandsOptions {
33
33
  globalClipboard?: GlobalClipboardLike;
34
34
  /** Persistent last-used values for the style pickers (color quick swatch + border) + memory. From the bridge's `usePersistentState`. */
35
35
  pickerMemory?: PickerMemory;
36
+ /**
37
+ * The sheet's scroll controller — the cell area's client size, which Zoom to Selection fits the
38
+ * selection into. The model has no viewport size, so it cannot do this itself. Omitted ⇒ the command
39
+ * is a no-op (a bare grid).
40
+ */
41
+ viewport?: IViewport;
36
42
  }
37
43
  /**
38
44
  * The single `data` bundle {@link contributeSheetCommands} takes — the sheet **and** its services
39
45
  * together (the `DynamicCommandContributor` shape). `sheet` may be `null` on a bare grid (⇒ no behavior).
40
46
  */
41
47
  export interface SheetCommandData extends ContributeSheetCommandsOptions {
42
- sheet: ISheet | null;
48
+ sheet: IWorksheet | null;
49
+ }
50
+ /**
51
+ * The arguments of the `freezePanesAt` command.
52
+ */
53
+ export interface FreezePanesAtArgs {
54
+ /** The axis to move: `Column` moves the vertical freeze line, `Row` the horizontal one. */
55
+ axis: IRange.Axis;
56
+ /** The number of rows or columns to freeze. `0` unfreezes the axis; the other axis is left as it is. */
57
+ index: number;
43
58
  }
44
59
  /**
45
60
  * Persistent "last used" values for the style pickers — the quick swatch (`quickColor`/`quickBorder`) and the
@@ -0,0 +1,14 @@
1
+ import { default as React } from 'react';
2
+ import { ISheet } from '@sheetxl/sdk';
3
+ export interface SheetKindIconProps extends React.HTMLAttributes<HTMLElement> {
4
+ /**
5
+ * The kind of sheet.
6
+ */
7
+ kind: ISheet.Kind;
8
+ }
9
+ /**
10
+ * The glyph that marks a sheet of a kind other than a worksheet: on its tab, in sheet lists, and on
11
+ * its pane. A worksheet has none, so it renders nothing.
12
+ */
13
+ export declare const SheetKindIcon: React.FC<SheetKindIconProps>;
14
+ //# sourceMappingURL=SheetKindIcon.d.ts.map
@@ -1,11 +1,11 @@
1
1
  import { default as React } from 'react';
2
2
  import { FixedEdge } from '@sheetxl/utils';
3
- import { IRange, ISheet } from '@sheetxl/sdk';
3
+ import { IRange, IWorksheet } from '@sheetxl/sdk';
4
4
  import { Viewport, ThemeMode } from '@sheetxl/utils-react';
5
5
  import { OutlineButtonProps, OutlineLevelButtonProps } from '../cell/OutlineButton';
6
6
  export interface SheetOutlineElementProps extends React.HTMLAttributes<HTMLElement> {
7
7
  /** The sheet whose outline is drawn. */
8
- sheet: ISheet;
8
+ sheet: IWorksheet;
9
9
  /** Rows (the gutter left of the row headers) or columns (above the column headers). */
10
10
  axis: IRange.Axis;
11
11
  /** The lanes across the gutter: one per level, plus one. */
@@ -19,7 +19,7 @@ export interface SheetOutlineElementProps extends React.HTMLAttributes<HTMLEleme
19
19
  /** The app color scheme. */
20
20
  colorScheme?: ThemeMode;
21
21
  /** Renders a group's collapse / expand button. Defaults to `OutlineButton`. */
22
- renderButton?: (props: OutlineButtonProps) => React.ReactNode;
22
+ renderButton?: ((props: OutlineButtonProps) => React.ReactNode) | null;
23
23
  /** The space around the buttons, in pixels: between neighbors, before the first and after the last. */
24
24
  laneGap?: number;
25
25
  /** Space between a bracket's end and its button, in pixels. */
@@ -31,7 +31,7 @@ export interface SheetOutlineElementProps extends React.HTMLAttributes<HTMLEleme
31
31
  * @remarks
32
32
  * Built like `SheetHeaderElement` — its own `GridSurface` over the header's offsets, following the
33
33
  * sheet's viewport along the axis, so it scrolls, zooms, hides and freezes with the headers. The
34
- * owner decides whether there is one (see `ISheetView.isShowOutlineSymbols` and `getLevelCount`) and sizes
34
+ * owner decides whether there is one (see `IWorksheetView.isShowOutlineSymbols` and `getLevelCount`) and sizes
35
35
  * it.
36
36
  *
37
37
  * It is app chrome, not header: it declares the `app` surface and paints no fill, so it shows what
@@ -40,7 +40,7 @@ export interface SheetOutlineElementProps extends React.HTMLAttributes<HTMLEleme
40
40
  export declare const SheetOutlineElement: React.MemoExoticComponent<(props: SheetOutlineElementProps) => React.JSX.Element>;
41
41
  export interface SheetOutlineLevelsProps extends React.HTMLAttributes<HTMLElement> {
42
42
  /** The sheet whose outline the buttons show levels of. */
43
- sheet: ISheet;
43
+ sheet: IWorksheet;
44
44
  /** Rows or columns. */
45
45
  axis: IRange.Axis;
46
46
  /** The number of buttons: one per level, plus one. */
@@ -56,7 +56,7 @@ export interface SheetOutlineLevelsProps extends React.HTMLAttributes<HTMLElemen
56
56
  /** The app color scheme. */
57
57
  colorScheme?: ThemeMode;
58
58
  /** Renders a level button. Defaults to `OutlineLevelButton`. */
59
- renderLevelButton?: (props: OutlineLevelButtonProps) => React.ReactNode;
59
+ renderLevelButton?: ((props: OutlineLevelButtonProps) => React.ReactNode) | null;
60
60
  }
61
61
  /**
62
62
  * The level buttons `1`..`n` for one axis: button *k* shows the groups above level *k* and collapses
@@ -0,0 +1,11 @@
1
+ import { default as React } from 'react';
2
+ import { ErrorPanelProps, LoadingPanelProps } from '@sheetxl/utils-react';
3
+ /**
4
+ * The default loading panel of a sheet or workbook element: a spinner, centered.
5
+ */
6
+ export declare const defaultRenderSheetLoading: (props: LoadingPanelProps) => React.ReactElement;
7
+ /**
8
+ * The default error panel of a sheet or workbook element: the error's message, centered.
9
+ */
10
+ export declare const defaultRenderSheetError: (props: ErrorPanelProps) => React.ReactElement;
11
+ //# sourceMappingURL=SheetPanels.d.ts.map
@@ -1,11 +1,11 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
3
- import { ScrollbarOrientation, VirtualScrollbarProps, IScrollbarElement, IShowToolTipProperties } from '@sheetxl/utils-react';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
+ import { ScrollbarOrientation, VirtualScrollbarProps, IScrollbarElement } from '@sheetxl/utils-react';
4
4
  export interface SheetScrollbarProps extends VirtualScrollbarProps {
5
5
  /**
6
- * The `ISheet` for the given scrollbar.
6
+ * The `IWorksheet` for the given scrollbar.
7
7
  */
8
- sheet: ISheet;
8
+ sheet: IWorksheet;
9
9
  /**
10
10
  * The direction of the scrollbar.
11
11
  */
@@ -14,15 +14,6 @@ export interface SheetScrollbarProps extends VirtualScrollbarProps {
14
14
  * @defaultValue false
15
15
  */
16
16
  showCustomScrollButtons?: boolean;
17
- /**
18
- * To show the tooltip
19
- * @param properties
20
- */
21
- onShowTooltip?: (properties: IShowToolTipProperties) => void;
22
- /**
23
- * Called to close the tooltip. Required is onShowTip is provided
24
- */
25
- onCloseTooltip?: () => void;
26
17
  }
27
18
  export declare const SheetScrollbar: React.NamedExoticComponent<Omit<SheetScrollbarProps, "ref"> & React.RefAttributes<IScrollbarElement>>;
28
19
  //# sourceMappingURL=SheetScrollbar.d.ts.map
@@ -1,8 +1,8 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { ThemeMode } from '@sheetxl/utils-react';
4
4
  export interface TopLeftCornerProps extends React.HTMLProps<HTMLElement> {
5
- sheet: ISheet;
5
+ sheet: IWorksheet;
6
6
  /** The app (header) color scheme — headers follow the app surface; colors come from the header-surface
7
7
  * tokens. */
8
8
  colorScheme?: ThemeMode;
@@ -0,0 +1,12 @@
1
+ import { default as React } from 'react';
2
+ import { IWorksheetElement, WorksheetElementProps } from './IWorksheetElement';
3
+ /**
4
+ * UI representation for IWorksheet.
5
+ *
6
+ * @remarks
7
+ * It draws once the sheet has resolved and the text engine has loaded, so a sheet with no workbook
8
+ * needs no `whenReady()` first. Until then its box shows the loading panel, or the error panel if the
9
+ * sheet fails.
10
+ */
11
+ export declare const WorksheetElement: React.NamedExoticComponent<Omit<WorksheetElementProps, "ref"> & React.RefAttributes<IWorksheetElement>>;
12
+ //# sourceMappingURL=WorksheetElement.d.ts.map