@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
@@ -26,13 +26,16 @@ export interface FormulaInputProps extends Omit<React.InputHTMLAttributes<HTMLIn
26
26
  onChangeText?: (text: string) => void;
27
27
  /** The commit channel. See `UseFormulaInputOptions.onDone`. */
28
28
  onDone?: (value: ICalculation.IFormula | null, args: ReferenceDoneArgs) => void;
29
- /** `'done'` suppresses the live notifications — the host hears only `onDone`. Default `'live'`. */
29
+ /**
30
+ * `'done'` suppresses the live notifications — the host hears only `onDone` — and shows the ✓/✗
31
+ * while the text differs from the committed value. Default `'live'`. See `UseFormulaInputOptions.changeOn`.
32
+ */
30
33
  changeOn?: 'live' | 'done';
31
34
  /** Resolution/picking context. Defaults to the enclosing `WorkbookContext`. */
32
35
  workbook?: IWorkbook | null;
33
36
  /** The headless field API, for host-driven commit points (a dialog's OK → `apiRef.current?.commit()`). */
34
37
  apiRef?: React.Ref<FormulaInputApi>;
35
- /** Hide the adornment cluster (✓/✗ while engaged in modal mode; the select-current action). */
38
+ /** Hide the adornment cluster (✓/✗ while editing in `'done'` mode; the select-current action). */
36
39
  hideAdornment?: boolean;
37
40
  /** Hide the error line under the field (hosts that surface `api.error` themselves). */
38
41
  hideError?: boolean;
@@ -51,7 +51,10 @@ export interface UseEditCommitOptions<V> {
51
51
  /**
52
52
  * `'done'` suppresses the live {@link onChange} notifications entirely (parsing still runs, so the
53
53
  * error state and the commit-channel value stay current) and makes Enter the field's OWN commit
54
- * point rather than a key the host form gets to see. Default `'live'`.
54
+ * point rather than a key the host form gets to see. A field's ✓/✗ adornments follow it: shown only
55
+ * in `'done'`, while the text differs from the committed value. Default `'live'`.
56
+ *
57
+ * It does not change when {@link onDone} fires — that is the same in both.
55
58
  */
56
59
  changeOn?: 'live' | 'done';
57
60
  /** The live PREVIEW channel — every valid text state. */
@@ -114,8 +117,17 @@ export interface EditCommitApi<V> {
114
117
  revertToCommitted(): void;
115
118
  /** Restore the session-start text (a cancel) and re-parse it. */
116
119
  revertToBaseline(): void;
117
- /** Adopt `next` as the committed text (an outside value change): clean, unerrored, revert target. */
118
- resetCommitted(next: string, value?: V | null): void;
120
+ /**
121
+ * Adopt `next` as the committed text (an outside value change): clean, unerrored, revert target.
122
+ *
123
+ * While the user is EDITING (a session open and touched) the text is theirs: `next` becomes the
124
+ * committed text but the display keeps what they typed, and the next accept shows `next` — see the
125
+ * module doc.
126
+ *
127
+ * @returns `false` when the display was left alone for that reason — its error state is still the
128
+ * typed text's, so the host must not overwrite it with `next`'s.
129
+ */
130
+ resetCommitted(next: string, value?: V | null): boolean;
119
131
  /** A session is starting: the CURRENT text becomes the cancel baseline. */
120
132
  beginSession(): void;
121
133
  /**
@@ -147,6 +159,9 @@ export interface EditCommitApi<V> {
147
159
  *
148
160
  * The rules it owns, once, for every field:
149
161
  *
162
+ * - **Two channels, one mode.** `onChange` is the value while it is edited; `onDone` is the edit
163
+ * ending. `changeOn` governs only the first (and who owns Enter): an edit ENDS the same way in
164
+ * both modes — Enter, Tab, a blur to another input, the ✓/✗, `commit()`/`cancel()`, Escape.
150
165
  * - **Two baselines.** `committedText` is the last ACCEPTED value; `baselineText` is the text when the
151
166
  * current session started. They differ because the live-change model applies every intermediate
152
167
  * change — "the value before" can then only mean before-the-session, not before-the-last-change.
@@ -161,6 +176,11 @@ export interface EditCommitApi<V> {
161
176
  * CANCELS instead of committing, so focus never advances carrying an error.
162
177
  * - **Invalid never commits** on any accept path; **blur commits only when dirty**; and a done key
163
178
  * plus the blur it causes are ONE gesture, delivered once (the one-shot guard).
179
+ * - **The text is the user's while they edit.** A live host echoes each change back as its value, and
180
+ * the echo is often the value NORMALIZED (`09` → `9`, `9/2` → `9/2/2026`). Rewriting the display
181
+ * with it would retype the field under the caret, so an outside value that lands mid-edit only
182
+ * becomes the committed text; the accept that ends the edit shows it. An untouched field follows
183
+ * outside changes at once.
164
184
  * - **The input owns its text keys.** Delete / caret motion / the native chords are consumed
165
185
  * ({@link EditCommitApi.handleTextKeys}) so they never reach the app's command dispatch.
166
186
  *
@@ -56,9 +56,8 @@ export interface InputFieldApi {
56
56
  /** `true` when the text differs from the committed value's text. */
57
57
  dirty: boolean;
58
58
  /**
59
- * `true` while an edit SESSION is open — for a plain field that means focused (or edited while
60
- * focus stayed after a commit), and it is what the modal ✓/✗ adornments key off. A done key ends
61
- * the session even though focus stays, exactly like the formula field's engagement.
59
+ * `true` while an edit SESSION is open — for a plain field, while it is focused. A done key ends the
60
+ * session and, focus staying, a fresh one starts — exactly like the formula field's engagement.
62
61
  */
63
62
  engaged: boolean;
64
63
  /** Restore the committed value's text (the field-level Escape). */
@@ -1,4 +1,5 @@
1
- import { IRange, ICell, ICellRanges, ICellRange, IColor, ITable, INamedCollection, IStyleCollection, IStyle, IBorders, ITheme, IThemeCollection, IFunction, IFunctionCollection, IWorkbook } from '@sheetxl/sdk';
1
+ import { IRange, ICell, ICellRanges, ICellRange, IColor, ITable, INamedCollection, IStyleCollection, ICellStyle, IBorders, ITheme, IThemeCollection, IFunction, IFunctionCollection, IWorkbook, ISlicer, IChart, IPivotTable, ISparklineGroup } from '@sheetxl/sdk';
2
+ import { PivotFieldsModel } from '../pivot/PivotFieldsModel';
2
3
  /**
3
4
  * For providing Adjustable Color Commands additional rendering capabilities.
4
5
  *
@@ -25,7 +26,7 @@ export interface Border {
25
26
  onBorderSelect: (border: Partial<IBorders.Properties>) => void;
26
27
  }
27
28
  export interface NamedStyle {
28
- readonly named: () => IStyle.INamed;
29
+ readonly named: () => ICellStyle.INamed;
29
30
  readonly styles: () => IStyleCollection;
30
31
  createCell: (update: ICell.Update) => ICell;
31
32
  }
@@ -46,6 +47,45 @@ export interface Table {
46
47
  */
47
48
  resolveRanges: (address: ICellRanges.Address) => ICellRanges;
48
49
  }
50
+ /** What the pivot table style gallery draws its previews with: the active pivot table and the workbook's styles. */
51
+ export interface Pivot {
52
+ /** `null` when the selection is in no pivot table. */
53
+ readonly pivot: () => IPivotTable | null;
54
+ readonly styles: () => IStyleCollection;
55
+ }
56
+ /** The pivot value settings window's value: one value of a pivot table, and what to change. */
57
+ export interface PivotValueSettings {
58
+ /** The value. The window starts from its settings, and reads its table's fields and their items. */
59
+ readonly value: IPivotTable.IDataField;
60
+ /** What the window hands back: the settings changed, the rest left out. */
61
+ readonly changes?: PivotFieldsModel.ValueSettings;
62
+ }
63
+ /** What a slicer-style gallery draws its previews with. */
64
+ export interface Slicer {
65
+ readonly slicer: () => ISlicer;
66
+ readonly styles: () => IStyleCollection;
67
+ }
68
+ /** What a chart's galleries (its type, its elements) read: the active chart. */
69
+ export interface Chart {
70
+ readonly chart: () => IChart;
71
+ }
72
+ /**
73
+ * What Insert Slicer offers: the fields a slicer can filter by, and the one the active cell is in,
74
+ * which a press filters by.
75
+ */
76
+ export interface InsertSlicer {
77
+ /** A table's column names, or a pivot table's field names, in order. */
78
+ readonly fields: () => readonly string[];
79
+ /** The field the active cell is in; `null` when it is in none, as on a pivot table's values. */
80
+ readonly anchor: () => string | null;
81
+ }
82
+ /** What Insert Slicer adds. Each omitted: the field the active cell is in, in the default slicer style. */
83
+ export interface InsertSlicerOptions {
84
+ /** One of {@link InsertSlicer.fields}. */
85
+ field?: string;
86
+ /** A slicer style's name. */
87
+ style?: string;
88
+ }
49
89
  export interface Theme {
50
90
  readonly theme: ITheme;
51
91
  readonly themes: IThemeCollection;
@@ -59,7 +99,7 @@ export interface NamedReference {
59
99
  }
60
100
  /**
61
101
  * Used for the workbook-statistics dialog — the dialog profiles the live workbook itself
62
- * (`IWorkbook.getStats` / `ISheet.getStats`), so the context is just the model getter.
102
+ * (`IWorkbook.getStats` / `IWorksheet.getStats`), so the context is just the model getter.
63
103
  */
64
104
  export interface WorkbookStatistics {
65
105
  getWorkbook: () => IWorkbook;
@@ -107,6 +147,37 @@ export interface NewTable {
107
147
  /** The table's name. When omitted the next free default name is used. */
108
148
  name?: string;
109
149
  }
150
+ /** What the Create Sparklines dialog makes, as `ICellRange.setSparkline` takes it. */
151
+ export interface NewSparklines {
152
+ /** The cells the sparklines draw: one area, on any sheet. */
153
+ data: ICellRanges | null;
154
+ /** The cells they draw in: one cell, or one row or one column of cells. */
155
+ location: ICellRanges | null;
156
+ type: ISparklineGroup.Type;
157
+ }
158
+ /** What the Edit Sparklines dialog changes, as `ISparklineGroup.setRanges` takes it. */
159
+ export interface EditSparklines {
160
+ /** The cells the sparklines draw: one or more areas, as `ISparklineGroup.getData` spells them. */
161
+ data: ICellRanges | string | null;
162
+ /** The cells they draw in: one or more areas, each a cell, a row or a column of cells. */
163
+ location: ICellRanges | null;
164
+ }
165
+ /** What the New PivotTable dialog makes, as `IPivotTableCollection.add` takes it. */
166
+ export interface NewPivotTable {
167
+ /** The cells to summarize: one range, or a table's or defined name's name. */
168
+ source: ICellRanges | string | null;
169
+ /** The table's top-left cell. */
170
+ location: ICellRanges | null;
171
+ /** The table's name. When omitted the next free default name is used. */
172
+ name?: string;
173
+ }
174
+ /** What the New PivotTable dialog asks of the workbook while it is open. */
175
+ export interface PivotTableTarget {
176
+ /** Throws for a name a new table cannot take on the sheet `location` is on. */
177
+ validateName(name: string, location: ICellRanges | null): void;
178
+ /** Why a new table cannot go at `location`, as a message key; `null` when it can. */
179
+ checkLocation(location: ICellRanges): string | null;
180
+ }
110
181
  export interface SelectedRange {
111
182
  range: ICellRange;
112
183
  cell?: ICell.Address;
@@ -0,0 +1,25 @@
1
+ import { default as React } from 'react';
2
+ import { IMovable } from '@sheetxl/sdk';
3
+ import { MovableElementProps } from '../movable';
4
+ export interface GroupEditorProps extends MovableElementProps {
5
+ /** The content of a movable that holds movables ({@link IMovable.getMovables}): a group. */
6
+ container: IMovable.IContent;
7
+ ref?: React.Ref<HTMLDivElement>;
8
+ }
9
+ /**
10
+ * Content that holds movables, in the sheet: a container that draws each member with the
11
+ * renderer of its own kind, where the member says it is drawn.
12
+ *
13
+ * @remarks
14
+ * A member answers its placement on the canvas, so the members are laid out in canvas pixels in
15
+ * one box whose transform takes the canvas back into the frame: it undoes the frame's turn and
16
+ * mirror about the frame's center. While the group itself is in a gesture, the same transform
17
+ * maps the committed frame onto the gesture's, so the members follow it before it commits (a plain
18
+ * stretch, without the quadrant rule, until the drop). A member's box carries its id, so a press
19
+ * on it reaches the member (Excel's two-step), and a member's own gesture draws its preview here.
20
+ * Nothing here is a hit target but what the members paint and, while the group is selected, its
21
+ * edge: a group paints nothing of its own, so its outline is where a press grabs the group itself
22
+ * rather than a member, as Excel drags a selected group by its frame.
23
+ */
24
+ export declare const GroupEditor: React.NamedExoticComponent<Omit<GroupEditorProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
25
+ //# sourceMappingURL=GroupEditor.d.ts.map
@@ -5,25 +5,33 @@ export * from './editor';
5
5
  export * from './selection';
6
6
  export * from './border';
7
7
  export * from './sheet';
8
+ export * from './annotation';
9
+ export * from './presence';
8
10
  export * from './picture';
11
+ export * from './slicer';
9
12
  export * from './shape';
10
13
  export * from './chart';
11
- export * from './slicer';
12
14
  export * from './comment';
13
15
  export * from './richText';
14
16
  export * from './movable';
15
- export * from './control';
16
17
  export * from './form';
17
18
  export * from './editableLabel';
18
19
  export * from './tabStrip';
19
20
  export * from './icons';
20
21
  export * from './layer/ConditionalIcons';
22
+ export { SheetLayers, DefaultSheetLayersRegistry, useGridSurface, type SheetLayersProps, type SheetLayersFilter, type SheetSurface, type SheetLayersEntry, type ISheetLayersRegistry } from './layer/SheetLayers';
23
+ export * from './layer/CellInsertLayer';
24
+ export * from './layer/HyperlinkLayer';
25
+ export type { RangeToolbarRenderProps } from './layer/RangeToolbar';
26
+ export type { TableToolbarRenderProps } from './layer/TableToolbar';
27
+ export type { PivotToolbarRenderProps } from './layer/PivotToolbar';
21
28
  export * from './picker';
22
29
  export * from './checklist';
23
30
  export * from './conditionalFormat';
24
31
  export * from './autoFill';
25
32
  export * from './protection';
26
33
  export * from './externalLink';
34
+ export * from './pivot';
27
35
  export * from './clipboard';
28
36
  export * from './commands';
29
37
  export * from './undo';
@@ -1,14 +1,17 @@
1
- import { IRange, ISheet, ICell } from '@sheetxl/sdk';
1
+ import { IRange, IWorksheet, ICell } from '@sheetxl/sdk';
2
2
  import { LayerProps, IGridPane } from '@sheetxl/grid-react';
3
+ import { BordersCache } from '../border';
3
4
  export interface BorderLayerProps extends LayerProps {
4
5
  /** Class for the borders host box (devtools identification). */
5
6
  className?: string;
6
- sheet: ISheet;
7
+ sheet: IWorksheet;
7
8
  getVisibleCells: (pane: IGridPane) => {
8
9
  cell: ICell.Coords;
9
10
  value?: ICell;
10
11
  range?: IRange.Coords;
11
12
  }[];
13
+ /** Shared with the {@link SheetGridLineLayer} that draws the same cells. */
14
+ bordersCache?: BordersCache;
12
15
  }
13
16
  export declare const BorderLayer: import('react').NamedExoticComponent<BorderLayerProps & import('react').RefAttributes<HTMLDivElement>>;
14
17
  //# sourceMappingURL=BorderLayer.d.ts.map
@@ -1,6 +1,6 @@
1
1
  import { default as React } from 'react';
2
2
  import { RangeCoords } from '@sheetxl/utils';
3
- import { ICalculation, IRange, ISheet } from '@sheetxl/sdk';
3
+ import { ICalculation, IRange, IWorksheet } from '@sheetxl/sdk';
4
4
  import { StickyState, GridPlacement, LayerProps } from '@sheetxl/grid-react';
5
5
  import { ValidationMark } from './validationMark';
6
6
  /** The kind of annotation a cell carries (drives the default tip styling). */
@@ -11,6 +11,13 @@ export interface CellErrorTip {
11
11
  range: RangeCoords;
12
12
  /** `getErrors()` (preferred) or `getWarnings()` joined by newline. */
13
13
  message: string;
14
+ /**
15
+ * The error the cell shows (`#DIV/0!`, as displayed), when its value is one. `kind === 'error'` only;
16
+ * `message` is then the error's own message, empty when it carries none.
17
+ */
18
+ code?: string;
19
+ /** What that kind of error means, in general — not this cell's particulars. With {@link code}. */
20
+ description?: string;
14
21
  /** Which list the message came from. */
15
22
  kind: CellErrorKind;
16
23
  /** The resolved sticky state (e.g. `state.scrollIntoView()` to reveal the cell). */
@@ -37,12 +44,15 @@ export interface CellErrorLayerProps extends Omit<LayerProps, 'children'> {
37
44
  /** Class forwarded to the inner layer's host box (devtools identification). */
38
45
  className?: string;
39
46
  /** The sheet whose cells are probed for `getErrors()` / `getCircularReference()` / `getWarnings()`. */
40
- sheet: ISheet;
41
- /** Which side of the cell the tip attaches to. @defaultValue `{ side: 'r', align: 'start' }` */
47
+ sheet: IWorksheet;
48
+ /** Which side of the cell the tip attaches to. @defaultValue `{ side: 'b', align: 'start' }`, as the input prompt's */
42
49
  placement?: GridPlacement;
43
50
  /** Gap (px) between the cell edge and the tip. @defaultValue 6 */
44
51
  offset?: number;
45
- /** Offset (px) along the cell edge — only applies to `start` / `end` align (inset from the corner). @defaultValue 2 */
52
+ /**
53
+ * Offset (px) along the cell edge, from the corner `align` names. Omitted, the tip starts `offset`
54
+ * past the cell's right edge, as the input prompt does.
55
+ */
46
56
  alignOffset?: number;
47
57
  /** Dwell (ms) before the tip shows. @defaultValue 300 */
48
58
  openDelay?: number;
@@ -50,13 +60,14 @@ export interface CellErrorLayerProps extends Omit<LayerProps, 'children'> {
50
60
  closeDelay?: number;
51
61
  /**
52
62
  * Optional custom tip renderer. Spread `tipProps` (from context via `useSticky`, or reuse the
53
- * default) onto the returned element to keep the tip open while hovered. Omit for the default pill.
63
+ * default) onto the returned element to keep the tip open while hovered. Omit for the default card;
64
+ * `null` for none.
54
65
  */
55
- renderTip?: (tip: CellErrorTip) => React.ReactNode;
66
+ renderTip?: ((tip: CellErrorTip) => React.ReactNode) | null;
56
67
  }
57
68
  /**
58
69
  * A grid layer that shows a **hover tooltip on cells carrying errors / warnings**. A thin
59
- * {@link HoverTipLayer} whose probe asks the sheet — `getErrors()`, then
70
+ * {@link RangeTooltipLayer} whose probe asks the sheet — `getErrors()`, then
60
71
  * `getCircularReference()`, then the data validations the value fails, then `getWarnings()` — and
61
72
  * anchors on the cell's own range; the tip stays open while hovered. `getComments()` is not yet
62
73
  * wired (unimplemented in the model).
@@ -1,10 +1,10 @@
1
1
  import { default as React } from 'react';
2
- import { IRange, ISheet, ICell } from '@sheetxl/sdk';
2
+ import { IRange, IWorksheet, ICell } from '@sheetxl/sdk';
3
3
  import { IGridPane, LayerProps } from '@sheetxl/grid-react';
4
4
  export interface CellFillLayerProps extends LayerProps {
5
5
  /** Style for the fills host box. */
6
6
  style?: React.CSSProperties;
7
- sheet: ISheet;
7
+ sheet: IWorksheet;
8
8
  getVisibleCells: (pane: IGridPane) => {
9
9
  cell: ICell.Coords;
10
10
  value?: ICell;
@@ -0,0 +1,31 @@
1
+ import { default as React } from 'react';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
+ import { LayerProps } from '@sheetxl/grid-react';
4
+ export interface CellIndicatorLayerProps extends LayerProps {
5
+ /** Class for the layer (devtools identification). */
6
+ className?: string;
7
+ /** Style for the indicators host box. */
8
+ style?: React.CSSProperties;
9
+ /** The sheet whose cells are marked. */
10
+ sheet: IWorksheet;
11
+ /** Size (px, unzoomed) of the error triangle. @defaultValue 7 */
12
+ markSize?: number;
13
+ /** Height (px) of the pending bar. Not zoomed, like a gridline. @defaultValue 2 */
14
+ barHeight?: number;
15
+ }
16
+ /**
17
+ * The marks a cell's **result** earns: the error-checking triangle at the top left of a cell
18
+ * holding an error (or whose calculation failed), and the pending bar along the bottom of a cell
19
+ * whose result has not settled (`ICalculation.ResultStatus.Pending` / `Waiting`).
20
+ *
21
+ * @remarks
22
+ * A {@link CellTileDiv} over the cells in view, so the marks survive scroll and the cell renderer
23
+ * only paints text. The scan resolves only the calc state (and merges, for the box a mark sits
24
+ * in), never styles. `#BUSY!` and `#GETTING_DATA` take no triangle: they are placeholders for an
25
+ * answer still coming, not something to fix. A reference cycle has its own glyph (`CircularIndicatorLayer`); it takes the
26
+ * triangle only when iteration is off, when the cycle is an error (`ICell.getErrors`).
27
+ *
28
+ * Passive paint below the selection (`pointerEvents: none`).
29
+ */
30
+ export declare const CellIndicatorLayer: React.MemoExoticComponent<(props: CellIndicatorLayerProps) => React.JSX.Element | null>;
31
+ //# sourceMappingURL=CellIndicatorLayer.d.ts.map
@@ -0,0 +1,71 @@
1
+ import { default as React } from 'react';
2
+ import { ICellRange, IRange } from '@sheetxl/sdk';
3
+ import { LayerProps } from '@sheetxl/grid-react';
4
+ /** Props for the button that inserts a row or column. */
5
+ export interface CellInsertButtonProps extends React.ButtonHTMLAttributes<HTMLElement> {
6
+ /** Rows or columns. */
7
+ axis: IRange.Axis;
8
+ /** The cells a press inserts. */
9
+ range: ICellRange;
10
+ /** The edge of the square the button fills, in pixels (zoom applied). */
11
+ size: number;
12
+ /** A localized description of what a press does. */
13
+ title: string;
14
+ /** Inserts the cells. */
15
+ onInsert: () => void;
16
+ }
17
+ export interface CellInsertLayerProps extends Omit<LayerProps, 'children'> {
18
+ /** Class for the layer. */
19
+ className?: string;
20
+ /**
21
+ * Whether the button inserts rows, from the row headers, or columns, from the column headers.
22
+ * A host that wants both declares one layer for each.
23
+ *
24
+ * @defaultValue 'row'
25
+ */
26
+ axis?: IRange.Axis;
27
+ /**
28
+ * The cells to insert at the header border nearest the pointer, or `null` for no button. The
29
+ * preview line runs along the returned range. Called on every pointer move, so it should be cheap.
30
+ *
31
+ * @param range The entire row (column) just past the border: below it for rows, right of it for
32
+ * columns. A host usually narrows it, e.g. `range.getIntersect(table.getRange())`.
33
+ *
34
+ * Defaults to `range` when the sheet's protection allows inserting rows (columns).
35
+ */
36
+ resolve?: (range: ICellRange) => ICellRange | null;
37
+ /** Called when the button is pressed. Defaults to `range.insert(axis)`. */
38
+ onInsert?: (range: ICellRange) => void;
39
+ /** Edge (px, unzoomed) of the button. @defaultValue 16 */
40
+ size?: number;
41
+ /**
42
+ * Renders the button, filling the square it is placed in. Defaults to {@link CellInsertButton}.
43
+ */
44
+ renderButton?: (props: CellInsertButtonProps) => React.ReactNode;
45
+ }
46
+ /**
47
+ * An **insert** button in the headers, on the border nearest the pointer, as Word shows one in the
48
+ * margin beside a table. Pressing it inserts cells at that border; while it shows, a line across the
49
+ * cells previews where.
50
+ *
51
+ * @remarks
52
+ * Declared on both the header strip and the cells, which a {@link SheetLayers} does:
53
+ *
54
+ * ```tsx
55
+ * <WorksheetElement sheet={sheet}>
56
+ * <SheetLayers surface={['rowHeaders', 'cells']}>
57
+ * <CellInsertLayer />
58
+ * </SheetLayers>
59
+ * </WorksheetElement>
60
+ * ```
61
+ *
62
+ * The button is offered from the headers only: hovering the cells shows nothing. Which cells an insert
63
+ * covers, and whether there is one at all, are the host's, through `resolve`. Left alone it inserts
64
+ * entire rows (columns) wherever the sheet's protection allows.
65
+ */
66
+ export declare const CellInsertLayer: React.MemoExoticComponent<(props: CellInsertLayerProps) => React.JSX.Element | null>;
67
+ /**
68
+ * The chromeless insert button: a circled `+` in the primary color, filled while hovered.
69
+ */
70
+ export declare const CellInsertButton: React.MemoExoticComponent<(props: CellInsertButtonProps) => React.JSX.Element>;
71
+ //# sourceMappingURL=CellInsertLayer.d.ts.map
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  export interface CircularIndicatorLayerProps extends LayerProps {
5
5
  /** Class for the layer (devtools identification). */
@@ -7,7 +7,7 @@ export interface CircularIndicatorLayerProps extends LayerProps {
7
7
  /** Style for the indicators host box. */
8
8
  style?: React.CSSProperties;
9
9
  /** The sheet whose circular references are marked. */
10
- sheet: ISheet;
10
+ sheet: IWorksheet;
11
11
  /** Size (px, unzoomed) of the corner glyph. @defaultValue 9 */
12
12
  markSize?: number;
13
13
  /** Inset (px, unzoomed) of the glyph from the cell's top-left corner. @defaultValue 1 */
@@ -21,7 +21,7 @@ export interface CircularIndicatorLayerProps extends LayerProps {
21
21
  * A {@link CellTileDiv} fed the sheet's `Feature.Circular` regions (engine-merged blocks: a
22
22
  * 28K-cell block downstream of one cycle is one region, not 28K nodes), so a sheet with no cycles
23
23
  * costs one lookup per frame. Members only get the glyph — a downstream cell is `0` for the same
24
- * reason (DESIGN-CIRCULAR-CALC.md §2.1) but the fix is never there, and a column of glyphs reads
24
+ * reason but the fix is never there, and a column of glyphs reads
25
25
  * as a column of problems. The tooltip (`CellErrorLayer`) still answers for downstream cells.
26
26
  *
27
27
  * The glyph shows in every state; an unresolved cycle — iterative calculation off, or capped
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  import { CommentCardRenderProps } from '../comment/CommentCardRequest';
5
5
  export interface CommentCardLayerProps extends Omit<LayerProps, 'children'> {
@@ -8,7 +8,7 @@ export interface CommentCardLayerProps extends Omit<LayerProps, 'children'> {
8
8
  /** Style for the floated card container. */
9
9
  style?: React.CSSProperties;
10
10
  /** The sheet whose threads are shown. */
11
- sheet: ISheet;
11
+ sheet: IWorksheet;
12
12
  /**
13
13
  * Renders the card. The layer places it, keeps it open and keeps its keystrokes and presses from
14
14
  * the grid; what it looks like is the renderer's.
@@ -17,7 +17,7 @@ export interface CommentCardLayerProps extends Omit<LayerProps, 'children'> {
17
17
  /**
18
18
  * The task pane that lists the sheet's threads. While it is the active pane the cards are shown
19
19
  * there and this layer shows none.
20
- * @defaultValue 'comments'
20
+ * @defaultValue {@link TaskPaneKey.Comments}
21
21
  */
22
22
  paneKey?: string;
23
23
  /** Gap (px) between the cell's right edge and the card. @defaultValue 18 */
@@ -29,17 +29,15 @@ export interface CommentCardLayerProps extends Omit<LayerProps, 'children'> {
29
29
  }
30
30
  /**
31
31
  * The **comment card** beside a cell — a {@link RangeFloatLayer} showing the thread of the cell the
32
- * pointer rests on, and the card a command {@link requestCommentCard | asked for}: a draft on a
32
+ * pointer rests on, and the card a command asked for (`requestCommentCard`): a draft on a
33
33
  * cell with no thread, or the thread a command went to. Selecting a cell shows nothing by itself,
34
34
  * as in Excel.
35
35
  *
36
36
  * @remarks
37
37
  * A note has a box of its own and is not shown here. The card of a requested cell stays until the
38
- * selection leaves the cell or the card is dismissed; a card that takes the focus is kept the same
39
- * way, so a reply being typed does not close when the pointer wanders off.
40
- *
41
- * The float portals out of the pane, but React events still bubble through the React tree to the
42
- * grid, so the layer stops the card's keystrokes, presses, clipboard and context-menu events there.
38
+ * selection leaves the cell or the card is dismissed. The card is a `'focus'` float: while it holds the
39
+ * caret it stays on its thread whatever the pointer does, Escape or a press outside it closes it (focus
40
+ * back to the grid), and none of its events reach the grid.
43
41
  */
44
42
  export declare const CommentCardLayer: React.MemoExoticComponent<(props: CommentCardLayerProps) => React.JSX.Element>;
45
43
  //# sourceMappingURL=CommentCardLayer.d.ts.map
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  export interface CommentsLayerProps extends LayerProps {
5
5
  /** Class for the layer (devtools identification). */
@@ -7,7 +7,7 @@ export interface CommentsLayerProps extends LayerProps {
7
7
  /** Style for the indicators host box. */
8
8
  style?: React.CSSProperties;
9
9
  /** The sheet whose comments are indicated. */
10
- sheet: ISheet;
10
+ sheet: IWorksheet;
11
11
  /** Size (px, unzoomed) of the corner indicator. @defaultValue 7 */
12
12
  markSize?: number;
13
13
  /** Dwell (ms) on a note's cell before its box shows. @defaultValue 300 */
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  export interface ConditionalBarLayerProps extends LayerProps {
5
5
  /** Class for the layer (devtools identification). */
@@ -7,7 +7,7 @@ export interface ConditionalBarLayerProps extends LayerProps {
7
7
  /** Style for the bars host box. */
8
8
  style?: React.CSSProperties;
9
9
  /** The sheet whose conditional data bars are drawn. */
10
- sheet: ISheet;
10
+ sheet: IWorksheet;
11
11
  /**
12
12
  * Margin (px, unzoomed) between the cell's edges and the bar, on ALL FOUR sides.
13
13
  *
@@ -1,4 +1,4 @@
1
- import { IStyle, IConditionalFormat } from '@sheetxl/sdk';
1
+ import { ICellStyle, IConditionalFormat } from '@sheetxl/sdk';
2
2
  /**
3
3
  * One icon of a conditional-format icon set: which shape to draw and what to tint it.
4
4
  */
@@ -47,11 +47,11 @@ export type ConditionalIconTone = keyof typeof Tone;
47
47
  * `set` is asked per cell rather than per rule because a rule may borrow each band's icon from a
48
48
  * different set — see `IConditionalFormat.IconSetDecoration`.
49
49
  */
50
- export declare const getConditionalIcon: (set: IStyle.IconSet, index: number) => ConditionalIconSpec | null;
50
+ export declare const getConditionalIcon: (set: ICellStyle.IconSet, index: number) => ConditionalIconSpec | null;
51
51
  /**
52
52
  * Returns every icon of a built-in set, band 0 first — for a picker previewing the set.
53
53
  */
54
- export declare const getConditionalIconSet: (set: IStyle.IconSet) => readonly ConditionalIconSpec[];
54
+ export declare const getConditionalIconSet: (set: ICellStyle.IconSet) => readonly ConditionalIconSpec[];
55
55
  /**
56
56
  * The icon each band of a rule draws — the set's own, or the band's override — lowest band first.
57
57
  *
@@ -78,7 +78,7 @@ export declare const describeConditionalIcon: (spec: ConditionalIconSpec) => {
78
78
  */
79
79
  export interface ConditionalIconCatalogEntry {
80
80
  /** The set the icon is borrowed from — what `IConditionalFormat.IconSet.icon` holds. */
81
- set: IStyle.IconSet;
81
+ set: ICellStyle.IconSet;
82
82
  /** The icon's index within that set. */
83
83
  id: number;
84
84
  spec: ConditionalIconSpec;
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  export interface ConditionalIconsLayerProps extends LayerProps {
5
5
  /** Class for the layer (devtools identification). */
@@ -7,7 +7,7 @@ export interface ConditionalIconsLayerProps extends LayerProps {
7
7
  /** Style for the icons host box. */
8
8
  style?: React.CSSProperties;
9
9
  /** The sheet whose conditional icon sets are drawn. */
10
- sheet: ISheet;
10
+ sheet: IWorksheet;
11
11
  }
12
12
  /**
13
13
  * The sheet's **conditional icons** — the in-cell marks an `iconSet` rule draws.
@@ -1,10 +1,10 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  import { SheetLocation } from '../sheet';
5
5
  export interface ContextMenuLayerProps extends LayerProps {
6
6
  /** The sheet — the keyboard path anchors the menu to its selected cell (`getSelection().getCoords().cell`). */
7
- sheet: ISheet;
7
+ sheet: IWorksheet;
8
8
  /**
9
9
  * Returns the coordinates of the cell where the context menu was requested.
10
10
  */
@@ -0,0 +1,17 @@
1
+ import { default as React } from 'react';
2
+ export interface FreezeDragLinesProps {
3
+ /**
4
+ * Also draw the line at the grid's start while a grip is active (hovered, pressed or dragged) with
5
+ * nothing frozen on its axis — where the grid has no freeze line of its own to highlight. For the main
6
+ * grid; a header has the grip's bar there instead.
7
+ */
8
+ showStart?: boolean;
9
+ }
10
+ /**
11
+ * The lines of an in-progress freeze drag: solid at the boundary the drop would freeze at, dashed at the
12
+ * pointer while it is over the grid. Reads the drag from `useSurfaceState` (published by
13
+ * {@link useFreezeDrag}) and draws this pane's clipped slice, so it mounts in the headers and the main
14
+ * grid alike.
15
+ */
16
+ export declare const FreezeDragLines: React.MemoExoticComponent<(props: FreezeDragLinesProps) => React.JSX.Element>;
17
+ //# sourceMappingURL=FreezeDragLines.d.ts.map