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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (405) hide show
  1. package/LICENSE.md +8 -7
  2. package/browser/esm/6lfBozPNyWlFBEDn.mjs +19 -0
  3. package/browser/esm/B7TCFLHs7nnOgLMi.mjs +79 -0
  4. package/browser/esm/BQur1iFrng9Y4kh4.mjs +2706 -0
  5. package/browser/esm/BjnWnPjhT1QFkbUC.mjs +60 -0
  6. package/browser/esm/BwMC6jAg2neI4LTH.mjs +32 -0
  7. package/browser/esm/BzCq_Z7J2qQlY4Dp.mjs +134 -0
  8. package/browser/esm/BzFKdDmdCdg3cXdh.mjs +262 -0
  9. package/browser/esm/C2HjD-DbaqXq93R7.mjs +45 -0
  10. package/browser/esm/C46qV9hBGqlz6_Kt.mjs +323 -0
  11. package/browser/esm/C9dHNoiKtX9PLY1g.mjs +20 -0
  12. package/browser/esm/CA6w64diOtRCgr4n.mjs +67 -0
  13. package/browser/esm/CCL3pFmdsuwahoCR.mjs +42 -0
  14. package/browser/esm/CHgyrBEiFmspcFXV.mjs +8 -0
  15. package/browser/esm/CPwcEeQtvkrESNEy.mjs +303 -0
  16. package/browser/esm/CdE8JeJkTtdh5qqp.mjs +78 -0
  17. package/browser/esm/CkYId3pjG9v3XZM2.mjs +36 -0
  18. package/browser/esm/Co65nK3fyBcyVzrS.mjs +401 -0
  19. package/browser/esm/DG1f60gvSkz8Y3qb.mjs +197 -0
  20. package/browser/esm/DL2WZkJdK1lZfpJo.mjs +341 -0
  21. package/browser/esm/Dl0ye0MfTml4mjhA.mjs +9560 -0
  22. package/browser/esm/_T8e_9xhVAagwkPD.mjs +31 -0
  23. package/browser/esm/chart.mjs +41 -0
  24. package/browser/esm/control.mjs +217 -0
  25. package/browser/esm/fHDciYUZvXpLzoID.mjs +128 -0
  26. package/browser/esm/group.mjs +123 -0
  27. package/browser/esm/index.mjs +22374 -13204
  28. package/browser/esm/k1IvXgw5-153QQUo.mjs +14092 -0
  29. package/browser/esm/mOYnwl3MMod-yX7a.mjs +63 -0
  30. package/browser/esm/note.mjs +112 -0
  31. package/browser/esm/picture.mjs +7 -0
  32. package/browser/esm/shape.mjs +7 -0
  33. package/browser/esm/slicer.mjs +277 -0
  34. package/browser/esm/zTaXN_1rvsoWg94m.mjs +145 -0
  35. package/licenses/dependencies.txt +284 -565
  36. package/node/esm/8PerdW56-NyRf0pg.mjs +134 -0
  37. package/node/esm/B2a1mRx9B8XMRd8H.mjs +2706 -0
  38. package/node/esm/B4qJFO-8Vml8JbaC.mjs +146 -0
  39. package/node/esm/BBBfGP0lLhBFoR9F.mjs +198 -0
  40. package/node/esm/BQpm93aEyzN5TiU6.mjs +8 -0
  41. package/node/esm/BadjRr_jKKGvmEW-.mjs +80 -0
  42. package/node/esm/Bzuh8HcJcFD2dYTY.mjs +128 -0
  43. package/node/esm/CD1OBtF4vEthYy6e.mjs +35 -0
  44. package/node/esm/CGEbcsNJ40cYQEWX.mjs +1697 -0
  45. package/node/esm/CNYzecnb2TInTI8p.mjs +80 -0
  46. package/node/esm/COg8aOu0d67g_Pg5.mjs +37 -0
  47. package/node/esm/CdKkuM4Yy04LbhRL.mjs +19 -0
  48. package/node/esm/Df-nWyFJwXaVd79x.mjs +263 -0
  49. package/node/esm/DtrPF3bSD4CZC5VG.mjs +45 -0
  50. package/node/esm/EXPN4LM0alUK5Zw7.mjs +20 -0
  51. package/node/esm/JrDkDzP0l4TgHusH.mjs +32 -0
  52. package/node/esm/Mq8a4csdTfwY5CnZ.mjs +63 -0
  53. package/node/esm/cgqViNUwnlIX8-UW.mjs +328 -0
  54. package/node/esm/chart.mjs +41 -0
  55. package/node/esm/control.mjs +217 -0
  56. package/node/esm/fM9xnrz0LJWdndYE.mjs +68 -0
  57. package/node/esm/group.mjs +123 -0
  58. package/node/esm/index.mjs +18717 -9431
  59. package/node/esm/note.mjs +113 -0
  60. package/node/esm/picture.mjs +305 -0
  61. package/node/esm/shape.mjs +342 -0
  62. package/node/esm/slicer.mjs +279 -0
  63. package/node/esm/tRhXTPxocmY7ZY3z.mjs +66 -0
  64. package/node/esm/uzlKB6H0b-ol8pDK.mjs +406 -0
  65. package/package.json +56 -15
  66. package/resources/contents.json +36 -0
  67. package/resources/locales/contents.json +84 -0
  68. package/resources/locales/de/chart.cmd.json +82 -0
  69. package/resources/locales/de/movable.cmd.json +68 -0
  70. package/resources/locales/de/picture.cmd.json +188 -0
  71. package/resources/locales/de/pivot.cmd.json +79 -0
  72. package/resources/locales/de/shape.cmd.json +17 -0
  73. package/resources/locales/de/sheet.cmd.json +314 -27
  74. package/resources/locales/de/slicer.cmd.json +17 -0
  75. package/resources/locales/de/sparkline.cmd.json +301 -0
  76. package/resources/locales/de/table.cmd.json +13 -2
  77. package/resources/locales/de/ui.msg.json +367 -3
  78. package/resources/locales/de/workbook.cmd.json +8 -1
  79. package/resources/locales/en/chart.cmd.json +82 -0
  80. package/resources/locales/en/movable.cmd.json +68 -0
  81. package/resources/locales/en/picture.cmd.json +188 -0
  82. package/resources/locales/en/pivot.cmd.json +79 -0
  83. package/resources/locales/en/shape.cmd.json +17 -0
  84. package/resources/locales/en/sheet.cmd.json +328 -29
  85. package/resources/locales/en/slicer.cmd.json +17 -0
  86. package/resources/locales/en/sparkline.cmd.json +301 -0
  87. package/resources/locales/en/table.cmd.json +13 -2
  88. package/resources/locales/en/ui.msg.json +369 -3
  89. package/resources/locales/en/workbook.cmd.json +8 -1
  90. package/types/chart.d.ts +2 -0
  91. package/types/control.d.ts +2 -0
  92. package/types/group.d.ts +2 -0
  93. package/types/note.d.ts +2 -0
  94. package/types/picture.d.ts +2 -0
  95. package/types/shape.d.ts +2 -0
  96. package/types/slicer.d.ts +2 -0
  97. package/types/src/annotation/RangeAnnotationLayer.d.ts +110 -0
  98. package/types/src/annotation/RangeAnnotationTag.d.ts +23 -0
  99. package/types/src/annotation/RangeAnnotations.d.ts +180 -0
  100. package/types/src/annotation/index.d.ts +4 -0
  101. package/types/src/autoFill/FillMenu.d.ts +2 -2
  102. package/types/src/autoFill/FillSeries.d.ts +2 -2
  103. package/types/src/border/StaticBorderRenderer.d.ts +18 -1
  104. package/types/src/border/useBorders.d.ts +95 -3
  105. package/types/src/cell/CellCheckboxRenderer.d.ts +20 -0
  106. package/types/src/cell/CellContent.d.ts +68 -0
  107. package/types/src/cell/CellControlContext.d.ts +37 -0
  108. package/types/src/cell/{FormulaCellRenderer.d.ts → CellFormulaRenderer.d.ts} +10 -7
  109. package/types/src/cell/CellImageRenderer.d.ts +11 -0
  110. package/types/src/cell/CellRenderers.d.ts +190 -0
  111. package/types/src/cell/{SheetCellRenderer.d.ts → CellTextRenderer.d.ts} +11 -8
  112. package/types/src/cell/ColumnButton.d.ts +3 -3
  113. package/types/src/cell/CornerTriangle.d.ts +6 -0
  114. package/types/src/cell/OutlineButton.d.ts +123 -0
  115. package/types/src/cell/PivotButton.d.ts +55 -0
  116. package/types/src/cell/SheetHeaderRenderer.d.ts +6 -1
  117. package/types/src/cell/StaticCellRenderer.d.ts +3 -3
  118. package/types/src/cell/_DropdownFace.d.ts +29 -0
  119. package/types/src/cell/index.d.ts +10 -2
  120. package/types/src/cell/useFormulaViewAnchor.d.ts +3 -3
  121. package/types/src/cell/useInsertableCellControls.d.ts +25 -0
  122. package/types/src/chart/ChartCommands.d.ts +15 -0
  123. package/types/src/chart/ChartEditor.d.ts +12 -2
  124. package/types/src/chart/ChartElement.d.ts +122 -0
  125. package/types/src/chart/ChartKind.d.ts +7 -0
  126. package/types/src/chart/PresetChartTypeDescriptors.d.ts +3 -1
  127. package/types/src/chart/index.d.ts +2 -1
  128. package/types/src/chart/paint/_fills.d.ts +24 -0
  129. package/types/src/chart/paint/_graphics.d.ts +38 -0
  130. package/types/src/chart/paint/_mode.d.ts +6 -0
  131. package/types/src/chart/paint/echarts.d.ts +33 -0
  132. package/types/src/chart/paint/index.d.ts +12 -0
  133. package/types/src/chart/paint/kinds/ChartPaintKind.d.ts +140 -0
  134. package/types/src/chart/paint/kinds/_Area.d.ts +3 -0
  135. package/types/src/chart/paint/kinds/_Bar.d.ts +3 -0
  136. package/types/src/chart/paint/kinds/_BoxWhisker.d.ts +3 -0
  137. package/types/src/chart/paint/kinds/_Bubble.d.ts +3 -0
  138. package/types/src/chart/paint/kinds/_Funnel.d.ts +3 -0
  139. package/types/src/chart/paint/kinds/_Histogram.d.ts +3 -0
  140. package/types/src/chart/paint/kinds/_Line.d.ts +10 -0
  141. package/types/src/chart/paint/kinds/_OfPie.d.ts +3 -0
  142. package/types/src/chart/paint/kinds/_Pie.d.ts +21 -0
  143. package/types/src/chart/paint/kinds/_Placeholder.d.ts +7 -0
  144. package/types/src/chart/paint/kinds/_Radar.d.ts +3 -0
  145. package/types/src/chart/paint/kinds/_Scatter.d.ts +3 -0
  146. package/types/src/chart/paint/kinds/_Sunburst.d.ts +3 -0
  147. package/types/src/chart/paint/kinds/_Surface.d.ts +3 -0
  148. package/types/src/chart/paint/kinds/_Treemap.d.ts +3 -0
  149. package/types/src/chart/paint/kinds/_Waterfall.d.ts +3 -0
  150. package/types/src/chart/paint/kinds/_builtIns.d.ts +3 -0
  151. package/types/src/chart/paint/toEChartsOption.d.ts +42 -0
  152. package/types/src/checklist/ValueChecklist.d.ts +60 -19
  153. package/types/src/clipboard/ClipboardCommands.d.ts +3 -3
  154. package/types/src/clipboard/SheetClipboardLayer.d.ts +2 -2
  155. package/types/src/commands/ContextualToolbar.d.ts +19 -0
  156. package/types/src/commands/createTransactionalMiddleware.d.ts +4 -1
  157. package/types/src/commands/index.d.ts +1 -0
  158. package/types/src/comment/CommentCardRequest.d.ts +94 -0
  159. package/types/src/comment/CommentUtils.d.ts +43 -0
  160. package/types/src/comment/NoteEditor.d.ts +20 -0
  161. package/types/src/comment/index.d.ts +5 -0
  162. package/types/src/comment/useCommentThread.d.ts +37 -0
  163. package/types/src/comment/useSheetComments.d.ts +28 -0
  164. package/types/src/conditionalFormat/ConditionalFormatPresets.d.ts +6 -6
  165. package/types/src/context/WorksheetContext.d.ts +18 -0
  166. package/types/src/context/index.d.ts +1 -1
  167. package/types/src/control/FormControlRenderers.d.ts +22 -0
  168. package/types/src/editableLabel/EditableLabel.d.ts +3 -1
  169. package/types/src/editor/EditorCommands.d.ts +3 -3
  170. package/types/src/editor/FunctionPreviewPanel.d.ts +1 -1
  171. package/types/src/editor/SheetCellEditorLayer.d.ts +2 -10
  172. package/types/src/editor/SheetCellEditorStartLayer.d.ts +61 -0
  173. package/types/src/editor/SheetCellInput.d.ts +14 -0
  174. package/types/src/editor/SheetEditable.d.ts +6 -6
  175. package/types/src/editor/SheetReferenceHeaderLayer.d.ts +1 -1
  176. package/types/src/editor/SheetReferenceLayer.d.ts +4 -4
  177. package/types/src/editor/VirtualKeyboardLayer.d.ts +50 -0
  178. package/types/src/editor/formulaAnchor.d.ts +12 -0
  179. package/types/src/editor/index.d.ts +3 -0
  180. package/types/src/editor/pickedReference.d.ts +3 -3
  181. package/types/src/editor/useEditRejectedNotice.d.ts +3 -3
  182. package/types/src/editor/useFormulaHints.d.ts +3 -3
  183. package/types/src/editor/useFormulaInput.d.ts +15 -3
  184. package/types/src/editor/validationAlert.d.ts +24 -0
  185. package/types/src/form/FormulaInput.d.ts +5 -2
  186. package/types/src/form/useEditCommit.d.ts +23 -3
  187. package/types/src/form/useInputField.d.ts +2 -3
  188. package/types/src/frame/CommandContext.d.ts +101 -3
  189. package/types/src/group/GroupEditor.d.ts +25 -0
  190. package/types/src/index.d.ts +12 -1
  191. package/types/src/layer/BorderLayer.d.ts +5 -2
  192. package/types/src/layer/CellErrorLayer.d.ts +18 -7
  193. package/types/src/layer/CellFillLayer.d.ts +2 -2
  194. package/types/src/layer/CellIndicatorLayer.d.ts +31 -0
  195. package/types/src/layer/CellInsertLayer.d.ts +71 -0
  196. package/types/src/layer/CircularIndicatorLayer.d.ts +3 -3
  197. package/types/src/layer/CommentCardLayer.d.ts +43 -0
  198. package/types/src/layer/CommentsLayer.d.ts +35 -0
  199. package/types/src/layer/ConditionalBarLayer.d.ts +2 -2
  200. package/types/src/layer/ConditionalIcons.d.ts +4 -4
  201. package/types/src/layer/ConditionalIconsLayer.d.ts +2 -2
  202. package/types/src/layer/ContextMenuLayer.d.ts +2 -2
  203. package/types/src/layer/FreezeDragLines.d.ts +17 -0
  204. package/types/src/layer/GridFreezeLayer.d.ts +11 -0
  205. package/types/src/layer/HeaderFreezeLayer.d.ts +12 -0
  206. package/types/src/layer/HeaderResizerLayer.d.ts +2 -1
  207. package/types/src/layer/HeaderSelectionLayer.d.ts +4 -4
  208. package/types/src/layer/HyperlinkLayer.d.ts +116 -0
  209. package/types/src/layer/MovableKindScope.d.ts +17 -0
  210. package/types/src/layer/PivotLayer.d.ts +47 -0
  211. package/types/src/layer/PivotToolbar.d.ts +29 -0
  212. package/types/src/layer/ProtectionLayer.d.ts +4 -5
  213. package/types/src/layer/RangeToolbar.d.ts +75 -0
  214. package/types/src/layer/ResizeIndicator.d.ts +11 -10
  215. package/types/src/layer/ResizeTooltip.d.ts +13 -0
  216. package/types/src/layer/SheetBackgroundLayer.d.ts +3 -3
  217. package/types/src/layer/SheetCellLayer.d.ts +15 -8
  218. package/types/src/layer/SheetColumnButtonLayer.d.ts +2 -2
  219. package/types/src/layer/SheetGridLineLayer.d.ts +25 -15
  220. package/types/src/layer/SheetHeaderCellLayer.d.ts +10 -1
  221. package/types/src/layer/SheetLayers.d.ts +171 -0
  222. package/types/src/layer/SheetMovableLayer.d.ts +4 -3
  223. package/types/src/layer/SheetOutlineLayer.d.ts +40 -0
  224. package/types/src/layer/SheetPivotCommandLayer.d.ts +13 -0
  225. package/types/src/layer/SheetSparklineCommandLayer.d.ts +14 -0
  226. package/types/src/layer/SheetTableCommandLayer.d.ts +2 -2
  227. package/types/src/layer/SparklineLayer.d.ts +32 -0
  228. package/types/src/layer/SpillLayer.d.ts +2 -2
  229. package/types/src/layer/TableLayer.d.ts +6 -5
  230. package/types/src/layer/TableToolbar.d.ts +23 -0
  231. package/types/src/layer/ValidationDropdownLayer.d.ts +2 -2
  232. package/types/src/layer/ValidationIndicatorLayer.d.ts +2 -2
  233. package/types/src/layer/ValidationPromptLayer.d.ts +47 -16
  234. package/types/src/layer/_sheetBorders.d.ts +6 -0
  235. package/types/src/layer/_tableColor.d.ts +6 -0
  236. package/types/src/layer/_visibleCellFeatures.d.ts +11 -0
  237. package/types/src/layer/cellTip.d.ts +13 -0
  238. package/types/src/layer/freezeDragState.d.ts +21 -0
  239. package/types/src/layer/index.d.ts +17 -0
  240. package/types/src/layer/resizeIndicatorState.d.ts +3 -1
  241. package/types/src/layer/useFreezeDrag.d.ts +22 -0
  242. package/types/src/layer/useNormalBorderLines.d.ts +15 -0
  243. package/types/src/layer/useSheetFeatureRegions.d.ts +2 -2
  244. package/types/src/layer/useSheetVisibleCells.d.ts +5 -6
  245. package/types/src/layer/useSheetVisibleDecorations.d.ts +2 -2
  246. package/types/src/layer/useTableHeaderCells.d.ts +2 -2
  247. package/types/src/layer/useValidationPicker.d.ts +3 -3
  248. package/types/src/layer/useVisibleTables.d.ts +2 -2
  249. package/types/src/layer/validationMark.d.ts +3 -3
  250. package/types/src/listener/index.d.ts +5 -0
  251. package/types/src/listener/useCell.d.ts +29 -0
  252. package/types/src/listener/useCellRange.d.ts +23 -0
  253. package/types/src/listener/useCellValue.d.ts +26 -0
  254. package/types/src/listener/useModelListener.d.ts +8 -8
  255. package/types/src/listener/useRangeListener.d.ts +13 -7
  256. package/types/src/listener/useRangeSnapshot.d.ts +35 -0
  257. package/types/src/listener/useTable.d.ts +26 -0
  258. package/types/src/movable/ConnectionSites.d.ts +18 -0
  259. package/types/src/movable/DefaultMovable.d.ts +8 -0
  260. package/types/src/movable/IMovableArea.d.ts +56 -0
  261. package/types/src/movable/MovableAdornment.d.ts +26 -0
  262. package/types/src/movable/MovableCommandGroups.d.ts +22 -0
  263. package/types/src/movable/MovableCommands.d.ts +8 -3
  264. package/types/src/movable/MovableControl.d.ts +80 -0
  265. package/types/src/movable/MovableEdit.d.ts +22 -0
  266. package/types/src/movable/MovableFrame.d.ts +18 -14
  267. package/types/src/movable/MovableLayer.d.ts +30 -5
  268. package/types/src/movable/MovableRenderers.d.ts +210 -0
  269. package/types/src/movable/PlaceholderFrames.d.ts +11 -0
  270. package/types/src/movable/RotateHandle.d.ts +37 -0
  271. package/types/src/movable/TextBox.d.ts +34 -0
  272. package/types/src/movable/connect.d.ts +16 -0
  273. package/types/src/movable/framePlacement.d.ts +72 -0
  274. package/types/src/movable/geometry.d.ts +61 -0
  275. package/types/src/movable/index.d.ts +11 -0
  276. package/types/src/movable/pressTarget.d.ts +20 -0
  277. package/types/src/movable/useFramePreview.d.ts +17 -0
  278. package/types/src/picker/cellPickerOpen.d.ts +3 -3
  279. package/types/src/picker/useCellPicker.d.ts +7 -5
  280. package/types/src/picture/PictureCommands.d.ts +20 -0
  281. package/types/src/picture/PictureKind.d.ts +7 -0
  282. package/types/src/picture/_pictureHyperlink.d.ts +13 -0
  283. package/types/src/picture/index.d.ts +0 -1
  284. package/types/src/picture/pictureCrop.d.ts +32 -0
  285. package/types/src/pivot/PivotAreas.d.ts +16 -0
  286. package/types/src/pivot/PivotChip.d.ts +33 -0
  287. package/types/src/pivot/PivotChipMenu.d.ts +74 -0
  288. package/types/src/pivot/PivotCommands.d.ts +24 -0
  289. package/types/src/pivot/PivotFieldList.d.ts +14 -0
  290. package/types/src/pivot/PivotFields.d.ts +47 -0
  291. package/types/src/pivot/PivotFieldsModel.d.ts +143 -0
  292. package/types/src/pivot/PivotTablePane.d.ts +47 -0
  293. package/types/src/pivot/_PivotFieldsContext.d.ts +41 -0
  294. package/types/src/pivot/_pivotNew.d.ts +12 -0
  295. package/types/src/pivot/_pivotRegion.d.ts +14 -0
  296. package/types/src/pivot/index.d.ts +9 -0
  297. package/types/src/pivot/usePivotFields.d.ts +17 -0
  298. package/types/src/presence/PresenceCommands.d.ts +35 -0
  299. package/types/src/presence/PresenceHost.d.ts +58 -0
  300. package/types/src/presence/PresenceMessages.d.ts +42 -0
  301. package/types/src/presence/PresenceStore.d.ts +165 -0
  302. package/types/src/presence/PresenceTypes.d.ts +78 -0
  303. package/types/src/presence/index.d.ts +7 -0
  304. package/types/src/presence/usePresence.d.ts +20 -0
  305. package/types/src/richText/RichTextEditor.d.ts +41 -0
  306. package/types/src/richText/index.d.ts +2 -0
  307. package/types/src/selection/SelectionCommands.d.ts +2 -2
  308. package/types/src/selection/SheetSelectionLayer.d.ts +6 -12
  309. package/types/src/shape/ConnectorControl.d.ts +46 -0
  310. package/types/src/shape/ShapeCommands.d.ts +11 -0
  311. package/types/src/shape/ShapeControl.d.ts +8 -0
  312. package/types/src/shape/ShapeEditor.d.ts +15 -2
  313. package/types/src/shape/ShapeGallery.d.ts +31 -0
  314. package/types/src/shape/ShapeHandles.d.ts +28 -0
  315. package/types/src/shape/ShapeKind.d.ts +7 -0
  316. package/types/src/shape/ShapeSVG.d.ts +22 -0
  317. package/types/src/shape/ShapeText.d.ts +17 -0
  318. package/types/src/shape/icons/ShapeIcons.d.ts +16 -0
  319. package/types/src/shape/icons/_ShapeIconPack.d.ts +4 -0
  320. package/types/src/shape/index.d.ts +3 -1
  321. package/types/src/shape/shapeFrame.d.ts +50 -0
  322. package/types/src/shape/shapeStyle.d.ts +82 -0
  323. package/types/src/sheet/ISheetHeaderElement.d.ts +3 -3
  324. package/types/src/sheet/{ISheetElement.d.ts → IWorksheetElement.d.ts} +111 -81
  325. package/types/src/sheet/OpaqueSheetElement.d.ts +21 -0
  326. package/types/src/sheet/SheetCommandProvider.d.ts +14 -6
  327. package/types/src/sheet/SheetCommands.d.ts +20 -5
  328. package/types/src/sheet/SheetKindIcon.d.ts +14 -0
  329. package/types/src/sheet/SheetOutlineElement.d.ts +70 -0
  330. package/types/src/sheet/SheetPanels.d.ts +11 -0
  331. package/types/src/sheet/SheetScrollbar.d.ts +4 -13
  332. package/types/src/sheet/TopLeftCorner.d.ts +2 -2
  333. package/types/src/sheet/WorksheetElement.d.ts +12 -0
  334. package/types/src/sheet/_freezeAt.d.ts +10 -0
  335. package/types/src/sheet/_hyperlinkEdit.d.ts +7 -0
  336. package/types/src/sheet/_useHeaderMetrics.d.ts +11 -0
  337. package/types/src/sheet/circularReferences.d.ts +4 -4
  338. package/types/src/sheet/index.d.ts +5 -2
  339. package/types/src/sheet/useCycleHighlight.d.ts +2 -2
  340. package/types/src/slicer/SlicerCommands.d.ts +10 -0
  341. package/types/src/slicer/SlicerEditor.d.ts +8 -2
  342. package/types/src/slicer/SlicerKind.d.ts +7 -0
  343. package/types/src/slicer/SlicerStylePreview.d.ts +18 -0
  344. package/types/src/slicer/index.d.ts +2 -1
  345. package/types/src/slicer/slicerStyles.d.ts +32 -0
  346. package/types/src/sparkline/PictureCache.d.ts +37 -0
  347. package/types/src/sparkline/SparklineCommands.d.ts +23 -0
  348. package/types/src/sparkline/SparklinePictures.d.ts +7 -0
  349. package/types/src/sparkline/paint/_drawing.d.ts +24 -0
  350. package/types/src/sparkline/paint/echarts.d.ts +8 -0
  351. package/types/src/sparkline/paint/index.d.ts +8 -0
  352. package/types/src/tabStrip/SheetTab.d.ts +1 -1
  353. package/types/src/tabStrip/Sortable.d.ts +5 -5
  354. package/types/src/tabStrip/TabStrip.d.ts +13 -6
  355. package/types/src/tabStrip/TabStripItem.d.ts +15 -13
  356. package/types/src/table/TableCommands.d.ts +2 -2
  357. package/types/src/taskPane/CellControlPane.d.ts +15 -0
  358. package/types/src/taskPane/MovablePane.d.ts +15 -0
  359. package/types/src/taskPane/TaskPaneArea.d.ts +7 -0
  360. package/types/src/taskPane/TaskPaneFrame.d.ts +4 -4
  361. package/types/src/taskPane/TaskPaneKeys.d.ts +38 -0
  362. package/types/src/taskPane/TaskPaneRegistry.d.ts +32 -12
  363. package/types/src/taskPane/_paneReasons.d.ts +7 -0
  364. package/types/src/taskPane/index.d.ts +3 -0
  365. package/types/src/taskPane/useTaskPane.d.ts +6 -3
  366. package/types/src/theme/ThemeState.d.ts +15 -2
  367. package/types/src/theme/buildDocThemeCSS.d.ts +4 -1
  368. package/types/src/theme/buildOOXMLThemeCSS.d.ts +2 -2
  369. package/types/src/theme/useGridColorScheme.d.ts +3 -3
  370. package/types/src/theme/useSystemColors.d.ts +2 -2
  371. package/types/src/workbook/DefaultMovableRenderers.d.ts +20 -0
  372. package/types/src/workbook/DefaultRenderers.d.ts +5 -4
  373. package/types/src/workbook/IWorkbookElement.d.ts +108 -23
  374. package/types/src/workbook/WorkbookCommands.d.ts +8 -3
  375. package/types/src/workbook/WorkbookStrip.d.ts +14 -5
  376. package/browser/cjs/Bo9Kx3L_XQkGPBJ5.cjs +0 -1
  377. package/browser/cjs/Pl04-kDEQSO8_qFU.cjs +0 -156
  378. package/browser/cjs/index.cjs +0 -41
  379. package/browser/esm/Dsn3z1hmkv-bWGVr.mjs +0 -6286
  380. package/node/esm/CyU4sKDpHyc6kF7j.mjs +0 -9
  381. package/types/src/chart/templates/area-stacked-percent-template.json.d.ts +0 -10
  382. package/types/src/chart/templates/area-stacked-template.json.d.ts +0 -10
  383. package/types/src/chart/templates/area-template.json.d.ts +0 -9
  384. package/types/src/chart/templates/bar-stacked-percent-template.json.d.ts +0 -10
  385. package/types/src/chart/templates/bar-stacked-template.json.d.ts +0 -10
  386. package/types/src/chart/templates/bar-template.json.d.ts +0 -9
  387. package/types/src/chart/templates/column-stacked-percent-template.json.d.ts +0 -10
  388. package/types/src/chart/templates/column-stacked-template.json.d.ts +0 -10
  389. package/types/src/chart/templates/column-template.json.d.ts +0 -9
  390. package/types/src/chart/templates/line-markers-template.json.d.ts +0 -10
  391. package/types/src/chart/templates/line-stacked-markers-template.json.d.ts +0 -11
  392. package/types/src/chart/templates/line-stacked-percent-markers-template.json.d.ts +0 -11
  393. package/types/src/chart/templates/line-stacked-percent-template.json.d.ts +0 -10
  394. package/types/src/chart/templates/line-stacked-template.json.d.ts +0 -10
  395. package/types/src/chart/templates/line-template.json.d.ts +0 -9
  396. package/types/src/chart/templates/pie-doughnut-template.json.d.ts +0 -10
  397. package/types/src/chart/templates/pie-template.json.d.ts +0 -9
  398. package/types/src/chart/templates/scatter-lines-markers-smooth-template.json.d.ts +0 -10
  399. package/types/src/chart/templates/scatter-lines-markers-template.json.d.ts +0 -10
  400. package/types/src/chart/templates/scatter-lines-smooth-template.json.d.ts +0 -10
  401. package/types/src/chart/templates/scatter-lines-template.json.d.ts +0 -10
  402. package/types/src/chart/templates/scatter-markers-template.json.d.ts +0 -10
  403. package/types/src/context/SheetContext.d.ts +0 -18
  404. package/types/src/movable/MoveableBundle.d.ts +0 -4
  405. package/types/src/sheet/SheetElement.d.ts +0 -15
@@ -19,16 +19,24 @@ export interface TaskPaneEntry {
19
19
  */
20
20
  readonly contributionPoints?: string[];
21
21
  /**
22
- * The title to display to identify the task pane.
22
+ * The title to display to identify the task pane. Call `t()` here to translate it.
23
+ *
24
+ * @remarks
25
+ * Omit it to use the label of the command catalog record that shares the pane's key, which is
26
+ * translated with the rest of the chrome. With neither, the title is the key.
27
+ *
28
+ * @param catalogTitle That record's label, if there is one, for a title that adjusts it.
23
29
  */
24
- getTitle(): string;
30
+ getTitle?(catalogTitle: string | undefined): string;
25
31
  /**
26
- * The icon to display to identify the task pane.
32
+ * The icon to display to identify the task pane: an icon key or a React element.
27
33
  *
28
34
  * @remarks
29
- * This can be either a string (iconKey) or a React element.
35
+ * Omit it to use the icon of the command catalog record that shares the pane's key.
36
+ *
37
+ * @param catalogIcon That record's icon key, if there is one.
30
38
  */
31
- getIcon?(): React.ReactElement | string | undefined;
39
+ getIcon?(catalogIcon: string | undefined): React.ReactElement | string | undefined;
32
40
  /**
33
41
  * The task pane component.
34
42
  *
@@ -67,13 +75,25 @@ export interface TaskPaneEntry {
67
75
  */
68
76
  componentCommandButton?: React.ComponentType<CommandButtonProps>;
69
77
  }
78
+ /**
79
+ * A registered task pane, as {@link ITaskPaneRegistry} returns it: its title and icon resolved from
80
+ * the entry, else from the command catalog.
81
+ */
82
+ export interface ResolvedTaskPaneEntry extends Omit<TaskPaneEntry, 'getTitle' | 'getIcon'> {
83
+ /** The title to show: the entry's, else its catalog record's label, else the key. */
84
+ getTitle(): string;
85
+ /** The icon to show: the entry's, else its catalog record's icon. */
86
+ getIcon(): React.ReactElement | string | undefined;
87
+ }
70
88
  export interface ITaskPaneRegistry {
71
89
  /**
72
90
  * Registers a task pane container.
73
91
  * @param entry The task pane entry.
74
92
  * @param replace Whether to replace an existing task pane. Default is false.
93
+ * @returns A function that removes this registration. It does nothing once the key is unregistered
94
+ * or registered again by someone else.
75
95
  */
76
- registerTaskPane(entry: TaskPaneEntry, replace?: boolean): void;
96
+ registerTaskPane(entry: TaskPaneEntry, replace?: boolean): () => void;
77
97
  /**
78
98
  * Unregister a task pane container.
79
99
  *
@@ -86,22 +106,22 @@ export interface ITaskPaneRegistry {
86
106
  * @param key The unique key for the task pane.
87
107
  * @returns The registered task pane or null if not found.
88
108
  */
89
- getRegisteredTaskPane(key: string): TaskPaneEntry | null;
109
+ getRegisteredTaskPane(key: string): ResolvedTaskPaneEntry | null;
90
110
  /**
91
111
  * Finds contributions for a specific entry.
92
112
  * @param contributionKey
93
113
  */
94
- findContributions(contributionKey: string): TaskPaneEntry[];
114
+ findContributions(contributionKey: string): ResolvedTaskPaneEntry[];
95
115
  }
96
116
  declare class TaskPaneRegistry implements ITaskPaneRegistry {
97
- protected _taskPanes: Map<string, TaskPaneEntry>;
117
+ protected _taskPanes: Map<string, ResolvedTaskPaneEntry>;
98
118
  /** @inheritdoc ITaskPaneRegistry.registerTaskPane */
99
- registerTaskPane(entry: TaskPaneEntry, replace?: boolean): void;
119
+ registerTaskPane(entry: TaskPaneEntry, replace?: boolean): () => void;
100
120
  /** @inheritdoc ITaskPaneRegistry.unregisterTaskPane */
101
121
  unregisterTaskPane(key: string): void;
102
122
  /** @inheritdoc ITaskPaneRegistry.getRegisteredTaskPane */
103
- getRegisteredTaskPane(key: string): TaskPaneEntry | null;
104
- findContributions(contributionKey: string): TaskPaneEntry[];
123
+ getRegisteredTaskPane(key: string): ResolvedTaskPaneEntry | null;
124
+ findContributions(contributionKey: string): ResolvedTaskPaneEntry[];
105
125
  }
106
126
  export declare const DefaultTaskPaneRegistry: TaskPaneRegistry;
107
127
  export {};
@@ -0,0 +1,7 @@
1
+ import { ITaskPaneArea } from './TaskPaneArea';
2
+ /**
3
+ * The reason a command that opens the pane `key` is disabled: there is no task pane area, or no pane
4
+ * registered under `key`. Empty when the pane can be shown.
5
+ */
6
+ export declare const noTaskPaneReasons: (taskPaneArea: ITaskPaneArea | undefined, key: string) => string[];
7
+ //# sourceMappingURL=_paneReasons.d.ts.map
@@ -4,4 +4,7 @@ export * from './TaskPaneArea';
4
4
  export * from './TaskPaneTitle';
5
5
  export * from './TaskPaneStrip';
6
6
  export * from './TaskPaneRegistry';
7
+ export * from './TaskPaneKeys';
8
+ export * from './MovablePane';
9
+ export * from './CellControlPane';
7
10
  //# sourceMappingURL=index.d.ts.map
@@ -1,5 +1,6 @@
1
1
  import { default as React } from 'react';
2
- import { ITaskPaneArea, ITaskPaneAreaElement, TaskPaneAreaProps } from './TaskPaneArea';
2
+ import { RenderSlotFn } from '@sheetxl/utils-react';
3
+ import { ITaskPaneArea, TaskPaneAreaProps } from './TaskPaneArea';
3
4
  import { ITaskPaneRegistry } from './TaskPaneRegistry';
4
5
  /**
5
6
  * Context provider for task panes. Allows custom task pane manager
@@ -16,8 +17,10 @@ import { ITaskPaneRegistry } from './TaskPaneRegistry';
16
17
  */
17
18
  export interface TaskPaneProviderProps {
18
19
  children: React.ReactNode;
19
- renderArea: (props: TaskPaneAreaProps) => React.ReactElement<ITaskPaneAreaElement>;
20
- onUpdateArea: (area: React.ReactElement<ITaskPaneAreaElement> | null) => void;
20
+ /** Render the area. Pass `props.ref` on to the {@link ITaskPaneAreaElement}. */
21
+ renderArea: RenderSlotFn<TaskPaneAreaProps>;
22
+ /** The area to mount, or `null` once it closes. */
23
+ onUpdateArea: (area: React.ReactElement | null) => void;
21
24
  registry?: ITaskPaneRegistry;
22
25
  }
23
26
  export declare const TaskPaneProvider: React.FC<TaskPaneProviderProps>;
@@ -1,19 +1,32 @@
1
+ import { ThemeMode } from '@sheetxl/utils-react';
1
2
  /**
2
3
  * Persistence keys for the spreadsheet's self-managed appearance state.
3
4
  *
4
5
  * @remarks
5
- * Owned via `usePersistenceState` against the surrounding `PersistenceStateProvider` (Studio, or a
6
+ * Owned via `usePersistentState` against the surrounding `PersistentStateProvider` (Studio, or a
6
7
  * standalone host). A consumer that wants to read or set them (e.g. a VS Code host driving the mode from
7
8
  * its editor theme) does so with the same key, or by supplying its own provider/store. They are
8
9
  * intentionally not component props — appearance is *state*, theme customization is *config* (see
9
10
  * `Studio.theme`).
11
+ *
12
+ * A host changes the starting value of any of these with `PersistentStateProvider`'s `defaultValues`;
13
+ * the user's own choice still wins.
10
14
  */
11
15
  export declare const ThemeStateKey: {
12
- /** 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). */
13
17
  readonly Mode: "themeMode";
14
18
  /** Whether the grid renders dark when the app is dark (Excel-style: dark app, optional dark grid). */
15
19
  readonly DarkGrid: "enableDarkGrid";
16
20
  /** Whether images invert in a dark grid. */
17
21
  readonly DarkImages: "enableDarkImages";
18
22
  };
23
+ /**
24
+ * The shipped defaults for {@link ThemeStateKey}, used when neither the store nor the provider's
25
+ * `defaultValues` has a value. They match Excel: no mode override, light grid, images unchanged.
26
+ */
27
+ export declare const ThemeStateDefaults: {
28
+ readonly themeMode: ThemeMode | null;
29
+ readonly enableDarkGrid: false;
30
+ readonly enableDarkImages: false;
31
+ };
19
32
  //# sourceMappingURL=ThemeState.d.ts.map
@@ -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
@@ -3,11 +3,11 @@ 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*
7
- * (`ThemeStateKey.DarkGrid`, default off) so the grid stays light in a dark app unless opted in.
6
+ * (`ThemeStateKey.Mode`, resolved via `useResolvedThemeMode` when unset), gated by *Enable Dark Grid*
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
  *
@@ -18,7 +18,7 @@ export declare const installSystemColorDefaults: () => void;
18
18
  * to the provided values rather than the global host mapping.
19
19
  *
20
20
  * @remarks
21
- * Used by the grid container ({@link SheetElement}) and by UI rendered *outside* the grid subtree
21
+ * Used by the grid container ({@link WorksheetElement}) and by UI rendered *outside* the grid subtree
22
22
  * that must still match the grid's light/dark intent — most notably a color picker popup, which is
23
23
  * portaled and would otherwise inherit the host's `--sxl-sys-color-*` (e.g. a light grid in a dark host
24
24
  * would show the host's dark `auto` color). Names are lower-cased to match the variable
@@ -27,7 +27,7 @@ export declare const installSystemColorDefaults: () => void;
27
27
  export declare const createSystemColorVars: (colors: Partial<Record<IColor.Named, string>>) => Record<string, string>;
28
28
  /**
29
29
  * 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.
30
+ * Wired into `WorksheetElement`, so the grid themes from `--sxl-sys-color-*` out of the box.
31
31
  */
32
32
  export declare const useSystemColors: () => void;
33
33
  /**
@@ -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,10 @@
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 { CommandContext } from '../frame';
7
8
  import { WorkbookStripProps } from './WorkbookStrip';
8
9
  /**
9
10
  * Workbook specific attributes beyond HTMLDivElement.
@@ -17,7 +18,7 @@ export interface IWorkbookAttributes {
17
18
  * Retrieve the sheet element associated with this workbook element.
18
19
  * `null` before the sheet has mounted.
19
20
  */
20
- getSheetElement: () => ISheetElement | null;
21
+ getSheetElement: () => IWorksheetElement | null;
21
22
  /**
22
23
  * Retrieve the viewport element associated with this workbook element.
23
24
  * `null` before the viewport has mounted.
@@ -46,8 +47,44 @@ export interface IWorkbookElement extends HTMLDivElement, IWorkbookAttributes {
46
47
  export type WorkbookLoadEvent = {
47
48
  source: IWorkbookElement;
48
49
  };
50
+ /**
51
+ * What every workbook menu renderer is handed. Spread the rest on the menu's root.
52
+ */
53
+ export interface WorkbookMenuRenderProps extends React.HTMLAttributes<HTMLDivElement> {
54
+ /** The menu's float. Close it when an entry runs. */
55
+ floatReference: FloatReference;
56
+ disabled?: boolean;
57
+ }
58
+ /** What {@link WorkbookElementProps.renderContextMenu} is handed. */
59
+ export interface ContextMenuRenderProps extends WorkbookMenuRenderProps {
60
+ workbook: IWorkbook;
61
+ }
62
+ /** What {@link WorkbookElementProps.renderColumnMenu} is handed. */
63
+ export interface ColumnMenuRenderProps extends WorkbookMenuRenderProps {
64
+ /** The table column whose button was pressed. */
65
+ column: ITable.IColumn;
66
+ }
67
+ /** What {@link WorkbookElementProps.renderPivotMenu} is handed. */
68
+ export interface PivotMenuRenderProps extends WorkbookMenuRenderProps {
69
+ /** The fields of the pivot table's button that was pressed: one, or a compact header's row or column fields. */
70
+ fields: readonly IPivotTable.IField[];
71
+ }
72
+ /** What {@link WorkbookElementProps.renderMovableMenu} is handed. */
73
+ export interface MovableMenuRenderProps extends WorkbookMenuRenderProps {
74
+ movable: IMovable;
75
+ }
76
+ /** What {@link WorkbookElementProps.renderFillMenu} is handed. */
77
+ export interface FillMenuRenderProps extends WorkbookMenuRenderProps {
78
+ workbook: IWorkbook;
79
+ /** What the right-drag offers and runs. */
80
+ menu: CommandContext.FillMenu;
81
+ }
49
82
  /**
50
83
  * Properties and methods available on the workbook element.
84
+ *
85
+ * @remarks
86
+ * Every `render*` slot is mounted as its own component, so a renderer may call hooks. Omit a slot (or
87
+ * pass `undefined`) for its default; pass `null` to render nothing.
51
88
  */
52
89
  export interface WorkbookElementProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'autoFocus'>, React.Attributes {
53
90
  /**
@@ -61,7 +98,9 @@ export interface WorkbookElementProps extends Omit<React.HTMLAttributes<HTMLDivE
61
98
  workbook?: IWorkbook | Promise<IWorkbook> | IWorkbookIO.ReadOptions;
62
99
  /**
63
100
  * 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`).
101
+ * it from the shared appearance preference (`ThemeStateKey.Mode`). With no preference set it is light,
102
+ * unless the page puts a `dark`/`light` class on `<html>`/`<body>` or a `ThemeModeFallbackContext`
103
+ * above says otherwise (`'system'` follows the OS, as Studio does).
65
104
  */
66
105
  colorScheme?: ThemeMode;
67
106
  /**
@@ -74,6 +113,43 @@ export interface WorkbookElementProps extends Omit<React.HTMLAttributes<HTMLDivE
74
113
  * loading panels.
75
114
  */
76
115
  onWorkbookLoad?: (event: WorkbookLoadEvent) => void | Promise<void>;
116
+ /**
117
+ * Called with the workbook once {@link WorkbookElementProps.workbook} resolves, and again whenever
118
+ * a new input resolves to a different one. Until the first input resolves, or if an input fails,
119
+ * the workbook is `null`; while a later input resolves, the current workbook is kept.
120
+ *
121
+ * @remarks
122
+ * Lets an app pass a `Promise` here and hold the live workbook in its own state, without awaiting
123
+ * or suspending.
124
+ *
125
+ * @example
126
+ * ```tsx
127
+ * const [pending] = useState(() => createInvoice());
128
+ * const [workbook, setWorkbook] = useState<IWorkbook | null>(null);
129
+ * const [total] = useCellValue<number>(workbook, 'D23');
130
+ * return <WorkbookElement workbook={pending} onWorkbookChange={setWorkbook} />;
131
+ * ```
132
+ */
133
+ onWorkbookChange?: (workbook: IWorkbook | null) => void;
134
+ /**
135
+ * Whether features that load on first use (charts, shapes, form controls, file formats, dialogs)
136
+ * are loaded ahead of use once the workbook has shown, so their first use does not wait on the
137
+ * network.
138
+ *
139
+ * - `'auto'` - only while the browser reports a fast connection. Browsers that report none
140
+ * (Firefox, Safari) load each feature on first use.
141
+ * - `true` - on any connection but a 2g one.
142
+ * - `false` - each feature on first use.
143
+ *
144
+ * @remarks
145
+ * Loads every module defined with `defineLazyModule` from `@sheetxl/utils` that has not opted out,
146
+ * including every kind registered with `MovableContentRegistry` and `registerMovableRenderer`.
147
+ * Nothing is loaded while offline or when the connection asks to save data; it resumes when the
148
+ * connection changes.
149
+ *
150
+ * @defaultValue 'auto'
151
+ */
152
+ prefetch?: boolean | 'auto';
77
153
  /**
78
154
  * A custom undo manager.
79
155
  *
@@ -97,30 +173,35 @@ export interface WorkbookElementProps extends Omit<React.HTMLAttributes<HTMLDivE
97
173
  */
98
174
  propsTabs?: Partial<WorkbookStripProps>;
99
175
  /**
100
- * Render custom tabs.
176
+ * Render the sheet tabs.
101
177
  */
102
- renderTabs?: (props: WorkbookStripProps) => React.ReactElement;
178
+ renderTabs?: RenderSlotFn<WorkbookStripProps> | null;
103
179
  /**
104
- * Props for the context menu.
180
+ * Props handed to every menu renderer.
105
181
  */
106
- propsContextMenu?: any;
182
+ propsContextMenu?: Partial<WorkbookMenuRenderProps>;
107
183
  /**
108
- * Render custom context menu. (chrome - no default)
184
+ * Render the grid's context menu. The default renders none, and the browser's menu shows.
109
185
  */
110
- renderContextMenu?: (props: any) => React.ReactElement;
186
+ renderContextMenu?: RenderSlotFn<ContextMenuRenderProps> | null;
111
187
  /**
112
- * Render custom filter/column menu. (chrome - no default)
188
+ * Render the filter menu of a table column's button. The default renders none.
113
189
  */
114
- renderColumnMenu?: (props: any) => React.ReactElement;
190
+ renderColumnMenu?: RenderSlotFn<ColumnMenuRenderProps> | null;
115
191
  /**
116
- * Render custom movable menu. (chrome - no default)
192
+ * Render the menu of a pivot table's field button: its items to show or hide, or a page field's
193
+ * item to choose. The default renders none.
117
194
  */
118
- renderMovableMenu?: (props: any) => React.ReactElement;
195
+ renderPivotMenu?: RenderSlotFn<PivotMenuRenderProps> | null;
119
196
  /**
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)
197
+ * Render the context menu of a chart, shape or other movable. The default renders none.
122
198
  */
123
- renderFillMenu?: (props: any) => React.ReactElement;
199
+ renderMovableMenu?: RenderSlotFn<MovableMenuRenderProps> | null;
200
+ /**
201
+ * Render the menu a right-drag of the fill handle ends in. The default renders none, and the
202
+ * right-drag is inert.
203
+ */
204
+ renderFillMenu?: RenderSlotFn<FillMenuRenderProps> | null;
124
205
  /**
125
206
  * Allow for customizations on the floating surface used for the workbook's popups.
126
207
  */
@@ -137,12 +218,12 @@ export interface WorkbookElementProps extends Omit<React.HTMLAttributes<HTMLDivE
137
218
  /**
138
219
  * Assign a custom loading panel.
139
220
  */
140
- renderWorkbookLoading?: (props: LoadingPanelProps) => React.ReactElement;
221
+ renderWorkbookLoading?: RenderSlotFn<LoadingPanelProps> | null;
141
222
  /**
142
223
  * Custom error panel, shown when a `Promise` / {@link IWorkbookIO.ReadOptions} {@link WorkbookElementProps.workbook}
143
224
  * fails to resolve. Defaults to a minimal message. (Studio supplies a themed panel.)
144
225
  */
145
- renderWorkbookError?: (props: ErrorPanelProps) => React.ReactElement;
226
+ renderWorkbookError?: RenderSlotFn<ErrorPanelProps> | null;
146
227
  /**
147
228
  * The app-created editor for the new always-mounted cell editor. Pass the SAME stable
148
229
  * {@link IEditable} instance here and to the formula bar for free two-way sync; this forwards it to
@@ -152,11 +233,15 @@ export interface WorkbookElementProps extends Omit<React.HTMLAttributes<HTMLDivE
152
233
  /**
153
234
  * Allow for customizations on the sheet.
154
235
  */
155
- propsSheet?: Partial<SheetElementProps>;
236
+ propsSheet?: Partial<WorksheetElementProps>;
237
+ /**
238
+ * Render the active worksheet. Pass `props.ref` on to the {@link IWorksheetElement}.
239
+ */
240
+ renderWorksheet?: RenderSlotFn<WorksheetElementProps>;
156
241
  /**
157
- * Render custom ISheetElement.
242
+ * Render the pane of a chart sheet, a macro sheet or a dialog sheet while it is the active tab.
158
243
  */
159
- renderSheet?: (props: SheetElementProps) => React.ReactElement;
244
+ renderOpaqueSheet?: RenderSlotFn<OpaqueSheetElementProps>;
160
245
  /**
161
246
  * Allows users to Wrap stage children in Top level Context.
162
247
  */
@@ -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
@@ -45,7 +45,7 @@ export interface FindMemory {
45
45
  scope?: CommandContext.FindScopeOptions;
46
46
  }
47
47
  /**
48
- * The last-search memory handle — **live getter/setter** over the bridge's `usePersistenceState`, exactly
48
+ * The last-search memory handle — **live getter/setter** over the bridge's `usePersistentState`, exactly
49
49
  * like {@link PickerMemory} for the style pickers. A getter (not the value) so recording a search doesn't
50
50
  * change the `data` identity and re-run this whole contributor.
51
51
  */
@@ -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
  /**
@@ -77,7 +82,7 @@ export interface ContributeWorkbookCommandsOptions {
77
82
  */
78
83
  editable?: SheetEditable | null;
79
84
  /**
80
- * Persisted last-search memory (`workbook.lastFind`), owned by the bridge's `usePersistenceState`. Feeds
85
+ * Persisted last-search memory (`workbook.lastFind`), owned by the bridge's `usePersistentState`. Feeds
81
86
  * `findNext` / `findPrevious` and the find window's seed. Omit ⇒ those two stay disabled and the window
82
87
  * always seeds from the active cell.
83
88
  */
@@ -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}});