@sheetxl/react 0.8.0-beta.7 → 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 (406) 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/SJAlYSFKC-5yNZ-C.mjs +2706 -0
  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 +22289 -13986
  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 +284 -565
  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/CeMKhq6cSxfWzN5H.mjs +2706 -0
  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 +18027 -9614
  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 -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 +270 -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 +358 -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 +283 -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 +360 -2
  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 +123 -0
  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 +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 +59 -18
  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 +22 -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 +101 -3
  186. package/types/src/group/GroupEditor.d.ts +25 -0
  187. package/types/src/index.d.ts +10 -1
  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 +10 -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 +40 -0
  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 +15 -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 +38 -0
  258. package/types/src/movable/MovableAdornment.d.ts +26 -0
  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 +80 -0
  262. package/types/src/movable/MovableFrame.d.ts +18 -16
  263. package/types/src/movable/MovableLayer.d.ts +30 -5
  264. package/types/src/movable/MovableRenderers.d.ts +210 -0
  265. package/types/src/movable/PlaceholderFrames.d.ts +11 -0
  266. package/types/src/movable/RotateHandle.d.ts +37 -0
  267. package/types/src/movable/connect.d.ts +16 -0
  268. package/types/src/movable/framePlacement.d.ts +72 -0
  269. package/types/src/movable/geometry.d.ts +61 -0
  270. package/types/src/movable/index.d.ts +9 -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 +15 -2
  307. package/types/src/shape/ShapeGallery.d.ts +31 -0
  308. package/types/src/shape/ShapeHandles.d.ts +28 -0
  309. package/types/src/shape/ShapeKind.d.ts +7 -0
  310. package/types/src/shape/ShapeSVG.d.ts +22 -0
  311. package/types/src/shape/ShapeText.d.ts +17 -0
  312. package/types/src/shape/icons/ShapeIcons.d.ts +16 -0
  313. package/types/src/shape/icons/_ShapeIconPack.d.ts +4 -0
  314. package/types/src/shape/index.d.ts +3 -1
  315. package/types/src/shape/shapeFrame.d.ts +50 -0
  316. package/types/src/shape/shapeStyle.d.ts +82 -0
  317. package/types/src/sheet/ISheetHeaderElement.d.ts +3 -3
  318. package/types/src/sheet/IWorksheetElement.d.ts +289 -0
  319. package/types/src/sheet/OpaqueSheetElement.d.ts +21 -0
  320. package/types/src/sheet/SheetCommandProvider.d.ts +14 -6
  321. package/types/src/sheet/SheetCommands.d.ts +18 -3
  322. package/types/src/sheet/SheetKindIcon.d.ts +14 -0
  323. package/types/src/sheet/SheetOutlineElement.d.ts +70 -0
  324. package/types/src/sheet/SheetPanels.d.ts +11 -0
  325. package/types/src/sheet/SheetScrollbar.d.ts +4 -13
  326. package/types/src/sheet/TopLeftCorner.d.ts +2 -2
  327. package/types/src/sheet/WorksheetElement.d.ts +12 -0
  328. package/types/src/sheet/_freezeAt.d.ts +10 -0
  329. package/types/src/sheet/_hyperlinkEdit.d.ts +7 -0
  330. package/types/src/sheet/_useHeaderMetrics.d.ts +11 -0
  331. package/types/src/sheet/circularReferences.d.ts +4 -4
  332. package/types/src/sheet/index.d.ts +5 -2
  333. package/types/src/sheet/useCycleHighlight.d.ts +2 -2
  334. package/types/src/slicer/SlicerCommands.d.ts +10 -0
  335. package/types/src/slicer/SlicerEditor.d.ts +8 -2
  336. package/types/src/slicer/SlicerKind.d.ts +7 -0
  337. package/types/src/slicer/SlicerStylePreview.d.ts +18 -0
  338. package/types/src/slicer/index.d.ts +2 -1
  339. package/types/src/slicer/slicerStyles.d.ts +32 -0
  340. package/types/src/sparkline/PictureCache.d.ts +37 -0
  341. package/types/src/sparkline/SparklineCommands.d.ts +23 -0
  342. package/types/src/sparkline/SparklinePictures.d.ts +7 -0
  343. package/types/src/sparkline/paint/_drawing.d.ts +24 -0
  344. package/types/src/sparkline/paint/echarts.d.ts +8 -0
  345. package/types/src/sparkline/paint/index.d.ts +8 -0
  346. package/types/src/tabStrip/SheetTab.d.ts +1 -1
  347. package/types/src/tabStrip/Sortable.d.ts +5 -5
  348. package/types/src/tabStrip/TabStrip.d.ts +13 -6
  349. package/types/src/tabStrip/TabStripItem.d.ts +15 -13
  350. package/types/src/table/TableCommands.d.ts +2 -2
  351. package/types/src/taskPane/CellControlPane.d.ts +15 -0
  352. package/types/src/taskPane/MovablePane.d.ts +15 -0
  353. package/types/src/taskPane/TaskPaneArea.d.ts +7 -0
  354. package/types/src/taskPane/TaskPaneFrame.d.ts +4 -4
  355. package/types/src/taskPane/TaskPaneKeys.d.ts +38 -0
  356. package/types/src/taskPane/TaskPaneRegistry.d.ts +32 -12
  357. package/types/src/taskPane/_paneReasons.d.ts +7 -0
  358. package/types/src/taskPane/index.d.ts +3 -0
  359. package/types/src/taskPane/useTaskPane.d.ts +6 -3
  360. package/types/src/theme/ExplicitTokens.d.ts +18 -0
  361. package/types/src/theme/GridColorSchemeContext.d.ts +8 -0
  362. package/types/src/theme/ThemeRootStyles.d.ts +31 -0
  363. package/types/src/theme/ThemeState.d.ts +2 -2
  364. package/types/src/theme/buildDocThemeCSS.d.ts +4 -1
  365. package/types/src/theme/buildOOXMLThemeCSS.d.ts +2 -2
  366. package/types/src/theme/buildTokensCSS.d.ts +15 -0
  367. package/types/src/theme/index.d.ts +2 -4
  368. package/types/src/theme/useAppColorScheme.d.ts +4 -1
  369. package/types/src/theme/useGridColorScheme.d.ts +9 -4
  370. package/types/src/theme/useSystemColors.d.ts +1 -15
  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 +176 -30
  374. package/types/src/workbook/WorkbookCommands.d.ts +6 -1
  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 -42
  379. package/browser/esm/CwXbsCWTrl3QB1t6.mjs +0 -6286
  380. package/node/esm/CZc8rKcLzArmqJz2.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/ISheetElement.d.ts +0 -258
  406. package/types/src/sheet/SheetElement.d.ts +0 -15
@@ -0,0 +1,31 @@
1
+ import { default as React } from 'react';
2
+ import { ExplicitTokens } from './ExplicitTokens';
3
+ export interface ThemeRootStylesProps {
4
+ /**
5
+ * The theme root's scope class, without the leading dot. Put the same class on the root element; the
6
+ * styles apply to it and everything inside it, and to floats that carry it.
7
+ */
8
+ scopeClass: string;
9
+ /** Token values for this root, per mode and surface. Pass a stable object. */
10
+ tokens?: ExplicitTokens;
11
+ }
12
+ /**
13
+ * The stylesheets that make an element a self-contained themed instance: the neutral token defaults for
14
+ * the `app`, `grid` and `header` surfaces, the spreadsheet system colors (`--sxl-sys-color-*`) resolved
15
+ * against those surfaces, and the host's {@link ThemeRootStylesProps.tokens}, all scoped to `scopeClass`.
16
+ *
17
+ * @remarks
18
+ * `WorkbookElement` and `WorksheetElement` render this at their roots. Render it yourself only when you
19
+ * build your own shell around them and its chrome sits outside their roots: then that shell is the theme
20
+ * root. Set `data-sxl-theme-mode` on the root element alongside the class.
21
+ *
22
+ * ```tsx
23
+ * const scopeClass = createThemeScopeClass('shell', useId());
24
+ * <div className={scopeClass} data-sxl-theme-mode="dark">
25
+ * <ThemeRootStyles scopeClass={scopeClass} />
26
+ * …
27
+ * </div>
28
+ * ```
29
+ */
30
+ export declare const ThemeRootStyles: React.MemoExoticComponent<({ scopeClass, tokens }: ThemeRootStylesProps) => React.JSX.Element>;
31
+ //# sourceMappingURL=ThemeRootStyles.d.ts.map
@@ -13,7 +13,7 @@ import { ThemeMode } from '@sheetxl/utils-react';
13
13
  * the user's own choice still wins.
14
14
  */
15
15
  export declare const ThemeStateKey: {
16
- /** The user's light/dark override (`null` = follow system). */
16
+ /** The user's light/dark override (`null` = no override: the tree's `ThemeModeFallbackContext` decides — light, or the system mode under Studio). */
17
17
  readonly Mode: "themeMode";
18
18
  /** Whether the grid renders dark when the app is dark (Excel-style: dark app, optional dark grid). */
19
19
  readonly DarkGrid: "enableDarkGrid";
@@ -22,7 +22,7 @@ export declare const ThemeStateKey: {
22
22
  };
23
23
  /**
24
24
  * The shipped defaults for {@link ThemeStateKey}, used when neither the store nor the provider's
25
- * `defaultValues` has a value. They match Excel: follow the system mode, light grid, images unchanged.
25
+ * `defaultValues` has a value. They match Excel: no mode override, light grid, images unchanged.
26
26
  */
27
27
  export declare const ThemeStateDefaults: {
28
28
  readonly themeMode: ThemeMode | null;
@@ -11,6 +11,9 @@ import { ITheme } from '@sheetxl/sdk';
11
11
  *
12
12
  * Wraps the generic {@link buildThemeCSS} (utils-react) — OOXML/`--sxl-doc-*` is a react-layer concept — with
13
13
  * the doc-color records cast to the token shape (the emitter is a generic `--sxl-*` matrix, agnostic to keys).
14
+ *
15
+ * @param defaultFontSize The document's default font size, in points.
16
+ * @param lineHeight A cell's line in the document font at that size, in px (`ICellStyle.measureText`).
14
17
  */
15
- export declare const buildDocThemeCSS: (theme: ITheme, defaultFontSize?: number, layer?: string, scope?: string) => string;
18
+ export declare const buildDocThemeCSS: (theme: ITheme, defaultFontSize: number, lineHeight: number, layer?: string, scope?: string) => string;
16
19
  //# sourceMappingURL=buildDocThemeCSS.d.ts.map
@@ -4,10 +4,10 @@
4
4
  * own tokens; decision 4). It wraps the generic {@link buildThemeCSS} (utils-react) — OOXML lives here in
5
5
  * `@sheetxl/react`, not below — passing the sys aliases as the per-surface records.
6
6
  *
7
- * The sys aliases are **just another surface layer**, so each top-level instance (`SheetElement`,
7
+ * The sys aliases are **just another surface layer**, so each top-level instance (`WorksheetElement`,
8
8
  * `WorkbookElement`, studio) emits its own copy `@scope`d to its instance root — same per-instance `useId`
9
9
  * model as the token sheets. Pass the instance's scope selector. The `--sxl-doc-*` document colors are
10
- * model-driven and stay with `SheetElement` for now.
10
+ * model-driven and stay with `WorksheetElement` for now.
11
11
  */
12
12
  export declare const buildOOXMLThemeCSS: (layer?: string, scope?: string) => string;
13
13
  //# sourceMappingURL=buildOOXMLThemeCSS.d.ts.map
@@ -0,0 +1,15 @@
1
+ import { ExplicitTokens } from './ExplicitTokens';
2
+ /**
3
+ * The override stylesheet for {@link ExplicitTokens}: the same rules a client would write by hand in
4
+ * `@layer sxl-overrides`, scoped to one instance.
5
+ *
6
+ * @remarks
7
+ * An `app` value reaches every surface in that mode, because each surface element carries its own mode and
8
+ * the override layer outranks the surface defaults. State a `grid` or `header` cell to make that surface
9
+ * differ. A value stated for one mode never applies in the other.
10
+ *
11
+ * @param tokens The host's cells.
12
+ * @param scope The instance's `@scope` selector (e.g. `.sheetxl-workbook-r1`).
13
+ */
14
+ export declare const buildTokensCSS: (tokens: ExplicitTokens, scope?: string) => string;
15
+ //# sourceMappingURL=buildTokensCSS.d.ts.map
@@ -1,11 +1,9 @@
1
1
  export * from './DocThemesContext';
2
2
  export * from './DocThemesProvider';
3
3
  export * from './useDocThemes';
4
- export * from './createCSSSystemLookup';
5
- export * from './useSystemColors';
6
- export * from './buildOOXMLThemeCSS';
7
- export * from './buildDocThemeCSS';
8
4
  export * from './ThemeState';
9
5
  export * from './useGridColorScheme';
10
6
  export * from './useAppColorScheme';
7
+ export * from './ExplicitTokens';
8
+ export * from './ThemeRootStyles';
11
9
  //# sourceMappingURL=index.d.ts.map
@@ -10,6 +10,9 @@ import { ThemeMode } from '@sheetxl/utils-react';
10
10
  * rule, and both the workbook root (app mode) and the sheet (grid mode) are ancestors, so CSS would pick by
11
11
  * source order rather than proximity. Stating the mode selects the compound `[mode][surface]` cell, which is
12
12
  * emitted last and wins.
13
+ *
14
+ * @param override A controlled scheme (a host's `colorScheme` prop); when provided it wins over the
15
+ * preference. `'auto'` follows the page class, else the OS.
13
16
  */
14
- export declare const useAppColorScheme: () => ThemeMode;
17
+ export declare const useAppColorScheme: (override?: ThemeMode | "auto") => ThemeMode;
15
18
  //# sourceMappingURL=useAppColorScheme.d.ts.map
@@ -3,18 +3,23 @@ import { ThemeMode } from '@sheetxl/utils-react';
3
3
  * The grid body's resolved light/dark scheme — the single source of the grid's mode.
4
4
  *
5
5
  * Derived from the shared appearance preference: the user's light/dark override
6
- * (`ThemeStateKey.Mode`, resolved via `prefers-color-scheme` when unset), gated by *Enable Dark Grid*
6
+ * (`ThemeStateKey.Mode`, resolved via `useResolvedThemeMode` when unset), gated by *Enable Dark Grid*
7
7
  * (`ThemeStateKey.DarkGrid`, off unless a host or the user turns it on) so the grid stays light in a dark app unless opted in.
8
8
  *
9
9
  * Because it reads the shared (module-singleton) preference store, every caller — the grid surface
10
- * (`SheetElement`) **and** chrome that must match the grid but renders outside its DOM (the table-style
10
+ * (`WorksheetElement`) **and** chrome that must match the grid but renders outside its DOM (the table-style
11
11
  * preview, the cell-style / color pickers) — resolves the *same* value with no prop-threading and no
12
12
  * drift from the studio (which reads the same keys the same way).
13
13
  *
14
+ * Inside a workbook or worksheet element the element's own scheme wins: a host that passes
15
+ * `gridColorScheme` gets it for everything drawn in that grid (charts, cell renderers, sheet tabs),
16
+ * not only the cells.
17
+ *
14
18
  * A consumer uses it to set `data-sxl-theme-surface="grid"` + `data-sxl-theme-mode={scheme}` on its own
15
19
  * element, then resolves `--sxl-*` from the cascade / `getComputedStyle`.
16
20
  *
17
- * @param override Optional controlled scheme; when provided it wins over the preference.
21
+ * @param override Optional controlled scheme; when provided it wins over the enclosing grid and the preference.
22
+ * `'auto'` follows the page class, else the OS, without the *Enable Dark Grid* gate: the host asked for it.
18
23
  */
19
- export declare const useGridColorScheme: (override?: ThemeMode) => ThemeMode;
24
+ export declare const useGridColorScheme: (override?: ThemeMode | "auto") => ThemeMode;
20
25
  //# sourceMappingURL=useGridColorScheme.d.ts.map
@@ -1,4 +1,3 @@
1
- import { IColor } from '@sheetxl/sdk';
2
1
  import { CSSSystemLookup } from './createCSSSystemLookup';
3
2
  /**
4
3
  * Injects the default `--sxl-sys-color-*` CSS variables — the built-in (baked) system color
@@ -12,22 +11,9 @@ import { CSSSystemLookup } from './createCSSSystemLookup';
12
11
  * `:root` stylesheet (not inline styles) keeps specificity low so host overrides win.
13
12
  */
14
13
  export declare const installSystemColorDefaults: () => void;
15
- /**
16
- * Builds `--sxl-sys-color-*` CSS variable overrides from a partial set of {@link IColor.Named} system
17
- * colors, so that system/auto colors (which `IColor.toCSS()` emits as `var(--sxl-sys-color-*)`) resolve
18
- * to the provided values rather than the global host mapping.
19
- *
20
- * @remarks
21
- * Used by the grid container ({@link SheetElement}) and by UI rendered *outside* the grid subtree
22
- * that must still match the grid's light/dark intent — most notably a color picker popup, which is
23
- * portaled and would otherwise inherit the host's `--sxl-sys-color-*` (e.g. a light grid in a dark host
24
- * would show the host's dark `auto` color). Names are lower-cased to match the variable
25
- * `IColor.toCSS()` references; centralizing that here keeps callers from drifting.
26
- */
27
- export declare const createSystemColorVars: (colors: Partial<Record<IColor.Named, string>>) => Record<string, string>;
28
14
  /**
29
15
  * Ensures the default system-color CSS variables are present (see {@link installSystemColorDefaults}).
30
- * Wired into `SheetElement`, so the grid themes from `--sxl-sys-color-*` out of the box.
16
+ * Wired into `WorksheetElement`, so the grid themes from `--sxl-sys-color-*` out of the box.
31
17
  */
32
18
  export declare const useSystemColors: () => void;
33
19
  /**
@@ -0,0 +1,20 @@
1
+ import { registerBuiltInMovableRenderer } from '../movable/MovableRenderers';
2
+ /**
3
+ * Registers the built-in renderer for each kind of movable content. Called by the renderer
4
+ * registry before its first use; a host replaces any of them with `registerMovableRenderer`.
5
+ *
6
+ * @remarks
7
+ * A call, not an import for its effect: the package declares only its CSS as side effects, so a
8
+ * bundler drops a module imported only for one, and every built-in renderer with it.
9
+ *
10
+ * Every one is loaded the first time a movable of its kind is drawn, or ahead of use by a prefetch,
11
+ * so a workbook with no charts does not wait on the chart editor to show. For that to hold in a
12
+ * bundle, the editor must not also be reached statically: the package's index does not re-export
13
+ * the editors, which hosts that render one directly import from its subpath
14
+ * (`@sheetxl/react/chart`, `/shape`, ...; see vite.config.ts).
15
+ *
16
+ * Each is one `import()` with its export picked by `select`, so a failed fetch can be imported
17
+ * again.
18
+ */
19
+ export declare function registerDefaultMovableRenderers(register: typeof registerBuiltInMovableRenderer): void;
20
+ //# sourceMappingURL=DefaultMovableRenderers.d.ts.map
@@ -1,6 +1,6 @@
1
1
  import { default as React } from 'react';
2
2
  import { LoadingPanelProps } from '@sheetxl/utils-react';
3
- import { SheetElementProps } from '../sheet';
3
+ import { WorksheetElementProps, OpaqueSheetElementProps } from '../sheet';
4
4
  import { WorkbookStripProps } from './WorkbookStrip';
5
5
  /**
6
6
  * Default renderers for {@link WorkbookElement}.
@@ -8,7 +8,8 @@ import { WorkbookStripProps } from './WorkbookStrip';
8
8
  * @remarks
9
9
  * These can be replaced by host application layers as needed.
10
10
  */
11
- export declare const renderWorkbookSheet: (props: SheetElementProps) => React.ReactElement;
12
- export declare const renderWorkbookStrip: (props: WorkbookStripProps) => React.ReactElement;
13
- export declare const renderWorkbookLoading: (props: LoadingPanelProps) => React.ReactElement;
11
+ export declare const defaultRenderWorksheet: (props: WorksheetElementProps) => React.ReactElement;
12
+ export declare const defaultRenderOpaqueSheet: (props: OpaqueSheetElementProps) => React.ReactElement;
13
+ export declare const defaultRenderTabs: (props: WorkbookStripProps) => React.ReactElement;
14
+ export declare const defaultRenderWorkbookLoading: (props: LoadingPanelProps) => React.ReactElement;
14
15
  //# sourceMappingURL=DefaultRenderers.d.ts.map
@@ -1,9 +1,11 @@
1
1
  import { default as React } from 'react';
2
2
  import { UndoManager } from '@sheetxl/utils';
3
- import { IWorkbook, IWorkbookIO } from '@sheetxl/sdk';
4
- import { LoadingPanelProps, ErrorPanelProps, RenderFloatPanel, FloatPanelProps, ThemeMode, Command } from '@sheetxl/utils-react';
5
- import { SheetElementProps, ISheetElement } from '../sheet';
3
+ import { IWorkbook, IWorkbookIO, IMovable, ITable, IPivotTable } from '@sheetxl/sdk';
4
+ import { LoadingPanelProps, ErrorPanelProps, RenderFloatPanel, FloatPanelProps, FloatReference, RenderSlotFn, ThemeMode, Command } from '@sheetxl/utils-react';
5
+ import { WorksheetElementProps, IWorksheetElement, OpaqueSheetElementProps } from '../sheet';
6
6
  import { SheetEditable } from '../editor';
7
+ import { ExplicitTokens } from '../theme';
8
+ import { CommandContext } from '../frame';
7
9
  import { WorkbookStripProps } from './WorkbookStrip';
8
10
  /**
9
11
  * Workbook specific attributes beyond HTMLDivElement.
@@ -17,7 +19,7 @@ export interface IWorkbookAttributes {
17
19
  * Retrieve the sheet element associated with this workbook element.
18
20
  * `null` before the sheet has mounted.
19
21
  */
20
- getSheetElement: () => ISheetElement | null;
22
+ getSheetElement: () => IWorksheetElement | null;
21
23
  /**
22
24
  * Retrieve the viewport element associated with this workbook element.
23
25
  * `null` before the viewport has mounted.
@@ -33,6 +35,13 @@ export interface IWorkbookAttributes {
33
35
  * `null` until the scope is created (or for a bare chromeless grid with no ambient command root).
34
36
  */
35
37
  getCommandScope: () => Command.CommandScope | null;
38
+ /**
39
+ * Resolves once everything on screen has finished drawing: pictures decoded, charts laid out.
40
+ * Unlike {@link WorkbookElementProps.onRenderSettled} it is never cut short by
41
+ * {@link WorkbookElementProps.renderSettleTimeout}, so it suits a capture (a thumbnail, a
42
+ * screenshot). Wait for the next paint after it before reading the screen.
43
+ */
44
+ whenRenderSettled: () => Promise<void>;
36
45
  /**
37
46
  * For runtime type checking
38
47
  */
@@ -46,8 +55,52 @@ export interface IWorkbookElement extends HTMLDivElement, IWorkbookAttributes {
46
55
  export type WorkbookLoadEvent = {
47
56
  source: IWorkbookElement;
48
57
  };
58
+ /** What {@link WorkbookElementProps.onRenderSettled} is handed. */
59
+ export type WorkbookRenderSettledEvent = WorkbookLoadEvent & {
60
+ /**
61
+ * `true` when {@link WorkbookElementProps.renderSettleTimeout} ran out first, so some drawing may
62
+ * still be on its way. Await {@link IWorkbookAttributes.whenRenderSettled} for all of it.
63
+ */
64
+ timedOut: boolean;
65
+ };
66
+ /**
67
+ * What every workbook menu renderer is handed. Spread the rest on the menu's root.
68
+ */
69
+ export interface WorkbookMenuRenderProps extends React.HTMLAttributes<HTMLDivElement> {
70
+ /** The menu's float. Close it when an entry runs. */
71
+ floatReference: FloatReference;
72
+ disabled?: boolean;
73
+ }
74
+ /** What {@link WorkbookElementProps.renderContextMenu} is handed. */
75
+ export interface ContextMenuRenderProps extends WorkbookMenuRenderProps {
76
+ workbook: IWorkbook;
77
+ }
78
+ /** What {@link WorkbookElementProps.renderColumnMenu} is handed. */
79
+ export interface ColumnMenuRenderProps extends WorkbookMenuRenderProps {
80
+ /** The table column whose button was pressed. */
81
+ column: ITable.IColumn;
82
+ }
83
+ /** What {@link WorkbookElementProps.renderPivotMenu} is handed. */
84
+ export interface PivotMenuRenderProps extends WorkbookMenuRenderProps {
85
+ /** The fields of the pivot table's button that was pressed: one, or a compact header's row or column fields. */
86
+ fields: readonly IPivotTable.IField[];
87
+ }
88
+ /** What {@link WorkbookElementProps.renderMovableMenu} is handed. */
89
+ export interface MovableMenuRenderProps extends WorkbookMenuRenderProps {
90
+ movable: IMovable;
91
+ }
92
+ /** What {@link WorkbookElementProps.renderFillMenu} is handed. */
93
+ export interface FillMenuRenderProps extends WorkbookMenuRenderProps {
94
+ workbook: IWorkbook;
95
+ /** What the right-drag offers and runs. */
96
+ menu: CommandContext.FillMenu;
97
+ }
49
98
  /**
50
99
  * Properties and methods available on the workbook element.
100
+ *
101
+ * @remarks
102
+ * Every `render*` slot is mounted as its own component, so a renderer may call hooks. Omit a slot (or
103
+ * pass `undefined`) for its default; pass `null` to render nothing.
51
104
  */
52
105
  export interface WorkbookElementProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'autoFocus'>, React.Attributes {
53
106
  /**
@@ -60,20 +113,104 @@ export interface WorkbookElementProps extends Omit<React.HTMLAttributes<HTMLDivE
60
113
  */
61
114
  workbook?: IWorkbook | Promise<IWorkbook> | IWorkbookIO.ReadOptions;
62
115
  /**
63
- * Controlled override for the app (chrome) light/dark scheme. When omitted, the workbook self-sources
64
- * it from the shared appearance preference (`ThemeStateKey.Mode`, resolved via `prefers-color-scheme`).
116
+ * Controlled override for the app (chrome) light/dark scheme. `'auto'` follows the page: a
117
+ * `dark`/`light` class on `<html>`/`<body>`, else the OS.
118
+ *
119
+ * When omitted, the workbook self-sources it from the shared appearance preference
120
+ * (`ThemeStateKey.Mode`). With no preference set it is light, unless the page puts a `dark`/`light` class
121
+ * on `<html>`/`<body>` or a `ThemeModeFallbackContext` above says otherwise.
65
122
  */
66
- colorScheme?: ThemeMode;
123
+ colorScheme?: ThemeMode | 'auto';
67
124
  /**
68
- * Controlled override for the grid-body scheme (stays light in a dark app when *Enable Dark Grid* is
69
- * off). When omitted, derived from {@link colorScheme} + the `ThemeStateKey.DarkGrid` preference.
125
+ * Controlled override for the grid-body scheme. `'auto'` follows the page as {@link colorScheme} does.
126
+ *
127
+ * When omitted, the grid follows {@link colorScheme} only if *Enable Dark Grid*
128
+ * (`ThemeStateKey.DarkGrid`) is on, so by default it stays light in a dark app. Pass it to make the grid
129
+ * dark with the page.
130
+ */
131
+ gridColorScheme?: ThemeMode | 'auto';
132
+ /**
133
+ * Token values for this workbook, per mode and surface: the React form of a stylesheet in
134
+ * `@layer sxl-overrides`, scoped to this instance.
135
+ *
136
+ * ```tsx
137
+ * <WorkbookElement
138
+ * colorScheme="auto"
139
+ * gridColorScheme="auto"
140
+ * tokens={{
141
+ * dark: {
142
+ * app: { 'color-base-100': '#14102c', 'color-base-200': '#14102c', 'color-primary': '#6e9bff' },
143
+ * header: { 'color-base-100': '#1a1538', 'color-base-300': '#312b55' }
144
+ * }
145
+ * }}
146
+ * />
147
+ * ```
148
+ *
149
+ * @remarks
150
+ * An `app` value reaches the grid and headers too in that mode; state a `grid` or `header` cell to make
151
+ * that surface differ. Pass a stable object: a new reference rebuilds the stylesheet.
70
152
  */
71
- gridColorScheme?: ThemeMode;
153
+ tokens?: ExplicitTokens;
72
154
  /**
73
- * Callback for when the workbook is loaded (first render). Useful for hiding/showing
74
- * loading panels.
155
+ * Called when the workbook first renders, before its pictures and charts have finished drawing.
156
+ * To reveal it, use {@link WorkbookElementProps.onRenderSettled}.
75
157
  */
76
158
  onWorkbookLoad?: (event: WorkbookLoadEvent) => void | Promise<void>;
159
+ /**
160
+ * Called once the first screen has finished drawing (pictures, charts, the sheet background) and
161
+ * painted, or once {@link WorkbookElementProps.renderSettleTimeout} runs out. The workbook shows at
162
+ * this moment, so it opens whole rather than filling in piece by piece.
163
+ *
164
+ * @remarks
165
+ * Fires once, after {@link WorkbookElementProps.onWorkbookLoad} (and after a returned promise
166
+ * resolves).
167
+ */
168
+ onRenderSettled?: (event: WorkbookRenderSettledEvent) => void;
169
+ /**
170
+ * How long, in milliseconds after the first paint, the workbook stays hidden waiting for the first
171
+ * screen to finish drawing. Whatever is still loading then appears when it is ready. `0` shows the
172
+ * workbook at its first paint; `Infinity` waits for everything.
173
+ *
174
+ * @defaultValue 300
175
+ */
176
+ renderSettleTimeout?: number;
177
+ /**
178
+ * Called with the workbook once {@link WorkbookElementProps.workbook} resolves, and again whenever
179
+ * a new input resolves to a different one. Until the first input resolves, or if an input fails,
180
+ * the workbook is `null`; while a later input resolves, the current workbook is kept.
181
+ *
182
+ * @remarks
183
+ * Lets an app pass a `Promise` here and hold the live workbook in its own state, without awaiting
184
+ * or suspending.
185
+ *
186
+ * @example
187
+ * ```tsx
188
+ * const [pending] = useState(() => createInvoice());
189
+ * const [workbook, setWorkbook] = useState<IWorkbook | null>(null);
190
+ * const [total] = useCellValue<number>(workbook, 'D23');
191
+ * return <WorkbookElement workbook={pending} onWorkbookChange={setWorkbook} />;
192
+ * ```
193
+ */
194
+ onWorkbookChange?: (workbook: IWorkbook | null) => void;
195
+ /**
196
+ * Whether features that load on first use (charts, shapes, form controls, file formats, dialogs)
197
+ * are loaded ahead of use once the workbook has shown, so their first use does not wait on the
198
+ * network.
199
+ *
200
+ * - `'auto'` - only while the browser reports a fast connection. Browsers that report none
201
+ * (Firefox, Safari) load each feature on first use.
202
+ * - `true` - on any connection but a 2g one.
203
+ * - `false` - each feature on first use.
204
+ *
205
+ * @remarks
206
+ * Loads every module defined with `defineLazyModule` from `@sheetxl/utils` that has not opted out,
207
+ * including every kind registered with `MovableContentRegistry` and `registerMovableRenderer`.
208
+ * Nothing is loaded while offline or when the connection asks to save data; it resumes when the
209
+ * connection changes.
210
+ *
211
+ * @defaultValue 'auto'
212
+ */
213
+ prefetch?: boolean | 'auto';
77
214
  /**
78
215
  * A custom undo manager.
79
216
  *
@@ -97,30 +234,35 @@ export interface WorkbookElementProps extends Omit<React.HTMLAttributes<HTMLDivE
97
234
  */
98
235
  propsTabs?: Partial<WorkbookStripProps>;
99
236
  /**
100
- * Render custom tabs.
237
+ * Render the sheet tabs.
101
238
  */
102
- renderTabs?: (props: WorkbookStripProps) => React.ReactElement;
239
+ renderTabs?: RenderSlotFn<WorkbookStripProps> | null;
103
240
  /**
104
- * Props for the context menu.
241
+ * Props handed to every menu renderer.
105
242
  */
106
- propsContextMenu?: any;
243
+ propsContextMenu?: Partial<WorkbookMenuRenderProps>;
107
244
  /**
108
- * Render custom context menu. (chrome - no default)
245
+ * Render the grid's context menu. The default renders none, and the browser's menu shows.
109
246
  */
110
- renderContextMenu?: (props: any) => React.ReactElement;
247
+ renderContextMenu?: RenderSlotFn<ContextMenuRenderProps> | null;
111
248
  /**
112
- * Render custom filter/column menu. (chrome - no default)
249
+ * Render the filter menu of a table column's button. The default renders none.
113
250
  */
114
- renderColumnMenu?: (props: any) => React.ReactElement;
251
+ renderColumnMenu?: RenderSlotFn<ColumnMenuRenderProps> | null;
115
252
  /**
116
- * Render custom movable menu. (chrome - no default)
253
+ * Render the menu of a pivot table's field button: its items to show or hide, or a page field's
254
+ * item to choose. The default renders none.
117
255
  */
118
- renderMovableMenu?: (props: any) => React.ReactElement;
256
+ renderPivotMenu?: RenderSlotFn<PivotMenuRenderProps> | null;
119
257
  /**
120
- * Render the fill menu a right-drag of the fill handle ends in. (chrome - no default; without it
121
- * the right-drag is inert)
258
+ * Render the context menu of a chart, shape or other movable. The default renders none.
122
259
  */
123
- renderFillMenu?: (props: any) => React.ReactElement;
260
+ renderMovableMenu?: RenderSlotFn<MovableMenuRenderProps> | null;
261
+ /**
262
+ * Render the menu a right-drag of the fill handle ends in. The default renders none, and the
263
+ * right-drag is inert.
264
+ */
265
+ renderFillMenu?: RenderSlotFn<FillMenuRenderProps> | null;
124
266
  /**
125
267
  * Allow for customizations on the floating surface used for the workbook's popups.
126
268
  */
@@ -137,12 +279,12 @@ export interface WorkbookElementProps extends Omit<React.HTMLAttributes<HTMLDivE
137
279
  /**
138
280
  * Assign a custom loading panel.
139
281
  */
140
- renderWorkbookLoading?: (props: LoadingPanelProps) => React.ReactElement;
282
+ renderWorkbookLoading?: RenderSlotFn<LoadingPanelProps> | null;
141
283
  /**
142
284
  * Custom error panel, shown when a `Promise` / {@link IWorkbookIO.ReadOptions} {@link WorkbookElementProps.workbook}
143
285
  * fails to resolve. Defaults to a minimal message. (Studio supplies a themed panel.)
144
286
  */
145
- renderWorkbookError?: (props: ErrorPanelProps) => React.ReactElement;
287
+ renderWorkbookError?: RenderSlotFn<ErrorPanelProps> | null;
146
288
  /**
147
289
  * The app-created editor for the new always-mounted cell editor. Pass the SAME stable
148
290
  * {@link IEditable} instance here and to the formula bar for free two-way sync; this forwards it to
@@ -152,11 +294,15 @@ export interface WorkbookElementProps extends Omit<React.HTMLAttributes<HTMLDivE
152
294
  /**
153
295
  * Allow for customizations on the sheet.
154
296
  */
155
- propsSheet?: Partial<SheetElementProps>;
297
+ propsSheet?: Partial<WorksheetElementProps>;
298
+ /**
299
+ * Render the active worksheet. Pass `props.ref` on to the {@link IWorksheetElement}.
300
+ */
301
+ renderWorksheet?: RenderSlotFn<WorksheetElementProps>;
156
302
  /**
157
- * Render custom ISheetElement.
303
+ * Render the pane of a chart sheet, a macro sheet or a dialog sheet while it is the active tab.
158
304
  */
159
- renderSheet?: (props: SheetElementProps) => React.ReactElement;
305
+ renderOpaqueSheet?: RenderSlotFn<OpaqueSheetElementProps>;
160
306
  /**
161
307
  * Allows users to Wrap stage children in Top level Context.
162
308
  */
@@ -2,7 +2,7 @@ import { RemoveListener } from '@sheetxl/utils';
2
2
  import { IWorkbook, IThemeCollection, ICell, IRange } from '@sheetxl/sdk';
3
3
  import { Command, IReactNotifier } from '@sheetxl/utils-react';
4
4
  import { CommandContext } from '../frame';
5
- import { ActivateFrameOptions } from '../taskPane';
5
+ import { ActivateFrameOptions, ITaskPaneArea } from '../taskPane';
6
6
  import { SheetEditable } from '../editor';
7
7
  /**
8
8
  * Workbook-level command **behavior** (pure callbacks) + the structure-protection / sheet-count disable
@@ -59,6 +59,11 @@ export interface ContributeWorkbookCommandsOptions {
59
59
  notifier?: IReactNotifier;
60
60
  /** Activate a task pane by key (the test `activateTask` command). Threaded from `useTaskPaneArea()`. */
61
61
  activateTaskPane?: (key: string, options?: ActivateFrameOptions) => void;
62
+ /**
63
+ * The task-pane area `activateTaskPane` opens into, read to disable the commands whose pane it cannot
64
+ * show. Threaded from `useTaskPaneArea()`; omitted ⇒ those commands are disabled.
65
+ */
66
+ taskPaneArea?: ITaskPaneArea;
62
67
  /** Theme collection for the `selectTheme` picker context. Omit ⇒ the picker has no list to show. */
63
68
  themes?: IThemeCollection;
64
69
  /**
@@ -1,6 +1,6 @@
1
1
  import { default as React } from 'react';
2
2
  import { IWorkbook } from '@sheetxl/sdk';
3
- import { ScrollButtonProps } from '@sheetxl/utils-react';
3
+ import { ScrollButtonProps, RenderSlotFn } from '@sheetxl/utils-react';
4
4
  import { SheetTabProps } from '../tabStrip';
5
5
  /**
6
6
  * A table tab strip that operates on an {@link IWorkbook}.
@@ -38,13 +38,22 @@ export interface WorkbookStripProps extends React.HTMLAttributes<HTMLDivElement>
38
38
  * @defaultValue false
39
39
  */
40
40
  condensed?: boolean;
41
+ /**
42
+ * Draw the strip's segment of the seam framing the grid along its top edge. Off when the row
43
+ * above already draws that seam and nothing visible sits between them: the stacked layout on a
44
+ * touch device, where the scrollbar track is invisible and the tabs would get a second line 2px
45
+ * under the first.
46
+ *
47
+ * @defaultValue true
48
+ */
49
+ seam?: boolean;
41
50
  /**
42
51
  * Override how each sheet tab renders. Defaults to a plain {@link SheetTab}. A host with its
43
52
  * own tab chrome (e.g. the MUI strip's ripple surface) supplies this rather than re-forking
44
53
  * the whole strip. The `sheet`, `inverted` and (when {@link onTabContextMenu} is set)
45
54
  * `onContextMenu` are provided; anything else is the underlying {@link TabStrip} tab props.
46
55
  */
47
- renderSheetTab?: (props: SheetTabProps) => React.ReactElement;
56
+ renderSheetTab?: RenderSlotFn<SheetTabProps>;
48
57
  /**
49
58
  * Called on a sheet tab's context-menu (right-click) event, after that tab has been selected.
50
59
  * The strip itself renders no menu — a host provides one (e.g. the MUI strip's `SheetTabMenu`).
@@ -56,9 +65,9 @@ export interface WorkbookStripProps extends React.HTMLAttributes<HTMLDivElement>
56
65
  * currently rendered by `TabStrip`; start/end are accepted for parity. Pass `null` to suppress
57
66
  * a button (as the strip does for all three in {@link condensed} layout).
58
67
  */
59
- renderScrollButtonStart?: ((props: ScrollButtonProps) => React.ReactElement) | null;
60
- renderScrollButtonEnd?: ((props: ScrollButtonProps) => React.ReactElement) | null;
61
- renderScrollButtonEdge?: ((props: ScrollButtonProps) => React.ReactElement) | null;
68
+ renderScrollButtonStart?: RenderSlotFn<ScrollButtonProps> | null;
69
+ renderScrollButtonEnd?: RenderSlotFn<ScrollButtonProps> | null;
70
+ renderScrollButtonEdge?: RenderSlotFn<ScrollButtonProps> | null;
62
71
  }
63
72
  /**
64
73
  * Imperative handle for {@link WorkbookStrip}: the root element plus tab-editing methods
@@ -1 +0,0 @@
1
- var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,n)=>{let r={};for(var i in e)t(r,i,{get:e[i],enumerable:!0});return n||t(r,Symbol.toStringTag,{value:`Module`}),r},s=(o,s,c)=>(c=o==null?{}:e(i(o)),((e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c,l=r(i),u=0,d=l.length;u<d;u++)c=l[u],a.call(e,c)||c===o||t(e,c,{get:(e=>i[e]).bind(null,c),enumerable:!(s=n(i,c))||s.enumerable});return e})(!s&&o&&o.__esModule?c:t(c,`default`,{value:o,enumerable:!0}),o));Object.defineProperty(exports,"n",{enumerable:!0,get:function(){return s}}),Object.defineProperty(exports,"t",{enumerable:!0,get:function(){return o}});