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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (405) hide show
  1. package/LICENSE.md +8 -7
  2. package/browser/esm/B06WJCAWTIB7QYlK.mjs +45 -0
  3. package/browser/esm/B8_6V0LUnuA1dLW6.mjs +20 -0
  4. package/browser/esm/BFjx8_H3wUxrWDq9.mjs +60 -0
  5. package/browser/esm/BGcs5WWx5PpaiJo4.mjs +36 -0
  6. package/browser/esm/BcC6S9k7zkHfCNRX.mjs +42 -0
  7. package/browser/esm/BkBxhk45Iln3h-sG.mjs +67 -0
  8. package/browser/esm/BzZ2vOT8CNsqcL8P.mjs +79 -0
  9. package/browser/esm/C1Qp40Kq88D9nzcX.mjs +19 -0
  10. package/browser/esm/C5RaHvks1HTBfWcr.mjs +14092 -0
  11. package/browser/esm/CM9e6dbkYbw56iFf.mjs +401 -0
  12. package/browser/esm/COn0z_IT5hyEPNfV.mjs +8 -0
  13. package/browser/esm/CPjk4grd05Rp-e3V.mjs +9560 -0
  14. package/browser/esm/CU67T36gmVTq9ZwH.mjs +31 -0
  15. package/browser/esm/CUPlUCBX7owYqDq5.mjs +78 -0
  16. package/browser/esm/Ca_Ki0Si5ozlm1sl.mjs +197 -0
  17. package/browser/esm/CckrsFaUWle82oNL.mjs +63 -0
  18. package/browser/esm/Ch5X-uGft55TOqxa.mjs +262 -0
  19. package/browser/esm/CtbJ8PCap2NGxlu0.mjs +32 -0
  20. package/browser/esm/Cwye4MAU1-EF7Xlv.mjs +341 -0
  21. package/browser/esm/DcEGutcM_5gl0fZm.mjs +145 -0
  22. package/browser/esm/DeOhqQroIiAic6-j.mjs +2706 -0
  23. package/browser/esm/Dkw3FFdQKXZQrkFv.mjs +303 -0
  24. package/browser/esm/QJPDAP6UIHTbY1fM.mjs +134 -0
  25. package/browser/esm/SESUB_fypyWmhCWm.mjs +323 -0
  26. package/browser/esm/chart.mjs +41 -0
  27. package/browser/esm/control.mjs +217 -0
  28. package/browser/esm/group.mjs +123 -0
  29. package/browser/esm/index.mjs +22345 -13175
  30. package/browser/esm/note.mjs +112 -0
  31. package/browser/esm/picture.mjs +7 -0
  32. package/browser/esm/qeb-_mAjUAWD7bo4.mjs +128 -0
  33. package/browser/esm/shape.mjs +7 -0
  34. package/browser/esm/slicer.mjs +277 -0
  35. package/licenses/dependencies.txt +284 -565
  36. package/node/esm/77PQMLXXAN7fjBHS.mjs +8 -0
  37. package/node/esm/7_AWLfp_6MpYBpiV.mjs +32 -0
  38. package/node/esm/BOAB33GIG2M2CWMr.mjs +80 -0
  39. package/node/esm/BbnUYxeK64Fq92Lo.mjs +406 -0
  40. package/node/esm/C7wmHIY8RLeNSX3T.mjs +35 -0
  41. package/node/esm/C9Yq98-vMDznppO2.mjs +134 -0
  42. package/node/esm/CBHY_xaB7ke3yH-f.mjs +66 -0
  43. package/node/esm/CER7_OJffhze14wR.mjs +20 -0
  44. package/node/esm/CWOKAmLpdinc-0TK.mjs +263 -0
  45. package/node/esm/CqnJ_hGK1txHO0j9.mjs +328 -0
  46. package/node/esm/D63HF8XToGXrf7ds.mjs +45 -0
  47. package/node/esm/DmPmSA-2Aha-_6qu.mjs +198 -0
  48. package/node/esm/DrFBSp6XMEAjkdoG.mjs +1697 -0
  49. package/node/esm/DytW9LaLlJGM-6m6.mjs +2706 -0
  50. package/node/esm/Ef8HHL90yLZgk3Gf.mjs +146 -0
  51. package/node/esm/G9tXP39ldfioRVhL.mjs +68 -0
  52. package/node/esm/Jy5x43_CAF31L14-.mjs +37 -0
  53. package/node/esm/Nn0yfoegNHIym4QM.mjs +63 -0
  54. package/node/esm/UBas29HOMjk4p5jo.mjs +19 -0
  55. package/node/esm/c1FOnFN_eCD6KR4l.mjs +80 -0
  56. package/node/esm/chart.mjs +41 -0
  57. package/node/esm/control.mjs +217 -0
  58. package/node/esm/gfwmGAXGhq9IIu1U.mjs +128 -0
  59. package/node/esm/group.mjs +123 -0
  60. package/node/esm/index.mjs +19282 -9996
  61. package/node/esm/note.mjs +113 -0
  62. package/node/esm/picture.mjs +305 -0
  63. package/node/esm/shape.mjs +342 -0
  64. package/node/esm/slicer.mjs +279 -0
  65. package/package.json +56 -15
  66. package/resources/contents.json +36 -0
  67. package/resources/locales/contents.json +84 -0
  68. package/resources/locales/de/chart.cmd.json +82 -0
  69. package/resources/locales/de/movable.cmd.json +68 -0
  70. package/resources/locales/de/picture.cmd.json +188 -0
  71. package/resources/locales/de/pivot.cmd.json +79 -0
  72. package/resources/locales/de/shape.cmd.json +17 -0
  73. package/resources/locales/de/sheet.cmd.json +314 -27
  74. package/resources/locales/de/slicer.cmd.json +17 -0
  75. package/resources/locales/de/sparkline.cmd.json +301 -0
  76. package/resources/locales/de/table.cmd.json +13 -2
  77. package/resources/locales/de/ui.msg.json +367 -3
  78. package/resources/locales/de/workbook.cmd.json +8 -1
  79. package/resources/locales/en/chart.cmd.json +82 -0
  80. package/resources/locales/en/movable.cmd.json +68 -0
  81. package/resources/locales/en/picture.cmd.json +188 -0
  82. package/resources/locales/en/pivot.cmd.json +79 -0
  83. package/resources/locales/en/shape.cmd.json +17 -0
  84. package/resources/locales/en/sheet.cmd.json +328 -29
  85. package/resources/locales/en/slicer.cmd.json +17 -0
  86. package/resources/locales/en/sparkline.cmd.json +301 -0
  87. package/resources/locales/en/table.cmd.json +13 -2
  88. package/resources/locales/en/ui.msg.json +369 -3
  89. package/resources/locales/en/workbook.cmd.json +8 -1
  90. package/types/chart.d.ts +2 -0
  91. package/types/control.d.ts +2 -0
  92. package/types/group.d.ts +2 -0
  93. package/types/note.d.ts +2 -0
  94. package/types/picture.d.ts +2 -0
  95. package/types/shape.d.ts +2 -0
  96. package/types/slicer.d.ts +2 -0
  97. package/types/src/annotation/RangeAnnotationLayer.d.ts +110 -0
  98. package/types/src/annotation/RangeAnnotationTag.d.ts +23 -0
  99. package/types/src/annotation/RangeAnnotations.d.ts +180 -0
  100. package/types/src/annotation/index.d.ts +4 -0
  101. package/types/src/autoFill/FillMenu.d.ts +2 -2
  102. package/types/src/autoFill/FillSeries.d.ts +2 -2
  103. package/types/src/border/StaticBorderRenderer.d.ts +18 -1
  104. package/types/src/border/useBorders.d.ts +95 -3
  105. package/types/src/cell/CellCheckboxRenderer.d.ts +20 -0
  106. package/types/src/cell/CellContent.d.ts +68 -0
  107. package/types/src/cell/CellControlContext.d.ts +37 -0
  108. package/types/src/cell/{FormulaCellRenderer.d.ts → CellFormulaRenderer.d.ts} +10 -7
  109. package/types/src/cell/CellImageRenderer.d.ts +11 -0
  110. package/types/src/cell/CellRenderers.d.ts +190 -0
  111. package/types/src/cell/{SheetCellRenderer.d.ts → CellTextRenderer.d.ts} +11 -8
  112. package/types/src/cell/ColumnButton.d.ts +3 -3
  113. package/types/src/cell/CornerTriangle.d.ts +6 -0
  114. package/types/src/cell/OutlineButton.d.ts +123 -0
  115. package/types/src/cell/PivotButton.d.ts +55 -0
  116. package/types/src/cell/SheetHeaderRenderer.d.ts +6 -1
  117. package/types/src/cell/StaticCellRenderer.d.ts +3 -3
  118. package/types/src/cell/_DropdownFace.d.ts +29 -0
  119. package/types/src/cell/index.d.ts +10 -2
  120. package/types/src/cell/useFormulaViewAnchor.d.ts +3 -3
  121. package/types/src/cell/useInsertableCellControls.d.ts +25 -0
  122. package/types/src/chart/ChartCommands.d.ts +15 -0
  123. package/types/src/chart/ChartEditor.d.ts +12 -2
  124. package/types/src/chart/ChartElement.d.ts +122 -0
  125. package/types/src/chart/ChartKind.d.ts +7 -0
  126. package/types/src/chart/PresetChartTypeDescriptors.d.ts +3 -1
  127. package/types/src/chart/index.d.ts +2 -1
  128. package/types/src/chart/paint/_fills.d.ts +24 -0
  129. package/types/src/chart/paint/_graphics.d.ts +38 -0
  130. package/types/src/chart/paint/_mode.d.ts +6 -0
  131. package/types/src/chart/paint/echarts.d.ts +33 -0
  132. package/types/src/chart/paint/index.d.ts +12 -0
  133. package/types/src/chart/paint/kinds/ChartPaintKind.d.ts +140 -0
  134. package/types/src/chart/paint/kinds/_Area.d.ts +3 -0
  135. package/types/src/chart/paint/kinds/_Bar.d.ts +3 -0
  136. package/types/src/chart/paint/kinds/_BoxWhisker.d.ts +3 -0
  137. package/types/src/chart/paint/kinds/_Bubble.d.ts +3 -0
  138. package/types/src/chart/paint/kinds/_Funnel.d.ts +3 -0
  139. package/types/src/chart/paint/kinds/_Histogram.d.ts +3 -0
  140. package/types/src/chart/paint/kinds/_Line.d.ts +10 -0
  141. package/types/src/chart/paint/kinds/_OfPie.d.ts +3 -0
  142. package/types/src/chart/paint/kinds/_Pie.d.ts +21 -0
  143. package/types/src/chart/paint/kinds/_Placeholder.d.ts +7 -0
  144. package/types/src/chart/paint/kinds/_Radar.d.ts +3 -0
  145. package/types/src/chart/paint/kinds/_Scatter.d.ts +3 -0
  146. package/types/src/chart/paint/kinds/_Sunburst.d.ts +3 -0
  147. package/types/src/chart/paint/kinds/_Surface.d.ts +3 -0
  148. package/types/src/chart/paint/kinds/_Treemap.d.ts +3 -0
  149. package/types/src/chart/paint/kinds/_Waterfall.d.ts +3 -0
  150. package/types/src/chart/paint/kinds/_builtIns.d.ts +3 -0
  151. package/types/src/chart/paint/toEChartsOption.d.ts +42 -0
  152. package/types/src/checklist/ValueChecklist.d.ts +60 -19
  153. package/types/src/clipboard/ClipboardCommands.d.ts +3 -3
  154. package/types/src/clipboard/SheetClipboardLayer.d.ts +2 -2
  155. package/types/src/commands/ContextualToolbar.d.ts +19 -0
  156. package/types/src/commands/createTransactionalMiddleware.d.ts +4 -1
  157. package/types/src/commands/index.d.ts +1 -0
  158. package/types/src/comment/CommentCardRequest.d.ts +94 -0
  159. package/types/src/comment/CommentUtils.d.ts +43 -0
  160. package/types/src/comment/NoteEditor.d.ts +20 -0
  161. package/types/src/comment/index.d.ts +5 -0
  162. package/types/src/comment/useCommentThread.d.ts +37 -0
  163. package/types/src/comment/useSheetComments.d.ts +28 -0
  164. package/types/src/conditionalFormat/ConditionalFormatPresets.d.ts +6 -6
  165. package/types/src/context/WorksheetContext.d.ts +18 -0
  166. package/types/src/context/index.d.ts +1 -1
  167. package/types/src/control/FormControlRenderers.d.ts +22 -0
  168. package/types/src/editableLabel/EditableLabel.d.ts +3 -1
  169. package/types/src/editor/EditorCommands.d.ts +3 -3
  170. package/types/src/editor/FunctionPreviewPanel.d.ts +1 -1
  171. package/types/src/editor/SheetCellEditorLayer.d.ts +2 -10
  172. package/types/src/editor/SheetCellEditorStartLayer.d.ts +61 -0
  173. package/types/src/editor/SheetCellInput.d.ts +14 -0
  174. package/types/src/editor/SheetEditable.d.ts +6 -6
  175. package/types/src/editor/SheetReferenceHeaderLayer.d.ts +1 -1
  176. package/types/src/editor/SheetReferenceLayer.d.ts +4 -4
  177. package/types/src/editor/VirtualKeyboardLayer.d.ts +50 -0
  178. package/types/src/editor/formulaAnchor.d.ts +12 -0
  179. package/types/src/editor/index.d.ts +3 -0
  180. package/types/src/editor/pickedReference.d.ts +3 -3
  181. package/types/src/editor/useEditRejectedNotice.d.ts +3 -3
  182. package/types/src/editor/useFormulaHints.d.ts +3 -3
  183. package/types/src/editor/useFormulaInput.d.ts +15 -3
  184. package/types/src/editor/validationAlert.d.ts +24 -0
  185. package/types/src/form/FormulaInput.d.ts +5 -2
  186. package/types/src/form/useEditCommit.d.ts +23 -3
  187. package/types/src/form/useInputField.d.ts +2 -3
  188. package/types/src/frame/CommandContext.d.ts +101 -3
  189. package/types/src/group/GroupEditor.d.ts +25 -0
  190. package/types/src/index.d.ts +12 -1
  191. package/types/src/layer/BorderLayer.d.ts +5 -2
  192. package/types/src/layer/CellErrorLayer.d.ts +18 -7
  193. package/types/src/layer/CellFillLayer.d.ts +2 -2
  194. package/types/src/layer/CellIndicatorLayer.d.ts +31 -0
  195. package/types/src/layer/CellInsertLayer.d.ts +71 -0
  196. package/types/src/layer/CircularIndicatorLayer.d.ts +3 -3
  197. package/types/src/layer/CommentCardLayer.d.ts +43 -0
  198. package/types/src/layer/CommentsLayer.d.ts +35 -0
  199. package/types/src/layer/ConditionalBarLayer.d.ts +2 -2
  200. package/types/src/layer/ConditionalIcons.d.ts +4 -4
  201. package/types/src/layer/ConditionalIconsLayer.d.ts +2 -2
  202. package/types/src/layer/ContextMenuLayer.d.ts +2 -2
  203. package/types/src/layer/FreezeDragLines.d.ts +17 -0
  204. package/types/src/layer/GridFreezeLayer.d.ts +11 -0
  205. package/types/src/layer/HeaderFreezeLayer.d.ts +12 -0
  206. package/types/src/layer/HeaderResizerLayer.d.ts +2 -1
  207. package/types/src/layer/HeaderSelectionLayer.d.ts +4 -4
  208. package/types/src/layer/HyperlinkLayer.d.ts +116 -0
  209. package/types/src/layer/MovableKindScope.d.ts +17 -0
  210. package/types/src/layer/PivotLayer.d.ts +47 -0
  211. package/types/src/layer/PivotToolbar.d.ts +29 -0
  212. package/types/src/layer/ProtectionLayer.d.ts +4 -5
  213. package/types/src/layer/RangeToolbar.d.ts +75 -0
  214. package/types/src/layer/ResizeIndicator.d.ts +11 -10
  215. package/types/src/layer/ResizeTooltip.d.ts +13 -0
  216. package/types/src/layer/SheetBackgroundLayer.d.ts +3 -3
  217. package/types/src/layer/SheetCellLayer.d.ts +15 -8
  218. package/types/src/layer/SheetColumnButtonLayer.d.ts +2 -2
  219. package/types/src/layer/SheetGridLineLayer.d.ts +25 -15
  220. package/types/src/layer/SheetHeaderCellLayer.d.ts +10 -1
  221. package/types/src/layer/SheetLayers.d.ts +171 -0
  222. package/types/src/layer/SheetMovableLayer.d.ts +4 -3
  223. package/types/src/layer/SheetOutlineLayer.d.ts +40 -0
  224. package/types/src/layer/SheetPivotCommandLayer.d.ts +13 -0
  225. package/types/src/layer/SheetSparklineCommandLayer.d.ts +14 -0
  226. package/types/src/layer/SheetTableCommandLayer.d.ts +2 -2
  227. package/types/src/layer/SparklineLayer.d.ts +32 -0
  228. package/types/src/layer/SpillLayer.d.ts +2 -2
  229. package/types/src/layer/TableLayer.d.ts +6 -5
  230. package/types/src/layer/TableToolbar.d.ts +23 -0
  231. package/types/src/layer/ValidationDropdownLayer.d.ts +2 -2
  232. package/types/src/layer/ValidationIndicatorLayer.d.ts +2 -2
  233. package/types/src/layer/ValidationPromptLayer.d.ts +47 -16
  234. package/types/src/layer/_sheetBorders.d.ts +6 -0
  235. package/types/src/layer/_tableColor.d.ts +6 -0
  236. package/types/src/layer/_visibleCellFeatures.d.ts +11 -0
  237. package/types/src/layer/cellTip.d.ts +13 -0
  238. package/types/src/layer/freezeDragState.d.ts +21 -0
  239. package/types/src/layer/index.d.ts +17 -0
  240. package/types/src/layer/resizeIndicatorState.d.ts +3 -1
  241. package/types/src/layer/useFreezeDrag.d.ts +22 -0
  242. package/types/src/layer/useNormalBorderLines.d.ts +15 -0
  243. package/types/src/layer/useSheetFeatureRegions.d.ts +2 -2
  244. package/types/src/layer/useSheetVisibleCells.d.ts +5 -6
  245. package/types/src/layer/useSheetVisibleDecorations.d.ts +2 -2
  246. package/types/src/layer/useTableHeaderCells.d.ts +2 -2
  247. package/types/src/layer/useValidationPicker.d.ts +3 -3
  248. package/types/src/layer/useVisibleTables.d.ts +2 -2
  249. package/types/src/layer/validationMark.d.ts +3 -3
  250. package/types/src/listener/index.d.ts +5 -0
  251. package/types/src/listener/useCell.d.ts +29 -0
  252. package/types/src/listener/useCellRange.d.ts +23 -0
  253. package/types/src/listener/useCellValue.d.ts +26 -0
  254. package/types/src/listener/useModelListener.d.ts +8 -8
  255. package/types/src/listener/useRangeListener.d.ts +13 -7
  256. package/types/src/listener/useRangeSnapshot.d.ts +35 -0
  257. package/types/src/listener/useTable.d.ts +26 -0
  258. package/types/src/movable/ConnectionSites.d.ts +18 -0
  259. package/types/src/movable/DefaultMovable.d.ts +8 -0
  260. package/types/src/movable/IMovableArea.d.ts +56 -0
  261. package/types/src/movable/MovableAdornment.d.ts +26 -0
  262. package/types/src/movable/MovableCommandGroups.d.ts +22 -0
  263. package/types/src/movable/MovableCommands.d.ts +8 -3
  264. package/types/src/movable/MovableControl.d.ts +80 -0
  265. package/types/src/movable/MovableEdit.d.ts +22 -0
  266. package/types/src/movable/MovableFrame.d.ts +18 -14
  267. package/types/src/movable/MovableLayer.d.ts +30 -5
  268. package/types/src/movable/MovableRenderers.d.ts +210 -0
  269. package/types/src/movable/PlaceholderFrames.d.ts +11 -0
  270. package/types/src/movable/RotateHandle.d.ts +37 -0
  271. package/types/src/movable/TextBox.d.ts +34 -0
  272. package/types/src/movable/connect.d.ts +16 -0
  273. package/types/src/movable/framePlacement.d.ts +72 -0
  274. package/types/src/movable/geometry.d.ts +61 -0
  275. package/types/src/movable/index.d.ts +11 -0
  276. package/types/src/movable/pressTarget.d.ts +20 -0
  277. package/types/src/movable/useFramePreview.d.ts +17 -0
  278. package/types/src/picker/cellPickerOpen.d.ts +3 -3
  279. package/types/src/picker/useCellPicker.d.ts +7 -5
  280. package/types/src/picture/PictureCommands.d.ts +20 -0
  281. package/types/src/picture/PictureKind.d.ts +7 -0
  282. package/types/src/picture/_pictureHyperlink.d.ts +13 -0
  283. package/types/src/picture/index.d.ts +0 -1
  284. package/types/src/picture/pictureCrop.d.ts +32 -0
  285. package/types/src/pivot/PivotAreas.d.ts +16 -0
  286. package/types/src/pivot/PivotChip.d.ts +33 -0
  287. package/types/src/pivot/PivotChipMenu.d.ts +74 -0
  288. package/types/src/pivot/PivotCommands.d.ts +24 -0
  289. package/types/src/pivot/PivotFieldList.d.ts +14 -0
  290. package/types/src/pivot/PivotFields.d.ts +47 -0
  291. package/types/src/pivot/PivotFieldsModel.d.ts +143 -0
  292. package/types/src/pivot/PivotTablePane.d.ts +47 -0
  293. package/types/src/pivot/_PivotFieldsContext.d.ts +41 -0
  294. package/types/src/pivot/_pivotNew.d.ts +12 -0
  295. package/types/src/pivot/_pivotRegion.d.ts +14 -0
  296. package/types/src/pivot/index.d.ts +9 -0
  297. package/types/src/pivot/usePivotFields.d.ts +17 -0
  298. package/types/src/presence/PresenceCommands.d.ts +35 -0
  299. package/types/src/presence/PresenceHost.d.ts +58 -0
  300. package/types/src/presence/PresenceMessages.d.ts +42 -0
  301. package/types/src/presence/PresenceStore.d.ts +165 -0
  302. package/types/src/presence/PresenceTypes.d.ts +78 -0
  303. package/types/src/presence/index.d.ts +7 -0
  304. package/types/src/presence/usePresence.d.ts +20 -0
  305. package/types/src/richText/RichTextEditor.d.ts +41 -0
  306. package/types/src/richText/index.d.ts +2 -0
  307. package/types/src/selection/SelectionCommands.d.ts +2 -2
  308. package/types/src/selection/SheetSelectionLayer.d.ts +6 -12
  309. package/types/src/shape/ConnectorControl.d.ts +46 -0
  310. package/types/src/shape/ShapeCommands.d.ts +11 -0
  311. package/types/src/shape/ShapeControl.d.ts +8 -0
  312. package/types/src/shape/ShapeEditor.d.ts +15 -2
  313. package/types/src/shape/ShapeGallery.d.ts +31 -0
  314. package/types/src/shape/ShapeHandles.d.ts +28 -0
  315. package/types/src/shape/ShapeKind.d.ts +7 -0
  316. package/types/src/shape/ShapeSVG.d.ts +22 -0
  317. package/types/src/shape/ShapeText.d.ts +17 -0
  318. package/types/src/shape/icons/ShapeIcons.d.ts +16 -0
  319. package/types/src/shape/icons/_ShapeIconPack.d.ts +4 -0
  320. package/types/src/shape/index.d.ts +3 -1
  321. package/types/src/shape/shapeFrame.d.ts +50 -0
  322. package/types/src/shape/shapeStyle.d.ts +82 -0
  323. package/types/src/sheet/ISheetHeaderElement.d.ts +3 -3
  324. package/types/src/sheet/{ISheetElement.d.ts → IWorksheetElement.d.ts} +111 -81
  325. package/types/src/sheet/OpaqueSheetElement.d.ts +21 -0
  326. package/types/src/sheet/SheetCommandProvider.d.ts +14 -6
  327. package/types/src/sheet/SheetCommands.d.ts +20 -5
  328. package/types/src/sheet/SheetKindIcon.d.ts +14 -0
  329. package/types/src/sheet/SheetOutlineElement.d.ts +70 -0
  330. package/types/src/sheet/SheetPanels.d.ts +11 -0
  331. package/types/src/sheet/SheetScrollbar.d.ts +4 -13
  332. package/types/src/sheet/TopLeftCorner.d.ts +2 -2
  333. package/types/src/sheet/WorksheetElement.d.ts +12 -0
  334. package/types/src/sheet/_freezeAt.d.ts +10 -0
  335. package/types/src/sheet/_hyperlinkEdit.d.ts +7 -0
  336. package/types/src/sheet/_useHeaderMetrics.d.ts +11 -0
  337. package/types/src/sheet/circularReferences.d.ts +4 -4
  338. package/types/src/sheet/index.d.ts +5 -2
  339. package/types/src/sheet/useCycleHighlight.d.ts +2 -2
  340. package/types/src/slicer/SlicerCommands.d.ts +10 -0
  341. package/types/src/slicer/SlicerEditor.d.ts +8 -2
  342. package/types/src/slicer/SlicerKind.d.ts +7 -0
  343. package/types/src/slicer/SlicerStylePreview.d.ts +18 -0
  344. package/types/src/slicer/index.d.ts +2 -1
  345. package/types/src/slicer/slicerStyles.d.ts +32 -0
  346. package/types/src/sparkline/PictureCache.d.ts +37 -0
  347. package/types/src/sparkline/SparklineCommands.d.ts +23 -0
  348. package/types/src/sparkline/SparklinePictures.d.ts +7 -0
  349. package/types/src/sparkline/paint/_drawing.d.ts +24 -0
  350. package/types/src/sparkline/paint/echarts.d.ts +8 -0
  351. package/types/src/sparkline/paint/index.d.ts +8 -0
  352. package/types/src/tabStrip/SheetTab.d.ts +1 -1
  353. package/types/src/tabStrip/Sortable.d.ts +5 -5
  354. package/types/src/tabStrip/TabStrip.d.ts +13 -6
  355. package/types/src/tabStrip/TabStripItem.d.ts +15 -13
  356. package/types/src/table/TableCommands.d.ts +2 -2
  357. package/types/src/taskPane/CellControlPane.d.ts +15 -0
  358. package/types/src/taskPane/MovablePane.d.ts +15 -0
  359. package/types/src/taskPane/TaskPaneArea.d.ts +7 -0
  360. package/types/src/taskPane/TaskPaneFrame.d.ts +4 -4
  361. package/types/src/taskPane/TaskPaneKeys.d.ts +38 -0
  362. package/types/src/taskPane/TaskPaneRegistry.d.ts +32 -12
  363. package/types/src/taskPane/_paneReasons.d.ts +7 -0
  364. package/types/src/taskPane/index.d.ts +3 -0
  365. package/types/src/taskPane/useTaskPane.d.ts +6 -3
  366. package/types/src/theme/ThemeState.d.ts +15 -2
  367. package/types/src/theme/buildDocThemeCSS.d.ts +4 -1
  368. package/types/src/theme/buildOOXMLThemeCSS.d.ts +2 -2
  369. package/types/src/theme/useGridColorScheme.d.ts +3 -3
  370. package/types/src/theme/useSystemColors.d.ts +2 -2
  371. package/types/src/workbook/DefaultMovableRenderers.d.ts +20 -0
  372. package/types/src/workbook/DefaultRenderers.d.ts +5 -4
  373. package/types/src/workbook/IWorkbookElement.d.ts +108 -23
  374. package/types/src/workbook/WorkbookCommands.d.ts +8 -3
  375. package/types/src/workbook/WorkbookStrip.d.ts +14 -5
  376. package/browser/cjs/Bo9Kx3L_XQkGPBJ5.cjs +0 -1
  377. package/browser/cjs/Pl04-kDEQSO8_qFU.cjs +0 -156
  378. package/browser/cjs/index.cjs +0 -41
  379. package/browser/esm/Dsn3z1hmkv-bWGVr.mjs +0 -6286
  380. package/node/esm/CyU4sKDpHyc6kF7j.mjs +0 -9
  381. package/types/src/chart/templates/area-stacked-percent-template.json.d.ts +0 -10
  382. package/types/src/chart/templates/area-stacked-template.json.d.ts +0 -10
  383. package/types/src/chart/templates/area-template.json.d.ts +0 -9
  384. package/types/src/chart/templates/bar-stacked-percent-template.json.d.ts +0 -10
  385. package/types/src/chart/templates/bar-stacked-template.json.d.ts +0 -10
  386. package/types/src/chart/templates/bar-template.json.d.ts +0 -9
  387. package/types/src/chart/templates/column-stacked-percent-template.json.d.ts +0 -10
  388. package/types/src/chart/templates/column-stacked-template.json.d.ts +0 -10
  389. package/types/src/chart/templates/column-template.json.d.ts +0 -9
  390. package/types/src/chart/templates/line-markers-template.json.d.ts +0 -10
  391. package/types/src/chart/templates/line-stacked-markers-template.json.d.ts +0 -11
  392. package/types/src/chart/templates/line-stacked-percent-markers-template.json.d.ts +0 -11
  393. package/types/src/chart/templates/line-stacked-percent-template.json.d.ts +0 -10
  394. package/types/src/chart/templates/line-stacked-template.json.d.ts +0 -10
  395. package/types/src/chart/templates/line-template.json.d.ts +0 -9
  396. package/types/src/chart/templates/pie-doughnut-template.json.d.ts +0 -10
  397. package/types/src/chart/templates/pie-template.json.d.ts +0 -9
  398. package/types/src/chart/templates/scatter-lines-markers-smooth-template.json.d.ts +0 -10
  399. package/types/src/chart/templates/scatter-lines-markers-template.json.d.ts +0 -10
  400. package/types/src/chart/templates/scatter-lines-smooth-template.json.d.ts +0 -10
  401. package/types/src/chart/templates/scatter-lines-template.json.d.ts +0 -10
  402. package/types/src/chart/templates/scatter-markers-template.json.d.ts +0 -10
  403. package/types/src/context/SheetContext.d.ts +0 -18
  404. package/types/src/movable/MoveableBundle.d.ts +0 -4
  405. package/types/src/sheet/SheetElement.d.ts +0 -15
@@ -0,0 +1,110 @@
1
+ import { default as React } from 'react';
2
+ import { IWorksheet, IWorkbook } from '@sheetxl/sdk';
3
+ import { LayerProps, StickyState, GridFloatSide } from '@sheetxl/grid-react';
4
+ import { RangeAnnotation } from './RangeAnnotations';
5
+ /** How an intent is drawn: its box, and the tag. */
6
+ export interface RangeAnnotationStyle {
7
+ /** The box border. */
8
+ border: string;
9
+ /** The box fill — translucent, the cells show through. */
10
+ fill: string;
11
+ /** The tag's color — opaque; a tag reads by z-order, never by letting what is under it show through. */
12
+ chip: string;
13
+ }
14
+ /**
15
+ * The default look per intent. Deliberately flatter than the selection (no thick, handled border,
16
+ * which reads as "draggable"): a soft fill and a thin border.
17
+ */
18
+ export declare const DEFAULT_ANNOTATION_STYLES: Readonly<Record<string, RangeAnnotationStyle>>;
19
+ /** What a tag (in view, or waiting at an edge) is rendered from. */
20
+ export interface RangeAnnotationChipProps {
21
+ workbook: IWorkbook;
22
+ /** The annotation the tag stands for — the current one of its group when it is among them. */
23
+ annotation: RangeAnnotation;
24
+ /** Others sharing this tag's anchor cell. */
25
+ more: number;
26
+ /** 1-based position in the walked list; `0` for a `working` annotation. */
27
+ position: number;
28
+ /** How many are walked. */
29
+ total: number;
30
+ isCurrent: boolean;
31
+ /** Under the pointer — here, or in a host's list of the same annotations. */
32
+ isHovered: boolean;
33
+ /**
34
+ * Which way the tag stands off the corner it points at — always outward, off the range's cells:
35
+ * `left` of a left corner, `right` of a right one. Top or bottom is the float's placement.
36
+ */
37
+ side: 'left' | 'right';
38
+ /**
39
+ * The tag does not stand on a corner: the range has no corner in view (it runs past both ends of an
40
+ * axis) or is out of view altogether.
41
+ */
42
+ cornerOff: boolean;
43
+ /**
44
+ * When the tag stands on a visible edge of a range with no corner in view: which way the range lies
45
+ * from it. `null` on a corner, and for the marker of a range out of view.
46
+ */
47
+ toward?: GridFloatSide | null;
48
+ /** Reports the open card's size, which the layer uses to choose where the tag stands. */
49
+ onCardSize?: (width: number, height: number) => void;
50
+ style: RangeAnnotationStyle;
51
+ /** The range's address on its sheet (`C8:D8`), unqualified. */
52
+ address: string;
53
+ /** The float's resolved state (`slid`, `outOfView`, `scrollIntoView`, …). */
54
+ state: StickyState;
55
+ }
56
+ export interface RangeAnnotationLayerProps extends Omit<LayerProps, 'children'> {
57
+ /** The sheet whose annotations are drawn. @defaultValue the sheet in context (an injected layer needs none) */
58
+ sheet?: IWorksheet;
59
+ /** Per-intent look. Merged over {@link DEFAULT_ANNOTATION_STYLES}. */
60
+ styles?: Readonly<Record<string, RangeAnnotationStyle>>;
61
+ /** Render the tag beside an annotation that is in view. Omit for {@link RangeAnnotationTag}. */
62
+ renderChip?: (props: RangeAnnotationChipProps) => React.ReactNode;
63
+ /**
64
+ * Render the marker that stands in for a tag whose range is scrolled out of view. Omit for
65
+ * {@link RangeAnnotationTag}, which turns its pointer toward the range.
66
+ */
67
+ renderMarker?: (props: RangeAnnotationChipProps) => React.ReactNode;
68
+ /** How much a box that is not the navigator's current one fades. Boxes only — never tags. @defaultValue 0.45 */
69
+ dimOpacity?: number;
70
+ /**
71
+ * Whether an annotation gets a tag (and, scrolled off, a marker) or is drawn as its box alone —
72
+ * for a host that shows some annotations elsewhere (an agent's cursor, in its own status control).
73
+ * @defaultValue every walked annotation, and a `working` one only when it has a label
74
+ */
75
+ showChip?: (annotation: RangeAnnotation) => boolean;
76
+ /**
77
+ * Which of the workbook's annotations this layer draws: boxes, tags and the tags' grouping alike. A
78
+ * feature that writes annotations draws its own, so it passes a test on its `source`. An annotation
79
+ * this layer leaves out is still in the store and the navigator, and another layer can draw it.
80
+ * Escape and a press on the grid close the open card whichever layer drew it.
81
+ * @defaultValue every annotation
82
+ */
83
+ filter?: (annotation: RangeAnnotation) => boolean;
84
+ }
85
+ /**
86
+ * The workbook's range annotations on this sheet: a soft box per annotation, and a tag per anchor
87
+ * cell. The tag rides a {@link StickyPortal} with `whenOff: 'clamp'`, so when its range scrolls out
88
+ * of view it stays at the edge, its pointer turned toward the range (click reveals it) instead of
89
+ * vanishing.
90
+ *
91
+ * @remarks
92
+ * A tag is its number alone until the annotation is current or hovered; then it grows into the card
93
+ * (label, walk controls). Hover is shared through the annotation state, so a host's list of the same
94
+ * annotations lights the tag and the tag lights the list.
95
+ *
96
+ * The navigator's current annotation draws last (on top) at full strength; the others dim. That is
97
+ * what keeps overlapping annotations legible. Hovering lifts a tag — and its boxes — above the
98
+ * current one while the pointer stays, so a tag hidden under another can be read and reached.
99
+ * Annotations that share a top-left cell share one tag — the current one's if it is among them —
100
+ * with a `+N` for the rest, so tags never stack.
101
+ *
102
+ * A prebuilt layer, not part of the sheet's default stack: the feature that writes annotations mounts
103
+ * one for them, filtered to its own `source`. A plugin registers it for every sheet with
104
+ * `DefaultSheetLayersRegistry`; a host can also pass it in a sheet's `layers`
105
+ * (`propsSheet={{ layers: [<RangeAnnotationLayer key="annotations" />] }}` on a workbook element). It
106
+ * reads the sheet from context and draws nothing while it has no annotations to show. Fed through
107
+ * {@link addRangeAnnotations}.
108
+ */
109
+ export declare const RangeAnnotationLayer: React.MemoExoticComponent<(props: RangeAnnotationLayerProps) => React.JSX.Element>;
110
+ //# sourceMappingURL=RangeAnnotationLayer.d.ts.map
@@ -0,0 +1,23 @@
1
+ import { default as React } from 'react';
2
+ import { IWorkbook } from '@sheetxl/sdk';
3
+ import { RangeAnnotation } from './RangeAnnotations';
4
+ import { RangeAnnotationChipProps } from './RangeAnnotationLayer';
5
+ /**
6
+ * Take the user to an annotation: a walked one becomes the navigator's current; any other (a
7
+ * `working` cursor) is only revealed — `goTo` refuses what is not walked, which would leave its tag
8
+ * dead.
9
+ */
10
+ export declare const activateRangeAnnotation: (workbook: IWorkbook, a: RangeAnnotation) => void;
11
+ /**
12
+ * The default tag of a {@link RangeAnnotationLayer}: a pointer on the range and a badge with the
13
+ * review number. While the annotation is current or hovered, the badge gives way to the card —
14
+ * `n / N`, the range's address, the walk controls, the label. The card is laid out from the closed
15
+ * tag alone and always contains the badge, so opening it moves nothing and its pointer stays with it.
16
+ * The label and the address can be selected and copied. The same component is the edge marker:
17
+ * `state` says where the range is, and the pointer swings toward it.
18
+ *
19
+ * @remarks
20
+ * A host may render it inside its own chip, or replace it through the layer's `renderChip`.
21
+ */
22
+ export declare const RangeAnnotationTag: React.FC<RangeAnnotationChipProps>;
23
+ //# sourceMappingURL=RangeAnnotationTag.d.ts.map
@@ -0,0 +1,180 @@
1
+ import { IWorkbook } from '@sheetxl/sdk';
2
+ /**
3
+ * What an annotation is for. The vocabulary of the MCP `highlight` tool, unchanged; any other string
4
+ * is accepted and styled by the host.
5
+ *
6
+ * - `working` — the agent's cursor: transient, replaced by its next call, never walked.
7
+ * - `finding` / `question` — things the agent wants the user to look at; they accumulate as walks and
8
+ * stay until dismissed.
9
+ */
10
+ export type RangeAnnotationIntent = 'working' | 'finding' | 'question' | (string & {});
11
+ /** One range to annotate, with the label for that stop. */
12
+ export interface RangeAnnotationInput {
13
+ /** A sheet-qualified address (`'Sheet 1'!B2:D6`), resolved against the live workbook. */
14
+ range: string;
15
+ label?: string;
16
+ }
17
+ /**
18
+ * One annotated range.
19
+ *
20
+ * @remarks
21
+ * Transient view state: never serialized, never on the undo stack. `range` is kept current as rows
22
+ * and columns move under it; `status` turns `stale` once its cells (or its sheet) are gone, and back
23
+ * to `open` if an undo brings them back. Every change replaces the object, so views compare by
24
+ * identity.
25
+ */
26
+ export interface RangeAnnotation {
27
+ /** `${walk}:${index}` — stable for the life of the walk. */
28
+ id: string;
29
+ intent: RangeAnnotationIntent;
30
+ /** Who added it (an agent session); the host's tag, carried through. */
31
+ source?: string;
32
+ /** The sheet the range is on. An annotation is on exactly one sheet. */
33
+ sheet: string;
34
+ /** Sheet-qualified address, current. */
35
+ range: string;
36
+ label?: string;
37
+ /** The call that produced it; ordering across walks. */
38
+ walk: number;
39
+ /** Position within the walk — the agent's review order. */
40
+ index: number;
41
+ createdAt: number;
42
+ /**
43
+ * `stale` means the range can no longer be placed (its cells or its sheet were deleted). A stale
44
+ * annotation is listed, so the user still sees what was said, but is not drawn and is skipped by
45
+ * the navigator. A dismissed annotation is removed, not marked.
46
+ */
47
+ status: 'open' | 'stale';
48
+ }
49
+ /** Options for {@link addRangeAnnotations}. */
50
+ export interface AddRangeAnnotationsOptions {
51
+ /** Who is adding (an agent session). Carried onto each annotation as `source`. */
52
+ source?: string;
53
+ /**
54
+ * Drop the existing annotations of this intent from the same {@link source} first (a cursor that is
55
+ * replaced by the next call). Annotations from other sources stay; a write with no source replaces
56
+ * only others with no source. @defaultValue `true` for `working`, else `false`
57
+ */
58
+ replace?: boolean;
59
+ }
60
+ /** What the workbook's annotations look like right now — one frozen object per change. */
61
+ export interface RangeAnnotationState {
62
+ /** Every annotation, every intent and status, in review order: newest walk first, the agent's order within a walk. */
63
+ annotations: readonly RangeAnnotation[];
64
+ /** The ones the navigator walks: open, and not `working`. */
65
+ navigable: readonly RangeAnnotation[];
66
+ /** The navigator's current annotation, or `null`. */
67
+ current: RangeAnnotation | null;
68
+ /** 1-based position of {@link current} in {@link navigable}; `0` for none. */
69
+ position: number;
70
+ /**
71
+ * The annotation under the pointer — on the grid or in a list that shows the same annotations — or
72
+ * `null`. Both views read it, so pointing at one side lights the other. Transient; never a
73
+ * `stale` annotation.
74
+ */
75
+ hovered: RangeAnnotation | null;
76
+ /** Bumps on every change. */
77
+ version: number;
78
+ }
79
+ /**
80
+ * What changed, handed to {@link addRangeAnnotationListener} listeners. One event per change.
81
+ *
82
+ * @remarks
83
+ * A writer that has to hear how the user dealt with its annotations reads `dismissed` and `cleared`
84
+ * rather than wrapping every way of dismissing: the tag, a list, a command and a clear all arrive the
85
+ * same way. Each event carries the annotations as they were when it happened.
86
+ */
87
+ export type RangeAnnotationEvent =
88
+ /** One call's walk. `replaced` is what its `replace` dropped first (empty when it dropped nothing). */
89
+ {
90
+ type: 'added';
91
+ annotations: readonly RangeAnnotation[];
92
+ replaced: readonly RangeAnnotation[];
93
+ }
94
+ /** One annotation, through {@link dismissRangeAnnotation}. */
95
+ | {
96
+ type: 'dismissed';
97
+ annotation: RangeAnnotation;
98
+ }
99
+ /** Those removed by one {@link clearRangeAnnotations}. */
100
+ | {
101
+ type: 'cleared';
102
+ annotations: readonly RangeAnnotation[];
103
+ }
104
+ /** The navigator moved: the new current annotation, or `null` when the cursor was cleared. */
105
+ | {
106
+ type: 'current';
107
+ annotation: RangeAnnotation | null;
108
+ }
109
+ /** The annotation under the pointer, or `null`. */
110
+ | {
111
+ type: 'hovered';
112
+ annotation: RangeAnnotation | null;
113
+ }
114
+ /** An annotation's cells moved, or it went stale or came back. */
115
+ | {
116
+ type: 'moved';
117
+ annotation: RangeAnnotation;
118
+ };
119
+ /** Whether the navigator walks this intent. */
120
+ export declare const isWalkedIntent: (intent: RangeAnnotationIntent) => boolean;
121
+ /**
122
+ * Annotate ranges: one call = one **walk**, in the caller's order. The annotations follow their cells
123
+ * through edits and stay until dismissed (a `working` cursor is replaced by the next `working` call
124
+ * from the same source).
125
+ *
126
+ * @returns The annotations created, in order (empty for a clear).
127
+ */
128
+ export declare const addRangeAnnotations: (workbook: IWorkbook, intent: RangeAnnotationIntent, ranges: readonly RangeAnnotationInput[], options?: AddRangeAnnotationsOptions) => RangeAnnotation[];
129
+ /** The workbook's annotations right now. The same object until something changes. */
130
+ export declare const getRangeAnnotationState: (workbook: IWorkbook) => RangeAnnotationState;
131
+ /** One annotation by id, or `null`. */
132
+ export declare const getRangeAnnotation: (workbook: IWorkbook, id: string) => RangeAnnotation | null;
133
+ /** Remove one annotation. The navigator moves on if it was current. Returns whether it was there. */
134
+ export declare const dismissRangeAnnotation: (workbook: IWorkbook, id: string) => boolean;
135
+ /**
136
+ * Remove annotations — all of them, or those matching `intent` and / or `source`. Returns how many
137
+ * went.
138
+ */
139
+ export declare const clearRangeAnnotations: (workbook: IWorkbook, filter?: {
140
+ intent?: RangeAnnotationIntent | readonly RangeAnnotationIntent[];
141
+ source?: string;
142
+ }) => number;
143
+ /**
144
+ * Bring an annotation's range into view without touching the selection: activate its sheet when the
145
+ * range is on another one, then scroll (a no-op when it is already on screen). Best effort — a stale
146
+ * annotation, or a sheet that will not select, is not an error.
147
+ */
148
+ export declare const revealRangeAnnotation: (workbook: IWorkbook, id: string) => Promise<void>;
149
+ /**
150
+ * Make an annotation the navigator's current one and reveal it. A stale, `working` or unknown id does
151
+ * nothing. `null` clears the cursor; {@link nextRangeAnnotation} and {@link prevRangeAnnotation} then walk on
152
+ * from the annotation that was current.
153
+ */
154
+ export declare const goToRangeAnnotation: (workbook: IWorkbook, id: string | null) => void;
155
+ /**
156
+ * Mark an annotation as the one under the pointer, or `null` for none. Views that show the same
157
+ * annotations (the grid's tags, a host's list) read {@link RangeAnnotationState.hovered} so that
158
+ * pointing at one lights the other. A pointer leaving should pass the id it entered with through
159
+ * {@link unhoverRangeAnnotation}, so a leave that arrives after the next enter does not clear it.
160
+ */
161
+ export declare const hoverRangeAnnotation: (workbook: IWorkbook, id: string | null) => void;
162
+ /** Clear the hover, but only while `id` is still the hovered one. */
163
+ export declare const unhoverRangeAnnotation: (workbook: IWorkbook, id: string) => void;
164
+ /**
165
+ * Move to the next walked annotation (wrapping) and reveal it.
166
+ *
167
+ * @param fromId Step from this annotation instead of the current one — a chip's own arrows walk
168
+ * from that chip, wherever the user scrolled to.
169
+ */
170
+ export declare const nextRangeAnnotation: (workbook: IWorkbook, fromId?: string) => void;
171
+ /** Move to the previous walked annotation (wrapping) and reveal it. See {@link nextRangeAnnotation}. */
172
+ export declare const prevRangeAnnotation: (workbook: IWorkbook, fromId?: string) => void;
173
+ /**
174
+ * Listen for the workbook's annotations changing: once per change, told what changed. The returned
175
+ * function stops listening.
176
+ */
177
+ export declare const addRangeAnnotationListener: (workbook: IWorkbook, listener: (event: RangeAnnotationEvent) => void) => (() => void);
178
+ /** {@link getRangeAnnotationState}, kept current. `null` workbook ⇒ the empty state. */
179
+ export declare const useRangeAnnotations: (workbook: IWorkbook | null) => RangeAnnotationState;
180
+ //# sourceMappingURL=RangeAnnotations.d.ts.map
@@ -0,0 +1,4 @@
1
+ export * from './RangeAnnotations';
2
+ export * from './RangeAnnotationLayer';
3
+ export * from './RangeAnnotationTag';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -1,11 +1,11 @@
1
- import { IRange, ISheet } from '@sheetxl/sdk';
1
+ import { IRange, IWorksheet } from '@sheetxl/sdk';
2
2
  import { IReactNotifier } from '@sheetxl/utils-react';
3
3
  import { CommandContext } from '../frame';
4
4
  /**
5
5
  * The drag {@link createFillMenu} builds a menu for.
6
6
  */
7
7
  export interface CreateFillMenuOptions {
8
- sheet: ISheet;
8
+ sheet: IWorksheet;
9
9
  /** The cells the fill reads — the selection the handle was dragged from. */
10
10
  template: IRange.Coords;
11
11
  /** The cells the fill covers, the template included — where the handle was released. */
@@ -1,11 +1,11 @@
1
- import { IRange, IAutoFill, ICellRange, ISheet } from '@sheetxl/sdk';
1
+ import { IRange, IAutoFill, ICellRange, IWorksheet } from '@sheetxl/sdk';
2
2
  import { IReactNotifier } from '@sheetxl/utils-react';
3
3
  import { CommandContext } from '../frame';
4
4
  /**
5
5
  * What the Series dialog is opened on — see {@link openFillSeries}.
6
6
  */
7
7
  export interface OpenFillSeriesOptions {
8
- sheet: ISheet;
8
+ sheet: IWorksheet;
9
9
  /** Shows the dialog; nothing opens without one. */
10
10
  notifier?: IReactNotifier;
11
11
  /** The range the dialog reports as the selection. */
@@ -1,10 +1,15 @@
1
1
  import { default as React } from 'react';
2
- import { IBorders } from '@sheetxl/sdk';
2
+ import { IRange, IBorders } from '@sheetxl/sdk';
3
+ import { UseBordersMode, BorderNormalLine } from './useBorders';
3
4
  export interface StaticBorderRendererProps extends React.HTMLAttributes<HTMLDivElement> {
4
5
  /**
5
6
  * Returns a border for the given value and index.
6
7
  */
7
8
  getBorderAt?: (value: any, index: number) => IBorders;
9
+ /**
10
+ * {@inheritDoc UseBorderOptions.getMergeAt}
11
+ */
12
+ getMergeAt?: (value: any, index: number) => IRange.Coords | null;
8
13
  rowCount?: number;
9
14
  columnCount?: number;
10
15
  /**
@@ -22,6 +27,18 @@ export interface StaticBorderRendererProps extends React.HTMLAttributes<HTMLDivE
22
27
  */
23
28
  height?: number;
24
29
  forceThinBorder?: boolean;
30
+ /**
31
+ * {@inheritDoc UseBorderOptions.mode}
32
+ */
33
+ mode?: UseBordersMode;
34
+ /**
35
+ * {@inheritDoc UseBorderOptions.normalRows}
36
+ */
37
+ normalRows?: BorderNormalLine | null;
38
+ /**
39
+ * {@inheritDoc UseBorderOptions.normalColumns}
40
+ */
41
+ normalColumns?: BorderNormalLine | null;
25
42
  }
26
43
  /**
27
44
  * Render a grid border using a border property as an input. Useful
@@ -1,14 +1,19 @@
1
1
  import { default as React } from 'react';
2
2
  import { IBorders, IRange, ICell } from '@sheetxl/sdk';
3
+ import { ReactUtils } from '@sheetxl/utils-react';
3
4
  import { IGridPane, IGridMetrics } from '@sheetxl/grid-react';
4
5
  export interface BorderRenderProps {
5
6
  stroke: IBorders.IStroke;
6
7
  range: IRange.Coords;
8
+ /**
9
+ * `[x, y, x2, y2]`. For a diagonal these are its two corners.
10
+ */
7
11
  points: number[];
8
12
  key: string;
9
13
  /**
10
14
  * Which cell edge this stroke belongs to. Trailing edges (right/bottom) are
11
15
  * shifted to sit after the divider; leading edges (left/top) sit before it.
16
+ * {@link IBorders.Edge.DiagonalUp} and {@link IBorders.Edge.DiagonalDown} run corner to corner.
12
17
  */
13
18
  edge?: IBorders.Edge;
14
19
  /**
@@ -41,6 +46,47 @@ export interface BorderRenderProps {
41
46
  */
42
47
  endExtend?: number;
43
48
  }
49
+ /**
50
+ * Which lines a {@link useBorders} layer draws.
51
+ *
52
+ * - `direct`: the borders cells carry, plus {@link UseBorderOptions.normalRows} /
53
+ * {@link UseBorderOptions.normalColumns} as the Normal style's border — a border on every cell,
54
+ * blank ones included, so it draws above the fills like any other border.
55
+ * - `normal`: only the normal lines, below the cell fills so a fill hides them — the gridlines.
56
+ *
57
+ * Either way a normal line is drawn only where no cell border owns the edge.
58
+ */
59
+ export type UseBordersMode = 'direct' | 'normal';
60
+ /**
61
+ * One axis' line for a {@link UseBordersMode | normal} layer.
62
+ */
63
+ export interface BorderNormalLine {
64
+ /** CSS color. */
65
+ color: string;
66
+ /**
67
+ * Width in device pixels.
68
+ *
69
+ * @defaultValue 1
70
+ */
71
+ width?: number;
72
+ /** Dash pattern in CSS px; solid when omitted. */
73
+ dashArray?: readonly number[] | null;
74
+ /** Two parallel lines, open where they cross. */
75
+ isDouble?: boolean;
76
+ /**
77
+ * The side of the boundary an even width grows toward.
78
+ *
79
+ * @defaultValue 'leading'
80
+ */
81
+ edge?: ReactUtils.EdgeKind;
82
+ }
83
+ /**
84
+ * The {@link BorderNormalLine} that draws `stroke`, or `null` for none.
85
+ *
86
+ * @param stroke The stroke.
87
+ * @param edge The edge the stroke comes from; decides which way an even width grows.
88
+ */
89
+ export declare const toBorderNormalLine: (stroke: IBorders.IStroke | null | undefined, edge: IBorders.Edge) => BorderNormalLine | null;
44
90
  export interface UseBorderOptions {
45
91
  /**
46
92
  * Returns a list of visible cells.
@@ -61,6 +107,14 @@ export interface UseBorderOptions {
61
107
  * @returns The IBorders at the location.
62
108
  */
63
109
  getBorderAt?: (value: any, index: number) => IBorders;
110
+ /**
111
+ * The merged range a cell belongs to, or `null` when it is not merged. A merged cell's diagonals
112
+ * run corner to corner across the whole merge. When omitted every cell is its own box.
113
+ *
114
+ * @param value The value returned from `getVisibleCells`.
115
+ * @param index The index of that value.
116
+ */
117
+ getMergeAt?: (value: any, index: number) => IRange.Coords | null;
64
118
  /**
65
119
  * Allow users to customize border rendering.
66
120
  * Note - This is wrapped in a single SVG so must be an SVG Element type (like a path).
@@ -72,16 +126,54 @@ export interface UseBorderOptions {
72
126
  * Use for previews.
73
127
  */
74
128
  forceThinBorder?: boolean;
129
+ /**
130
+ * @defaultValue 'direct'
131
+ */
132
+ mode?: UseBordersMode;
133
+ /**
134
+ * The horizontal line drawn where no cell border owns the boundary (see {@link UseBordersMode}).
135
+ * `null` draws none.
136
+ */
137
+ normalRows?: BorderNormalLine | null;
138
+ /**
139
+ * The vertical line drawn where no cell border owns the boundary (see {@link UseBordersMode}).
140
+ * `null` draws none.
141
+ */
142
+ normalColumns?: BorderNormalLine | null;
143
+ /**
144
+ * Shared by layers that draw the same cells, so the cells are read into borders once for all of
145
+ * them. Layers share a read when `getVisibleCells` returns the same array and `getBorderAt`,
146
+ * `getMergeAt`, and `defaultColor` are the same.
147
+ */
148
+ cache?: BordersCache;
75
149
  }
150
+ declare const _BordersCacheBrand: unique symbol;
151
+ /**
152
+ * Lets several {@link useBorders} layers share the work of reading their cells into borders. Create
153
+ * one with {@link createBordersCache} and pass it to each layer as {@link UseBorderOptions.cache}.
154
+ */
155
+ export interface BordersCache {
156
+ readonly [_BordersCacheBrand]: true;
157
+ }
158
+ /**
159
+ * A new {@link BordersCache}.
160
+ */
161
+ export declare const createBordersCache: () => BordersCache;
76
162
  export interface UseBorderResults {
77
163
  /**
78
- * Array of functions that return components to overlay
164
+ * Draws a pane's borders, or `null` when it has none.
79
165
  */
80
- renderLayer?: (props: React.HTMLProps<HTMLDivElement>, pane: IGridPane) => React.ReactNode;
166
+ renderLayer?: (pane: IGridPane) => React.ReactNode;
81
167
  }
82
168
  /**
83
169
  * useBorders
84
170
  * Renders borders by combining individual cells border attributes.
171
+ *
172
+ * @remarks
173
+ * A double is drawn as one solid band with its center cut out by a mask. Each cut runs to the
174
+ * center of the double it meets, so two doubles open into each other where they cross, tee or
175
+ * turn a corner. Strokes that are not double are outside the mask and never cut.
85
176
  */
86
- export declare const useBorders: ({ getBorderAt, rendererBorder, getVisibleCells: propGetVisibleCells, forceThinBorder, defaultColor, }: UseBorderOptions) => UseBorderResults;
177
+ export declare const useBorders: ({ getBorderAt, getMergeAt, rendererBorder, getVisibleCells: propGetVisibleCells, forceThinBorder, defaultColor, mode, normalRows, normalColumns, cache }: UseBorderOptions) => UseBorderResults;
178
+ export {};
87
179
  //# sourceMappingURL=useBorders.d.ts.map
@@ -0,0 +1,20 @@
1
+ import { default as React } from 'react';
2
+ import { CellContentEntry, CellContentRendererProps } from './CellRenderers';
3
+ /**
4
+ * The checkbox cell control: `TRUE` draws checked, `FALSE` and blank draw unchecked, and a press on
5
+ * the box writes the other.
6
+ *
7
+ * @remarks
8
+ * The box takes the cell's font color and scales with its font size, and sits centered on the line
9
+ * the cell's text would paint in. Under General alignment it is centered, as Excel centers a
10
+ * boolean; an explicit left or right alignment moves it to that edge.
11
+ * A formula cell draws the box but takes no press: it is drawn disabled, and a press on it selects
12
+ * the cell as a press on any cell does.
13
+ */
14
+ export declare const CellCheckboxRenderer: (props: CellContentRendererProps) => React.ReactElement;
15
+ /**
16
+ * What the checkbox control contributes to the UI: the box, the press that writes the other value,
17
+ * and Space, which toggles every checkbox the selection touches.
18
+ */
19
+ export declare const CheckboxCellContent: CellContentEntry;
20
+ //# sourceMappingURL=CellCheckboxRenderer.d.ts.map
@@ -0,0 +1,68 @@
1
+ import { default as React } from 'react';
2
+ import { CellContentRendererProps } from './CellRenderers';
3
+ /**
4
+ * The value type whose General alignment {@link CellContent} follows: text sits left, a number
5
+ * right, a boolean centered.
6
+ */
7
+ export type CellContentAlignAs = 'text' | 'number' | 'boolean';
8
+ /**
9
+ * Props for {@link CellContent}: the renderer's own props, spread whole, plus what the host should
10
+ * do with them.
11
+ */
12
+ export interface CellContentProps extends CellContentRendererProps {
13
+ /**
14
+ * Where General alignment places the children: where it would place a value of this type. An
15
+ * explicit horizontal alignment on the cell places them instead.
16
+ *
17
+ * @defaultValue 'boolean'
18
+ */
19
+ alignAs?: CellContentAlignAs;
20
+ /**
21
+ * Makes the whole cell the hit region: the root carries
22
+ * {@link CellContentRendererProps.interactiveProps}. Leave it off and spread the props on the
23
+ * element inside that should take the pointer instead (a checkbox's box, a rating's stars).
24
+ */
25
+ interactive?: boolean;
26
+ /**
27
+ * Centers the children on the line the cell's text would paint in, rather than placing them
28
+ * against the content box: the cell's vertical alignment, font and row height move them as they
29
+ * move text. For content sized to the font that sits beside text (a checkbox, a slider). Content
30
+ * taller than the room about the line is centered on it and may be shrunk by `max-height`.
31
+ */
32
+ centerOnTextLine?: boolean;
33
+ /**
34
+ * Places the children inside the cell's text insets, the padding text gets. Turn it off for
35
+ * content that runs to the cell's edges, such as a picture or a button.
36
+ *
37
+ * @defaultValue true
38
+ */
39
+ inset?: boolean;
40
+ /** The cell's content. */
41
+ children?: React.ReactNode;
42
+ }
43
+ /**
44
+ * The host a content renderer draws into: the cell's root, placed by the layer, with the renderer's
45
+ * props stripped of what is not for the DOM, its children placed in the cell's content box by the
46
+ * cell's alignment, in the cell's font color and size.
47
+ *
48
+ * @remarks
49
+ * Spread the renderer's props onto it whole and put what the cell shows inside:
50
+ *
51
+ * ```tsx
52
+ * const StarsRenderer: CellContentRenderer = (props) => (
53
+ * <CellContent {...props} alignAs="text">
54
+ * <div {...props.interactiveProps}>★★★☆☆</div>
55
+ * </CellContent>
56
+ * );
57
+ * ```
58
+ *
59
+ * It is a component, so a renderer that uses it is one fiber per cell inside a cached tile; the
60
+ * layer calls the renderer itself as a plain function. A renderer that replaces the text and
61
+ * positions nothing of its own needs nothing else; one that decorates the text wraps
62
+ * {@link CellContentRendererProps.Default} instead, which is its own root.
63
+ */
64
+ export declare const CellContent: {
65
+ (props: CellContentProps): React.ReactElement;
66
+ displayName: string;
67
+ };
68
+ //# sourceMappingURL=CellContent.d.ts.map
@@ -0,0 +1,37 @@
1
+ import { ICell, ICellRange, IWorksheet, Scalar } from '@sheetxl/sdk';
2
+ import { IReactNotifier } from '@sheetxl/utils-react';
3
+ import { EditRejectedNotice } from '../editor/useEditRejectedNotice';
4
+ /**
5
+ * What a cell content entry writes through: guarded writes into the sheet, and the notifier for
6
+ * anything else it has to say. One per layer; every entry of the layer shares it.
7
+ */
8
+ export interface CellControlContext {
9
+ sheet: IWorksheet;
10
+ notifier: IReactNotifier;
11
+ /**
12
+ * Writes `value` into `cell`.
13
+ *
14
+ * @returns `false` when the cell refuses the write: it holds a formula, or it is locked on a
15
+ * protected sheet (the user is told why).
16
+ */
17
+ setCellValue(cell: ICell, value: Scalar): boolean;
18
+ /**
19
+ * Writes `value` into every cell of `range` that holds no formula, in one operation.
20
+ *
21
+ * @returns `false` when nothing was written: every cell holds a formula, or the sheet refused
22
+ * (a locked cell on a protected sheet; the user is told why).
23
+ */
24
+ setRangeValue(range: ICellRange, value: Scalar): boolean;
25
+ }
26
+ /** What {@link createCellControlContext} binds. */
27
+ export interface CellControlContextOptions {
28
+ sheet: IWorksheet;
29
+ notifier: IReactNotifier;
30
+ /** The Excel-style heads-up for a write the sheet's protection refuses. */
31
+ notifyEditRejected: EditRejectedNotice;
32
+ }
33
+ /**
34
+ * Creates the {@link CellControlContext} of a layer.
35
+ */
36
+ export declare function createCellControlContext(options: CellControlContextOptions): CellControlContext;
37
+ //# sourceMappingURL=CellControlContext.d.ts.map