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

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/6lfBozPNyWlFBEDn.mjs +19 -0
  3. package/browser/esm/B7TCFLHs7nnOgLMi.mjs +79 -0
  4. package/browser/esm/BQur1iFrng9Y4kh4.mjs +2706 -0
  5. package/browser/esm/BjnWnPjhT1QFkbUC.mjs +60 -0
  6. package/browser/esm/BwMC6jAg2neI4LTH.mjs +32 -0
  7. package/browser/esm/BzCq_Z7J2qQlY4Dp.mjs +134 -0
  8. package/browser/esm/BzFKdDmdCdg3cXdh.mjs +262 -0
  9. package/browser/esm/C2HjD-DbaqXq93R7.mjs +45 -0
  10. package/browser/esm/C46qV9hBGqlz6_Kt.mjs +323 -0
  11. package/browser/esm/C9dHNoiKtX9PLY1g.mjs +20 -0
  12. package/browser/esm/CA6w64diOtRCgr4n.mjs +67 -0
  13. package/browser/esm/CCL3pFmdsuwahoCR.mjs +42 -0
  14. package/browser/esm/CHgyrBEiFmspcFXV.mjs +8 -0
  15. package/browser/esm/CPwcEeQtvkrESNEy.mjs +303 -0
  16. package/browser/esm/CdE8JeJkTtdh5qqp.mjs +78 -0
  17. package/browser/esm/CkYId3pjG9v3XZM2.mjs +36 -0
  18. package/browser/esm/Co65nK3fyBcyVzrS.mjs +401 -0
  19. package/browser/esm/DG1f60gvSkz8Y3qb.mjs +197 -0
  20. package/browser/esm/DL2WZkJdK1lZfpJo.mjs +341 -0
  21. package/browser/esm/Dl0ye0MfTml4mjhA.mjs +9560 -0
  22. package/browser/esm/_T8e_9xhVAagwkPD.mjs +31 -0
  23. package/browser/esm/chart.mjs +41 -0
  24. package/browser/esm/control.mjs +217 -0
  25. package/browser/esm/fHDciYUZvXpLzoID.mjs +128 -0
  26. package/browser/esm/group.mjs +123 -0
  27. package/browser/esm/index.mjs +22374 -13204
  28. package/browser/esm/k1IvXgw5-153QQUo.mjs +14092 -0
  29. package/browser/esm/mOYnwl3MMod-yX7a.mjs +63 -0
  30. package/browser/esm/note.mjs +112 -0
  31. package/browser/esm/picture.mjs +7 -0
  32. package/browser/esm/shape.mjs +7 -0
  33. package/browser/esm/slicer.mjs +277 -0
  34. package/browser/esm/zTaXN_1rvsoWg94m.mjs +145 -0
  35. package/licenses/dependencies.txt +284 -565
  36. package/node/esm/8PerdW56-NyRf0pg.mjs +134 -0
  37. package/node/esm/B2a1mRx9B8XMRd8H.mjs +2706 -0
  38. package/node/esm/B4qJFO-8Vml8JbaC.mjs +146 -0
  39. package/node/esm/BBBfGP0lLhBFoR9F.mjs +198 -0
  40. package/node/esm/BQpm93aEyzN5TiU6.mjs +8 -0
  41. package/node/esm/BadjRr_jKKGvmEW-.mjs +80 -0
  42. package/node/esm/Bzuh8HcJcFD2dYTY.mjs +128 -0
  43. package/node/esm/CD1OBtF4vEthYy6e.mjs +35 -0
  44. package/node/esm/CGEbcsNJ40cYQEWX.mjs +1697 -0
  45. package/node/esm/CNYzecnb2TInTI8p.mjs +80 -0
  46. package/node/esm/COg8aOu0d67g_Pg5.mjs +37 -0
  47. package/node/esm/CdKkuM4Yy04LbhRL.mjs +19 -0
  48. package/node/esm/Df-nWyFJwXaVd79x.mjs +263 -0
  49. package/node/esm/DtrPF3bSD4CZC5VG.mjs +45 -0
  50. package/node/esm/EXPN4LM0alUK5Zw7.mjs +20 -0
  51. package/node/esm/JrDkDzP0l4TgHusH.mjs +32 -0
  52. package/node/esm/Mq8a4csdTfwY5CnZ.mjs +63 -0
  53. package/node/esm/cgqViNUwnlIX8-UW.mjs +328 -0
  54. package/node/esm/chart.mjs +41 -0
  55. package/node/esm/control.mjs +217 -0
  56. package/node/esm/fM9xnrz0LJWdndYE.mjs +68 -0
  57. package/node/esm/group.mjs +123 -0
  58. package/node/esm/index.mjs +18717 -9431
  59. package/node/esm/note.mjs +113 -0
  60. package/node/esm/picture.mjs +305 -0
  61. package/node/esm/shape.mjs +342 -0
  62. package/node/esm/slicer.mjs +279 -0
  63. package/node/esm/tRhXTPxocmY7ZY3z.mjs +66 -0
  64. package/node/esm/uzlKB6H0b-ol8pDK.mjs +406 -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,17 @@
1
+ import { ReactElement } from 'react';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
+ export interface MovableKindScopeProps {
4
+ sheet: IWorksheet;
5
+ /** The movable layer's z. The kind's scope joins the pane's chain just above it. */
6
+ order: number;
7
+ }
8
+ /**
9
+ * The scope and contextual tab of the active movable's kind. While a movable is the active selection,
10
+ * its kind's `commands` run in a scope named for the content type, stacked just above the `movable`
11
+ * scope so they out-resolve it, and its `toolbar` is shown in the main toolbar strip; a kind that
12
+ * brings no tab gets the default one ({@link createDefaultMovableToolbar}). Both follow the active
13
+ * movable and go when the selection clears; another movable of the same kind becoming active re-runs
14
+ * the commands with it. A kind whose module is still loading gets them when the load settles.
15
+ */
16
+ export declare const MovableKindScope: import('react').MemoExoticComponent<(props: MovableKindScopeProps) => ReactElement | null>;
17
+ //# sourceMappingURL=MovableKindScope.d.ts.map
@@ -0,0 +1,47 @@
1
+ import { default as React } from 'react';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
+ import { LayerProps } from '@sheetxl/grid-react';
4
+ import { PivotButtonConfigProps } from '../cell/PivotButton';
5
+ export interface PivotLayerProps extends LayerProps, PivotButtonConfigProps {
6
+ /** The sheet whose pivot tables' controls are rendered. */
7
+ sheet: IWorksheet;
8
+ }
9
+ /**
10
+ * The sheet's pivot table controls: each field's dropdown and each item's expand/collapse box, drawn
11
+ * where Excel draws them - a dropdown pinned to its cell's right edge, a box after its label's
12
+ * indent and before its text.
13
+ *
14
+ * @remarks
15
+ * Sits above the selection, as the table column buttons do: a layer above the hit is offered a press
16
+ * first, so below the selection a press would move it before the button could stop it. The tables'
17
+ * empty boxes and outlines are {@link PivotFrameLayer}'s, below the selection. With no pivot table in
18
+ * the pane's view it renders nothing.
19
+ *
20
+ * A cell layer fed a pivot-aware source, as the table column buttons are: one walk of the
21
+ * sheet's pivot tables per pane, `[]` when none is in view, emitting only the cells that hold a
22
+ * control. Where the cells are is the table's (from its definition, with no calculation), so the
23
+ * layer draws for a table the moment it is placed.
24
+ *
25
+ * The box sits in the gutter {@link ICell.getInsets} already reserves on a label, so the text,
26
+ * wrapping, best-fit and the editor all start after it without this layer telling them to. A
27
+ * press changes the table's definition through {@link IPivotTable.IField} / {@link IPivotTable.IItem};
28
+ * the table announces the change and the layer redraws. Presses never reach the grid, so they do not
29
+ * move the selection.
30
+ */
31
+ export declare const PivotLayer: React.MemoExoticComponent<(props: PivotLayerProps) => React.JSX.Element | null>;
32
+ export interface PivotFrameLayerProps extends LayerProps {
33
+ /** The sheet whose pivot tables are framed. */
34
+ sheet: IWorksheet;
35
+ }
36
+ /**
37
+ * The frame of the sheet's pivot tables: the outline of the hovered table and of the active cell's,
38
+ * as a table's, and over a table with no fields yet its name, a hint and a picture of a pivot table,
39
+ * as Excel draws over its empty box. The hint says to pick fields once the active cell is in the
40
+ * table, and to click into it until then.
41
+ *
42
+ * @remarks
43
+ * Passive paint below the selection, so the selection draws over it. The table's controls are
44
+ * {@link PivotLayer}'s. With no pivot table in the pane's view it renders nothing.
45
+ */
46
+ export declare const PivotFrameLayer: React.MemoExoticComponent<(props: PivotFrameLayerProps) => React.JSX.Element | null>;
47
+ //# sourceMappingURL=PivotLayer.d.ts.map
@@ -0,0 +1,29 @@
1
+ import { default as React } from 'react';
2
+ import { IPivotTable, IWorksheet } from '@sheetxl/sdk';
3
+ import { LayerProps } from '@sheetxl/grid-react';
4
+ import { RangeToolbarRenderProps } from './RangeToolbar';
5
+ /** What the pivot table toolbar is handed. */
6
+ export interface PivotToolbarRenderProps extends RangeToolbarRenderProps {
7
+ /**
8
+ * The hovered pivot table. A press anywhere on the toolbar first puts the selection in it when it
9
+ * is elsewhere, so the PivotTable tab and its pane follow.
10
+ */
11
+ pivot: IPivotTable;
12
+ }
13
+ /** Props for {@link PivotToolbarLayer}. */
14
+ export interface PivotToolbarLayerProps extends LayerProps {
15
+ sheet: IWorksheet;
16
+ /**
17
+ * The toolbar that floats at a hovered pivot table's top-right corner.
18
+ * @defaultValue a plain split button: edit the pivot table · a menu of its commands
19
+ */
20
+ renderToolbar?: ((props: PivotToolbarRenderProps) => React.ReactNode) | null;
21
+ }
22
+ /**
23
+ * The **pivot table toolbar**: hover a pivot table, its body or the page fields above it, and its
24
+ * commands float at its top-right corner, a quick action (edit it) and a dropdown of the rest, as the
25
+ * {@link TableToolbarFloat table toolbar} does for a table. The layer finds the hovered table itself;
26
+ * the float is a {@link RangeToolbarFloat}.
27
+ */
28
+ export declare const PivotToolbarLayer: React.MemoExoticComponent<(props: PivotToolbarLayerProps) => React.ReactElement>;
29
+ //# sourceMappingURL=PivotToolbar.d.ts.map
@@ -1,6 +1,5 @@
1
- import { default as React } from 'react';
2
1
  import { RangeCoordValue } from '@sheetxl/utils';
3
- import { ICellRegion, ISheet, ISheetView } from '@sheetxl/sdk';
2
+ import { ICellRegion, IWorksheet, IWorksheetView } from '@sheetxl/sdk';
4
3
  import { LayerProps } from '@sheetxl/grid-react';
5
4
  /**
6
5
  * The regions to punch out of the hatch, coalesced by appearance.
@@ -26,9 +25,9 @@ export interface ProtectionLayerProps extends LayerProps {
26
25
  /** Class for the layer (devtools identification). */
27
26
  className?: string;
28
27
  /** The sheet whose locked area is hatched. */
29
- sheet: ISheet;
28
+ sheet: IWorksheet;
30
29
  /** The view carrying `isShowLockedShading()` — the toggle this layer draws for. */
31
- sheetView: ISheetView;
30
+ sheetView: IWorksheetView;
32
31
  }
33
32
  /**
34
33
  * The **locked-cell hatch** — the sheet's protected area, with the unlocked ranges cut out of it.
@@ -48,5 +47,5 @@ export interface ProtectionLayerProps extends LayerProps {
48
47
  *
49
48
  * Passive paint (`pointerEvents: none`), below the selection.
50
49
  */
51
- export declare const ProtectionLayer: React.MemoExoticComponent<(props: ProtectionLayerProps) => React.JSX.Element | null>;
50
+ export declare const ProtectionLayer: import('react').MemoExoticComponent<(props: ProtectionLayerProps) => import("react").JSX.Element | null>;
52
51
  //# sourceMappingURL=ProtectionLayer.d.ts.map
@@ -0,0 +1,75 @@
1
+ import { default as React } from 'react';
2
+ import { IRange, IWorksheet, ICell } from '@sheetxl/sdk';
3
+ import { HoverTipProps, StickyState } from '@sheetxl/grid-react';
4
+ /**
5
+ * What a toolbar floated over a hovered range is handed, whatever the range holds. Each kind adds
6
+ * the object it floats over: {@link TableToolbarRenderProps}, {@link PivotToolbarRenderProps}.
7
+ */
8
+ export interface RangeToolbarRenderProps {
9
+ sheet: IWorksheet;
10
+ /** Spread onto the toolbar root: it takes the pointer, and hovering it keeps the toolbar up. */
11
+ floatProps: HoverTipProps;
12
+ /**
13
+ * Keep the toolbar up while something it opened has the pointer, its dropdown. Call `true` when the
14
+ * dropdown opens and `false` when it closes.
15
+ */
16
+ setHeld: (held: boolean) => void;
17
+ state: StickyState;
18
+ }
19
+ /** An object a toolbar floats over: a table, a pivot table. */
20
+ interface Hoverable {
21
+ isDeleted(): boolean;
22
+ getName(): string;
23
+ }
24
+ /** What {@link RangeToolbarFloat} takes of the kind of object it floats over. */
25
+ export interface RangeToolbarFloatProps<T extends Hoverable> {
26
+ /** The float's name, unique per kind. */
27
+ name: string;
28
+ sheet: IWorksheet;
29
+ /** The object under the pointer, or `null`. */
30
+ hovered: T | null;
31
+ /** The cells the toolbar floats beside. */
32
+ rangeOf: (object: T) => IRange.Coords;
33
+ /** Whether the active cell is in the object already, so a press on the toolbar selects nothing. */
34
+ contains: (object: T, cell: ICell.Coords) => boolean;
35
+ /** Puts the selection in the object. */
36
+ select: (object: T) => void;
37
+ /** Draws the toolbar for the object, with what every toolbar is handed. */
38
+ render: (object: T, props: RangeToolbarRenderProps) => React.ReactNode;
39
+ }
40
+ /**
41
+ * A toolbar floated at a hovered object's top-right: a {@link VirtualRangeFloat} opened by hover but
42
+ * not a tooltip (it outlives a tip opening beside it and a press on its own buttons), `clamp`ed so it
43
+ * stays on screen while the object's top is scrolled away, and gone while a cell is edited.
44
+ *
45
+ * @remarks
46
+ * The commands act on the object under the active cell, so a press on the toolbar first puts the
47
+ * selection in the hovered object when it is elsewhere. While something it opened is up the toolbar
48
+ * is held (`setHeld`), as the pointer is there, not on the toolbar.
49
+ */
50
+ export declare const RangeToolbarFloat: <T extends Hoverable>(props: RangeToolbarFloatProps<T>) => React.ReactElement;
51
+ /** Draws a toolbar slot: the host's renderer, the default when it gives none, nothing for `null`. */
52
+ export declare const renderToolbarSlot: <P>(render: ((props: P) => React.ReactNode) | null | undefined, fallback: (props: P) => React.ReactNode, props: P) => React.ReactNode;
53
+ /** What {@link RangeToolbarSplitButton} is handed. */
54
+ export interface RangeToolbarSplitButtonProps {
55
+ /** The object the commands take. */
56
+ target: Hoverable;
57
+ /** The quick action first, then the dropdown's commands, by key. */
58
+ commandKeys: readonly string[];
59
+ /** The quick action's color. */
60
+ color: string;
61
+ /** The quick action's icon. */
62
+ iconKey: string;
63
+ /** The dropdown's float name. */
64
+ menuName: string;
65
+ floatProps: HoverTipProps;
66
+ setHeld: (held: boolean) => void;
67
+ }
68
+ /**
69
+ * The plain toolbar, with no UI kit: a quick action in the object's color and a dropdown listing it
70
+ * and the other commands. The dropdown opens in the float stack, so it closes under a context menu
71
+ * like any popup, and holds the toolbar up while open.
72
+ */
73
+ export declare const RangeToolbarSplitButton: React.FC<RangeToolbarSplitButtonProps>;
74
+ export {};
75
+ //# sourceMappingURL=RangeToolbar.d.ts.map
@@ -1,19 +1,20 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
+ import { LayerProps } from '@sheetxl/grid-react';
3
4
  /**
4
5
  * Props for {@link ResizeIndicator}.
5
6
  */
6
- export interface ResizeIndicatorProps {
7
- /** The sheet — for the unit readout (header scale factor) and the entire-range extent. */
8
- sheet: ISheet;
7
+ export interface ResizeIndicatorProps extends Omit<LayerProps, 'children'> {
8
+ /** The sheet — for the entire-range extent. */
9
+ sheet: IWorksheet;
9
10
  }
10
11
  /**
11
12
  * The **main-grid overlay** for an in-progress header resize: the before/after guide-lines that span the
12
- * body plus the live size tooltip. It's a self-contained grid layer — it reads the gesture from
13
- * `useSurfaceState` (published by {@link HeaderResizerLayer} in the header surface, shared via the sheet's
14
- * `SurfaceStateProvider`) and the pane from context, so it mounts as a plain child of the grid with no
15
- * render-prop bridge. Rendered once per pane; each pane draws its own clipped slice of the lines, and the
16
- * tooltip ({@link StickyFloat}) self-gates to a single owner pane.
13
+ * body. It's a self-contained grid layer — it reads the gesture from `useSurfaceState` (published by
14
+ * {@link HeaderResizerLayer} in the header surface, shared via the sheet's `SurfaceStateProvider`) and the
15
+ * pane from context, so it mounts as a plain child of the grid with no render-prop bridge. Rendered once
16
+ * per pane; each pane draws its own clipped slice of the lines. The size tooltip belongs to the header
17
+ * ({@link ResizeTooltip}).
17
18
  */
18
- export declare const ResizeIndicator: React.MemoExoticComponent<(props: ResizeIndicatorProps) => React.JSX.Element | null>;
19
+ export declare const ResizeIndicator: React.MemoExoticComponent<(props: ResizeIndicatorProps) => React.JSX.Element>;
19
20
  //# sourceMappingURL=ResizeIndicator.d.ts.map
@@ -0,0 +1,13 @@
1
+ import { ISheetHeader } from '@sheetxl/sdk';
2
+ export interface ResizeTooltipProps {
3
+ /** The header being resized. */
4
+ sheetHeader: ISheetHeader;
5
+ }
6
+ /**
7
+ * The size tooltip of an in-progress header resize, anchored to the header being resized. Renders inside a
8
+ * header's layer: the header lays out every move of the drag, so the tooltip stays centered on the size
9
+ * being dragged. Reads the gesture published by {@link HeaderResizerLayer}. A {@link GestureTip}: it holds
10
+ * the tooltip group for the drag and self-gates to one owner pane.
11
+ */
12
+ export declare const ResizeTooltip: import('react').MemoExoticComponent<(props: ResizeTooltipProps) => import("react").JSX.Element>;
13
+ //# sourceMappingURL=ResizeTooltip.d.ts.map
@@ -1,4 +1,4 @@
1
- import { ISheet } from '@sheetxl/sdk';
1
+ import { IWorksheet } from '@sheetxl/sdk';
2
2
  import { LayerProps } from '@sheetxl/grid-react';
3
3
  export interface SheetBackgroundLayerProps extends LayerProps {
4
4
  /** Class for the background box (devtools identification). */
@@ -6,7 +6,7 @@ export interface SheetBackgroundLayerProps extends LayerProps {
6
6
  /** Style for the background box. */
7
7
  style?: React.CSSProperties;
8
8
  /** The sheet whose background picture (a tiled fill rendered behind the cells) is rendered. */
9
- sheet: ISheet;
9
+ sheet: IWorksheet;
10
10
  }
11
11
  /**
12
12
  * Renders the sheet's background.
@@ -16,7 +16,7 @@ export interface SheetBackgroundLayerProps extends LayerProps {
16
16
  * through to the cells. The tile pattern is anchored to the sheet's A1 origin — the pane's screen
17
17
  * position for cell `0,0` encodes the current scroll offset — so it scrolls with the content (one
18
18
  * instance per pane). The caller adds this layer only when a picture is present (see
19
- * `ISheet.getPicture`) and places it FIRST, so it sits at the bottom of the z-stack.
19
+ * `IWorksheet.getPicture`) and places it FIRST, so it sits at the bottom of the z-stack.
20
20
  */
21
21
  export declare const SheetBackgroundLayer: import('react').NamedExoticComponent<SheetBackgroundLayerProps & import('react').RefAttributes<HTMLDivElement>>;
22
22
  //# sourceMappingURL=SheetBackgroundLayer.d.ts.map
@@ -1,16 +1,17 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet, ISheetView } from '@sheetxl/sdk';
2
+ import { IWorksheet, IWorksheetView } from '@sheetxl/sdk';
3
3
  import { CellRendererProps, IEditable, LayerProps } from '@sheetxl/grid-react';
4
- import { SheetCellRendererProps, ColumnButtonConfigProps } from '../cell';
4
+ import { CellTextRendererProps, ColumnButtonConfigProps, PivotButtonConfigProps } from '../cell';
5
+ import { EditRejectedNotice } from '../editor/useEditRejectedNotice';
5
6
  export interface SheetCellLayerProps extends LayerProps {
6
7
  /** Class for the layer (devtools identification). */
7
8
  className?: string;
8
9
  /** The sheet whose cells are rendered. */
9
- sheet: ISheet;
10
+ sheet: IWorksheet;
10
11
  /** The sheet view — drives show-zeros / show-formulas (which cells are worth rendering). */
11
- sheetView: ISheetView;
12
+ sheetView: IWorksheetView;
12
13
  /**
13
- * Custom per-cell renderer. Default: {@link SheetCellRenderer} wired to the sheet (doc theme,
14
+ * Custom per-cell renderer. Default: {@link CellTextRenderer} wired to the sheet (doc theme,
14
15
  * hyperlink taps, formula-view flags) — the layer owns cell styling, so most hosts never pass this.
15
16
  */
16
17
  renderCell?: (props: CellRendererProps) => React.ReactNode;
@@ -19,13 +20,19 @@ export interface SheetCellLayerProps extends LayerProps {
19
20
  * column-button members ride along on the shared type but are consumed by
20
21
  * `SheetColumnButtonLayer`, not here — they are stripped before the spread.
21
22
  */
22
- propsCellRender?: Partial<SheetCellRendererProps> & ColumnButtonConfigProps;
23
+ propsCellRender?: Partial<CellTextRendererProps> & ColumnButtonConfigProps & PivotButtonConfigProps;
23
24
  /**
24
25
  * The shared editable. Subscribed so the edited cell is suppressed while its editor is open —
25
26
  * via the layer's live CSS channel (`suppressCell`), so no tile is ever invalidated by an edit
26
27
  * start/stop and the grid above is never touched.
27
28
  */
28
29
  editable: IEditable<any, any, any>;
30
+ /**
31
+ * Told when a cell control's write is refused, as a click on a checkbox in a locked cell is.
32
+ * Share the host's callback ({@link useEditRejectedNotice}) so every pane forms one notice scope.
33
+ * @defaultValue this layer's own {@link useEditRejectedNotice}
34
+ */
35
+ onEditRejected?: EditRejectedNotice;
29
36
  }
30
37
  /**
31
38
  * The sheet's cell layer.
@@ -39,9 +46,9 @@ export interface SheetCellLayerProps extends LayerProps {
39
46
  * Beside the immutable tile snapshots ({@link CellTileDiv}) the layer owns the two LIVE per-cell
40
47
  * concerns that must never touch a tile:
41
48
  * - the edited cell is suppressed while its editor is open (live CSS `suppressCell` channel);
42
- * - **formula view** ({@link ISheetView.isShowFormulas}): when the selection anchor sits on a
49
+ * - **formula view** ({@link IWorksheetView.isShowFormulas}): when the selection anchor sits on a
43
50
  * formula cell, that cell's plain snapshot is suppressed through the SAME channel and a
44
- * tokenized, syntax-colored {@link FormulaCellRenderer} overlay is drawn in its place — the
51
+ * tokenized, syntax-colored {@link CellFormulaRenderer} overlay is drawn in its place — the
45
52
  * references themselves are outlined by `SheetReferenceLayer`, both keyed off
46
53
  * {@link useFormulaViewAnchor} so text and rectangles share colors.
47
54
  */
@@ -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 { ColumnButtonConfigProps } from '../cell/ColumnButton';
5
5
  export interface SheetColumnButtonLayerProps extends LayerProps, ColumnButtonConfigProps {
6
6
  /** The sheet whose table column (filter/sort) buttons are rendered. */
7
- sheet: ISheet;
7
+ sheet: IWorksheet;
8
8
  }
9
9
  /**
10
10
  * The sheet's column (filter/sort) button layer — a {@link CellLayer} (which roots the {@link Layer})
@@ -1,22 +1,32 @@
1
- import { default as React } from 'react';
2
- import { ISheet, ISheetView } from '@sheetxl/sdk';
3
- import { LayerProps } from '@sheetxl/grid-react';
1
+ import { ICell, IRange, IWorksheet, IWorksheetView } from '@sheetxl/sdk';
2
+ import { IGridPane, LayerProps } from '@sheetxl/grid-react';
3
+ import { BordersCache } from '../border';
4
4
  export interface SheetGridLineLayerProps extends LayerProps {
5
5
  /** The sheet whose gridlines are rendered. */
6
- sheet: ISheet;
7
- /** The sheet view — drives styling, per-axis visibility, and which cells are scanned (for merges). */
8
- sheetView: ISheetView;
6
+ sheet: IWorksheet;
7
+ /** The sheet view — drives styling and per-axis visibility. */
8
+ sheetView: IWorksheetView;
9
+ /**
10
+ * The cells in view, shared with the fill and border layers; their borders and their merges and
11
+ * overflow are what the lines break around.
12
+ */
13
+ getVisibleCells: (pane: IGridPane) => {
14
+ cell: ICell.Coords;
15
+ value?: ICell;
16
+ range?: IRange.Coords;
17
+ }[];
18
+ /** Shared with the {@link BorderLayer} that draws the same cells. */
19
+ bordersCache?: BordersCache;
9
20
  }
10
21
  /**
11
- * The sheet's gridline layer.
22
+ * The sheet's gridline layer: the view's gridline wherever no cell border owns the edge, so a
23
+ * dashed or double border never has a gridline under it. Sits below the fills, so a filled cell
24
+ * hides it. An axis whose Normal style has a border draws that border instead, in the
25
+ * {@link BorderLayer} (it is a border on every cell, and draws above the fills).
12
26
  *
13
- * @remarks
14
- * The line *styling* (color + the normal-style border edges baked into the line props) and per-axis
15
- * *visibility* are structural, so this layer self-subscribes to `onStyleChange` (sheet) + `onZoomScaleChange`
16
- * (view) and derives them from the sheet's normal style and the view's gridline color / zoom / show flags —
17
- * decoupled from the grid above it. The *merges* the lines break around are data, so it also self-subscribes
18
- * to its pane's visible range via {@link useSheetVisibleCells} and re-renders itself on a data change (busting
19
- * the underlying grid-react {@link GridlineLayer} with its own token). One per pane.
27
+ * Self-subscribes to `onStyleChange` and `onLayoutChange` (sheet) and `onZoomScaleChange` (view)
28
+ * for the styling, per-axis visibility, and the cells it breaks around, and to data changes in its
29
+ * pane's visible range. One per pane.
20
30
  */
21
- export declare const SheetGridLineLayer: React.MemoExoticComponent<(props: SheetGridLineLayerProps) => React.JSX.Element>;
31
+ export declare const SheetGridLineLayer: import('react').MemoExoticComponent<(props: SheetGridLineLayerProps) => import("react").JSX.Element | null>;
22
32
  //# sourceMappingURL=SheetGridLineLayer.d.ts.map
@@ -8,6 +8,12 @@ export interface SheetHeaderCellLayerProps extends LayerProps {
8
8
  header: ISheetHeader;
9
9
  /** Per-header renderer (the sheet's `SheetHeaderRenderer` wrapping). */
10
10
  renderCell: (props: CellRendererProps) => React.ReactNode;
11
+ /**
12
+ * A styling input the layer cannot watch itself: a new value busts the label cache. The header
13
+ * element passes its filtered runs' revision (a filter set or cleared may hide no row, so no
14
+ * size change repaints for it).
15
+ */
16
+ invalidateToken?: unknown;
11
17
  }
12
18
  /**
13
19
  * The header's cell layer.
@@ -17,9 +23,12 @@ export interface SheetHeaderCellLayerProps extends LayerProps {
17
23
  * busting the underlying grid-react {@link CellLayer} with its own token — so it re-renders only itself,
18
24
  * not the header grid. Two triggers bump the token:
19
25
  *
20
- * - **size change** (`onSizesChange`) — alters what is visible/labeled;
26
+ * - **metrics change** (`onMetricsChange`) — alters what is visible/labeled;
21
27
  * - **selection change** — header labels are styled by selection (fill / weight / color), but the tiled
22
28
  * `CellLayer` cache survives scroll, so it must be dropped when *this header's* selected runs change.
29
+ *
30
+ * A third comes from the owner as `invalidateToken`: the rows a filter holds a condition over (the blue
31
+ * row numbers), which the header element reads and the layer cannot.
23
32
  * Gated on the runs {@link selectedRunsSignature} so it busts only when the styling would differ (not
24
33
  * on every active-cell move, and never on scroll — there is no per-frame range work).
25
34
  *
@@ -0,0 +1,171 @@
1
+ import { default as React } from 'react';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
+ /**
4
+ * A grid surface of a sheet: the cells, or one of the header strips. Each is its own grid, with its own
5
+ * layer stack.
6
+ */
7
+ export type SheetSurface = 'cells' | 'rowHeaders' | 'columnHeaders';
8
+ /**
9
+ * Provides the {@link SheetSurface} a surface's layers are rendered on.
10
+ *
11
+ * @internal
12
+ */
13
+ export declare const SheetSurfaceProvider: React.Provider<SheetSurface | null>;
14
+ /**
15
+ * The {@link SheetSurface} the calling layer is rendered on, or `null` outside a sheet's surfaces.
16
+ *
17
+ * @remarks
18
+ * Only a layer declared on more than one surface needs it, to render the part that belongs on each:
19
+ *
20
+ * ```tsx
21
+ * const surface = useGridSurface();
22
+ * if (surface === 'rowHeaders') return <MyButtons />;
23
+ * if (surface === 'cells') return <MyPreview />;
24
+ * return null;
25
+ * ```
26
+ */
27
+ export declare const useGridSurface: () => SheetSurface | null;
28
+ /**
29
+ * Which sheets a {@link SheetLayers} applies to: a sheet, sheets, or a test. Not names: a sheet can be
30
+ * renamed, and a name can be reused by another sheet.
31
+ */
32
+ export type SheetLayersFilter = IWorksheet | readonly IWorksheet[] | ((sheet: IWorksheet) => boolean);
33
+ export interface SheetLayersProps {
34
+ /**
35
+ * The sheets whose surfaces get the layers. Omitted, every sheet's do.
36
+ */
37
+ sheets?: SheetLayersFilter;
38
+ /**
39
+ * The surfaces the layers are rendered on. A layer on more than one reads which it is on with
40
+ * {@link useGridSurface}.
41
+ *
42
+ * @defaultValue 'cells'
43
+ */
44
+ surface?: SheetSurface | readonly SheetSurface[] | 'all';
45
+ /**
46
+ * The layers: each a grid child rooted in a `Layer`, as in a sheet's `layers`.
47
+ */
48
+ children?: React.ReactNode;
49
+ }
50
+ interface Entry {
51
+ sheets?: SheetLayersFilter;
52
+ surfaces: readonly SheetSurface[];
53
+ children: React.ReactNode;
54
+ }
55
+ /**
56
+ * The {@link SheetLayers} declared under one scope, in declaration order.
57
+ *
58
+ * @internal
59
+ */
60
+ export declare class SheetLayersRegistry {
61
+ private _entries;
62
+ private _listeners;
63
+ private _version;
64
+ set(id: string, entry: Entry): void;
65
+ delete(id: string): void;
66
+ get(id: string): Entry | undefined;
67
+ subscribe: (listener: () => void) => (() => void);
68
+ getVersion: () => number;
69
+ entries(): IterableIterator<[string, Entry]>;
70
+ private _changed;
71
+ }
72
+ /** Layers a plugin adds to sheets, through {@link DefaultSheetLayersRegistry}. */
73
+ export interface SheetLayersEntry {
74
+ /** Identifies the entry, for {@link ISheetLayersRegistry.unregister}. Case-insensitive. */
75
+ key: string;
76
+ /**
77
+ * The layers: one grid child or an array of them, each rooted in a `Layer` and each with its own
78
+ * `key`, as in a sheet's `layers`.
79
+ */
80
+ layers: React.ReactNode;
81
+ /** The sheets whose surfaces get the layers. Omitted, every sheet's do. */
82
+ sheets?: SheetLayersFilter;
83
+ /**
84
+ * The surfaces the layers are rendered on. A layer on more than one reads which it is on with
85
+ * {@link useGridSurface}.
86
+ *
87
+ * @defaultValue 'cells'
88
+ */
89
+ surface?: SheetSurface | readonly SheetSurface[] | 'all';
90
+ }
91
+ /** Adds layers to every sheet of every workbook element. */
92
+ export interface ISheetLayersRegistry {
93
+ /**
94
+ * Add layers to every sheet surface the entry names, for as long as it is registered.
95
+ *
96
+ * @param entry The layers, and where they go.
97
+ * @param replace Whether to replace an entry with the same key. Without it, a second entry with the
98
+ * same key throws. @defaultValue false
99
+ * @returns A function that removes this registration. It does nothing once the key is unregistered
100
+ * or registered again by someone else.
101
+ */
102
+ register(entry: SheetLayersEntry, replace?: boolean): () => void;
103
+ /**
104
+ * Remove an entry's layers from every sheet.
105
+ *
106
+ * @param key The entry's key.
107
+ * @returns Whether the entry was registered.
108
+ */
109
+ unregister(key: string): boolean;
110
+ }
111
+ /**
112
+ * The layers plugins add to sheets. Every sheet surface, in every workbook or sheet element, renders
113
+ * the registered layers that match it:
114
+ *
115
+ * ```tsx
116
+ * DefaultSheetLayersRegistry.register({ key: 'focus-cell', layers: <FocusCellLayer key="focus-cell" /> });
117
+ * ```
118
+ *
119
+ * @remarks
120
+ * A surface stacks its built-in layers, then the element's `layers`, then the registered layers in
121
+ * registration order, then those declared with {@link SheetLayers}. A layer's `zIndex` overrides that
122
+ * order. A registered layer is mounted on every sheet it matches, on each pane, so it renders an empty
123
+ * `Layer` while it has nothing to show.
124
+ */
125
+ export declare const DefaultSheetLayersRegistry: ISheetLayersRegistry;
126
+ /**
127
+ * The registry the {@link SheetLayers} under an element register with: the one of a scope above it, or
128
+ * its own. A workbook element resolves one around both its children and its sheet, and the sheet
129
+ * element inherits it; a standalone sheet element has its own. Provide it with
130
+ * {@link SheetLayersScope}.
131
+ *
132
+ * @internal
133
+ */
134
+ export declare const useSheetLayersRegistry: () => SheetLayersRegistry;
135
+ /**
136
+ * Provides a {@link SheetLayersRegistry} to the {@link SheetLayers} and surfaces under it.
137
+ *
138
+ * @internal
139
+ */
140
+ export declare const SheetLayersScope: React.Provider<SheetLayersRegistry | null>;
141
+ /**
142
+ * Declares layers for a sheet's surfaces, as children of a sheet (or workbook) element:
143
+ *
144
+ * ```tsx
145
+ * <WorksheetElement sheet={sheet}>
146
+ * <SheetLayers surface={['rowHeaders', 'cells']}>
147
+ * <CellInsertLayer />
148
+ * </SheetLayers>
149
+ * </WorksheetElement>
150
+ * ```
151
+ *
152
+ * @remarks
153
+ * It renders nothing where it is declared: each matching surface renders the layers as its own, on top
154
+ * of its built-in ones, so they read that surface's pane, sheet and state. A layer declared on several
155
+ * surfaces is mounted on each (and on each pane of a frozen sheet); its copies share state through
156
+ * `useSurfaceState`, which spans all of a sheet's surfaces.
157
+ *
158
+ * Layers of separate `SheetLayers` stack in declaration order, unless a layer sets `zIndex`.
159
+ */
160
+ export declare const SheetLayers: React.FC<SheetLayersProps>;
161
+ /**
162
+ * The layers added to one surface of a sheet, flattened into one list of grid children: those
163
+ * registered with {@link DefaultSheetLayersRegistry}, then those declared with {@link SheetLayers}.
164
+ *
165
+ * @internal
166
+ */
167
+ export declare const useSheetLayers: (sheet: IWorksheet | null | undefined, surface: SheetSurface,
168
+ /** The registry, when the caller provides it rather than sits under it. */
169
+ propRegistry?: SheetLayersRegistry) => React.ReactNode[];
170
+ export {};
171
+ //# sourceMappingURL=SheetLayers.d.ts.map
@@ -1,18 +1,19 @@
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
+ import { RenderSlotFn } from '@sheetxl/utils-react';
4
5
  import { IMovableLayerElement, MovableLayerProps, MovableElementProps } from '../movable';
5
6
  export interface SheetMovableLayerProps extends LayerProps {
6
7
  /** Class forwarded to the inner layer's host box (devtools identification). */
7
8
  className?: string;
8
- sheet: ISheet;
9
+ sheet: IWorksheet;
9
10
  /**
10
11
  * Render a movable element
11
12
  *
12
13
  * @param props The props for the movable element
13
14
  * @returns The rendered movable element
14
15
  */
15
- renderMovable: (props: MovableElementProps) => React.ReactElement;
16
+ renderMovable: RenderSlotFn<MovableElementProps>;
16
17
  /**
17
18
  * Props to pass to MovableLayer
18
19
  */
@@ -0,0 +1,40 @@
1
+ import { default as React } from 'react';
2
+ import { IRange, IWorksheet } from '@sheetxl/sdk';
3
+ import { LayerProps } from '@sheetxl/grid-react';
4
+ import { OutlineButtonProps } from '../cell/OutlineButton';
5
+ export interface SheetOutlineLayerProps extends LayerProps {
6
+ /** The sheet whose outline is drawn. */
7
+ sheet: IWorksheet;
8
+ /** Rows or columns. */
9
+ axis: IRange.Axis;
10
+ /** The lanes across the gutter: one per level, plus one. */
11
+ lanes: number;
12
+ /** Renders a group's collapse / expand button. Defaults to `OutlineButton`. */
13
+ renderButton?: ((props: OutlineButtonProps) => React.ReactNode) | null;
14
+ /**
15
+ * The space around the buttons, in pixels: between neighbors, before the first and after the last.
16
+ *
17
+ * @defaultValue 1
18
+ */
19
+ laneGap?: number;
20
+ /**
21
+ * Space between a bracket's end and its button, in pixels.
22
+ *
23
+ * @defaultValue 0
24
+ */
25
+ bracketGap?: number;
26
+ }
27
+ /**
28
+ * The outline gutter's layer: for each group in view, a bracket beside its details and a button on
29
+ * its summary that collapses or expands it; and beside each detail header a dot, as Excel draws.
30
+ *
31
+ * @remarks
32
+ * Lane `level - 1` holds the groups of that level, outermost nearest the sheet edge. Groups come from
33
+ * {@link IOutline.getGroups} limited to the pane's visible span, so the work is per group in view. A
34
+ * collapsed group draws only its button. The dots are the gutter's cells: a {@link CellTileDiv} in
35
+ * this layer renders one per header the tiling engine finds in view, and a header at level `n` gets
36
+ * its dot in lane `n`, the lane after its deepest bracket, so a dot never sits on a line.
37
+ * Re-renders on scroll (the pane context) and on `onOutlineChange`.
38
+ */
39
+ export declare const SheetOutlineLayer: React.MemoExoticComponent<(props: SheetOutlineLayerProps) => React.JSX.Element>;
40
+ //# sourceMappingURL=SheetOutlineLayer.d.ts.map