@sheetxl/react 0.8.0-beta.9 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (398) hide show
  1. package/LICENSE.md +8 -7
  2. package/browser/esm/2YDUWXaXpl9cdsk7.mjs +8 -0
  3. package/browser/esm/64NfoZ1s7Oe3vdpX.mjs +60 -0
  4. package/browser/esm/BJDz5J4gFUEYi1Wz.mjs +36 -0
  5. package/browser/esm/B_CI6xMNropeWGgr.mjs +134 -0
  6. package/browser/esm/BgA4Cz8iMysciFOb.mjs +45 -0
  7. package/browser/esm/BkG6VuJDmu_hfIo6.mjs +31 -0
  8. package/browser/esm/BmO7yh4NjxeJylOD.mjs +14092 -0
  9. package/browser/esm/BwFFSeqtE3TIuvtc.mjs +341 -0
  10. package/browser/esm/CENTtj0PnF_tvpST.mjs +79 -0
  11. package/browser/esm/CVY0-_x6IgpdUVNp.mjs +264 -0
  12. package/browser/esm/CdyivRoMgPXvRiiE.mjs +197 -0
  13. package/browser/esm/CiylJlRA7mt8yjPD.mjs +128 -0
  14. package/browser/esm/D9CTIGFUbVGJkeVE.mjs +401 -0
  15. package/browser/esm/D9NgFucLwPgAQNgf.mjs +19 -0
  16. package/browser/esm/DdFOaG09eksHtKwT.mjs +145 -0
  17. package/browser/esm/DdHdNjRkzo1iShOo.mjs +78 -0
  18. package/browser/esm/DfIvpHB7HDdmIYNm.mjs +9560 -0
  19. package/browser/esm/DfNDtzixfTPjmoW_.mjs +32 -0
  20. package/browser/esm/Dtb9bOBjtPdUAr8x.mjs +20 -0
  21. package/browser/esm/Dz5pGpL4XWXVdntj.mjs +323 -0
  22. package/browser/esm/{Dk6274Lic6AOmEAq.mjs → SJAlYSFKC-5yNZ-C.mjs} +84 -2
  23. package/browser/esm/chart.mjs +41 -0
  24. package/browser/esm/control.mjs +217 -0
  25. package/browser/esm/group.mjs +123 -0
  26. package/browser/esm/index.mjs +21677 -15289
  27. package/browser/esm/jHqSboF5oFvzSM7a.mjs +63 -0
  28. package/browser/esm/note.mjs +112 -0
  29. package/browser/esm/oljQE8EpIzoxUjUz.mjs +323 -0
  30. package/browser/esm/picture.mjs +7 -0
  31. package/browser/esm/shape.mjs +7 -0
  32. package/browser/esm/slicer.mjs +282 -0
  33. package/browser/esm/w8MsScJSe7QxP6jL.mjs +67 -0
  34. package/browser/esm/yRqWQRSVyiR1kYh8.mjs +42 -0
  35. package/licenses/dependencies.txt +327 -53
  36. package/node/esm/1XOgrNXKQF__O9SV.mjs +8 -0
  37. package/node/esm/Aw6aaKE_YOA1Vi_V.mjs +146 -0
  38. package/node/esm/B6Oqu2Gw1pwWPf_N.mjs +328 -0
  39. package/node/esm/BizlElAhqg_Bc624.mjs +198 -0
  40. package/node/esm/C06Y1xPsbxgn3YX7.mjs +128 -0
  41. package/node/esm/C2dHN_gvhBxlFFnJ.mjs +45 -0
  42. package/node/esm/C4_5UcCdys1hzt5E.mjs +68 -0
  43. package/node/esm/CIidiDtqyubz13ys.mjs +80 -0
  44. package/node/esm/CTFb8PjwC1q6yilw.mjs +80 -0
  45. package/node/esm/C_GJPG-BTFhta8GD.mjs +265 -0
  46. package/node/esm/CdTeYrDgGp-s-KNG.mjs +134 -0
  47. package/node/esm/{B-5p0wwNM6Y5jlI2.mjs → CeMKhq6cSxfWzN5H.mjs} +84 -2
  48. package/node/esm/DJIBAu8bEDmlVjtD.mjs +20 -0
  49. package/node/esm/DUQ1PY9P63cTe_Es.mjs +37 -0
  50. package/node/esm/Db8NRp_kZ-FfkZaO.mjs +32 -0
  51. package/node/esm/Dl2kdvb4G_ddqeDN.mjs +19 -0
  52. package/node/esm/DlDr-o5nAZgPbn6R.mjs +1697 -0
  53. package/node/esm/DvRLP1lEBfwHBrEC.mjs +63 -0
  54. package/node/esm/JVlPlE1ys7DM3yCP.mjs +35 -0
  55. package/node/esm/NSddS40Vqf1xKdDd.mjs +406 -0
  56. package/node/esm/QqwCS9GFuDnQausz.mjs +66 -0
  57. package/node/esm/chart.mjs +41 -0
  58. package/node/esm/control.mjs +217 -0
  59. package/node/esm/group.mjs +123 -0
  60. package/node/esm/index.mjs +16970 -10477
  61. package/node/esm/note.mjs +113 -0
  62. package/node/esm/picture.mjs +326 -0
  63. package/node/esm/shape.mjs +342 -0
  64. package/node/esm/slicer.mjs +284 -0
  65. package/package.json +56 -14
  66. package/resources/contents.json +36 -0
  67. package/resources/locales/contents.json +84 -0
  68. package/resources/locales/de/chart.cmd.json +82 -0
  69. package/resources/locales/de/movable.cmd.json +68 -0
  70. package/resources/locales/de/picture.cmd.json +188 -0
  71. package/resources/locales/de/pivot.cmd.json +79 -0
  72. package/resources/locales/de/shape.cmd.json +17 -0
  73. package/resources/locales/de/sheet.cmd.json +169 -16
  74. package/resources/locales/de/slicer.cmd.json +17 -0
  75. package/resources/locales/de/sparkline.cmd.json +301 -0
  76. package/resources/locales/de/table.cmd.json +13 -2
  77. package/resources/locales/de/ui.msg.json +353 -2
  78. package/resources/locales/de/workbook.cmd.json +8 -1
  79. package/resources/locales/en/chart.cmd.json +82 -0
  80. package/resources/locales/en/movable.cmd.json +68 -0
  81. package/resources/locales/en/picture.cmd.json +188 -0
  82. package/resources/locales/en/pivot.cmd.json +79 -0
  83. package/resources/locales/en/shape.cmd.json +17 -0
  84. package/resources/locales/en/sheet.cmd.json +170 -17
  85. package/resources/locales/en/slicer.cmd.json +17 -0
  86. package/resources/locales/en/sparkline.cmd.json +301 -0
  87. package/resources/locales/en/table.cmd.json +13 -2
  88. package/resources/locales/en/ui.msg.json +195 -3
  89. package/resources/locales/en/workbook.cmd.json +8 -1
  90. package/types/chart.d.ts +2 -0
  91. package/types/control.d.ts +2 -0
  92. package/types/group.d.ts +2 -0
  93. package/types/note.d.ts +2 -0
  94. package/types/picture.d.ts +2 -0
  95. package/types/shape.d.ts +2 -0
  96. package/types/slicer.d.ts +2 -0
  97. package/types/src/annotation/RangeAnnotationLayer.d.ts +110 -0
  98. package/types/src/annotation/RangeAnnotationTag.d.ts +23 -0
  99. package/types/src/annotation/RangeAnnotations.d.ts +180 -0
  100. package/types/src/annotation/index.d.ts +4 -0
  101. package/types/src/autoFill/FillMenu.d.ts +2 -2
  102. package/types/src/autoFill/FillSeries.d.ts +2 -2
  103. package/types/src/border/StaticBorderRenderer.d.ts +18 -1
  104. package/types/src/border/useBorders.d.ts +95 -3
  105. package/types/src/cell/CellCheckboxRenderer.d.ts +20 -0
  106. package/types/src/cell/CellContent.d.ts +68 -0
  107. package/types/src/cell/CellControlContext.d.ts +37 -0
  108. package/types/src/cell/{FormulaCellRenderer.d.ts → CellFormulaRenderer.d.ts} +10 -7
  109. package/types/src/cell/CellImageRenderer.d.ts +11 -0
  110. package/types/src/cell/CellRenderers.d.ts +190 -0
  111. package/types/src/cell/{SheetCellRenderer.d.ts → CellTextRenderer.d.ts} +11 -8
  112. package/types/src/cell/ColumnButton.d.ts +3 -3
  113. package/types/src/cell/CornerTriangle.d.ts +2 -1
  114. package/types/src/cell/OutlineButton.d.ts +4 -4
  115. package/types/src/cell/PivotButton.d.ts +55 -0
  116. package/types/src/cell/SheetHeaderRenderer.d.ts +1 -1
  117. package/types/src/cell/StaticCellRenderer.d.ts +3 -3
  118. package/types/src/cell/_DropdownFace.d.ts +29 -0
  119. package/types/src/cell/index.d.ts +9 -2
  120. package/types/src/cell/useFormulaViewAnchor.d.ts +3 -3
  121. package/types/src/cell/useInsertableCellControls.d.ts +25 -0
  122. package/types/src/chart/ChartCommands.d.ts +15 -0
  123. package/types/src/chart/ChartEditor.d.ts +12 -2
  124. package/types/src/chart/ChartElement.d.ts +122 -0
  125. package/types/src/chart/ChartKind.d.ts +7 -0
  126. package/types/src/chart/PresetChartTypeDescriptors.d.ts +3 -1
  127. package/types/src/chart/index.d.ts +2 -1
  128. package/types/src/chart/paint/_fills.d.ts +24 -0
  129. package/types/src/chart/paint/_graphics.d.ts +38 -0
  130. package/types/src/chart/paint/_mode.d.ts +6 -0
  131. package/types/src/chart/paint/echarts.d.ts +33 -0
  132. package/types/src/chart/paint/index.d.ts +12 -0
  133. package/types/src/chart/paint/kinds/ChartPaintKind.d.ts +140 -0
  134. package/types/src/chart/paint/kinds/_Area.d.ts +3 -0
  135. package/types/src/chart/paint/kinds/_Bar.d.ts +3 -0
  136. package/types/src/chart/paint/kinds/_BoxWhisker.d.ts +3 -0
  137. package/types/src/chart/paint/kinds/_Bubble.d.ts +3 -0
  138. package/types/src/chart/paint/kinds/_Funnel.d.ts +3 -0
  139. package/types/src/chart/paint/kinds/_Histogram.d.ts +3 -0
  140. package/types/src/chart/paint/kinds/_Line.d.ts +10 -0
  141. package/types/src/chart/paint/kinds/_OfPie.d.ts +3 -0
  142. package/types/src/chart/paint/kinds/_Pie.d.ts +21 -0
  143. package/types/src/chart/paint/kinds/_Placeholder.d.ts +7 -0
  144. package/types/src/chart/paint/kinds/_Radar.d.ts +3 -0
  145. package/types/src/chart/paint/kinds/_Scatter.d.ts +3 -0
  146. package/types/src/chart/paint/kinds/_Sunburst.d.ts +3 -0
  147. package/types/src/chart/paint/kinds/_Surface.d.ts +3 -0
  148. package/types/src/chart/paint/kinds/_Treemap.d.ts +3 -0
  149. package/types/src/chart/paint/kinds/_Waterfall.d.ts +3 -0
  150. package/types/src/chart/paint/kinds/_builtIns.d.ts +3 -0
  151. package/types/src/chart/paint/toEChartsOption.d.ts +42 -0
  152. package/types/src/checklist/ValueChecklist.d.ts +44 -15
  153. package/types/src/clipboard/ClipboardCommands.d.ts +3 -3
  154. package/types/src/clipboard/SheetClipboardLayer.d.ts +2 -2
  155. package/types/src/commands/ContextualToolbar.d.ts +19 -0
  156. package/types/src/commands/createTransactionalMiddleware.d.ts +4 -1
  157. package/types/src/commands/index.d.ts +1 -0
  158. package/types/src/comment/CommentCardRequest.d.ts +9 -9
  159. package/types/src/comment/index.d.ts +0 -1
  160. package/types/src/comment/useSheetComments.d.ts +2 -2
  161. package/types/src/conditionalFormat/ConditionalFormatPresets.d.ts +6 -6
  162. package/types/src/context/WorksheetContext.d.ts +18 -0
  163. package/types/src/context/index.d.ts +1 -1
  164. package/types/src/control/FormControlRenderers.d.ts +8 -0
  165. package/types/src/editableLabel/EditableLabel.d.ts +3 -1
  166. package/types/src/editor/EditorCommands.d.ts +3 -3
  167. package/types/src/editor/SheetCellEditorLayer.d.ts +2 -7
  168. package/types/src/editor/SheetCellEditorStartLayer.d.ts +22 -5
  169. package/types/src/editor/SheetCellInput.d.ts +14 -0
  170. package/types/src/editor/SheetEditable.d.ts +6 -6
  171. package/types/src/editor/SheetReferenceHeaderLayer.d.ts +1 -1
  172. package/types/src/editor/SheetReferenceLayer.d.ts +4 -4
  173. package/types/src/editor/VirtualKeyboardLayer.d.ts +50 -0
  174. package/types/src/editor/formulaAnchor.d.ts +12 -0
  175. package/types/src/editor/formulaPresentation.d.ts +4 -3
  176. package/types/src/editor/index.d.ts +2 -0
  177. package/types/src/editor/pickedReference.d.ts +3 -3
  178. package/types/src/editor/useEditRejectedNotice.d.ts +3 -3
  179. package/types/src/editor/useFormulaHints.d.ts +3 -3
  180. package/types/src/editor/useFormulaInput.d.ts +6 -3
  181. package/types/src/editor/validationAlert.d.ts +24 -0
  182. package/types/src/form/FormulaInput.d.ts +5 -2
  183. package/types/src/form/useEditCommit.d.ts +23 -3
  184. package/types/src/form/useInputField.d.ts +2 -3
  185. package/types/src/frame/CommandContext.d.ts +74 -3
  186. package/types/src/group/GroupEditor.d.ts +25 -0
  187. package/types/src/index.d.ts +10 -2
  188. package/types/src/layer/BorderLayer.d.ts +5 -2
  189. package/types/src/layer/CellErrorLayer.d.ts +18 -7
  190. package/types/src/layer/CellFillLayer.d.ts +2 -2
  191. package/types/src/layer/CellIndicatorLayer.d.ts +31 -0
  192. package/types/src/layer/CellInsertLayer.d.ts +71 -0
  193. package/types/src/layer/CircularIndicatorLayer.d.ts +3 -3
  194. package/types/src/layer/CommentCardLayer.d.ts +7 -9
  195. package/types/src/layer/CommentsLayer.d.ts +2 -2
  196. package/types/src/layer/ConditionalBarLayer.d.ts +2 -2
  197. package/types/src/layer/ConditionalIcons.d.ts +4 -4
  198. package/types/src/layer/ConditionalIconsLayer.d.ts +2 -2
  199. package/types/src/layer/ContextMenuLayer.d.ts +2 -2
  200. package/types/src/layer/FreezeDragLines.d.ts +17 -0
  201. package/types/src/layer/GridFreezeLayer.d.ts +11 -0
  202. package/types/src/layer/HeaderFreezeLayer.d.ts +12 -0
  203. package/types/src/layer/HeaderResizerLayer.d.ts +2 -1
  204. package/types/src/layer/HeaderSelectionLayer.d.ts +4 -4
  205. package/types/src/layer/HyperlinkLayer.d.ts +116 -0
  206. package/types/src/layer/MovableKindScope.d.ts +17 -0
  207. package/types/src/layer/PivotLayer.d.ts +47 -0
  208. package/types/src/layer/PivotToolbar.d.ts +29 -0
  209. package/types/src/layer/ProtectionLayer.d.ts +4 -5
  210. package/types/src/layer/RangeToolbar.d.ts +75 -0
  211. package/types/src/layer/ResizeIndicator.d.ts +11 -10
  212. package/types/src/layer/ResizeTooltip.d.ts +13 -0
  213. package/types/src/layer/SheetBackgroundLayer.d.ts +3 -3
  214. package/types/src/layer/SheetCellLayer.d.ts +15 -8
  215. package/types/src/layer/SheetColumnButtonLayer.d.ts +2 -2
  216. package/types/src/layer/SheetGridLineLayer.d.ts +25 -15
  217. package/types/src/layer/SheetHeaderCellLayer.d.ts +1 -1
  218. package/types/src/layer/SheetLayers.d.ts +171 -0
  219. package/types/src/layer/SheetMovableLayer.d.ts +4 -3
  220. package/types/src/layer/SheetOutlineLayer.d.ts +3 -3
  221. package/types/src/layer/SheetPivotCommandLayer.d.ts +13 -0
  222. package/types/src/layer/SheetSparklineCommandLayer.d.ts +14 -0
  223. package/types/src/layer/SheetTableCommandLayer.d.ts +2 -2
  224. package/types/src/layer/SparklineLayer.d.ts +32 -0
  225. package/types/src/layer/SpillLayer.d.ts +2 -2
  226. package/types/src/layer/TableLayer.d.ts +6 -5
  227. package/types/src/layer/TableToolbar.d.ts +23 -0
  228. package/types/src/layer/ValidationDropdownLayer.d.ts +2 -2
  229. package/types/src/layer/ValidationIndicatorLayer.d.ts +2 -2
  230. package/types/src/layer/ValidationPromptLayer.d.ts +47 -16
  231. package/types/src/layer/_sheetBorders.d.ts +6 -0
  232. package/types/src/layer/_tableColor.d.ts +6 -0
  233. package/types/src/layer/_visibleCellFeatures.d.ts +11 -0
  234. package/types/src/layer/cellTip.d.ts +13 -0
  235. package/types/src/layer/freezeDragState.d.ts +21 -0
  236. package/types/src/layer/index.d.ts +14 -0
  237. package/types/src/layer/resizeIndicatorState.d.ts +3 -1
  238. package/types/src/layer/useFreezeDrag.d.ts +22 -0
  239. package/types/src/layer/useNormalBorderLines.d.ts +15 -0
  240. package/types/src/layer/useSheetFeatureRegions.d.ts +2 -2
  241. package/types/src/layer/useSheetVisibleCells.d.ts +5 -6
  242. package/types/src/layer/useSheetVisibleDecorations.d.ts +2 -2
  243. package/types/src/layer/useTableHeaderCells.d.ts +2 -2
  244. package/types/src/layer/useValidationPicker.d.ts +3 -3
  245. package/types/src/layer/useVisibleTables.d.ts +2 -2
  246. package/types/src/layer/validationMark.d.ts +3 -3
  247. package/types/src/listener/index.d.ts +5 -0
  248. package/types/src/listener/useCell.d.ts +29 -0
  249. package/types/src/listener/useCellRange.d.ts +23 -0
  250. package/types/src/listener/useCellValue.d.ts +26 -0
  251. package/types/src/listener/useModelListener.d.ts +4 -4
  252. package/types/src/listener/useRangeListener.d.ts +13 -7
  253. package/types/src/listener/useRangeSnapshot.d.ts +35 -0
  254. package/types/src/listener/useTable.d.ts +26 -0
  255. package/types/src/movable/ConnectionSites.d.ts +18 -0
  256. package/types/src/movable/DefaultMovable.d.ts +8 -0
  257. package/types/src/movable/IMovableArea.d.ts +28 -0
  258. package/types/src/movable/MovableAdornment.d.ts +9 -3
  259. package/types/src/movable/MovableCommandGroups.d.ts +22 -0
  260. package/types/src/movable/MovableCommands.d.ts +8 -3
  261. package/types/src/movable/MovableControl.d.ts +49 -1
  262. package/types/src/movable/MovableFrame.d.ts +5 -1
  263. package/types/src/movable/MovableLayer.d.ts +30 -5
  264. package/types/src/movable/MovableRenderers.d.ts +166 -11
  265. package/types/src/movable/PlaceholderFrames.d.ts +11 -0
  266. package/types/src/movable/RotateHandle.d.ts +12 -4
  267. package/types/src/movable/connect.d.ts +16 -0
  268. package/types/src/movable/framePlacement.d.ts +44 -1
  269. package/types/src/movable/geometry.d.ts +13 -3
  270. package/types/src/movable/index.d.ts +8 -0
  271. package/types/src/movable/pressTarget.d.ts +20 -0
  272. package/types/src/movable/useFramePreview.d.ts +17 -0
  273. package/types/src/picker/cellPickerOpen.d.ts +3 -3
  274. package/types/src/picker/useCellPicker.d.ts +7 -5
  275. package/types/src/picture/PictureCommands.d.ts +20 -0
  276. package/types/src/picture/PictureKind.d.ts +7 -0
  277. package/types/src/picture/_pictureHyperlink.d.ts +13 -0
  278. package/types/src/picture/index.d.ts +0 -1
  279. package/types/src/picture/pictureCrop.d.ts +32 -0
  280. package/types/src/pivot/PivotAreas.d.ts +16 -0
  281. package/types/src/pivot/PivotChip.d.ts +33 -0
  282. package/types/src/pivot/PivotChipMenu.d.ts +74 -0
  283. package/types/src/pivot/PivotCommands.d.ts +24 -0
  284. package/types/src/pivot/PivotFieldList.d.ts +14 -0
  285. package/types/src/pivot/PivotFields.d.ts +47 -0
  286. package/types/src/pivot/PivotFieldsModel.d.ts +143 -0
  287. package/types/src/pivot/PivotTablePane.d.ts +47 -0
  288. package/types/src/pivot/_PivotFieldsContext.d.ts +41 -0
  289. package/types/src/pivot/_pivotNew.d.ts +12 -0
  290. package/types/src/pivot/_pivotRegion.d.ts +14 -0
  291. package/types/src/pivot/index.d.ts +9 -0
  292. package/types/src/pivot/usePivotFields.d.ts +17 -0
  293. package/types/src/presence/PresenceCommands.d.ts +35 -0
  294. package/types/src/presence/PresenceHost.d.ts +58 -0
  295. package/types/src/presence/PresenceMessages.d.ts +42 -0
  296. package/types/src/presence/PresenceStore.d.ts +165 -0
  297. package/types/src/presence/PresenceTypes.d.ts +78 -0
  298. package/types/src/presence/index.d.ts +7 -0
  299. package/types/src/presence/usePresence.d.ts +20 -0
  300. package/types/src/richText/RichTextEditor.d.ts +2 -2
  301. package/types/src/selection/SelectionCommands.d.ts +2 -2
  302. package/types/src/selection/SheetSelectionLayer.d.ts +6 -12
  303. package/types/src/shape/ConnectorControl.d.ts +46 -0
  304. package/types/src/shape/ShapeCommands.d.ts +11 -0
  305. package/types/src/shape/ShapeControl.d.ts +8 -0
  306. package/types/src/shape/ShapeEditor.d.ts +2 -3
  307. package/types/src/shape/ShapeGallery.d.ts +21 -6
  308. package/types/src/shape/ShapeKind.d.ts +7 -0
  309. package/types/src/shape/ShapeSVG.d.ts +6 -8
  310. package/types/src/shape/index.d.ts +0 -1
  311. package/types/src/shape/shapeFrame.d.ts +46 -2
  312. package/types/src/shape/shapeStyle.d.ts +59 -8
  313. package/types/src/sheet/ISheetHeaderElement.d.ts +3 -3
  314. package/types/src/sheet/{ISheetElement.d.ts → IWorksheetElement.d.ts} +110 -86
  315. package/types/src/sheet/OpaqueSheetElement.d.ts +21 -0
  316. package/types/src/sheet/SheetCommandProvider.d.ts +14 -6
  317. package/types/src/sheet/SheetCommands.d.ts +18 -3
  318. package/types/src/sheet/SheetKindIcon.d.ts +14 -0
  319. package/types/src/sheet/SheetOutlineElement.d.ts +6 -6
  320. package/types/src/sheet/SheetPanels.d.ts +11 -0
  321. package/types/src/sheet/SheetScrollbar.d.ts +4 -13
  322. package/types/src/sheet/TopLeftCorner.d.ts +2 -2
  323. package/types/src/sheet/WorksheetElement.d.ts +12 -0
  324. package/types/src/sheet/_freezeAt.d.ts +10 -0
  325. package/types/src/sheet/_hyperlinkEdit.d.ts +7 -0
  326. package/types/src/sheet/_useHeaderMetrics.d.ts +11 -0
  327. package/types/src/sheet/circularReferences.d.ts +4 -4
  328. package/types/src/sheet/index.d.ts +5 -2
  329. package/types/src/sheet/useCycleHighlight.d.ts +2 -2
  330. package/types/src/slicer/SlicerCommands.d.ts +10 -0
  331. package/types/src/slicer/SlicerEditor.d.ts +8 -2
  332. package/types/src/slicer/SlicerKind.d.ts +7 -0
  333. package/types/src/slicer/SlicerStylePreview.d.ts +18 -0
  334. package/types/src/slicer/index.d.ts +2 -1
  335. package/types/src/slicer/slicerStyles.d.ts +32 -0
  336. package/types/src/sparkline/PictureCache.d.ts +37 -0
  337. package/types/src/sparkline/SparklineCommands.d.ts +23 -0
  338. package/types/src/sparkline/SparklinePictures.d.ts +7 -0
  339. package/types/src/sparkline/paint/_drawing.d.ts +24 -0
  340. package/types/src/sparkline/paint/echarts.d.ts +8 -0
  341. package/types/src/sparkline/paint/index.d.ts +8 -0
  342. package/types/src/tabStrip/SheetTab.d.ts +1 -1
  343. package/types/src/tabStrip/Sortable.d.ts +5 -5
  344. package/types/src/tabStrip/TabStrip.d.ts +13 -6
  345. package/types/src/tabStrip/TabStripItem.d.ts +15 -13
  346. package/types/src/table/TableCommands.d.ts +2 -2
  347. package/types/src/taskPane/CellControlPane.d.ts +15 -0
  348. package/types/src/taskPane/MovablePane.d.ts +15 -0
  349. package/types/src/taskPane/TaskPaneArea.d.ts +7 -0
  350. package/types/src/taskPane/TaskPaneFrame.d.ts +4 -4
  351. package/types/src/taskPane/TaskPaneKeys.d.ts +38 -0
  352. package/types/src/taskPane/TaskPaneRegistry.d.ts +32 -12
  353. package/types/src/taskPane/_paneReasons.d.ts +7 -0
  354. package/types/src/taskPane/index.d.ts +3 -0
  355. package/types/src/taskPane/useTaskPane.d.ts +6 -3
  356. package/types/src/theme/ExplicitTokens.d.ts +18 -0
  357. package/types/src/theme/GridColorSchemeContext.d.ts +8 -0
  358. package/types/src/theme/ThemeRootStyles.d.ts +31 -0
  359. package/types/src/theme/ThemeState.d.ts +2 -2
  360. package/types/src/theme/buildDocThemeCSS.d.ts +4 -1
  361. package/types/src/theme/buildOOXMLThemeCSS.d.ts +2 -2
  362. package/types/src/theme/buildTokensCSS.d.ts +15 -0
  363. package/types/src/theme/index.d.ts +2 -4
  364. package/types/src/theme/useAppColorScheme.d.ts +4 -1
  365. package/types/src/theme/useGridColorScheme.d.ts +9 -4
  366. package/types/src/theme/useSystemColors.d.ts +1 -15
  367. package/types/src/workbook/DefaultMovableRenderers.d.ts +19 -1
  368. package/types/src/workbook/DefaultRenderers.d.ts +5 -4
  369. package/types/src/workbook/IWorkbookElement.d.ts +176 -30
  370. package/types/src/workbook/WorkbookCommands.d.ts +6 -1
  371. package/types/src/workbook/WorkbookStrip.d.ts +14 -5
  372. package/browser/cjs/index.cjs +0 -43
  373. package/browser/cjs/xuAfpHmA2W4MFa_0.cjs +0 -1
  374. package/types/src/chart/templates/area-stacked-percent-template.json.d.ts +0 -10
  375. package/types/src/chart/templates/area-stacked-template.json.d.ts +0 -10
  376. package/types/src/chart/templates/area-template.json.d.ts +0 -9
  377. package/types/src/chart/templates/bar-stacked-percent-template.json.d.ts +0 -10
  378. package/types/src/chart/templates/bar-stacked-template.json.d.ts +0 -10
  379. package/types/src/chart/templates/bar-template.json.d.ts +0 -9
  380. package/types/src/chart/templates/column-stacked-percent-template.json.d.ts +0 -10
  381. package/types/src/chart/templates/column-stacked-template.json.d.ts +0 -10
  382. package/types/src/chart/templates/column-template.json.d.ts +0 -9
  383. package/types/src/chart/templates/line-markers-template.json.d.ts +0 -10
  384. package/types/src/chart/templates/line-stacked-markers-template.json.d.ts +0 -11
  385. package/types/src/chart/templates/line-stacked-percent-markers-template.json.d.ts +0 -11
  386. package/types/src/chart/templates/line-stacked-percent-template.json.d.ts +0 -10
  387. package/types/src/chart/templates/line-stacked-template.json.d.ts +0 -10
  388. package/types/src/chart/templates/line-template.json.d.ts +0 -9
  389. package/types/src/chart/templates/pie-doughnut-template.json.d.ts +0 -10
  390. package/types/src/chart/templates/pie-template.json.d.ts +0 -9
  391. package/types/src/chart/templates/scatter-lines-markers-smooth-template.json.d.ts +0 -10
  392. package/types/src/chart/templates/scatter-lines-markers-template.json.d.ts +0 -10
  393. package/types/src/chart/templates/scatter-lines-smooth-template.json.d.ts +0 -10
  394. package/types/src/chart/templates/scatter-lines-template.json.d.ts +0 -10
  395. package/types/src/chart/templates/scatter-markers-template.json.d.ts +0 -10
  396. package/types/src/context/SheetContext.d.ts +0 -18
  397. package/types/src/control/index.d.ts +0 -2
  398. package/types/src/sheet/SheetElement.d.ts +0 -15
@@ -0,0 +1,190 @@
1
+ import { default as React } from 'react';
2
+ import { ICell, ICellControl, IRangeSelection, IWorksheet } from '@sheetxl/sdk';
3
+ import { CellRendererProps } from '@sheetxl/grid-react';
4
+ import { CellTextRendererProps } from './CellTextRenderer';
5
+ import { CellControlContext } from './CellControlContext';
6
+ /**
7
+ * The props spread onto the element of a cell's content that takes the pointer (see
8
+ * {@link CellContentRendererProps.interactiveProps}). A marker only: one frozen object for every
9
+ * cell, no handlers.
10
+ */
11
+ export type CellInteractiveProps = Readonly<Record<string, string>>;
12
+ /**
13
+ * The props of the default text renderer as a content renderer receives it
14
+ * ({@link CellContentRendererProps.Default}): the content props may be spread straight onto it.
15
+ */
16
+ export type DefaultCellContentProps = Omit<CellContentRendererProps, keyof CellContentOnlyProps> & Partial<CellContentOnlyProps> & Partial<Omit<CellTextRendererProps, keyof CellRendererProps<ICell>>>;
17
+ /** The props a content renderer has that the default text renderer does not. */
18
+ export interface CellContentOnlyProps {
19
+ control: ICellControl | null;
20
+ context: CellControlContext;
21
+ interactiveProps: CellInteractiveProps;
22
+ Default: React.ComponentType<DefaultCellContentProps>;
23
+ }
24
+ /**
25
+ * What a cell content renderer is given: the cell layer's props for the cell, the layer's write
26
+ * context, the props that make an element interactive, and the default text renderer.
27
+ *
28
+ * @remarks
29
+ * A renderer is a pure function of these props: it is rendered inside the cell layer's cached
30
+ * tiles and calls no hook.
31
+ */
32
+ export interface CellContentRendererProps extends CellRendererProps<ICell> {
33
+ /**
34
+ * The control the renderer draws for, when it was chosen by the cell's control; `null` when it
35
+ * was chosen by the value's rich data type.
36
+ */
37
+ control: ICellControl | null;
38
+ /**
39
+ * The layer's write context, one for every cell of the layer: guarded writes
40
+ * (`setCellValue(cell, value)`) for a renderer that writes from its own pointer handlers, such
41
+ * as a slider's drag. A press and a key write through the entry instead.
42
+ */
43
+ context: CellControlContext;
44
+ /**
45
+ * Spread onto the element that takes the pointer: the box of a checkbox, a button, the track of a
46
+ * slider. It marks the element, nothing more. A plain press on a marked element selects the cell
47
+ * and then reaches the element; the cell layer runs the entry's {@link CellContentEntry.onPress}
48
+ * for it and stops the press, and keeps a double-click on it from opening the editor. For a drag
49
+ * or hover add your own handlers on the element (capture the pointer on it for a drag); a handler
50
+ * that stops the press keeps the layer out of it.
51
+ */
52
+ interactiveProps: CellInteractiveProps;
53
+ /**
54
+ * The default text renderer, bound to this layer's theme, Normal style and view flags. For a
55
+ * renderer that decorates the text rather than replacing it: `<Default {...props}>{badge}</Default>`.
56
+ */
57
+ Default: React.ComponentType<DefaultCellContentProps>;
58
+ }
59
+ /**
60
+ * Draws a cell's content in place of its text.
61
+ *
62
+ * @remarks
63
+ * A pure function of its props: the layer calls it directly inside its cached tiles, not as a
64
+ * component, so it can hold no state and call no hook (a hook throws). It returns the cell's root,
65
+ * which applies `props.style` to place itself in the cell; `CellContent` is that root ready-made.
66
+ * The layer takes no pointer events; the part that should take the pointer spreads
67
+ * `props.interactiveProps`.
68
+ */
69
+ export type CellContentRenderer = (props: CellContentRendererProps) => React.ReactNode;
70
+ /** What a key offered to a content entry is about: the selection it acts on. */
71
+ export interface CellKeyTarget {
72
+ sheet: IWorksheet;
73
+ selection: IRangeSelection;
74
+ /** The selection's anchor cell. */
75
+ anchor: ICell;
76
+ /** The controls of the entry's type that the selection touches; empty for a rich data entry. */
77
+ controls: ICellControl[];
78
+ }
79
+ /** Props of a content entry's task pane body ({@link CellContentEntry.pane}). */
80
+ export interface CellControlPaneProps {
81
+ sheet: IWorksheet;
82
+ /** The anchor cell. */
83
+ cell: ICell;
84
+ /** The cell's control; `null` for a rich data entry. */
85
+ control: ICellControl | null;
86
+ }
87
+ /**
88
+ * What a type of cell control, or of rich data value, contributes to the UI: how its cells draw,
89
+ * what a press and a key do to them, and the task pane body for them. Every field is optional; a
90
+ * type registered with none draws as text.
91
+ */
92
+ export interface CellContentEntry {
93
+ /** Draws the cell in place of its text. Without it the cell draws as text. */
94
+ renderer?: CellContentRenderer;
95
+ /**
96
+ * A press on the content: a primary press on an element carrying
97
+ * {@link CellContentRendererProps.interactiveProps}. A checkbox writes the other value. The
98
+ * event says what was pressed: a renderer with several hit zones in one cell (the stars of a
99
+ * rating) marks them with attributes of its own and reads `event.target`.
100
+ */
101
+ onPress?: (cell: ICell, ctx: CellControlContext, event: CellPressEvent) => void;
102
+ /**
103
+ * A printable key, Space included, typed on the grid while the selection touches cells of this
104
+ * type. Never Enter, Tab, an arrow, Escape or a function key, and never a key with a modifier.
105
+ * Return `true` when consumed: the key then never starts an edit. Return `false` to let the key
106
+ * start the normal edit of the anchor cell. Offered once per type with the whole selection; a
107
+ * checkbox toggles every checkbox cell of it on Space.
108
+ */
109
+ onKey?: (key: string, target: CellKeyTarget, ctx: CellControlContext) => boolean;
110
+ /** The body the cell control pane shows while a cell of this type is the selection's anchor. */
111
+ pane?: React.ComponentType<CellControlPaneProps>;
112
+ /**
113
+ * The icon where a UI lists the types that can be inserted: a `DynamicIcon` key or an element.
114
+ * The name comes from the sdk kind's `label`.
115
+ */
116
+ icon?: string | React.ReactElement;
117
+ /**
118
+ * Whether a UI lists the type among those that can be inserted. Off for a type whose default
119
+ * value shows nothing, such as an image, which needs a source.
120
+ *
121
+ * @defaultValue true
122
+ */
123
+ insertable?: boolean;
124
+ }
125
+ /** The press handed to {@link CellContentEntry.onPress}: the pointer event, already consumed. */
126
+ export type CellPressEvent = Pick<React.PointerEvent, 'button' | 'target' | 'clientX' | 'clientY' | 'shiftKey' | 'ctrlKey' | 'metaKey' | 'altKey'>;
127
+ /** A cell's content entry and what chose it, as {@link getCellContent} answers it. */
128
+ export interface ResolvedCellContent {
129
+ entry: CellContentEntry;
130
+ /** {@inheritDoc CellContentRendererProps.control} */
131
+ control: ICellControl | null;
132
+ }
133
+ /**
134
+ * Registers what a type of cell control contributes to the UI, replacing the built-in entry.
135
+ *
136
+ * @param type The control type (`ICellControl.getType()`), as registered with `CellControlRegistry`
137
+ * in the SDK.
138
+ * @returns A function that removes the registration.
139
+ */
140
+ export declare function registerCellControl(type: string, entry: CellContentEntry): () => void;
141
+ /**
142
+ * Registers what a type of rich data value contributes to the UI, used when the cell's control
143
+ * does not draw the value. Replaces the built-in entry (`image`).
144
+ *
145
+ * @param type The rich data type (`IRichData.getKind().getName()`), as registered with `RichDataRegistry` in
146
+ * the SDK.
147
+ * @returns A function that removes the registration.
148
+ */
149
+ export declare function registerRichData(type: string, entry: CellContentEntry): () => void;
150
+ /** The entry registered for a rich data type, built-in or not, or `undefined`. */
151
+ export declare function getRichDataEntry(type: string): CellContentEntry | undefined;
152
+ /** The entry registered for a control type, built-in or not, or `undefined`. */
153
+ export declare function getCellControlEntry(type: string): CellContentEntry | undefined;
154
+ /**
155
+ * The content entry for `cell`, or `null` for plain text.
156
+ *
157
+ * @remarks
158
+ * The cell's control comes first, when it accepts the cell's value and an entry is registered for
159
+ * its type; then the entry for the value's rich data type. The entry may still have no renderer,
160
+ * in which case the cell draws as text.
161
+ */
162
+ export declare function getCellContent(cell: ICell): ResolvedCellContent | null;
163
+ /**
164
+ * Calls `listener` whenever what {@link getCellContent} answers may have changed: an entry
165
+ * registered or removed.
166
+ *
167
+ * @returns A function that removes the listener.
168
+ */
169
+ export declare function addCellContentListener(listener: () => void): () => void;
170
+ /**
171
+ * Changes whenever an entry is registered or removed, for `useSyncExternalStore`.
172
+ * @internal
173
+ */
174
+ export declare function getCellContentVersion(): number;
175
+ /**
176
+ * A primary press that reached the cell layer: when it is on interactive content whose entry has a
177
+ * press, runs the press and consumes the event. The layer's own handler, so no cell carries one.
178
+ *
179
+ * @returns Whether the press was taken.
180
+ */
181
+ export declare function pressCellContent(e: CellPressEvent & Pick<React.PointerEvent, 'stopPropagation' | 'preventDefault'>, sheet: IWorksheet, ctx: CellControlContext): boolean;
182
+ /**
183
+ * Offers a printable key typed on the grid to the content entries the selection touches, once per
184
+ * type with the whole selection (the selection's controls grouped by type, then the anchor's rich
185
+ * data type).
186
+ *
187
+ * @returns Whether an entry consumed it. The caller then never starts an edit with the key.
188
+ */
189
+ export declare function offerCellKey(key: string, sheet: IWorksheet, ctx: CellControlContext): boolean;
190
+ //# sourceMappingURL=CellRenderers.d.ts.map
@@ -1,7 +1,7 @@
1
1
  import { default as React } from 'react';
2
- import { ICell, IStyle, ITheme } from '@sheetxl/sdk';
2
+ import { ICell, ICellStyle, ITheme } from '@sheetxl/sdk';
3
3
  import { CellRendererProps } from '@sheetxl/grid-react';
4
- export interface SheetCellRendererProps extends CellRendererProps<ICell> {
4
+ export interface CellTextRendererProps extends CellRendererProps<ICell> {
5
5
  /**
6
6
  * If true, prefer to show the formulas over values
7
7
  */
@@ -35,16 +35,19 @@ export interface SheetCellRendererProps extends CellRendererProps<ICell> {
35
35
  * An optimization that tells the render all of the styling is normal. And doesn't need to
36
36
  * be overwritten.
37
37
  */
38
- normalStyle?: IStyle;
38
+ normalStyle?: ICellStyle;
39
39
  /**
40
- * Callback for when a link has been clicked.
40
+ * Called when the cell's hyperlink is clicked: on release, as Excel follows a link on mouse up
41
+ * (the press itself selects the cell). The link text is interactive content of the cell.
41
42
  *
42
43
  * @param event - The mouse event
43
44
  */
44
- onLinkMouseDown?: (event: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;
45
+ onLinkClick?: (event: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;
45
46
  }
46
47
  /**
47
- * CellRender is used for rendering text values on ICell.
48
+ * Paints a cell's value as text: the formatted value (or its formula in formula view), laid out
49
+ * and decorated the way the sheet shows it. Everything else a cell shows (fill, borders,
50
+ * conditional icons and bars, column buttons, indicators) is a layer of its own.
48
51
  *
49
52
  * Some of the features are:
50
53
  * 1. Text Color
@@ -63,5 +66,5 @@ export interface SheetCellRendererProps extends CellRendererProps<ICell> {
63
66
  *
64
67
  * @param props
65
68
  */
66
- export declare const SheetCellRenderer: React.FC<SheetCellRendererProps>;
67
- //# sourceMappingURL=SheetCellRenderer.d.ts.map
69
+ export declare const CellTextRenderer: React.FC<CellTextRendererProps>;
70
+ //# sourceMappingURL=CellTextRenderer.d.ts.map
@@ -24,15 +24,15 @@ export interface ColumnButtonConfigProps {
24
24
  /**
25
25
  * Callback for creating a custom column button.
26
26
  *
27
- * @returns A React Element representing the ColumnButton.
28
27
  */
29
- renderColumnButton?: (props: ColumnButtonProps) => React.ReactElement;
28
+ renderColumnButton?: (props: ColumnButtonProps) => React.ReactNode;
30
29
  }
31
30
  /**
32
31
  * Property for the filter button
33
32
  */
34
33
  export interface ColumnButtonProps extends React.HTMLAttributes<HTMLElement> {
35
- renderBounds: Bounds;
34
+ /** The header cell's box the button pins itself into. */
35
+ bounds: Bounds;
36
36
  zoom: number;
37
37
  disabled: boolean;
38
38
  column: ITable.IColumn;
@@ -6,7 +6,8 @@ export interface CornerTriangleProps extends React.SVGProps<SVGSVGElement> {
6
6
  */
7
7
  anchorLocation?: AnchorLocation;
8
8
  /**
9
- * defaults based on corner
9
+ * The mark's color. Set on the root `<svg>`, so a stylesheet rule on the mark's class wins over it.
10
+ * @defaultValue the `color-neutral` token
10
11
  */
11
12
  fill?: string;
12
13
  /**
@@ -53,12 +53,12 @@ export interface OutlineProps extends React.HTMLAttributes<HTMLDivElement> {
53
53
  * Renders a group's collapse / expand button, filling the square it is placed in. Defaults to
54
54
  * {@link OutlineButton}.
55
55
  */
56
- renderButton?: (props: OutlineButtonProps) => React.ReactNode;
56
+ renderButton?: ((props: OutlineButtonProps) => React.ReactNode) | null;
57
57
  /**
58
58
  * Renders a level button, filling the square it is placed in. Defaults to
59
59
  * {@link OutlineLevelButton}.
60
60
  */
61
- renderLevelButton?: (props: OutlineLevelButtonProps) => React.ReactNode;
61
+ renderLevelButton?: ((props: OutlineLevelButtonProps) => React.ReactNode) | null;
62
62
  /**
63
63
  * The size of one level's lane across the gutter, in pixels at 100% zoom. A button fills its lane,
64
64
  * less {@link laneGap}.
@@ -118,6 +118,6 @@ export declare const OutlineButton: React.MemoExoticComponent<(props: OutlineBut
118
118
  * The chromeless level button: a square with its level number, in the corner knob's colors.
119
119
  */
120
120
  export declare const OutlineLevelButton: React.MemoExoticComponent<(props: OutlineLevelButtonProps) => React.JSX.Element>;
121
- export declare const renderOutlineButton: (props: OutlineButtonProps) => React.ReactNode;
122
- export declare const renderOutlineLevelButton: (props: OutlineLevelButtonProps) => React.ReactNode;
121
+ export declare const defaultRenderOutlineButton: (props: OutlineButtonProps) => React.ReactNode;
122
+ export declare const defaultRenderOutlineLevelButton: (props: OutlineLevelButtonProps) => React.ReactNode;
123
123
  //# sourceMappingURL=OutlineButton.d.ts.map
@@ -0,0 +1,55 @@
1
+ import { default as React } from 'react';
2
+ import { Bounds } from '@sheetxl/utils';
3
+ import { IPivotTable } from '@sheetxl/sdk';
4
+ /**
5
+ * The pivot table button configuration.
6
+ *
7
+ * @remarks
8
+ * Rides the shared `propsCellRender` channel, as the column buttons' does. Consumed by the pivot
9
+ * layer (`PivotLayer`), not the text cell renderer.
10
+ */
11
+ export interface PivotButtonConfigProps {
12
+ /**
13
+ * Callback for when a pivot table's field dropdown has been pressed.
14
+ *
15
+ * @param event - The mouse event (its `currentTarget` anchors the menu)
16
+ * @param fields - The fields the button is for: one, or a compact header's row or column fields
17
+ */
18
+ onPivotButtonMouseDown?: (event: React.MouseEvent<HTMLDivElement, MouseEvent>, fields: readonly IPivotTable.IField[]) => void;
19
+ }
20
+ /**
21
+ * Props for {@link PivotDropdownButton}.
22
+ */
23
+ export interface PivotDropdownButtonProps extends React.HTMLAttributes<HTMLElement> {
24
+ /** The cell's box the button pins itself into. */
25
+ bounds: Bounds;
26
+ zoom: number;
27
+ disabled: boolean;
28
+ /** The fields the button is for. */
29
+ fields: readonly IPivotTable.IField[];
30
+ onPivotButtonMouseDown?: PivotButtonConfigProps['onPivotButtonMouseDown'];
31
+ }
32
+ /**
33
+ * A pivot table field's dropdown: the column button's look, filtered while a field it is for shows
34
+ * less than all of its items.
35
+ */
36
+ export declare const PivotDropdownButton: (props: PivotDropdownButtonProps) => React.ReactElement;
37
+ /**
38
+ * Props for {@link PivotToggleButton}.
39
+ */
40
+ export interface PivotToggleButtonProps {
41
+ /** Whether the item's details show: the button collapses them. */
42
+ expanded: boolean;
43
+ /** The edge of the square, in pixels. */
44
+ size: number;
45
+ disabled?: boolean;
46
+ /** A localized description of what a press does. */
47
+ title?: string;
48
+ onToggle: () => void;
49
+ style?: React.CSSProperties;
50
+ }
51
+ /**
52
+ * A pivot table item's expand/collapse box: a square with a `+` or a `−`, as the outline's.
53
+ */
54
+ export declare const PivotToggleButton: (props: PivotToggleButtonProps) => React.ReactElement;
55
+ //# sourceMappingURL=PivotButton.d.ts.map
@@ -36,7 +36,7 @@ export interface SheetHeaderRendererProps extends CellRendererProps {
36
36
  *
37
37
  * @returns A React Element representing the ColumnButton.
38
38
  */
39
- renderColumnButton?: (props: ColumnButtonProps) => React.ReactElement;
39
+ renderColumnButton?: (props: ColumnButtonProps) => React.ReactNode;
40
40
  }
41
41
  export declare const SheetHeaderRenderer: React.MemoExoticComponent<(props: SheetHeaderRendererProps) => React.JSX.Element>;
42
42
  //# sourceMappingURL=SheetHeaderRenderer.d.ts.map
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { IStyle, ICell } from '@sheetxl/sdk';
2
+ import { ICellStyle, ICell } from '@sheetxl/sdk';
3
3
  import { StaticBorderRendererProps } from '../border';
4
4
  export interface StaticCellRendererProps extends React.HTMLAttributes<HTMLDivElement> {
5
5
  /**
@@ -9,7 +9,7 @@ export interface StaticCellRendererProps extends React.HTMLAttributes<HTMLDivEle
9
9
  /**
10
10
  * The style to preview, applied on top of the cell {@link createCell} mints.
11
11
  */
12
- cellStyle?: IStyle.Update;
12
+ cellStyle?: ICellStyle.Update;
13
13
  /**
14
14
  * Mints the cell that backs the preview — a workbook-attached factory, so theme colors, named
15
15
  * styles and the number format resolve exactly as they would in the grid.
@@ -46,7 +46,7 @@ export interface StaticCellRendererProps extends React.HTMLAttributes<HTMLDivEle
46
46
  *
47
47
  * @remarks
48
48
  * This is a PREVIEW, not the grid renderer: one cell, no measurement, no editing, no overflow into
49
- * neighbors. It reads fill / font / border / alignment off an `IStyle` and paints them directly, so
49
+ * neighbors. It reads fill / font / border / alignment off an `ICellStyle` and paints them directly, so
50
50
  * it stays truthful to the workbook's theme without paying for a grid.
51
51
  *
52
52
  * It adopts the GRID surface (`data-sxl-theme-surface="grid"`) and the grid's light/dark mode even
@@ -0,0 +1,29 @@
1
+ import { default as React } from 'react';
2
+ import { Bounds } from '@sheetxl/utils';
3
+ export declare const PATH_CLEAR = "M 7.4530672,10.134098 2.6725085,5.2978998 3.370275,4.5911648 7.4530672,8.7264777 11.530095,4.5911648 l 0.697764,0.706735M 7.4529247,10.134098 2.9086709,5.2978998 3.5719465,4.5911648 7.4529247,8.7264777 11.328423,4.5911648 l 0.663274,0.70673";
4
+ export declare const PATH_FILTERED = "m 9.429858,10.25386 2,-1 v -3 l 3,-4 h -8 l 3,4 z M 0.75000004,9.15 4.3000002,13.094444 7.8500003,9.15 Z";
5
+ export declare const PATH_SORT_ASC = "m 13.109228,9.865914 h -1.607622 v -7.37612 h -1.071748 v 7.37612 H 8.822236 l 2.143496,2.950446 z M 0.75000004,9.15 4.3000002,13.094444 7.8500003,9.15 Z";
6
+ export declare const PATH_SORT_DES = "m 13.109228,5.44024 h -1.607622 v 7.37612 H 10.429858 V 5.44024 H 8.822236 L 10.965732,2.489794 Z M 0.75000004,9.15 4.3000002,13.094444 7.8500003,9.15 Z";
7
+ export declare const PATH_FILTER_SORT_DES = "m 9.429858,10.25386 2,-1 v -3 l 3,-4 h -8 l 3,4 z M 5.849492,5.0266248 H 4.24187 V 12.402744 H 3.170122 V 5.0266248 H 1.5625 l 2.143496,-2.950446 z";
8
+ export declare const PATH_FILTER_SORT_ASC = "m 9.429858,10.25386 2,-1 v -3 l 3,-4 h -8 l 3,4 z M 5.849492,9.452298 H 4.24187 V 2.0761788 H 3.170122 V 9.452298 H 1.5625 l 2.143496,2.950446 z";
9
+ /**
10
+ * Props for {@link DropdownFace}.
11
+ * @internal
12
+ */
13
+ export interface DropdownFaceProps extends React.HTMLAttributes<HTMLDivElement> {
14
+ /** The cell's box the button pins itself into. */
15
+ bounds: Bounds;
16
+ zoom: number;
17
+ disabled: boolean;
18
+ /** The glyph, in a 15x15 viewport. */
19
+ path: string;
20
+ /** A press; the grid never sees it, so the selection does not move. */
21
+ onPress?: (event: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;
22
+ }
23
+ /**
24
+ * The box and glyph of a cell's dropdown button - a table column's, a pivot field's - pinned to
25
+ * the cell's right edge.
26
+ * @internal
27
+ */
28
+ export declare const DropdownFace: (props: DropdownFaceProps) => React.ReactElement;
29
+ //# sourceMappingURL=_DropdownFace.d.ts.map
@@ -1,9 +1,16 @@
1
- export * from './SheetCellRenderer';
1
+ export * from './CellTextRenderer';
2
+ export { registerCellControl, registerRichData, getCellContent, getCellControlEntry, addCellContentListener, type CellContentEntry, type CellContentRenderer, type CellContentRendererProps, type CellInteractiveProps, type CellPressEvent, type CellKeyTarget, type CellControlPaneProps, type DefaultCellContentProps, type ResolvedCellContent } from './CellRenderers';
3
+ export * from './CellControlContext';
4
+ export * from './CellContent';
5
+ export * from './CellCheckboxRenderer';
6
+ export * from './CellImageRenderer';
7
+ export * from './useInsertableCellControls';
2
8
  export * from './StaticCellRenderer';
3
- export * from './FormulaCellRenderer';
9
+ export * from './CellFormulaRenderer';
4
10
  export * from './useFormulaViewAnchor';
5
11
  export * from './SheetHeaderRenderer';
6
12
  export * from './ColumnButton';
13
+ export * from './PivotButton';
7
14
  export * from './OutlineButton';
8
15
  export * from './CornerTriangle';
9
16
  //# sourceMappingURL=index.d.ts.map
@@ -1,5 +1,5 @@
1
1
  import { RangeCoords } from '@sheetxl/utils';
2
- import { ICalculation, ICell, ISheet } from '@sheetxl/sdk';
2
+ import { ICalculation, ICell, IWorksheet } from '@sheetxl/sdk';
3
3
  /**
4
4
  * The formula-view anchor: the selection anchor's formula, tokenized, when the view is showing
5
5
  * formulas. `null` whenever there is nothing to spotlight (not in formula view, anchor isn't a
@@ -28,7 +28,7 @@ export interface FormulaViewAnchor {
28
28
  * The shared **formula-view spotlight** source: while `sheetView.isShowFormulas()` is on, tracks the
29
29
  * sheet's selection anchor and — when it sits on a formula cell — returns that formula's tokens and
30
30
  * scoped reference ranges. Consumed by `SheetCellLayer` (suppress the anchor's plain tile text +
31
- * overlay the colored `FormulaCellRenderer`) and `SheetReferenceLayer` (outline the references via
31
+ * overlay the colored `CellFormulaRenderer`) and `SheetReferenceLayer` (outline the references via
32
32
  * the ranges picker), so the two always agree on what is spotlighted — and colors line up, both
33
33
  * keying off `referenceIndex`.
34
34
  *
@@ -38,5 +38,5 @@ export interface FormulaViewAnchor {
38
38
  * (scroll) never re-tokenize; `token` lets a caller bust it when cell CONTENT changed (e.g. the
39
39
  * cells layer's visible-range cache token).
40
40
  */
41
- export declare const useFormulaViewAnchor: (sheet: ISheet, showFormulas: boolean, token?: unknown) => FormulaViewAnchor | null;
41
+ export declare const useFormulaViewAnchor: (sheet: IWorksheet, showFormulas: boolean, token?: unknown) => FormulaViewAnchor | null;
42
42
  //# sourceMappingURL=useFormulaViewAnchor.d.ts.map
@@ -0,0 +1,25 @@
1
+ import { default as React } from 'react';
2
+ /** A type of cell content that a UI can offer to insert: a cell control or a rich data value. */
3
+ export interface InsertableCellControl {
4
+ /** The control type or the rich data type, as registered in the SDK. */
5
+ type: string;
6
+ /**
7
+ * What inserting it does: `'control'` puts the control on the cells and keeps their values;
8
+ * `'richData'` writes the kind's default value into them.
9
+ */
10
+ family: 'control' | 'richData';
11
+ /** The sdk kind's `label`, or the type when the kind has none. */
12
+ label: string;
13
+ /** The entry's `icon`, or `null`. */
14
+ icon: string | React.ReactElement | null;
15
+ }
16
+ /**
17
+ * The cell content types that can be inserted: cell control types and rich data types registered
18
+ * in the SDK whose UI entry draws them, built-ins included.
19
+ *
20
+ * @remarks
21
+ * Follows {@link registerCellControl} and {@link registerRichData} live. The SDK registries have no
22
+ * change signal, so register a type's sdk kind before its UI entry.
23
+ */
24
+ export declare function useInsertableCellControls(): readonly InsertableCellControl[];
25
+ //# sourceMappingURL=useInsertableCellControls.d.ts.map
@@ -0,0 +1,15 @@
1
+ import { Command } from '@sheetxl/utils-react';
2
+ import { MovableKindCommandData } from '../movable';
3
+ /**
4
+ * The chart kind's commands, for the active chart. Chrome is the `chart` catalog.
5
+ *
6
+ * Excel's Chart Design tab, as far as the model goes: `chartChangeType` takes what the Insert Chart
7
+ * gallery states (a descriptor, or a type name) and draws every series as that type; `chartSwitchRowColumn`
8
+ * plots the other way; `chartSelectData` takes an address, or asks for one, and plots those cells;
9
+ * `chartAddElement` takes an element by VBA's name (`legendTop`), and the toggles are the Add Chart
10
+ * Element checkboxes, each with the element's state. Quick layouts, chart styles and colors wait on
11
+ * the style parts. Each setter is one step to undo on its own; the middleware
12
+ * reports an error and arms repeat.
13
+ */
14
+ export declare const contributeChartCommands: Command.DynamicCommandContributor<MovableKindCommandData>;
15
+ //# sourceMappingURL=ChartCommands.d.ts.map
@@ -1,17 +1,27 @@
1
1
  import { default as React } from 'react';
2
2
  import { IChart } from '@sheetxl/sdk';
3
3
  import { MovableElementProps } from '../movable';
4
+ import { IChartElement } from './ChartElement';
5
+ export { ChartElement, nextSelected, type ChartElementProps, type ChartElementAttributes, type ChartElementPress, type IChartElement } from './ChartElement';
4
6
  export interface ChartEditorAttributes {
5
7
  isChartEditor: () => true;
6
8
  }
7
- export interface IChartEditorElement extends HTMLDivElement, ChartEditorAttributes {
9
+ export interface IChartEditorElement extends IChartElement, ChartEditorAttributes {
8
10
  }
9
11
  export interface ChartEditorProps extends MovableElementProps {
10
12
  chart: IChart;
11
13
  ref?: React.Ref<IChartEditorElement>;
12
14
  }
13
15
  /**
14
- * Placeholder for chart editors.
16
+ * Paints a chart in its movable's frame: a {@link ChartElement} that takes the frame's zoom and
17
+ * shows the frame's states (disabled, dragging).
18
+ *
19
+ * @remarks
20
+ * The chart is drawn in the grid's color scheme, as the cells about it are.
21
+ *
22
+ * A press inside the chart selects what is under the pointer in the sheet view's chart element
23
+ * selection, Excel's way (the series first, its point next), and is the element's: the frame
24
+ * drags the chart from its chart area alone, as Excel does.
15
25
  */
16
26
  export declare const ChartEditor: React.NamedExoticComponent<Omit<ChartEditorProps, "ref"> & React.RefAttributes<IChartEditorElement>>;
17
27
  //# sourceMappingURL=ChartEditor.d.ts.map
@@ -0,0 +1,122 @@
1
+ import { default as React } from 'react';
2
+ import { IChart, IChartElementSelection } from '@sheetxl/sdk';
3
+ import { Point } from '@sheetxl/utils';
4
+ import { ThemeMode } from '@sheetxl/utils-react';
5
+ export interface ChartElementAttributes {
6
+ isChartElement: () => true;
7
+ /** The chart drawn; `null` until a `Promise` input resolves. */
8
+ getChart: () => IChart | null;
9
+ /**
10
+ * The chart as an SVG document of the element's unzoomed size; `null` while the chart has no
11
+ * layout or the element no size. It is drawn light, a chart area with no fill of its own white,
12
+ * unless `darkMode`.
13
+ */
14
+ toSVG: (options?: {
15
+ darkMode?: boolean;
16
+ }) => Promise<string | null>;
17
+ /**
18
+ * The chart element drawn under a point of the page (`clientX`, `clientY`), as the chart is
19
+ * painted now; `null` outside the chart, or before it is painted.
20
+ */
21
+ getElementAt: (clientX: number, clientY: number) => IChart.IElement | null;
22
+ }
23
+ export interface IChartElement extends HTMLDivElement, ChartElementAttributes {
24
+ }
25
+ /** A press on the chart, as {@link ChartElementProps.onElementPress} reports it. */
26
+ export interface ChartElementPress {
27
+ /** The element under the pointer; `null` outside the chart. The chart area is the chart itself. */
28
+ element: IChart.IElement | null;
29
+ /** Where, in px from the chart's top-left, unzoomed. */
30
+ point: Point;
31
+ event: React.PointerEvent<HTMLDivElement>;
32
+ }
33
+ export interface ChartElementProps extends React.HTMLAttributes<HTMLDivElement> {
34
+ /**
35
+ * The chart to draw: one in a workbook, or one made outside it with `createChart`, or a
36
+ * `Promise` for either. A promise draws nothing until it resolves and shows the error if it
37
+ * rejects; while a later promise resolves, the chart already drawn is kept.
38
+ *
39
+ * This can be accessed (once resolved) via the element ref.
40
+ */
41
+ chart: IChart | Promise<IChart>;
42
+ /**
43
+ * Called with the chart once {@link ChartElementProps.chart} resolves, and again whenever a new
44
+ * input resolves to a different one. Until the first input resolves, or if an input fails, the
45
+ * chart is `null`.
46
+ *
47
+ * @remarks
48
+ * Lets an app pass a `Promise` here and hold the live chart in its own state, without awaiting
49
+ * or suspending.
50
+ *
51
+ * @example
52
+ * ```tsx
53
+ * const [pending] = useState(() => sheet.getCharts().add('A1:D5', { type: 'line' }));
54
+ * const [chart, setChart] = useState<IChart | null>(null);
55
+ * return <ChartElement chart={pending} onChartChange={setChart} />;
56
+ * ```
57
+ */
58
+ onChartChange?: (chart: IChart | null) => void;
59
+ /**
60
+ * The scale the chart is drawn at, where `1` is unscaled: the element's box is measured at the
61
+ * scale and the chart laid out at the unscaled size.
62
+ * @defaultValue 1
63
+ */
64
+ zoom?: number;
65
+ /**
66
+ * The element's width, as `style.width`; by default the element fills its parent. A number is
67
+ * taken as the box's width without waiting to measure it.
68
+ */
69
+ width?: number | string;
70
+ /** The element's height, as `style.height`; a number as the box's height. */
71
+ height?: number | string;
72
+ /**
73
+ * The selection a press inside the chart changes, and whose selected elements are outlined: the
74
+ * sheet view's (`getChartElementSelection`) for a chart on a sheet, or one made for the chart
75
+ * (`new ChartElementSelection({ chart })`). Without one, a press selects nothing.
76
+ *
77
+ * @remarks
78
+ * As in Excel, the first press on a series selects the series and the next one its point; on
79
+ * the legend, the legend and then its entry; on a series' labels, all of them and then the one.
80
+ * A press on the chart area empties the selection: the chart is then what is selected.
81
+ */
82
+ selection?: IChartElementSelection | null;
83
+ /**
84
+ * Whether the chart is drawn light or dark. Dark, its colors are drawn as a dark grid draws its
85
+ * cells. A chart area with no fill of its own is the surface's background
86
+ * (`--sxl-color-base-100`) in either mode.
87
+ * @defaultValue the app's scheme (`useAppColorScheme`); a chart on a sheet is drawn in the grid's
88
+ */
89
+ colorScheme?: ThemeMode;
90
+ /**
91
+ * Called on a press inside the chart with what is under the pointer, before the selection (if
92
+ * any) changes.
93
+ */
94
+ onElementPress?: (press: ChartElementPress) => void;
95
+ ref?: React.Ref<IChartElement>;
96
+ }
97
+ /**
98
+ * The element a press selects, given what is under the pointer and what is selected: Excel's two
99
+ * steps, the whole first and the part of it on the next press.
100
+ */
101
+ export declare const nextSelected: (hit: IChart.IElement, active: IChart.IElement | null) => IChart.IElement;
102
+ /**
103
+ * Draws a chart, anywhere: a `div` the chart fills.
104
+ *
105
+ * @remarks
106
+ * The chart is laid out at the box's unzoomed px (`IChart.getLayout`) and painted as laid out,
107
+ * so the same chart in two elements is drawn twice, each at its own size. It is laid out again
108
+ * when the box is resized and whenever the chart says its layout may have changed
109
+ * (`onLayoutChange`: an edit, a cell it plots, a font arriving). The painter is loaded on the
110
+ * first mount through `ChartPaint`; a chart with no model (a `cx:` chart) draws nothing.
111
+ *
112
+ * Nothing of a sheet or a movable is needed: `ChartEditor` is this element inside a movable's
113
+ * frame, and a chart made with `createChart` draws from its own JSON. The chart may be given as a
114
+ * `Promise` (the one `getCharts().add` answers, say); `onChartChange` hands the app the chart
115
+ * once it is there.
116
+ *
117
+ * A press inside the chart is hit-tested against the layout painted (`IChart.getElementAt`), and
118
+ * with a {@link ChartElementProps.selection} selects what is pressed, Excel's way; the selected
119
+ * elements are outlined over the chart.
120
+ */
121
+ export declare const ChartElement: React.NamedExoticComponent<Omit<ChartElementProps, "ref"> & React.RefAttributes<IChartElement>>;
122
+ //# sourceMappingURL=ChartElement.d.ts.map