@sheetxl/react 0.8.0-beta.9 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (398) hide show
  1. package/LICENSE.md +8 -7
  2. package/browser/esm/2YDUWXaXpl9cdsk7.mjs +8 -0
  3. package/browser/esm/64NfoZ1s7Oe3vdpX.mjs +60 -0
  4. package/browser/esm/BJDz5J4gFUEYi1Wz.mjs +36 -0
  5. package/browser/esm/B_CI6xMNropeWGgr.mjs +134 -0
  6. package/browser/esm/BgA4Cz8iMysciFOb.mjs +45 -0
  7. package/browser/esm/BkG6VuJDmu_hfIo6.mjs +31 -0
  8. package/browser/esm/BmO7yh4NjxeJylOD.mjs +14092 -0
  9. package/browser/esm/BwFFSeqtE3TIuvtc.mjs +341 -0
  10. package/browser/esm/CENTtj0PnF_tvpST.mjs +79 -0
  11. package/browser/esm/CVY0-_x6IgpdUVNp.mjs +264 -0
  12. package/browser/esm/CdyivRoMgPXvRiiE.mjs +197 -0
  13. package/browser/esm/CiylJlRA7mt8yjPD.mjs +128 -0
  14. package/browser/esm/D9CTIGFUbVGJkeVE.mjs +401 -0
  15. package/browser/esm/D9NgFucLwPgAQNgf.mjs +19 -0
  16. package/browser/esm/DdFOaG09eksHtKwT.mjs +145 -0
  17. package/browser/esm/DdHdNjRkzo1iShOo.mjs +78 -0
  18. package/browser/esm/DfIvpHB7HDdmIYNm.mjs +9560 -0
  19. package/browser/esm/DfNDtzixfTPjmoW_.mjs +32 -0
  20. package/browser/esm/Dtb9bOBjtPdUAr8x.mjs +20 -0
  21. package/browser/esm/Dz5pGpL4XWXVdntj.mjs +323 -0
  22. package/browser/esm/{Dk6274Lic6AOmEAq.mjs → SJAlYSFKC-5yNZ-C.mjs} +84 -2
  23. package/browser/esm/chart.mjs +41 -0
  24. package/browser/esm/control.mjs +217 -0
  25. package/browser/esm/group.mjs +123 -0
  26. package/browser/esm/index.mjs +21677 -15289
  27. package/browser/esm/jHqSboF5oFvzSM7a.mjs +63 -0
  28. package/browser/esm/note.mjs +112 -0
  29. package/browser/esm/oljQE8EpIzoxUjUz.mjs +323 -0
  30. package/browser/esm/picture.mjs +7 -0
  31. package/browser/esm/shape.mjs +7 -0
  32. package/browser/esm/slicer.mjs +282 -0
  33. package/browser/esm/w8MsScJSe7QxP6jL.mjs +67 -0
  34. package/browser/esm/yRqWQRSVyiR1kYh8.mjs +42 -0
  35. package/licenses/dependencies.txt +327 -53
  36. package/node/esm/1XOgrNXKQF__O9SV.mjs +8 -0
  37. package/node/esm/Aw6aaKE_YOA1Vi_V.mjs +146 -0
  38. package/node/esm/B6Oqu2Gw1pwWPf_N.mjs +328 -0
  39. package/node/esm/BizlElAhqg_Bc624.mjs +198 -0
  40. package/node/esm/C06Y1xPsbxgn3YX7.mjs +128 -0
  41. package/node/esm/C2dHN_gvhBxlFFnJ.mjs +45 -0
  42. package/node/esm/C4_5UcCdys1hzt5E.mjs +68 -0
  43. package/node/esm/CIidiDtqyubz13ys.mjs +80 -0
  44. package/node/esm/CTFb8PjwC1q6yilw.mjs +80 -0
  45. package/node/esm/C_GJPG-BTFhta8GD.mjs +265 -0
  46. package/node/esm/CdTeYrDgGp-s-KNG.mjs +134 -0
  47. package/node/esm/{B-5p0wwNM6Y5jlI2.mjs → CeMKhq6cSxfWzN5H.mjs} +84 -2
  48. package/node/esm/DJIBAu8bEDmlVjtD.mjs +20 -0
  49. package/node/esm/DUQ1PY9P63cTe_Es.mjs +37 -0
  50. package/node/esm/Db8NRp_kZ-FfkZaO.mjs +32 -0
  51. package/node/esm/Dl2kdvb4G_ddqeDN.mjs +19 -0
  52. package/node/esm/DlDr-o5nAZgPbn6R.mjs +1697 -0
  53. package/node/esm/DvRLP1lEBfwHBrEC.mjs +63 -0
  54. package/node/esm/JVlPlE1ys7DM3yCP.mjs +35 -0
  55. package/node/esm/NSddS40Vqf1xKdDd.mjs +406 -0
  56. package/node/esm/QqwCS9GFuDnQausz.mjs +66 -0
  57. package/node/esm/chart.mjs +41 -0
  58. package/node/esm/control.mjs +217 -0
  59. package/node/esm/group.mjs +123 -0
  60. package/node/esm/index.mjs +16970 -10477
  61. package/node/esm/note.mjs +113 -0
  62. package/node/esm/picture.mjs +326 -0
  63. package/node/esm/shape.mjs +342 -0
  64. package/node/esm/slicer.mjs +284 -0
  65. package/package.json +56 -14
  66. package/resources/contents.json +36 -0
  67. package/resources/locales/contents.json +84 -0
  68. package/resources/locales/de/chart.cmd.json +82 -0
  69. package/resources/locales/de/movable.cmd.json +68 -0
  70. package/resources/locales/de/picture.cmd.json +188 -0
  71. package/resources/locales/de/pivot.cmd.json +79 -0
  72. package/resources/locales/de/shape.cmd.json +17 -0
  73. package/resources/locales/de/sheet.cmd.json +169 -16
  74. package/resources/locales/de/slicer.cmd.json +17 -0
  75. package/resources/locales/de/sparkline.cmd.json +301 -0
  76. package/resources/locales/de/table.cmd.json +13 -2
  77. package/resources/locales/de/ui.msg.json +353 -2
  78. package/resources/locales/de/workbook.cmd.json +8 -1
  79. package/resources/locales/en/chart.cmd.json +82 -0
  80. package/resources/locales/en/movable.cmd.json +68 -0
  81. package/resources/locales/en/picture.cmd.json +188 -0
  82. package/resources/locales/en/pivot.cmd.json +79 -0
  83. package/resources/locales/en/shape.cmd.json +17 -0
  84. package/resources/locales/en/sheet.cmd.json +170 -17
  85. package/resources/locales/en/slicer.cmd.json +17 -0
  86. package/resources/locales/en/sparkline.cmd.json +301 -0
  87. package/resources/locales/en/table.cmd.json +13 -2
  88. package/resources/locales/en/ui.msg.json +195 -3
  89. package/resources/locales/en/workbook.cmd.json +8 -1
  90. package/types/chart.d.ts +2 -0
  91. package/types/control.d.ts +2 -0
  92. package/types/group.d.ts +2 -0
  93. package/types/note.d.ts +2 -0
  94. package/types/picture.d.ts +2 -0
  95. package/types/shape.d.ts +2 -0
  96. package/types/slicer.d.ts +2 -0
  97. package/types/src/annotation/RangeAnnotationLayer.d.ts +110 -0
  98. package/types/src/annotation/RangeAnnotationTag.d.ts +23 -0
  99. package/types/src/annotation/RangeAnnotations.d.ts +180 -0
  100. package/types/src/annotation/index.d.ts +4 -0
  101. package/types/src/autoFill/FillMenu.d.ts +2 -2
  102. package/types/src/autoFill/FillSeries.d.ts +2 -2
  103. package/types/src/border/StaticBorderRenderer.d.ts +18 -1
  104. package/types/src/border/useBorders.d.ts +95 -3
  105. package/types/src/cell/CellCheckboxRenderer.d.ts +20 -0
  106. package/types/src/cell/CellContent.d.ts +68 -0
  107. package/types/src/cell/CellControlContext.d.ts +37 -0
  108. package/types/src/cell/{FormulaCellRenderer.d.ts → CellFormulaRenderer.d.ts} +10 -7
  109. package/types/src/cell/CellImageRenderer.d.ts +11 -0
  110. package/types/src/cell/CellRenderers.d.ts +190 -0
  111. package/types/src/cell/{SheetCellRenderer.d.ts → CellTextRenderer.d.ts} +11 -8
  112. package/types/src/cell/ColumnButton.d.ts +3 -3
  113. package/types/src/cell/CornerTriangle.d.ts +2 -1
  114. package/types/src/cell/OutlineButton.d.ts +4 -4
  115. package/types/src/cell/PivotButton.d.ts +55 -0
  116. package/types/src/cell/SheetHeaderRenderer.d.ts +1 -1
  117. package/types/src/cell/StaticCellRenderer.d.ts +3 -3
  118. package/types/src/cell/_DropdownFace.d.ts +29 -0
  119. package/types/src/cell/index.d.ts +9 -2
  120. package/types/src/cell/useFormulaViewAnchor.d.ts +3 -3
  121. package/types/src/cell/useInsertableCellControls.d.ts +25 -0
  122. package/types/src/chart/ChartCommands.d.ts +15 -0
  123. package/types/src/chart/ChartEditor.d.ts +12 -2
  124. package/types/src/chart/ChartElement.d.ts +122 -0
  125. package/types/src/chart/ChartKind.d.ts +7 -0
  126. package/types/src/chart/PresetChartTypeDescriptors.d.ts +3 -1
  127. package/types/src/chart/index.d.ts +2 -1
  128. package/types/src/chart/paint/_fills.d.ts +24 -0
  129. package/types/src/chart/paint/_graphics.d.ts +38 -0
  130. package/types/src/chart/paint/_mode.d.ts +6 -0
  131. package/types/src/chart/paint/echarts.d.ts +33 -0
  132. package/types/src/chart/paint/index.d.ts +12 -0
  133. package/types/src/chart/paint/kinds/ChartPaintKind.d.ts +140 -0
  134. package/types/src/chart/paint/kinds/_Area.d.ts +3 -0
  135. package/types/src/chart/paint/kinds/_Bar.d.ts +3 -0
  136. package/types/src/chart/paint/kinds/_BoxWhisker.d.ts +3 -0
  137. package/types/src/chart/paint/kinds/_Bubble.d.ts +3 -0
  138. package/types/src/chart/paint/kinds/_Funnel.d.ts +3 -0
  139. package/types/src/chart/paint/kinds/_Histogram.d.ts +3 -0
  140. package/types/src/chart/paint/kinds/_Line.d.ts +10 -0
  141. package/types/src/chart/paint/kinds/_OfPie.d.ts +3 -0
  142. package/types/src/chart/paint/kinds/_Pie.d.ts +21 -0
  143. package/types/src/chart/paint/kinds/_Placeholder.d.ts +7 -0
  144. package/types/src/chart/paint/kinds/_Radar.d.ts +3 -0
  145. package/types/src/chart/paint/kinds/_Scatter.d.ts +3 -0
  146. package/types/src/chart/paint/kinds/_Sunburst.d.ts +3 -0
  147. package/types/src/chart/paint/kinds/_Surface.d.ts +3 -0
  148. package/types/src/chart/paint/kinds/_Treemap.d.ts +3 -0
  149. package/types/src/chart/paint/kinds/_Waterfall.d.ts +3 -0
  150. package/types/src/chart/paint/kinds/_builtIns.d.ts +3 -0
  151. package/types/src/chart/paint/toEChartsOption.d.ts +42 -0
  152. package/types/src/checklist/ValueChecklist.d.ts +44 -15
  153. package/types/src/clipboard/ClipboardCommands.d.ts +3 -3
  154. package/types/src/clipboard/SheetClipboardLayer.d.ts +2 -2
  155. package/types/src/commands/ContextualToolbar.d.ts +19 -0
  156. package/types/src/commands/createTransactionalMiddleware.d.ts +4 -1
  157. package/types/src/commands/index.d.ts +1 -0
  158. package/types/src/comment/CommentCardRequest.d.ts +9 -9
  159. package/types/src/comment/index.d.ts +0 -1
  160. package/types/src/comment/useSheetComments.d.ts +2 -2
  161. package/types/src/conditionalFormat/ConditionalFormatPresets.d.ts +6 -6
  162. package/types/src/context/WorksheetContext.d.ts +18 -0
  163. package/types/src/context/index.d.ts +1 -1
  164. package/types/src/control/FormControlRenderers.d.ts +8 -0
  165. package/types/src/editableLabel/EditableLabel.d.ts +3 -1
  166. package/types/src/editor/EditorCommands.d.ts +3 -3
  167. package/types/src/editor/SheetCellEditorLayer.d.ts +2 -7
  168. package/types/src/editor/SheetCellEditorStartLayer.d.ts +22 -5
  169. package/types/src/editor/SheetCellInput.d.ts +14 -0
  170. package/types/src/editor/SheetEditable.d.ts +6 -6
  171. package/types/src/editor/SheetReferenceHeaderLayer.d.ts +1 -1
  172. package/types/src/editor/SheetReferenceLayer.d.ts +4 -4
  173. package/types/src/editor/VirtualKeyboardLayer.d.ts +50 -0
  174. package/types/src/editor/formulaAnchor.d.ts +12 -0
  175. package/types/src/editor/formulaPresentation.d.ts +4 -3
  176. package/types/src/editor/index.d.ts +2 -0
  177. package/types/src/editor/pickedReference.d.ts +3 -3
  178. package/types/src/editor/useEditRejectedNotice.d.ts +3 -3
  179. package/types/src/editor/useFormulaHints.d.ts +3 -3
  180. package/types/src/editor/useFormulaInput.d.ts +6 -3
  181. package/types/src/editor/validationAlert.d.ts +24 -0
  182. package/types/src/form/FormulaInput.d.ts +5 -2
  183. package/types/src/form/useEditCommit.d.ts +23 -3
  184. package/types/src/form/useInputField.d.ts +2 -3
  185. package/types/src/frame/CommandContext.d.ts +74 -3
  186. package/types/src/group/GroupEditor.d.ts +25 -0
  187. package/types/src/index.d.ts +10 -2
  188. package/types/src/layer/BorderLayer.d.ts +5 -2
  189. package/types/src/layer/CellErrorLayer.d.ts +18 -7
  190. package/types/src/layer/CellFillLayer.d.ts +2 -2
  191. package/types/src/layer/CellIndicatorLayer.d.ts +31 -0
  192. package/types/src/layer/CellInsertLayer.d.ts +71 -0
  193. package/types/src/layer/CircularIndicatorLayer.d.ts +3 -3
  194. package/types/src/layer/CommentCardLayer.d.ts +7 -9
  195. package/types/src/layer/CommentsLayer.d.ts +2 -2
  196. package/types/src/layer/ConditionalBarLayer.d.ts +2 -2
  197. package/types/src/layer/ConditionalIcons.d.ts +4 -4
  198. package/types/src/layer/ConditionalIconsLayer.d.ts +2 -2
  199. package/types/src/layer/ContextMenuLayer.d.ts +2 -2
  200. package/types/src/layer/FreezeDragLines.d.ts +17 -0
  201. package/types/src/layer/GridFreezeLayer.d.ts +11 -0
  202. package/types/src/layer/HeaderFreezeLayer.d.ts +12 -0
  203. package/types/src/layer/HeaderResizerLayer.d.ts +2 -1
  204. package/types/src/layer/HeaderSelectionLayer.d.ts +4 -4
  205. package/types/src/layer/HyperlinkLayer.d.ts +116 -0
  206. package/types/src/layer/MovableKindScope.d.ts +17 -0
  207. package/types/src/layer/PivotLayer.d.ts +47 -0
  208. package/types/src/layer/PivotToolbar.d.ts +29 -0
  209. package/types/src/layer/ProtectionLayer.d.ts +4 -5
  210. package/types/src/layer/RangeToolbar.d.ts +75 -0
  211. package/types/src/layer/ResizeIndicator.d.ts +11 -10
  212. package/types/src/layer/ResizeTooltip.d.ts +13 -0
  213. package/types/src/layer/SheetBackgroundLayer.d.ts +3 -3
  214. package/types/src/layer/SheetCellLayer.d.ts +15 -8
  215. package/types/src/layer/SheetColumnButtonLayer.d.ts +2 -2
  216. package/types/src/layer/SheetGridLineLayer.d.ts +25 -15
  217. package/types/src/layer/SheetHeaderCellLayer.d.ts +1 -1
  218. package/types/src/layer/SheetLayers.d.ts +171 -0
  219. package/types/src/layer/SheetMovableLayer.d.ts +4 -3
  220. package/types/src/layer/SheetOutlineLayer.d.ts +3 -3
  221. package/types/src/layer/SheetPivotCommandLayer.d.ts +13 -0
  222. package/types/src/layer/SheetSparklineCommandLayer.d.ts +14 -0
  223. package/types/src/layer/SheetTableCommandLayer.d.ts +2 -2
  224. package/types/src/layer/SparklineLayer.d.ts +32 -0
  225. package/types/src/layer/SpillLayer.d.ts +2 -2
  226. package/types/src/layer/TableLayer.d.ts +6 -5
  227. package/types/src/layer/TableToolbar.d.ts +23 -0
  228. package/types/src/layer/ValidationDropdownLayer.d.ts +2 -2
  229. package/types/src/layer/ValidationIndicatorLayer.d.ts +2 -2
  230. package/types/src/layer/ValidationPromptLayer.d.ts +47 -16
  231. package/types/src/layer/_sheetBorders.d.ts +6 -0
  232. package/types/src/layer/_tableColor.d.ts +6 -0
  233. package/types/src/layer/_visibleCellFeatures.d.ts +11 -0
  234. package/types/src/layer/cellTip.d.ts +13 -0
  235. package/types/src/layer/freezeDragState.d.ts +21 -0
  236. package/types/src/layer/index.d.ts +14 -0
  237. package/types/src/layer/resizeIndicatorState.d.ts +3 -1
  238. package/types/src/layer/useFreezeDrag.d.ts +22 -0
  239. package/types/src/layer/useNormalBorderLines.d.ts +15 -0
  240. package/types/src/layer/useSheetFeatureRegions.d.ts +2 -2
  241. package/types/src/layer/useSheetVisibleCells.d.ts +5 -6
  242. package/types/src/layer/useSheetVisibleDecorations.d.ts +2 -2
  243. package/types/src/layer/useTableHeaderCells.d.ts +2 -2
  244. package/types/src/layer/useValidationPicker.d.ts +3 -3
  245. package/types/src/layer/useVisibleTables.d.ts +2 -2
  246. package/types/src/layer/validationMark.d.ts +3 -3
  247. package/types/src/listener/index.d.ts +5 -0
  248. package/types/src/listener/useCell.d.ts +29 -0
  249. package/types/src/listener/useCellRange.d.ts +23 -0
  250. package/types/src/listener/useCellValue.d.ts +26 -0
  251. package/types/src/listener/useModelListener.d.ts +4 -4
  252. package/types/src/listener/useRangeListener.d.ts +13 -7
  253. package/types/src/listener/useRangeSnapshot.d.ts +35 -0
  254. package/types/src/listener/useTable.d.ts +26 -0
  255. package/types/src/movable/ConnectionSites.d.ts +18 -0
  256. package/types/src/movable/DefaultMovable.d.ts +8 -0
  257. package/types/src/movable/IMovableArea.d.ts +28 -0
  258. package/types/src/movable/MovableAdornment.d.ts +9 -3
  259. package/types/src/movable/MovableCommandGroups.d.ts +22 -0
  260. package/types/src/movable/MovableCommands.d.ts +8 -3
  261. package/types/src/movable/MovableControl.d.ts +49 -1
  262. package/types/src/movable/MovableFrame.d.ts +5 -1
  263. package/types/src/movable/MovableLayer.d.ts +30 -5
  264. package/types/src/movable/MovableRenderers.d.ts +166 -11
  265. package/types/src/movable/PlaceholderFrames.d.ts +11 -0
  266. package/types/src/movable/RotateHandle.d.ts +12 -4
  267. package/types/src/movable/connect.d.ts +16 -0
  268. package/types/src/movable/framePlacement.d.ts +44 -1
  269. package/types/src/movable/geometry.d.ts +13 -3
  270. package/types/src/movable/index.d.ts +8 -0
  271. package/types/src/movable/pressTarget.d.ts +20 -0
  272. package/types/src/movable/useFramePreview.d.ts +17 -0
  273. package/types/src/picker/cellPickerOpen.d.ts +3 -3
  274. package/types/src/picker/useCellPicker.d.ts +7 -5
  275. package/types/src/picture/PictureCommands.d.ts +20 -0
  276. package/types/src/picture/PictureKind.d.ts +7 -0
  277. package/types/src/picture/_pictureHyperlink.d.ts +13 -0
  278. package/types/src/picture/index.d.ts +0 -1
  279. package/types/src/picture/pictureCrop.d.ts +32 -0
  280. package/types/src/pivot/PivotAreas.d.ts +16 -0
  281. package/types/src/pivot/PivotChip.d.ts +33 -0
  282. package/types/src/pivot/PivotChipMenu.d.ts +74 -0
  283. package/types/src/pivot/PivotCommands.d.ts +24 -0
  284. package/types/src/pivot/PivotFieldList.d.ts +14 -0
  285. package/types/src/pivot/PivotFields.d.ts +47 -0
  286. package/types/src/pivot/PivotFieldsModel.d.ts +143 -0
  287. package/types/src/pivot/PivotTablePane.d.ts +47 -0
  288. package/types/src/pivot/_PivotFieldsContext.d.ts +41 -0
  289. package/types/src/pivot/_pivotNew.d.ts +12 -0
  290. package/types/src/pivot/_pivotRegion.d.ts +14 -0
  291. package/types/src/pivot/index.d.ts +9 -0
  292. package/types/src/pivot/usePivotFields.d.ts +17 -0
  293. package/types/src/presence/PresenceCommands.d.ts +35 -0
  294. package/types/src/presence/PresenceHost.d.ts +58 -0
  295. package/types/src/presence/PresenceMessages.d.ts +42 -0
  296. package/types/src/presence/PresenceStore.d.ts +165 -0
  297. package/types/src/presence/PresenceTypes.d.ts +78 -0
  298. package/types/src/presence/index.d.ts +7 -0
  299. package/types/src/presence/usePresence.d.ts +20 -0
  300. package/types/src/richText/RichTextEditor.d.ts +2 -2
  301. package/types/src/selection/SelectionCommands.d.ts +2 -2
  302. package/types/src/selection/SheetSelectionLayer.d.ts +6 -12
  303. package/types/src/shape/ConnectorControl.d.ts +46 -0
  304. package/types/src/shape/ShapeCommands.d.ts +11 -0
  305. package/types/src/shape/ShapeControl.d.ts +8 -0
  306. package/types/src/shape/ShapeEditor.d.ts +2 -3
  307. package/types/src/shape/ShapeGallery.d.ts +21 -6
  308. package/types/src/shape/ShapeKind.d.ts +7 -0
  309. package/types/src/shape/ShapeSVG.d.ts +6 -8
  310. package/types/src/shape/index.d.ts +0 -1
  311. package/types/src/shape/shapeFrame.d.ts +46 -2
  312. package/types/src/shape/shapeStyle.d.ts +59 -8
  313. package/types/src/sheet/ISheetHeaderElement.d.ts +3 -3
  314. package/types/src/sheet/{ISheetElement.d.ts → IWorksheetElement.d.ts} +110 -86
  315. package/types/src/sheet/OpaqueSheetElement.d.ts +21 -0
  316. package/types/src/sheet/SheetCommandProvider.d.ts +14 -6
  317. package/types/src/sheet/SheetCommands.d.ts +18 -3
  318. package/types/src/sheet/SheetKindIcon.d.ts +14 -0
  319. package/types/src/sheet/SheetOutlineElement.d.ts +6 -6
  320. package/types/src/sheet/SheetPanels.d.ts +11 -0
  321. package/types/src/sheet/SheetScrollbar.d.ts +4 -13
  322. package/types/src/sheet/TopLeftCorner.d.ts +2 -2
  323. package/types/src/sheet/WorksheetElement.d.ts +12 -0
  324. package/types/src/sheet/_freezeAt.d.ts +10 -0
  325. package/types/src/sheet/_hyperlinkEdit.d.ts +7 -0
  326. package/types/src/sheet/_useHeaderMetrics.d.ts +11 -0
  327. package/types/src/sheet/circularReferences.d.ts +4 -4
  328. package/types/src/sheet/index.d.ts +5 -2
  329. package/types/src/sheet/useCycleHighlight.d.ts +2 -2
  330. package/types/src/slicer/SlicerCommands.d.ts +10 -0
  331. package/types/src/slicer/SlicerEditor.d.ts +8 -2
  332. package/types/src/slicer/SlicerKind.d.ts +7 -0
  333. package/types/src/slicer/SlicerStylePreview.d.ts +18 -0
  334. package/types/src/slicer/index.d.ts +2 -1
  335. package/types/src/slicer/slicerStyles.d.ts +32 -0
  336. package/types/src/sparkline/PictureCache.d.ts +37 -0
  337. package/types/src/sparkline/SparklineCommands.d.ts +23 -0
  338. package/types/src/sparkline/SparklinePictures.d.ts +7 -0
  339. package/types/src/sparkline/paint/_drawing.d.ts +24 -0
  340. package/types/src/sparkline/paint/echarts.d.ts +8 -0
  341. package/types/src/sparkline/paint/index.d.ts +8 -0
  342. package/types/src/tabStrip/SheetTab.d.ts +1 -1
  343. package/types/src/tabStrip/Sortable.d.ts +5 -5
  344. package/types/src/tabStrip/TabStrip.d.ts +13 -6
  345. package/types/src/tabStrip/TabStripItem.d.ts +15 -13
  346. package/types/src/table/TableCommands.d.ts +2 -2
  347. package/types/src/taskPane/CellControlPane.d.ts +15 -0
  348. package/types/src/taskPane/MovablePane.d.ts +15 -0
  349. package/types/src/taskPane/TaskPaneArea.d.ts +7 -0
  350. package/types/src/taskPane/TaskPaneFrame.d.ts +4 -4
  351. package/types/src/taskPane/TaskPaneKeys.d.ts +38 -0
  352. package/types/src/taskPane/TaskPaneRegistry.d.ts +32 -12
  353. package/types/src/taskPane/_paneReasons.d.ts +7 -0
  354. package/types/src/taskPane/index.d.ts +3 -0
  355. package/types/src/taskPane/useTaskPane.d.ts +6 -3
  356. package/types/src/theme/ExplicitTokens.d.ts +18 -0
  357. package/types/src/theme/GridColorSchemeContext.d.ts +8 -0
  358. package/types/src/theme/ThemeRootStyles.d.ts +31 -0
  359. package/types/src/theme/ThemeState.d.ts +2 -2
  360. package/types/src/theme/buildDocThemeCSS.d.ts +4 -1
  361. package/types/src/theme/buildOOXMLThemeCSS.d.ts +2 -2
  362. package/types/src/theme/buildTokensCSS.d.ts +15 -0
  363. package/types/src/theme/index.d.ts +2 -4
  364. package/types/src/theme/useAppColorScheme.d.ts +4 -1
  365. package/types/src/theme/useGridColorScheme.d.ts +9 -4
  366. package/types/src/theme/useSystemColors.d.ts +1 -15
  367. package/types/src/workbook/DefaultMovableRenderers.d.ts +19 -1
  368. package/types/src/workbook/DefaultRenderers.d.ts +5 -4
  369. package/types/src/workbook/IWorkbookElement.d.ts +176 -30
  370. package/types/src/workbook/WorkbookCommands.d.ts +6 -1
  371. package/types/src/workbook/WorkbookStrip.d.ts +14 -5
  372. package/browser/cjs/index.cjs +0 -43
  373. package/browser/cjs/xuAfpHmA2W4MFa_0.cjs +0 -1
  374. package/types/src/chart/templates/area-stacked-percent-template.json.d.ts +0 -10
  375. package/types/src/chart/templates/area-stacked-template.json.d.ts +0 -10
  376. package/types/src/chart/templates/area-template.json.d.ts +0 -9
  377. package/types/src/chart/templates/bar-stacked-percent-template.json.d.ts +0 -10
  378. package/types/src/chart/templates/bar-stacked-template.json.d.ts +0 -10
  379. package/types/src/chart/templates/bar-template.json.d.ts +0 -9
  380. package/types/src/chart/templates/column-stacked-percent-template.json.d.ts +0 -10
  381. package/types/src/chart/templates/column-stacked-template.json.d.ts +0 -10
  382. package/types/src/chart/templates/column-template.json.d.ts +0 -9
  383. package/types/src/chart/templates/line-markers-template.json.d.ts +0 -10
  384. package/types/src/chart/templates/line-stacked-markers-template.json.d.ts +0 -11
  385. package/types/src/chart/templates/line-stacked-percent-markers-template.json.d.ts +0 -11
  386. package/types/src/chart/templates/line-stacked-percent-template.json.d.ts +0 -10
  387. package/types/src/chart/templates/line-stacked-template.json.d.ts +0 -10
  388. package/types/src/chart/templates/line-template.json.d.ts +0 -9
  389. package/types/src/chart/templates/pie-doughnut-template.json.d.ts +0 -10
  390. package/types/src/chart/templates/pie-template.json.d.ts +0 -9
  391. package/types/src/chart/templates/scatter-lines-markers-smooth-template.json.d.ts +0 -10
  392. package/types/src/chart/templates/scatter-lines-markers-template.json.d.ts +0 -10
  393. package/types/src/chart/templates/scatter-lines-smooth-template.json.d.ts +0 -10
  394. package/types/src/chart/templates/scatter-lines-template.json.d.ts +0 -10
  395. package/types/src/chart/templates/scatter-markers-template.json.d.ts +0 -10
  396. package/types/src/context/SheetContext.d.ts +0 -18
  397. package/types/src/control/index.d.ts +0 -2
  398. package/types/src/sheet/SheetElement.d.ts +0 -15
@@ -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
  */
@@ -1,16 +1,16 @@
1
1
  import { default as React } from 'react';
2
- import { IRange, ISheet } from '@sheetxl/sdk';
2
+ import { IRange, IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  import { OutlineButtonProps } from '../cell/OutlineButton';
5
5
  export interface SheetOutlineLayerProps extends LayerProps {
6
6
  /** The sheet whose outline is drawn. */
7
- sheet: ISheet;
7
+ sheet: IWorksheet;
8
8
  /** Rows or columns. */
9
9
  axis: IRange.Axis;
10
10
  /** The lanes across the gutter: one per level, plus one. */
11
11
  lanes: number;
12
12
  /** Renders a group's collapse / expand button. Defaults to `OutlineButton`. */
13
- renderButton?: (props: OutlineButtonProps) => React.ReactNode;
13
+ renderButton?: ((props: OutlineButtonProps) => React.ReactNode) | null;
14
14
  /**
15
15
  * The space around the buttons, in pixels: between neighbors, before the first and after the last.
16
16
  *
@@ -0,0 +1,13 @@
1
+ import { ReactElement } from 'react';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
+ import { LayerProps } from '@sheetxl/grid-react';
4
+ export interface SheetPivotCommandLayerProps extends LayerProps {
5
+ sheet: IWorksheet;
6
+ }
7
+ /**
8
+ * **Command-only layer for the `pivot` scope**: no visuals; it joins the pane's z-chain to contribute
9
+ * the {@link contributePivotCommands pivot table operations} while the selection is in a pivot
10
+ * table, as {@link SheetTableCommandLayer} does for tables.
11
+ */
12
+ export declare const SheetPivotCommandLayer: import('react').MemoExoticComponent<(props: SheetPivotCommandLayerProps) => ReactElement>;
13
+ //# sourceMappingURL=SheetPivotCommandLayer.d.ts.map
@@ -0,0 +1,14 @@
1
+ import { ReactElement } from 'react';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
+ import { LayerProps } from '@sheetxl/grid-react';
4
+ export interface SheetSparklineCommandLayerProps extends LayerProps {
5
+ sheet: IWorksheet;
6
+ }
7
+ /**
8
+ * **Command-only layer for the `sparkline` scope**: no visuals (the pictures are
9
+ * `SparklineLayer`'s); it joins the pane's z-chain to contribute
10
+ * {@link contributeSparklineCommands Excel's Sparkline tab} while the active cell has a sparkline,
11
+ * as `SheetTableCommandLayer` does for tables.
12
+ */
13
+ export declare const SheetSparklineCommandLayer: import('react').MemoExoticComponent<(props: SheetSparklineCommandLayerProps) => ReactElement>;
14
+ //# sourceMappingURL=SheetSparklineCommandLayer.d.ts.map
@@ -1,8 +1,8 @@
1
1
  import { ReactElement } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  export interface SheetTableCommandLayerProps extends LayerProps {
5
- sheet: ISheet;
5
+ sheet: IWorksheet;
6
6
  }
7
7
  /**
8
8
  * **Command-only layer for the `table` scope** — no visuals (the visual chrome lives in {@link TableLayer});
@@ -0,0 +1,32 @@
1
+ import { default as React } from 'react';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
+ import { LayerProps } from '@sheetxl/grid-react';
4
+ export interface SparklineLayerProps extends LayerProps {
5
+ /** Class for the layer (devtools identification). */
6
+ className?: string;
7
+ /** Style for the tiles' host box. */
8
+ style?: React.CSSProperties;
9
+ /** The sheet whose sparklines are drawn. */
10
+ sheet: IWorksheet;
11
+ /**
12
+ * Whether the grid is dark: the pictures' colors are drawn as the cells draw theirs there.
13
+ *
14
+ * @defaultValue false
15
+ */
16
+ darkMode?: boolean;
17
+ }
18
+ /**
19
+ * The sheet's **sparklines**: each group's picture in each of its cells (DESIGN-SPARKLINES §3).
20
+ *
21
+ * @remarks
22
+ * A layer of its own, not a cell content renderer: a sparkline's cell is usually empty, and the
23
+ * cell layer visits only cells with content. It mounts above the cells, as Excel draws the picture
24
+ * over the cell's value, and takes no pointer events.
25
+ *
26
+ * The tiles hold one view per visible sparkline and are rebuilt only when the groups change (one
27
+ * added, removed, or moved). A value the picture reads changing is the view's own business: it
28
+ * listens to its group's `onLayoutChange` and asks for a new picture, so an edit repaints the
29
+ * pictures without rebuilding a tile.
30
+ */
31
+ export declare const SparklineLayer: React.MemoExoticComponent<(props: SparklineLayerProps) => React.JSX.Element | null>;
32
+ //# sourceMappingURL=SparklineLayer.d.ts.map
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  export interface SpillLayerProps extends LayerProps {
5
5
  /** Style for the outline box. */
@@ -7,7 +7,7 @@ export interface SpillLayerProps extends LayerProps {
7
7
  /**
8
8
  * The sheet.
9
9
  */
10
- sheet: ISheet;
10
+ sheet: IWorksheet;
11
11
  /**
12
12
  * The animation time in milliseconds.
13
13
  *
@@ -1,16 +1,17 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet, ITable } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
+ import { TableToolbarRenderProps } from './TableToolbar';
4
5
  export interface TableLayerProps extends LayerProps {
5
6
  /**
6
7
  * The sheet.
7
8
  */
8
- sheet: ISheet;
9
+ sheet: IWorksheet;
9
10
  /**
10
- * Invoked by the hover toolbar's **edit** button. Wire it to the `editTable` command; if omitted the
11
- * button falls back to selecting the table.
11
+ * The toolbar that floats at a hovered table's top-right corner.
12
+ * @defaultValue a plain split button: edit the table · a menu of the table commands
12
13
  */
13
- onEditTable?: (table: ITable) => Promise<void>;
14
+ renderToolbar?: ((props: TableToolbarRenderProps) => React.ReactNode) | null;
14
15
  }
15
16
  /**
16
17
  * Is the outline, resizer, and row selection.
@@ -0,0 +1,23 @@
1
+ import { default as React } from 'react';
2
+ import { IWorksheet, ITable } from '@sheetxl/sdk';
3
+ import { RangeToolbarRenderProps } from './RangeToolbar';
4
+ /** What the table toolbar is handed. */
5
+ export interface TableToolbarRenderProps extends RangeToolbarRenderProps {
6
+ /** The hovered table. A press anywhere on the toolbar makes it the current table first, so the table commands act on it. */
7
+ table: ITable;
8
+ }
9
+ /** What {@link TableLayer} hands its toolbar float. */
10
+ export interface TableToolbarFloatProps {
11
+ sheet: IWorksheet;
12
+ /** The table under the pointer, as the table layer's hover found it. */
13
+ hovered: ITable | null;
14
+ renderToolbar?: ((props: TableToolbarRenderProps) => React.ReactNode) | null;
15
+ }
16
+ /**
17
+ * The **table toolbar**: hover a table and its commands float at its top-right corner, a quick action
18
+ * (edit the table) and a dropdown of the rest. A {@link RangeToolbarFloat} inside the table layer, fed
19
+ * the table the layer's own hover found. What it draws is the host's (`renderToolbar`); its commands
20
+ * resolve from the pane like any other.
21
+ */
22
+ export declare const TableToolbarFloat: React.FC<TableToolbarFloatProps>;
23
+ //# sourceMappingURL=TableToolbar.d.ts.map
@@ -1,6 +1,6 @@
1
1
  import { default as React } from 'react';
2
2
  import { CellCoords } from '@sheetxl/utils';
3
- import { ISheet, IDataValidation, IRange } from '@sheetxl/sdk';
3
+ import { IWorksheet, IDataValidation, IRange } from '@sheetxl/sdk';
4
4
  import { IEditable, LayerProps } from '@sheetxl/grid-react';
5
5
  /** What the probe hands the button: the validations to offer, and the cell they belong to. */
6
6
  export interface ValidationDropdown {
@@ -22,7 +22,7 @@ export interface ValidationDropdownLayerProps extends Omit<LayerProps, 'children
22
22
  /** Style for the floated button container. */
23
23
  style?: React.CSSProperties;
24
24
  /** The sheet whose selection is followed. */
25
- sheet: ISheet;
25
+ sheet: IWorksheet;
26
26
  /**
27
27
  * The editable a pick is entered through — the sheet's shared one, so a pick is a typed entry:
28
28
  * coerced, formatted and checked as one. Without it the button opens nothing.
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  export interface ValidationIndicatorLayerProps extends LayerProps {
5
5
  /** Class for the layer (devtools identification). */
@@ -7,7 +7,7 @@ export interface ValidationIndicatorLayerProps extends LayerProps {
7
7
  /** Style for the indicators host box. */
8
8
  style?: React.CSSProperties;
9
9
  /** The sheet whose data validations are indicated. */
10
- sheet: ISheet;
10
+ sheet: IWorksheet;
11
11
  /** Size (px, unzoomed) of the invalid-value corner mark. @defaultValue 7 */
12
12
  markSize?: number;
13
13
  }
@@ -1,7 +1,8 @@
1
1
  import { default as React } from 'react';
2
2
  import { CellCoords, RangeCoords } from '@sheetxl/utils';
3
- import { ISheet, IDataValidation } from '@sheetxl/sdk';
4
- import { LayerProps } from '@sheetxl/grid-react';
3
+ import { IDataValidation, IWorksheet } from '@sheetxl/sdk';
4
+ import { IEditable, LayerProps } from '@sheetxl/grid-react';
5
+ import { ValidationAlert } from '../editor/validationAlert';
5
6
  /** The prompt a cell shows: the rule's title and message, and the range it hangs under. */
6
7
  export interface ValidationPrompt {
7
8
  /** The cell, or the merge it anchors. */
@@ -15,32 +16,62 @@ export interface ValidationPrompt {
15
16
  }
16
17
  /**
17
18
  * The input prompt for the cell at `coords`: from the first covering rule, by priority, that shows
18
- * a prompt and has a title or a message to show. `null` when none does.
19
+ * a prompt and has a title or a message to show. `null` when none does, or when the sheet disables
20
+ * prompts.
19
21
  */
20
- export declare const findValidationPrompt: (sheet: ISheet, coords: CellCoords) => ValidationPrompt | null;
22
+ export declare const findValidationPrompt: (sheet: IWorksheet, coords: CellCoords) => ValidationPrompt | null;
21
23
  export interface ValidationPromptLayerProps extends Omit<LayerProps, 'children'> {
22
- /** Class for the floated prompt container. */
24
+ /** Class for the floated container. */
23
25
  className?: string;
24
- /** Style for the floated prompt container. */
26
+ /** Style for the floated container. */
25
27
  style?: React.CSSProperties;
26
- /** The sheet whose selection is followed. */
27
- sheet: ISheet;
28
- /** Gap (px) between the cell's bottom edge and the prompt. @defaultValue 4 */
28
+ /** The sheet whose selection is followed, and whose entries are checked. */
29
+ sheet: IWorksheet;
30
+ /**
31
+ * The editable entries are typed through. It tells an alert on an open edit, which stays while
32
+ * the edit does, from one left behind, which the next key or press clears.
33
+ */
34
+ editable?: IEditable<any, string, any> | null;
35
+ /** Gap (px) between the cell and the float, below it and past its right edge. @defaultValue 6 */
29
36
  offset?: number;
30
37
  /**
31
38
  * Render the prompt yourself. Spread `floatProps` on the returned element. Omit for the default
32
- * box: the title in bold over the message.
39
+ * box: the title in bold over the message; `null` for none.
40
+ */
41
+ renderPrompt?: ((props: ValidationPromptRenderProps) => React.ReactNode) | null;
42
+ /**
43
+ * Render the alert yourself. Spread `floatProps` on the returned element. Omit for the default
44
+ * card: the rule's alert title and message, and what to do next; `null` for none.
33
45
  */
34
- renderPrompt?: (prompt: ValidationPrompt, floatProps: React.HTMLAttributes<HTMLElement>) => React.ReactNode;
46
+ renderAlert?: ((props: ValidationAlertRenderProps) => React.ReactNode) | null;
47
+ }
48
+ /** What {@link ValidationPromptLayerProps.renderPrompt} is handed. */
49
+ export interface ValidationPromptRenderProps {
50
+ prompt: ValidationPrompt;
51
+ /** Spread on the returned element: its placement and pointer handling. */
52
+ floatProps: React.HTMLAttributes<HTMLElement>;
53
+ }
54
+ /** What {@link ValidationPromptLayerProps.renderAlert} is handed. */
55
+ export interface ValidationAlertRenderProps {
56
+ alert: ValidationAlert;
57
+ /** Spread on the returned element: its placement and pointer handling. */
58
+ floatProps: React.HTMLAttributes<HTMLElement>;
35
59
  }
36
60
  /**
37
- * The **input prompt** of a data validation — a {@link RangeFloatLayer} activated by the selection,
38
- * placed under the selected cell (or its merge), starting at its horizontal midpoint.
61
+ * The **input prompt** of a data validation, and the **alert** an entry raised in its place — one
62
+ * {@link RangeFloatLayer} at the cell-tip placement the error tips use: under the active cell (or
63
+ * its merge), starting just past its right edge.
39
64
  *
40
65
  * @remarks
41
- * Shows the title and message of the first covering rule that has a prompt to show
42
- * ({@link findValidationPrompt}). It stays while the cell is being edited, as Excel's does, and steps
43
- * aside while the list picker is open, since the two would drop under the same edge.
66
+ * At rest the float follows the selection and shows the title and message of the first covering
67
+ * rule that has a prompt to show ({@link findValidationPrompt}). It stays while the cell is being
68
+ * edited, as Excel's does, and steps aside while the list picker is open, since the picker drops
69
+ * under the same edge.
70
+ *
71
+ * An alert the entry check raised (`ValidationAlert`) takes the float over: Excel's alert dialog in
72
+ * tip form. A Stop keeps the edit open and the tip with it; a Warning's tip asks for Enter again; an
73
+ * Information entry is written and its tip stays until the next key or press. The prompt returns
74
+ * when the alert clears.
44
75
  */
45
76
  export declare const ValidationPromptLayer: React.MemoExoticComponent<(props: ValidationPromptLayerProps) => React.JSX.Element>;
46
77
  //# sourceMappingURL=ValidationPromptLayer.d.ts.map
@@ -0,0 +1,6 @@
1
+ import { IBorders, ICell, IRange } from '@sheetxl/sdk';
2
+ /** The borders a visible cell draws. */
3
+ export declare const getSheetBorderAt: (value: ICell, _index: number) => IBorders;
4
+ /** A merged cell's extrusion is its merge (merged cells never overflow); `null` when not merged. */
5
+ export declare const getSheetMergeAt: (value: ICell, _index: number) => IRange.Coords | null;
6
+ //# sourceMappingURL=_sheetBorders.d.ts.map
@@ -0,0 +1,6 @@
1
+ import { IWorksheet, ITable, IPivotTable, ITableStyle } from '@sheetxl/sdk';
2
+ /** A table style's theme color (header fill / whole-table top border) as CSS; `null` when it has none. */
3
+ export declare const tableStyleColor: (style: ITableStyle | null, sheet: IWorksheet) => string | null;
4
+ /** A table's or pivot table's theme color (header fill / whole-table top border) as CSS; grey when its style has none. */
5
+ export declare const tableLabelColor: (table: Pick<ITable, "getStyle"> | Pick<IPivotTable, "getStyle">, sheet: IWorksheet) => string;
6
+ //# sourceMappingURL=_tableColor.d.ts.map
@@ -0,0 +1,11 @@
1
+ import { ICellRange } from '@sheetxl/sdk';
2
+ /**
3
+ * Every feature a blank cell can be painted through, for the visible-cell scans.
4
+ *
5
+ * @remarks
6
+ * Naming them is what visits blanks at all. The list is the whole cell state, not what the layer
7
+ * draws: per-cell style resolution composes table and named styles through the full intersection,
8
+ * so a partial list breaks effective styles.
9
+ */
10
+ export declare const VisibleCellFeatures: readonly ICellRange.Feature[];
11
+ //# sourceMappingURL=_visibleCellFeatures.d.ts.map
@@ -0,0 +1,13 @@
1
+ import { RangeCoords } from '@sheetxl/utils';
2
+ import { GridPlacement, IGridPane } from '@sheetxl/grid-react';
3
+ /**
4
+ * Where a cell's tips hang: the input prompt, and the hover tip on an error, a warning or a failed
5
+ * validation alike. Below the cell, starting just past its right edge (under a dropdown button), so
6
+ * the cell and the one below it stay in view. Flip and shift apply as to any grid float.
7
+ */
8
+ export declare const CELL_TIP_PLACEMENT: GridPlacement;
9
+ /** Gap (px) between a cell and its tip, below it and past its right edge alike. */
10
+ export declare const CELL_TIP_GAP = 6;
11
+ /** The align offset that starts a tip `gap` past the right edge of `range`. */
12
+ export declare const cellTipAlignOffset: (pane: IGridPane, range: RangeCoords, gap?: number) => number;
13
+ //# sourceMappingURL=cellTip.d.ts.map
@@ -0,0 +1,21 @@
1
+ import { IRange } from '@sheetxl/sdk';
2
+ import { FreezeDragPosition } from '@sheetxl/grid-react';
3
+ /**
4
+ * The transient state of an in-progress freeze drag, published by the producer
5
+ * (the freeze grips, through {@link useFreezeDrag}) and read by {@link FreezeDragLines} in both the
6
+ * header and the main grid.
7
+ *
8
+ * It rides `useSurfaceState` under {@link freezeDragKey}. `null` means no freeze drag is active for that
9
+ * axis.
10
+ */
11
+ export type FreezeDragState = FreezeDragPosition;
12
+ /**
13
+ * The `useSurfaceState` key for the freeze drag, namespaced by axis.
14
+ */
15
+ export declare const freezeDragKey: (axis: IRange.Axis) => string;
16
+ /**
17
+ * The `useSurfaceState` key for whether an axis's freeze grip is active (hovered or dragging) — the sheet
18
+ * highlights its freeze line while it is. A boolean; `false` when never written.
19
+ */
20
+ export declare const freezeActiveKey: (axis: IRange.Axis) => string;
21
+ //# sourceMappingURL=freezeDragState.d.ts.map
@@ -4,30 +4,44 @@ export * from './useSheetFeatureRegions';
4
4
  export * from './useSheetVisibleDecorations';
5
5
  export * from './CellFillLayer';
6
6
  export * from './CellErrorLayer';
7
+ export * from './HyperlinkLayer';
7
8
  export * from './BorderLayer';
8
9
  export * from './SheetCellLayer';
9
10
  export * from './SheetColumnButtonLayer';
11
+ export * from './PivotLayer';
12
+ export * from './PivotToolbar';
10
13
  export * from './SheetGridLineLayer';
11
14
  export * from './SheetBackgroundLayer';
12
15
  export * from './SheetHeaderCellLayer';
13
16
  export * from './SheetOutlineLayer';
14
17
  export * from './SheetMovableLayer';
15
18
  export * from './TableLayer';
19
+ export * from './TableToolbar';
16
20
  export * from './SheetTableCommandLayer';
21
+ export * from './SheetSparklineCommandLayer';
22
+ export * from './SheetPivotCommandLayer';
17
23
  export * from './SpillLayer';
18
24
  export * from './ConditionalIcons';
19
25
  export * from './ConditionalBarLayer';
20
26
  export * from './ConditionalIconsLayer';
27
+ export * from './SparklineLayer';
21
28
  export * from './ValidationIndicatorLayer';
22
29
  export * from './ValidationDropdownLayer';
23
30
  export * from './ValidationPromptLayer';
24
31
  export * from './useValidationPicker';
25
32
  export * from './CircularIndicatorLayer';
33
+ export * from './CellIndicatorLayer';
26
34
  export * from './CommentsLayer';
27
35
  export * from './CommentCardLayer';
36
+ export * from './SheetLayers';
37
+ export * from './CellInsertLayer';
28
38
  export * from './ProtectionLayer';
29
39
  export * from './HeaderSelectionLayer';
30
40
  export * from './HeaderResizerLayer';
31
41
  export * from './ResizeIndicator';
42
+ export * from './HeaderFreezeLayer';
43
+ export * from './GridFreezeLayer';
44
+ export * from './FreezeDragLines';
45
+ export * from './freezeDragState';
32
46
  export * from './ContextMenuLayer';
33
47
  //# sourceMappingURL=index.d.ts.map
@@ -12,7 +12,9 @@ export interface ResizeIndicatorState {
12
12
  /** The index of the header (column or row) being resized. */
13
13
  index: number;
14
14
  /**
15
- * Live size (px) of the header during the gesture — `prevSize` at start, the dragged size while moving.
15
+ * Live size of the header during the gesture, in on-screen (zoomed) pixels — `prevSize` at start, the
16
+ * dragged size while moving. The model has not announced the new size yet, so the overlay draws the
17
+ * header's far edge from this rather than from the grid's metrics.
16
18
  * `0` ⇒ the header is (being) hidden (draw a single collapsed line, tooltip reads "Hidden").
17
19
  * `null` ⇒ draw the guide-lines only, with no size tooltip (e.g. a press-and-hold before any drag).
18
20
  */
@@ -0,0 +1,22 @@
1
+ import { IWorksheet, IRange } from '@sheetxl/sdk';
2
+ import { FreezeDragPosition } from '@sheetxl/grid-react';
3
+ export interface FreezeDrag {
4
+ disabled: boolean;
5
+ /** Whether a grip on this axis (header or body) is hovered or dragging. */
6
+ isActive: boolean;
7
+ onFreezeDragStart: (position: FreezeDragPosition) => void;
8
+ onFreezeDrag: (position: FreezeDragPosition) => void;
9
+ onFreezeDragEnd: (position: FreezeDragPosition) => void;
10
+ onFreezeDragCancel: () => void;
11
+ onActiveChange: (active: boolean) => void;
12
+ }
13
+ /**
14
+ * Wires a freeze grip on one axis to the sheet: publishes the drag for {@link FreezeDragLines}, commits the
15
+ * drop through `freezePanesAt`, and works out whether a drag is allowed right now.
16
+ *
17
+ * @remarks
18
+ * The drag is allowed only when the scrolling area starts exactly at the freeze — otherwise the frozen
19
+ * and scrolling areas are not contiguous and a drop could not land where it was let go.
20
+ */
21
+ export declare const useFreezeDrag: (sheet: IWorksheet, axis: IRange.Axis) => FreezeDrag;
22
+ //# sourceMappingURL=useFreezeDrag.d.ts.map
@@ -0,0 +1,15 @@
1
+ import { IWorksheet } from '@sheetxl/sdk';
2
+ import { BorderNormalLine } from '../border';
3
+ /**
4
+ * The Normal style's border as one line per axis — a border on every cell, blank ones included.
5
+ *
6
+ * @remarks
7
+ * A boundary is the trailing edge of one cell and the leading edge of the next; the Normal style's
8
+ * two edges meet there and the one Excel draws wins. `null` on an axis with no Normal border.
9
+ * Identity is stable while the resolved style is. The caller re-renders on `onStyleChange`.
10
+ */
11
+ export declare const useNormalBorderLines: (sheet: IWorksheet) => {
12
+ rows: BorderNormalLine | null;
13
+ columns: BorderNormalLine | null;
14
+ };
15
+ //# sourceMappingURL=useNormalBorderLines.d.ts.map