@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
@@ -1,14 +1,21 @@
1
1
  import { default as React } from 'react';
2
- import { Scalar } from '@sheetxl/sdk';
2
+ import { Scalar, IFilter } from '@sheetxl/sdk';
3
3
  import { CheckboxListProps } from '@sheetxl/grid-react';
4
4
  /** One value the checklist offers. */
5
5
  export interface ValueChecklistItem {
6
- /** The value as shown, and the identity a check is kept by. */
6
+ /** The value as shown, and the identity a check is kept by unless `key` says otherwise. */
7
7
  text: string;
8
+ /**
9
+ * The identity a check is kept by, when two rows may show the same text (by value, the number
10
+ * `1` and the text `'1`). Defaults to `text`.
11
+ */
12
+ key?: string;
8
13
  /** The value the text stands for, when a host needs it back (a filter writes it). */
9
14
  value?: Scalar;
10
15
  /** How many cells hold it, when the host knows. */
11
16
  count?: number;
17
+ /** The `(Blank)` row: a blank is a value, listed last, and shown apart from the texts. */
18
+ blank?: boolean;
12
19
  }
13
20
  /**
14
21
  * Props for {@link ValueChecklist}.
@@ -16,30 +23,52 @@ export interface ValueChecklistItem {
16
23
  export interface ValueChecklistProps {
17
24
  /** The values, in the order shown. */
18
25
  items: readonly ValueChecklistItem[];
19
- /** The checked values, by `text`. */
26
+ /**
27
+ * The date tree over the leading items, as `IFilter.getItems` answers it: one level per entry,
28
+ * each the runs of items its nodes span. Listed as Excel's tree: a row per node with a
29
+ * disclosure, the deepest level's nodes as the leaves, and the items past the tree flat under
30
+ * it. While a search is typed the dates list flat by their text.
31
+ */
32
+ dates?: readonly IFilter.DateLevel[];
33
+ /** The checked values, by their key (`text` unless an item gives a `key`). */
20
34
  checked: ReadonlySet<string>;
21
35
  /**
22
36
  * `texts` were set to `checked` — one on a click, the highlighted rows on Space, every row in
23
- * view on Select All. Rows out of the view (narrowed away by the search) are never named, so
24
- * they keep their state.
37
+ * view on Select All, every item of a node on its row. Rows out of the view (narrowed away by
38
+ * the search) are never named, so they keep their state.
25
39
  */
26
40
  onCheckedChange: (texts: readonly string[], checked: boolean) => void;
27
- /** Whether a `(Blanks)` row is offered, first in the list. */
28
- hasBlanks?: boolean;
29
- /** Whether the blanks row is checked. */
30
- blanksChecked?: boolean;
31
- /** The blanks row was set. Select All names it through this, not through `onCheckedChange`. */
32
- onBlanksChange?: (checked: boolean) => void;
41
+ /**
42
+ * Whether the items are the texts cells show (a spreadsheet's list) or their values. In value
43
+ * mode rows align by type, numbers to the right, so `1` and the text `'1` read apart.
44
+ *
45
+ * @defaultValue `true`
46
+ */
47
+ byDisplay?: boolean;
48
+ /** Offered as a "By value" option under the search field's glyph when given. */
49
+ onByDisplayChange?: (byDisplay: boolean) => void;
50
+ /**
51
+ * The typed text is to join the values. Given, the search line offers an Add while the text
52
+ * is not already a value, and Enter adds it.
53
+ */
54
+ onAdd?: (text: string) => void;
33
55
  /** The host stopped listing values at its cap: the count says so, the reason in its tooltip. */
34
56
  truncated?: boolean;
35
57
  /** A search field above the list. @defaultValue true */
36
58
  search?: boolean;
37
- /** Enter in the search field: the host applies. */
59
+ /** Enter in the search field, with nothing to add: the host applies. */
38
60
  onApply?: () => void;
39
61
  /** Escape with no search text to clear: the host closes. */
40
62
  onClose?: () => void;
41
- /** Take the focus on mount (the search field, or the list without one). @defaultValue true */
63
+ /** Take the focus on mount. @defaultValue true */
42
64
  autoFocus?: boolean;
65
+ /**
66
+ * Where the focus lands on mount: the list, so the arrows, Space and Enter work at once and a
67
+ * typed character moves to the search field; or the search field.
68
+ *
69
+ * @defaultValue 'list'
70
+ */
71
+ focusOn?: 'list' | 'search';
43
72
  /** See `CheckboxListProps.renderCheckbox`: a styled control (MUI) in place of the native one. */
44
73
  renderCheckbox?: CheckboxListProps['renderCheckbox'];
45
74
  /** Render a value row's label. @defaultValue the text */
@@ -54,15 +83,27 @@ export interface ValueChecklistProps {
54
83
  viewport?: CheckboxListProps['viewport'];
55
84
  }
56
85
  /**
57
- * A searchable **checklist of values** with a tri-state Select All, a `(Blanks)` row and a count
58
- * line — the filter dropdown's Values body, and any other "which of these" choice.
86
+ * A searchable **checklist of values** under a tri-state Select All — the filter dropdown's
87
+ * Values body, and any other "which of these" choice.
59
88
  *
60
89
  * @remarks
90
+ * The list holds values and nothing else. Over them, pinned above the scroll, is the root: one
91
+ * tri-state checkbox for every row in view, labeled by the count of checked values over the
92
+ * values in view. Add, for a host that takes typed values, sits after the search field. A blank
93
+ * is a value: a host that has one lists it last as its `blank` row, which the root and the count
94
+ * cover like any other.
95
+ *
61
96
  * Reads no cells: the host supplies the items and owns the checked set (by text). The search
62
- * narrows the VIEW only: Select All acts on the rows in view, rows narrowed away keep their state,
97
+ * narrows the VIEW only: the root acts on the rows in view, rows narrowed away keep their state,
63
98
  * and what the host applies is the whole set (Sheets' rule, not Excel's replace-with-results).
64
- * The search field keeps the focus; Up/Down move the list's highlight, Space toggles the
65
- * highlighted rows, Enter applies, Escape clears the search and then closes.
99
+ * The list has the focus on open: Up/Down move its highlight, Space toggles the highlighted rows,
100
+ * Enter applies, Tab leaves it, and a typed character moves to the search field. From the field
101
+ * the same keys reach the list, Enter applies, and Escape clears the search and then closes.
102
+ *
103
+ * With `dates`, the leading items are listed as a tree (Excel's year › month › day): a node's
104
+ * checkbox is the state of its items, its row toggles them all, and its disclosure (or Left and
105
+ * Right on the highlighted row, with nothing typed) folds it. Collapsing hides the member rows
106
+ * from the view; they keep their state.
66
107
  *
67
108
  * The root wears the grid's surface and mode, so the list looks like the cells it stands for even
68
109
  * inside chrome of another color.
@@ -1,5 +1,5 @@
1
1
  import { EditModeHandler, ReferenceableClipboard, RemoveListener } from '@sheetxl/utils';
2
- import { ICellRange, ISheet } from '@sheetxl/sdk';
2
+ import { ICellRange, IWorksheet } from '@sheetxl/sdk';
3
3
  import { Command, IReactNotifier } from '@sheetxl/utils-react';
4
4
  export interface SheetPasteOptions extends ReferenceableClipboard.PasteOptions, ICellRange.CopyOptions {
5
5
  }
@@ -57,11 +57,11 @@ export interface ContributeClipboardCommandsOptions {
57
57
  *
58
58
  * **Standalone:** this module owns *everything* about its commands — definitions, behavior, enablement
59
59
  * (protection-disable), and the marquee view — with **no dependency on SheetCommands** (it reads only the
60
- * generic `ISheet` model). It's the shape a third-party clipboard would take: sheet knows nothing about it.
60
+ * generic `IWorksheet` model). It's the shape a third-party clipboard would take: sheet knows nothing about it.
61
61
  */
62
62
  /** The single `data` bundle {@link contributeClipboardCommands} takes (the `DynamicCommandContributor` shape). */
63
63
  export interface ClipboardCommandData extends ContributeClipboardCommandsOptions {
64
- sheet: ISheet;
64
+ sheet: IWorksheet;
65
65
  }
66
66
  export declare function contributeClipboardCommands(contribution: Command.CommandContribution, data: ClipboardCommandData): RemoveListener;
67
67
  export {};
@@ -1,8 +1,8 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  export interface SheetClipboardLayerProps extends LayerProps {
5
- sheet: ISheet;
5
+ sheet: IWorksheet;
6
6
  /** Class for the marquee visuals (devtools identification). */
7
7
  className?: string;
8
8
  }
@@ -0,0 +1,19 @@
1
+ import { Command } from '@sheetxl/utils-react';
2
+ /**
3
+ * Key of the **main toolbar strip**: the registered entry whose members are the ordered ribbon tabs.
4
+ * A contextual tab contributes into it (`contributions: { [WORKBOOK_TOOLBARS_KEY]: { order } }`) and
5
+ * is shown with {@link contributeContextualToolbar}.
6
+ */
7
+ export declare const WORKBOOK_TOOLBARS_KEY = "workbookToolbars";
8
+ /**
9
+ * Registers `entry` in the default button registry for as long as at least one caller holds it, and
10
+ * returns the release. Several holders of the same key (several panes showing one table, a transient
11
+ * re-mount) share one registration; the last release unregisters it. Calling a release more than once
12
+ * is a no-op.
13
+ *
14
+ * Use this for a contextual tab and for any group only that tab references.
15
+ */
16
+ export declare function contributeContextualToolbar(entry: Command.CommandButtonEntry & {
17
+ key: string;
18
+ }): () => void;
19
+ //# sourceMappingURL=ContextualToolbar.d.ts.map
@@ -23,12 +23,15 @@ export interface TransactionalMiddlewareOptions {
23
23
  */
24
24
  isRepeatable?: (command: Command.ResolvedCommand<any, any, any>) => boolean;
25
25
  }
26
+ /** The commit meta entry naming the command that made the commit. */
27
+ export declare const COMMAND_META_KEY = "command";
26
28
  /**
27
29
  * The **shared transactional command wrapper** — one `CommandMiddleware` every feature reuses via
28
30
  * `contribution.use(...)` (sheet, movable, …) instead of re-implementing (or copying) it. Each
29
31
  * wrapped callback stays **pure**; the middleware adds, uniformly:
30
32
  *
31
- * - **batch** — runs the work in `transaction.doBatch(..., label)` so it's one undo entry;
33
+ * - **batch** — runs the work in `transaction.doBatch(..., label)` so it's one undo entry, recording
34
+ * the command's key in the commit's meta (`command`) so a view of the history can show its icon;
32
35
  * - **busy** — `notifier.showBusy(label)` for the duration;
33
36
  * - **error** — a thrown error is reported via `notifier.showError` (a *falsy* throw = user cancel ⇒ swallowed);
34
37
  * - **repeatable** — after success, sets `manager.setRepeatableOperation` so F4 / redo-when-empty
@@ -1,4 +1,5 @@
1
1
  export * from './createTransactionalMiddleware';
2
+ export * from './ContextualToolbar';
2
3
  export * from './InputClipboardCommands';
3
4
  export * from './InputClipboardInjector';
4
5
  export * from './MainFocusContext';
@@ -1,5 +1,5 @@
1
1
  import { CellCoords } from '@sheetxl/utils';
2
- import { IComment, ISheet } from '@sheetxl/sdk';
2
+ import { IComment, IWorksheet } from '@sheetxl/sdk';
3
3
  /**
4
4
  * What a comments task pane is asked to open on — `activateTaskPane('comments', { args })`.
5
5
  */
@@ -18,7 +18,7 @@ export interface CommentsPaneArgs {
18
18
  */
19
19
  export interface CommentCardRenderProps {
20
20
  /** The sheet the card's cell is on. */
21
- sheet: ISheet;
21
+ sheet: IWorksheet;
22
22
  /** The cell the card belongs to. */
23
23
  coords: CellCoords;
24
24
  /** The thread on the cell, or `null` for a draft: a comment that has not been posted. */
@@ -60,25 +60,25 @@ export interface RequestCommentCardOptions {
60
60
  * request is {@link clearCommentCard | cleared}, which the layer drawing it does when the selection
61
61
  * leaves the cell. A draft writes nothing until it is posted.
62
62
  */
63
- export declare const requestCommentCard: (sheet: ISheet, coords: CellCoords, options?: RequestCommentCardOptions) => void;
63
+ export declare const requestCommentCard: (sheet: IWorksheet, coords: CellCoords, options?: RequestCommentCardOptions) => void;
64
64
  /**
65
65
  * Takes back a {@link requestCommentCard | request}; a draft that was not posted is dropped.
66
66
  */
67
- export declare const clearCommentCard: (sheet: ISheet) => void;
67
+ export declare const clearCommentCard: (sheet: IWorksheet) => void;
68
68
  /**
69
69
  * The cell whose card is asked for on the sheet, or `null` for none.
70
70
  */
71
- export declare const getCommentCardRequest: (sheet: ISheet) => CommentCardRequest | null;
71
+ export declare const getCommentCardRequest: (sheet: IWorksheet) => CommentCardRequest | null;
72
72
  /**
73
73
  * Whether anything draws the sheet's comment cards. A command falls back to the comments task pane
74
74
  * when nothing does.
75
75
  */
76
- export declare const hasCommentCard: (sheet: ISheet) => boolean;
76
+ export declare const hasCommentCard: (sheet: IWorksheet) => boolean;
77
77
  /**
78
78
  * Listens for the sheet's card request changing. Whatever draws the cards listens; the returned
79
79
  * function stops listening.
80
80
  */
81
- export declare const addCommentCardListener: (sheet: ISheet, listener: () => void) => (() => void);
81
+ export declare const addCommentCardListener: (sheet: IWorksheet, listener: () => void) => (() => void);
82
82
  /**
83
83
  * The cell a draft is open on: a requested card whose cell has no comment yet. `null` for none.
84
84
  *
@@ -86,9 +86,9 @@ export declare const addCommentCardListener: (sheet: ISheet, listener: () => voi
86
86
  * For what marks the cell while its comment is being written. Following this does not count as
87
87
  * drawing the cards, so {@link hasCommentCard} is unchanged by it.
88
88
  */
89
- export declare const useCommentDraftCell: (sheet: ISheet) => CommentCardRequest | null;
89
+ export declare const useCommentDraftCell: (sheet: IWorksheet) => CommentCardRequest | null;
90
90
  /**
91
91
  * {@link getCommentCardRequest}, kept current.
92
92
  */
93
- export declare const useCommentCardRequest: (sheet: ISheet) => CommentCardRequest | null;
93
+ export declare const useCommentCardRequest: (sheet: IWorksheet) => CommentCardRequest | null;
94
94
  //# sourceMappingURL=CommentCardRequest.d.ts.map
@@ -1,4 +1,3 @@
1
- export * from './NoteEditor';
2
1
  export * from './CommentUtils';
3
2
  export * from './CommentCardRequest';
4
3
  export * from './useSheetComments';
@@ -1,4 +1,4 @@
1
- import { IComment, ISheet } from '@sheetxl/sdk';
1
+ import { IComment, IWorksheet } from '@sheetxl/sdk';
2
2
  /**
3
3
  * Options for {@link useSheetComments}.
4
4
  */
@@ -24,5 +24,5 @@ export interface UseSheetCommentsOptions {
24
24
  * return <ul>{open.map((comment) => <li key={comment.getId()}>{comment.getContent()}</li>)}</ul>;
25
25
  * ```
26
26
  */
27
- export declare const useSheetComments: (sheet: ISheet | null, options?: UseSheetCommentsOptions) => IComment[];
27
+ export declare const useSheetComments: (sheet: IWorksheet | null, options?: UseSheetCommentsOptions) => IComment[];
28
28
  //# sourceMappingURL=useSheetComments.d.ts.map
@@ -1,4 +1,4 @@
1
- import { IConditionalFormat, IStyle } from '@sheetxl/sdk';
1
+ import { IConditionalFormat, ICellStyle } from '@sheetxl/sdk';
2
2
  /**
3
3
  * Shared authoring presets for the conditional-format editor.
4
4
  *
@@ -13,7 +13,7 @@ import { IConditionalFormat, IStyle } from '@sheetxl/sdk';
13
13
  export interface StylePreset {
14
14
  /** Stable identifier; UI layers key their localized tooltip off it. */
15
15
  key: string;
16
- style: IStyle.Properties;
16
+ style: ICellStyle.Properties;
17
17
  }
18
18
  export declare const STYLE_PRESETS: readonly StylePreset[];
19
19
  /**
@@ -42,7 +42,7 @@ export declare const defaultIconSet: () => IConditionalFormat.IconSet;
42
42
  export interface IconSetGalleryBlock {
43
43
  key: 'directional' | 'shapes' | 'indicators' | 'ratings';
44
44
  /** Each row is a pair of sets; the right seat may be empty. */
45
- rows: readonly (readonly [IStyle.IconSet, IStyle.IconSet | null])[];
45
+ rows: readonly (readonly [ICellStyle.IconSet, ICellStyle.IconSet | null])[];
46
46
  }
47
47
  /**
48
48
  * Every set the gallery offers, laid out the way Excel Online's own gallery is — two sets to a
@@ -64,13 +64,13 @@ export declare const ICON_SET_GALLERY_BLOCKS: readonly IconSetGalleryBlock[];
64
64
  */
65
65
  export declare const iconSetSize: (set: string) => number;
66
66
  /** A ready-to-apply rule for a built-in set — the set at Excel's default even banding. */
67
- export declare const iconSetPreset: (set: IStyle.IconSet) => IConditionalFormat.IconSet;
67
+ export declare const iconSetPreset: (set: ICellStyle.IconSet) => IConditionalFormat.IconSet;
68
68
  /**
69
69
  * The per-band override that draws nothing — Excel's "No Cell Icon", spelled the way its x14
70
70
  * writer spells it.
71
71
  */
72
72
  export declare const NO_CELL_ICON: Readonly<{
73
- set: IStyle.IconSet;
73
+ set: ICellStyle.IconSet;
74
74
  id: number;
75
75
  }>;
76
76
  /**
@@ -87,7 +87,7 @@ export declare const NO_CELL_ICON: Readonly<{
87
87
  * @param icon The icon to draw there, or `null` to restore the band's own.
88
88
  */
89
89
  export declare const withIconOverride: (scale: IConditionalFormat.IconSet, band: number, icon: {
90
- set: IStyle.IconSet;
90
+ set: ICellStyle.IconSet;
91
91
  id: number;
92
92
  } | null) => IConditionalFormat.IconSet;
93
93
  //# sourceMappingURL=ConditionalFormatPresets.d.ts.map
@@ -0,0 +1,18 @@
1
+ import { default as React, ReactNode } from 'react';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
+ export type WorksheetProviderProps = {
4
+ sheet: IWorksheet | null;
5
+ children: ReactNode;
6
+ };
7
+ /**
8
+ * Provides a sheet to descendants.
9
+ *
10
+ * Notes:
11
+ * - Prefer passing the sheet object as a stable reference from the host.
12
+ */
13
+ export declare function WorksheetProvider(props: WorksheetProviderProps): React.JSX.Element;
14
+ /**
15
+ * Hook consumers call to access the current sheet.
16
+ */
17
+ export declare function useWorksheet(): IWorksheet | null;
18
+ //# sourceMappingURL=WorksheetContext.d.ts.map
@@ -1,3 +1,3 @@
1
1
  export * from './WorkbookContext';
2
- export * from './SheetContext';
2
+ export * from './WorksheetContext';
3
3
  //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1,22 @@
1
+ import { default as React } from 'react';
2
+ import { MovableRendererProps } from '../movable';
3
+ export declare const ButtonRenderer: React.ComponentType<MovableRendererProps>;
4
+ export declare const CheckBoxRenderer: React.ComponentType<MovableRendererProps>;
5
+ export declare const OptionButtonRenderer: React.ComponentType<MovableRendererProps>;
6
+ /**
7
+ * The browser's own slider, lying the way the shape does. A vertical one runs downward, its
8
+ * minimum at the top, as Excel's scroll bar does.
9
+ */
10
+ export declare const ScrollBarRenderer: React.ComponentType<MovableRendererProps>;
11
+ /**
12
+ * A spinner is its two buttons and nothing else; the number it holds is in its linked cell. The
13
+ * browser's own buttons, as the button control's are.
14
+ */
15
+ export declare const SpinnerRenderer: React.ComponentType<MovableRendererProps>;
16
+ export declare const DropDownRenderer: React.ComponentType<MovableRendererProps>;
17
+ export declare const ListBoxRenderer: React.ComponentType<MovableRendererProps>;
18
+ export declare const GroupBoxRenderer: React.ComponentType<MovableRendererProps>;
19
+ export declare const LabelRenderer: React.ComponentType<MovableRendererProps>;
20
+ /** A kind with no look of its own: a neutral frame with its name. */
21
+ export declare const UnmodeledControlRenderer: React.ComponentType<MovableRendererProps>;
22
+ //# sourceMappingURL=FormControlRenderers.d.ts.map
@@ -1,4 +1,5 @@
1
1
  import { default as React } from 'react';
2
+ import { RenderSlotFn } from '@sheetxl/utils-react';
2
3
  export interface EditableLabelAttributes {
3
4
  startEdit(): void;
4
5
  cancel(): void;
@@ -18,7 +19,8 @@ export interface EditableLabelProps extends Omit<React.HTMLAttributes<HTMLDivEle
18
19
  onChange?: (value: string) => void;
19
20
  onSubmit?: (value: string) => boolean | void;
20
21
  onCancel?: () => void;
21
- renderInput?: (props: any) => React.ReactElement<HTMLInputElement>;
22
+ /** Render the input shown while editing. Spread the props on an `<input>`. */
23
+ renderInput?: RenderSlotFn<React.InputHTMLAttributes<HTMLInputElement>>;
22
24
  /**
23
25
  * Reference to the HTMLInputElement (or other) used for editing
24
26
  */
@@ -1,5 +1,5 @@
1
1
  import { RemoveListener } from '@sheetxl/utils';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { Command } from '@sheetxl/utils-react';
4
4
  import { IEditable, EditorMode, EditorTextSelection } from '@sheetxl/grid-react';
5
5
  /**
@@ -52,7 +52,7 @@ export declare function insertEditText(editable: IEditable<any, any, any>, text:
52
52
  /** The single `data` bundle {@link contributeInsertCommands} takes (the `DynamicCommandContributor` shape). */
53
53
  export interface InsertCommandData {
54
54
  editable: IEditable<any, any, any>;
55
- sheet: ISheet;
55
+ sheet: IWorksheet;
56
56
  /** `'startEdit'` begins an edit (the sheet's version when NOT editing); `'caret'` inserts at the focused editor's caret. */
57
57
  flavor: InsertFlavor;
58
58
  }
@@ -86,7 +86,7 @@ export declare function contributeWhileEditingCommands(contribution: Command.Com
86
86
  /** The single `data` bundle {@link contributeEditorCommands} takes (the `DynamicCommandContributor` shape). */
87
87
  export interface EditorCommandData {
88
88
  editable: IEditable<any, any, any>;
89
- sheet: ISheet;
89
+ sheet: IWorksheet;
90
90
  /**
91
91
  * Contribute the edit-session commands only while an edit is **active** (a session exists). An idle editor
92
92
  * owns no F4 / no caret overrides, so they cede to `redo` / the sheet's begin-edit flavor. The host passes
@@ -1,12 +1,7 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { EditorAlignment, VirtualDivProps } from '@sheetxl/grid-react';
4
4
  import { SheetEditable } from './SheetEditable';
5
- /**
6
- * Props for {@link SheetCellEditorLayer}.
7
- *
8
- * @typeParam C - clean value type. @typeParam D - dirty value type. @typeParam A - commit args.
9
- */
10
5
  export interface SheetCellEditorLayerProps extends VirtualDivProps {
11
6
  /**
12
7
  * Stacking override, read by the grid's sorter **off this element** when the editor is a grid
@@ -14,7 +9,7 @@ export interface SheetCellEditorLayerProps extends VirtualDivProps {
14
9
  */
15
10
  zIndex?: number;
16
11
  /** The sheet — its selection drives the input's leave-key nav, its active cell the edit-session commands. */
17
- sheet: ISheet;
12
+ sheet: IWorksheet;
18
13
  /** The editable (UI model) — anchor + the single current edit. Shared with peers (the formula bar). */
19
14
  editable: SheetEditable;
20
15
  /**
@@ -1,18 +1,31 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
+ import { VirtualKeyboardHandler } from '@sheetxl/utils-react';
4
+ import { StartEditOptions } from '@sheetxl/grid-react';
3
5
  import { SheetEditable } from './SheetEditable';
4
6
  import { EditRejectedNotice } from './useEditRejectedNotice';
7
+ /**
8
+ * Start a ready-mode edit typed into the grid.
9
+ *
10
+ * @param keyboard The virtual keyboard the typing came through (a key typed into the
11
+ * {@link VirtualKeyboardLayer}'s input); omit for typing on the grid itself. In keyboard mode the
12
+ * edit opens in the keyboard's registered editor (a phone's formula bar) rather than the cell, by
13
+ * parking that editor on the new session before anything renders it.
14
+ * @returns Whether the edit started.
15
+ * @internal
16
+ */
17
+ export declare const startTypedEdit: (editable: SheetEditable, coords: Parameters<SheetEditable["startEdit"]>[0], options: StartEditOptions<string>, keyboard?: VirtualKeyboardHandler) => boolean;
5
18
  /**
6
19
  * Props for {@link SheetCellEditorStartLayer}.
7
20
  */
8
21
  export interface SheetCellEditorStartLayerProps {
9
22
  /** The sheet — stamps the double-clicked cell's scope (sheet name) onto the coords it starts on. */
10
- sheet: ISheet;
23
+ sheet: IWorksheet;
11
24
  /** The editable (UI model) — the same instance the {@link SheetCellEditorLayer} renders. */
12
25
  editable: SheetEditable;
13
26
  /**
14
27
  * Notified when a start-edit attempt is rejected (`startEdit` returned `false` — a non-editable
15
- * cell). The host that mounts one layer per pane (`SheetElement`) passes a SHARED callback
28
+ * cell). The host that mounts one layer per pane (`WorksheetElement`) passes a SHARED callback
16
29
  * ({@link useEditRejectedNotice}) so all panes form one notice scope; it receives the rejected cell.
17
30
  * @defaultValue this layer's own {@link useEditRejectedNotice}
18
31
  */
@@ -29,13 +42,17 @@ export interface SheetCellEditorStartLayerProps {
29
42
  * sits at the **top** of the stack to paint over everything, but a Layer's handlers are its slot's
30
43
  * tap — grid-wide ears that fire on every layer's turn, top first — so start handlers on the top
31
44
  * layer intercepted keys and double-clicks aimed at a chart or note before that widget's own handlers
32
- * ran. Starting an edit is the grid *floor's* behavior: `SheetElement` mounts this as the first grid
45
+ * ran. Starting an edit is the grid *floor's* behavior: `WorksheetElement` mounts this as the first grid
33
46
  * child, where it only hears what no widget above consumed.
34
47
  *
35
48
  * Keys are positionless, so the floor slot alone is not enough: a focused widget that does not consume
36
49
  * a printable key (it must let keys through so its own commands can resolve) would still reach this
37
50
  * tap. The key start therefore acts only when the key is aimed at the grid surface itself — the
38
- * surface is the focused element. A double-click has a position; a widget that owns it consumes it.
51
+ * surface, or the pane's focus target standing in for it (the {@link VirtualKeyboardLayer}'s input),
52
+ * is the focused element. A double-click has a position; a widget that owns it consumes it.
53
+ *
54
+ * Text that reaches the focus target without a keydown that started an edit (a virtual keyboard can
55
+ * deliver it that way) starts one too, seeded with the text.
39
56
  */
40
57
  export declare function SheetCellEditorStartLayer(props: SheetCellEditorStartLayerProps): React.ReactElement;
41
58
  export declare namespace SheetCellEditorStartLayer {
@@ -104,6 +104,20 @@ export type SheetCellInputProps = EditorInputProps<() => ICell, string> & {
104
104
  * a sliver of the next; supplying it makes the two exact.
105
105
  */
106
106
  lineHeight?: number;
107
+ /**
108
+ * The virtual keyboard a touch host asks for (`'decimal'` for a number pad). Applied to the
109
+ * textarea; a change takes effect on the next focus on some platforms.
110
+ */
111
+ inputMode?: React.TextareaHTMLAttributes<HTMLTextAreaElement>['inputMode'];
112
+ /** The action label of the virtual keyboard's Enter key. */
113
+ enterKeyHint?: React.TextareaHTMLAttributes<HTMLTextAreaElement>['enterKeyHint'];
114
+ /**
115
+ * Which side of the caret the function hint opens on. A host at the bottom of the screen (the
116
+ * phone's formula bar) asks for `'above'`, where the room is.
117
+ *
118
+ * @defaultValue 'below'
119
+ */
120
+ hintPlacement?: 'below' | 'above';
107
121
  };
108
122
  export declare const createSheetCellInput: (options: SheetCellInputOptions) => React.FC<SheetCellInputProps>;
109
123
  //# sourceMappingURL=SheetCellInput.d.ts.map
@@ -1,4 +1,4 @@
1
- import { ISheet, IWorkbook, ICell } from '@sheetxl/sdk';
1
+ import { IWorksheet, IWorkbook, ICell } from '@sheetxl/sdk';
2
2
  import { CreateEdit, IEditable, EditCommitArgs } from '@sheetxl/grid-react';
3
3
  import { ReferenceModeHandler } from './useReferenceMode';
4
4
  /** The editable shape for a spreadsheet: `clean` is a live cell getter, `dirty` is the working text. */
@@ -9,9 +9,9 @@ export type SheetEditable = IEditable<() => ICell, string, EditCommitArgs>;
9
9
  * uses it to cover the cell while editing. The cell-aware input itself paints only the cell's *own*
10
10
  * fill; this fallback is the container's job.
11
11
  */
12
- export declare const resolveCellBackground: (cell: ICell, sheet: ISheet, darkMode?: boolean, bodyFill?: string) => string;
12
+ export declare const resolveCellBackground: (cell: ICell, sheet: IWorksheet, darkMode?: boolean, bodyFill?: string) => string;
13
13
  /**
14
- * An `ISheet`-backed {@link CreateEdit} for the new {@link DefaultEditable} / {@link EditorLayer}.
14
+ * An `IWorksheet`-backed {@link CreateEdit} for the new {@link DefaultEditable} / {@link EditorLayer}.
15
15
  *
16
16
  * @remarks
17
17
  * - **clean** is `() => ICell` — a *live* cell getter (not a captured value), so a cell-aware input
@@ -21,7 +21,7 @@ export declare const resolveCellBackground: (cell: ICell, sheet: ISheet, darkMod
21
21
  * write leaves the selection as it is (a block typed into stays selected for Enter to move within),
22
22
  * and an undo or a redo of it lands on the cell.
23
23
  * - **`null`** ⇒ the cell is not editable (protected / read-only), via {@link ICell.isEditAllowed}.
24
- * - **scope-aware**: `coords.scope` (a sheet name) picks the sheet to edit, via `workbook.getSheet`,
24
+ * - **scope-aware**: `coords.scope` (a sheet name) picks the sheet to edit, via `workbook.getWorksheet`,
25
25
  * falling back to `sheet`. This is what makes a commit write back to the session's *origin* sheet even
26
26
  * if a different sheet is currently displayed — `coords` here is the session's own (fixed) coords, not
27
27
  * whatever the anchor currently reports.
@@ -33,7 +33,7 @@ export declare const resolveCellBackground: (cell: ICell, sheet: ISheet, darkMod
33
33
  * out of `commit`, which rejects it; the editable fans the error out to
34
34
  * `IEditable.subscribeCommitError`, where the host shows it.
35
35
  */
36
- export declare const createSheetCreateEdit: (sheet: ISheet, workbook?: IWorkbook | null) => CreateEdit<() => ICell, string, EditCommitArgs>;
36
+ export declare const createSheetCreateEdit: (sheet: IWorksheet, workbook?: IWorkbook | null) => CreateEdit<() => ICell, string, EditCommitArgs>;
37
37
  /**
38
38
  * Build the production {@link SheetEditable} for a sheet — the {@link DefaultEditable} wired with a
39
39
  * workbook-aware active-cell anchor ({@link createEditableAnchor}) and SDK edit strategy
@@ -55,5 +55,5 @@ export interface CreateEditableOptions {
55
55
  */
56
56
  referenceMode?: ReferenceModeHandler;
57
57
  }
58
- export declare const createEditable: (sheet: ISheet, options?: CreateEditableOptions) => SheetEditable;
58
+ export declare const createEditable: (sheet: IWorksheet, options?: CreateEditableOptions) => SheetEditable;
59
59
  //# sourceMappingURL=SheetEditable.d.ts.map
@@ -34,7 +34,7 @@ export interface SheetReferenceHeaderLayerProps extends LayerProps {
34
34
  * primary header selection fully in charge. The producer's gates — `scope` and `allowMulti` — are read
35
35
  * here exactly as {@link SheetReferenceLayer} reads them for the body: the two surfaces drive one
36
36
  * selection, so a gate honored by only one of them is no gate at all. It is a pointer surface
37
- * only ({@link HeaderSelectionLayer} with `renderBorders={false}`) — the reference rectangles are drawn on
37
+ * only ({@link HeaderSelectionLayer} with `hideAccent`) — the reference rectangles are drawn on
38
38
  * the body grid by {@link SheetReferenceLayer}; `preserveFocus` keeps the formula editor focused across a
39
39
  * header drag; `replaceActive` re-scopes/inserts the active reference instead of the primary's whole-
40
40
  * selection replace.
@@ -1,10 +1,10 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet, ISheetView } from '@sheetxl/sdk';
2
+ import { IWorksheet, IWorksheetView } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  import { SheetSelection } from '../selection';
5
5
  /**
6
6
  * Draws the current **reference selection** over the grid (Excel-style colored rectangles), highlighting
7
- * the active reference. A pane layer (mounted per pane by `SheetElement`), it reads the app-wide
7
+ * the active reference. A pane layer (mounted per pane by `WorksheetElement`), it reads the app-wide
8
8
  * reference-mode bus ({@link useReferenceMode}) — not any edit session — so it renders whenever a
9
9
  * reference selection is present, regardless of what produced it: a formula edit (via `SheetCellInput`)
10
10
  * or, later, a selected chart showing its source data with no active input at all.
@@ -23,14 +23,14 @@ import { SheetSelection } from '../selection';
23
23
  */
24
24
  export interface SheetReferenceLayerProps extends LayerProps {
25
25
  /** The sheet this pane renders — ranges belonging to a different sheet are filtered out of this pane. */
26
- sheet: ISheet;
26
+ sheet: IWorksheet;
27
27
  /**
28
28
  * The sheet view — enables the **formula-view** fallback: while `isShowFormulas()` and no
29
29
  * reference-mode state is on the bus, the selection anchor's formula (when it IS a formula)
30
30
  * has its references outlined read-only (same palette as the anchor's colored formula text —
31
31
  * see {@link useFormulaViewAnchor}). Omit for a host with no formula view.
32
32
  */
33
- sheetView?: ISheetView;
33
+ sheetView?: IWorksheetView;
34
34
  }
35
35
  /**
36
36
  * Wrap a selection so a range **committed through this pane** is stamped with this pane's sheet.