@sheetxl/react 0.7.21 → 0.7.23-beta.1

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 (456) hide show
  1. package/browser/cjs/Bo9Kx3L_XQkGPBJ5.cjs +1 -0
  2. package/browser/cjs/Pl04-kDEQSO8_qFU.cjs +156 -0
  3. package/browser/cjs/index.cjs +24 -24
  4. package/browser/esm/E9rKWgbrtweBguqR.mjs +6286 -0
  5. package/browser/esm/index.mjs +19252 -4914
  6. package/licenses/dependencies.txt +42 -214
  7. package/node/esm/CmChqiPvaotX5mCV.mjs +9 -0
  8. package/node/esm/index.mjs +17028 -3694
  9. package/package.json +10 -11
  10. package/resources/contents.json +60 -0
  11. package/resources/locales/contents.json +114 -0
  12. package/resources/locales/de/clipboard.cmd.json +36 -0
  13. package/resources/locales/de/editor.cmd.json +128 -0
  14. package/resources/locales/de/movable.cmd.json +123 -0
  15. package/resources/locales/de/selection.cmd.json +373 -0
  16. package/resources/locales/de/sheet.cmd.json +1563 -0
  17. package/resources/locales/de/table.cmd.json +83 -0
  18. package/resources/locales/de/ui.msg.json +166 -0
  19. package/resources/locales/de/workbook.cmd.json +282 -0
  20. package/resources/locales/en/clipboard.cmd.json +36 -0
  21. package/resources/locales/en/editor.cmd.json +128 -0
  22. package/resources/locales/en/movable.cmd.json +123 -0
  23. package/resources/locales/en/selection.cmd.json +373 -0
  24. package/resources/locales/en/sheet.cmd.json +1563 -0
  25. package/resources/locales/en/table.cmd.json +83 -0
  26. package/resources/locales/en/ui.msg.json +166 -0
  27. package/resources/locales/en/workbook.cmd.json +282 -0
  28. package/types/index.d.ts +2 -1815
  29. package/types/src/border/StaticBorderRenderer.d.ts +32 -0
  30. package/types/src/border/StaticBorderRenderer.d.ts.map +1 -0
  31. package/types/src/border/StyledStrokePath.d.ts +14 -0
  32. package/types/src/border/StyledStrokePath.d.ts.map +1 -0
  33. package/types/src/border/index.d.ts +4 -0
  34. package/types/src/border/index.d.ts.map +1 -0
  35. package/types/src/border/useBorders.d.ts +87 -0
  36. package/types/src/border/useBorders.d.ts.map +1 -0
  37. package/types/src/cell/ColumnButton.d.ts +45 -0
  38. package/types/src/cell/ColumnButton.d.ts.map +1 -0
  39. package/types/src/cell/CornerTriangle.d.ts +27 -0
  40. package/types/src/cell/CornerTriangle.d.ts.map +1 -0
  41. package/types/src/cell/FormulaCellRenderer.d.ts +34 -0
  42. package/types/src/cell/FormulaCellRenderer.d.ts.map +1 -0
  43. package/types/src/cell/SheetCellRenderer.d.ts +52 -0
  44. package/types/src/cell/SheetCellRenderer.d.ts.map +1 -0
  45. package/types/src/cell/SheetHeaderRenderer.d.ts +37 -0
  46. package/types/src/cell/SheetHeaderRenderer.d.ts.map +1 -0
  47. package/types/src/cell/index.d.ts +7 -0
  48. package/types/src/cell/index.d.ts.map +1 -0
  49. package/types/src/cell/useFormulaViewAnchor.d.ts +42 -0
  50. package/types/src/cell/useFormulaViewAnchor.d.ts.map +1 -0
  51. package/types/src/chart/ChartEditor.d.ts +17 -0
  52. package/types/src/chart/ChartEditor.d.ts.map +1 -0
  53. package/types/src/chart/PresetChartTypeDescriptors.d.ts +35 -0
  54. package/types/src/chart/PresetChartTypeDescriptors.d.ts.map +1 -0
  55. package/types/src/chart/index.d.ts +3 -0
  56. package/types/src/chart/index.d.ts.map +1 -0
  57. package/types/src/chart/templates/area-stacked-percent-template.json.d.ts +10 -0
  58. package/types/src/chart/templates/area-stacked-template.json.d.ts +10 -0
  59. package/types/src/chart/templates/area-template.json.d.ts +9 -0
  60. package/types/src/chart/templates/bar-stacked-percent-template.json.d.ts +10 -0
  61. package/types/src/chart/templates/bar-stacked-template.json.d.ts +10 -0
  62. package/types/src/chart/templates/bar-template.json.d.ts +9 -0
  63. package/types/src/chart/templates/column-stacked-percent-template.json.d.ts +10 -0
  64. package/types/src/chart/templates/column-stacked-template.json.d.ts +10 -0
  65. package/types/src/chart/templates/column-template.json.d.ts +9 -0
  66. package/types/src/chart/templates/line-markers-template.json.d.ts +10 -0
  67. package/types/src/chart/templates/line-stacked-markers-template.json.d.ts +11 -0
  68. package/types/src/chart/templates/line-stacked-percent-markers-template.json.d.ts +11 -0
  69. package/types/src/chart/templates/line-stacked-percent-template.json.d.ts +10 -0
  70. package/types/src/chart/templates/line-stacked-template.json.d.ts +10 -0
  71. package/types/src/chart/templates/line-template.json.d.ts +9 -0
  72. package/types/src/chart/templates/pie-doughnut-template.json.d.ts +10 -0
  73. package/types/src/chart/templates/pie-template.json.d.ts +9 -0
  74. package/types/src/chart/templates/scatter-lines-markers-smooth-template.json.d.ts +10 -0
  75. package/types/src/chart/templates/scatter-lines-markers-template.json.d.ts +10 -0
  76. package/types/src/chart/templates/scatter-lines-smooth-template.json.d.ts +10 -0
  77. package/types/src/chart/templates/scatter-lines-template.json.d.ts +10 -0
  78. package/types/src/chart/templates/scatter-markers-template.json.d.ts +10 -0
  79. package/types/src/clipboard/ClipboardCommands.d.ts +68 -0
  80. package/types/src/clipboard/ClipboardCommands.d.ts.map +1 -0
  81. package/types/src/clipboard/SheetClipboardLayer.d.ts +22 -0
  82. package/types/src/clipboard/SheetClipboardLayer.d.ts.map +1 -0
  83. package/types/src/clipboard/index.d.ts +3 -0
  84. package/types/src/clipboard/index.d.ts.map +1 -0
  85. package/types/src/commands/Catalog.d.ts +8 -0
  86. package/types/src/commands/Catalog.d.ts.map +1 -0
  87. package/types/src/commands/CommandRootProvider.d.ts +36 -0
  88. package/types/src/commands/CommandRootProvider.d.ts.map +1 -0
  89. package/types/src/commands/InputClipboardCommands.d.ts +41 -0
  90. package/types/src/commands/InputClipboardCommands.d.ts.map +1 -0
  91. package/types/src/commands/InputClipboardInjector.d.ts +16 -0
  92. package/types/src/commands/InputClipboardInjector.d.ts.map +1 -0
  93. package/types/src/commands/MainFocusContext.d.ts +13 -0
  94. package/types/src/commands/MainFocusContext.d.ts.map +1 -0
  95. package/types/src/commands/PaneScopeProvider.d.ts +40 -0
  96. package/types/src/commands/PaneScopeProvider.d.ts.map +1 -0
  97. package/types/src/commands/createTransactionalMiddleware.d.ts +49 -0
  98. package/types/src/commands/createTransactionalMiddleware.d.ts.map +1 -0
  99. package/types/src/commands/index.d.ts +7 -0
  100. package/types/src/commands/index.d.ts.map +1 -0
  101. package/types/src/context/SheetContext.d.ts +18 -0
  102. package/types/src/context/SheetContext.d.ts.map +1 -0
  103. package/types/src/context/WorkbookContext.d.ts +20 -0
  104. package/types/src/context/WorkbookContext.d.ts.map +1 -0
  105. package/types/src/context/index.d.ts +3 -0
  106. package/types/src/context/index.d.ts.map +1 -0
  107. package/types/src/editableLabel/EditableLabel.d.ts +28 -0
  108. package/types/src/editableLabel/EditableLabel.d.ts.map +1 -0
  109. package/types/src/editableLabel/index.d.ts +2 -0
  110. package/types/src/editableLabel/index.d.ts.map +1 -0
  111. package/types/src/editor/EditorCommands.d.ts +98 -0
  112. package/types/src/editor/EditorCommands.d.ts.map +1 -0
  113. package/types/src/editor/FunctionPreviewPanel.d.ts +166 -0
  114. package/types/src/editor/FunctionPreviewPanel.d.ts.map +1 -0
  115. package/types/src/editor/NamedHintPanel.d.ts +38 -0
  116. package/types/src/editor/NamedHintPanel.d.ts.map +1 -0
  117. package/types/src/editor/NamedItemsPanel.d.ts +59 -0
  118. package/types/src/editor/NamedItemsPanel.d.ts.map +1 -0
  119. package/types/src/editor/SheetCellEditorLayer.d.ts +40 -0
  120. package/types/src/editor/SheetCellEditorLayer.d.ts.map +1 -0
  121. package/types/src/editor/SheetCellInput.d.ts +99 -0
  122. package/types/src/editor/SheetCellInput.d.ts.map +1 -0
  123. package/types/src/editor/SheetEditable.d.ts +53 -0
  124. package/types/src/editor/SheetEditable.d.ts.map +1 -0
  125. package/types/src/editor/SheetReferenceHeaderLayer.d.ts +46 -0
  126. package/types/src/editor/SheetReferenceHeaderLayer.d.ts.map +1 -0
  127. package/types/src/editor/SheetReferenceLayer.d.ts +55 -0
  128. package/types/src/editor/SheetReferenceLayer.d.ts.map +1 -0
  129. package/types/src/editor/formulaCaret.d.ts +84 -0
  130. package/types/src/editor/formulaCaret.d.ts.map +1 -0
  131. package/types/src/editor/formulaEval.d.ts +202 -0
  132. package/types/src/editor/formulaEval.d.ts.map +1 -0
  133. package/types/src/editor/formulaPresentation.d.ts +136 -0
  134. package/types/src/editor/formulaPresentation.d.ts.map +1 -0
  135. package/types/src/editor/formulaText.d.ts +80 -0
  136. package/types/src/editor/formulaText.d.ts.map +1 -0
  137. package/types/src/editor/functionArgs.d.ts +111 -0
  138. package/types/src/editor/functionArgs.d.ts.map +1 -0
  139. package/types/src/editor/functionHint.d.ts +37 -0
  140. package/types/src/editor/functionHint.d.ts.map +1 -0
  141. package/types/src/editor/index.d.ts +18 -0
  142. package/types/src/editor/index.d.ts.map +1 -0
  143. package/types/src/editor/referencePointNav.d.ts +39 -0
  144. package/types/src/editor/referencePointNav.d.ts.map +1 -0
  145. package/types/src/editor/useFormulaHints.d.ts +126 -0
  146. package/types/src/editor/useFormulaHints.d.ts.map +1 -0
  147. package/types/src/editor/useFormulaInput.d.ts +326 -0
  148. package/types/src/editor/useFormulaInput.d.ts.map +1 -0
  149. package/types/src/editor/useProtectedEditNotice.d.ts +14 -0
  150. package/types/src/editor/useProtectedEditNotice.d.ts.map +1 -0
  151. package/types/src/editor/useReferenceMode.d.ts +177 -0
  152. package/types/src/editor/useReferenceMode.d.ts.map +1 -0
  153. package/types/src/form/FormulaInput.d.ts +86 -0
  154. package/types/src/form/FormulaInput.d.ts.map +1 -0
  155. package/types/src/form/FormulaInputParts.d.ts +94 -0
  156. package/types/src/form/FormulaInputParts.d.ts.map +1 -0
  157. package/types/src/form/index.d.ts +5 -0
  158. package/types/src/form/index.d.ts.map +1 -0
  159. package/types/src/form/useEditCommit.d.ts +174 -0
  160. package/types/src/form/useEditCommit.d.ts.map +1 -0
  161. package/types/src/form/useInputField.d.ts +86 -0
  162. package/types/src/form/useInputField.d.ts.map +1 -0
  163. package/types/src/frame/CommandContext.d.ts +179 -0
  164. package/types/src/frame/CommandContext.d.ts.map +1 -0
  165. package/types/src/frame/IFrame.d.ts +17 -0
  166. package/types/src/frame/IFrame.d.ts.map +1 -0
  167. package/types/src/frame/index.d.ts +3 -0
  168. package/types/src/frame/index.d.ts.map +1 -0
  169. package/types/src/icons/LogoNoPaddingIcon.d.ts +3 -0
  170. package/types/src/icons/LogoNoPaddingIcon.d.ts.map +1 -0
  171. package/types/src/icons/LogoTextNoPaddingIcon.d.ts +4 -0
  172. package/types/src/icons/LogoTextNoPaddingIcon.d.ts.map +1 -0
  173. package/types/src/icons/WaterMark.d.ts +12 -0
  174. package/types/src/icons/WaterMark.d.ts.map +1 -0
  175. package/types/src/icons/chart/ChartAreaIcon.d.ts +5 -0
  176. package/types/src/icons/chart/ChartAreaIcon.d.ts.map +1 -0
  177. package/types/src/icons/chart/ChartAreaStackedIcon.d.ts +5 -0
  178. package/types/src/icons/chart/ChartAreaStackedIcon.d.ts.map +1 -0
  179. package/types/src/icons/chart/ChartAreaStackedPercentIcon.d.ts +5 -0
  180. package/types/src/icons/chart/ChartAreaStackedPercentIcon.d.ts.map +1 -0
  181. package/types/src/icons/chart/ChartBarIcon.d.ts +5 -0
  182. package/types/src/icons/chart/ChartBarIcon.d.ts.map +1 -0
  183. package/types/src/icons/chart/ChartBarStackedIcon.d.ts +5 -0
  184. package/types/src/icons/chart/ChartBarStackedIcon.d.ts.map +1 -0
  185. package/types/src/icons/chart/ChartBarStackedPercentIcon.d.ts +5 -0
  186. package/types/src/icons/chart/ChartBarStackedPercentIcon.d.ts.map +1 -0
  187. package/types/src/icons/chart/ChartBubble3DIcon.d.ts +5 -0
  188. package/types/src/icons/chart/ChartBubble3DIcon.d.ts.map +1 -0
  189. package/types/src/icons/chart/ChartBubbleIcon.d.ts +5 -0
  190. package/types/src/icons/chart/ChartBubbleIcon.d.ts.map +1 -0
  191. package/types/src/icons/chart/ChartColumnIcon.d.ts +5 -0
  192. package/types/src/icons/chart/ChartColumnIcon.d.ts.map +1 -0
  193. package/types/src/icons/chart/ChartColumnStackedIcon.d.ts +5 -0
  194. package/types/src/icons/chart/ChartColumnStackedIcon.d.ts.map +1 -0
  195. package/types/src/icons/chart/ChartColumnStackedPercentIcon.d.ts +5 -0
  196. package/types/src/icons/chart/ChartColumnStackedPercentIcon.d.ts.map +1 -0
  197. package/types/src/icons/chart/ChartLineIcon.d.ts +5 -0
  198. package/types/src/icons/chart/ChartLineIcon.d.ts.map +1 -0
  199. package/types/src/icons/chart/ChartLineMarkersIcon.d.ts +5 -0
  200. package/types/src/icons/chart/ChartLineMarkersIcon.d.ts.map +1 -0
  201. package/types/src/icons/chart/ChartLineStackedIcon.d.ts +5 -0
  202. package/types/src/icons/chart/ChartLineStackedIcon.d.ts.map +1 -0
  203. package/types/src/icons/chart/ChartLineStackedMarkersIcon.d.ts +5 -0
  204. package/types/src/icons/chart/ChartLineStackedMarkersIcon.d.ts.map +1 -0
  205. package/types/src/icons/chart/ChartLineStackedPercentIcon.d.ts +5 -0
  206. package/types/src/icons/chart/ChartLineStackedPercentIcon.d.ts.map +1 -0
  207. package/types/src/icons/chart/ChartLineStackedPercentMarkersIcon.d.ts +5 -0
  208. package/types/src/icons/chart/ChartLineStackedPercentMarkersIcon.d.ts.map +1 -0
  209. package/types/src/icons/chart/ChartPieDoughnutIcon.d.ts +5 -0
  210. package/types/src/icons/chart/ChartPieDoughnutIcon.d.ts.map +1 -0
  211. package/types/src/icons/chart/ChartPieIcon.d.ts +5 -0
  212. package/types/src/icons/chart/ChartPieIcon.d.ts.map +1 -0
  213. package/types/src/icons/chart/ChartScatterLinesIcon.d.ts +5 -0
  214. package/types/src/icons/chart/ChartScatterLinesIcon.d.ts.map +1 -0
  215. package/types/src/icons/chart/ChartScatterLinesMarkersIcon.d.ts +5 -0
  216. package/types/src/icons/chart/ChartScatterLinesMarkersIcon.d.ts.map +1 -0
  217. package/types/src/icons/chart/ChartScatterLinesMarkersSmoothIcon.d.ts +5 -0
  218. package/types/src/icons/chart/ChartScatterLinesMarkersSmoothIcon.d.ts.map +1 -0
  219. package/types/src/icons/chart/ChartScatterLinesSmoothIcon.d.ts +5 -0
  220. package/types/src/icons/chart/ChartScatterLinesSmoothIcon.d.ts.map +1 -0
  221. package/types/src/icons/chart/ChartScatterMarkersIcon.d.ts +5 -0
  222. package/types/src/icons/chart/ChartScatterMarkersIcon.d.ts.map +1 -0
  223. package/types/src/icons/chart/ChartWaterfallIcon.d.ts +5 -0
  224. package/types/src/icons/chart/ChartWaterfallIcon.d.ts.map +1 -0
  225. package/types/src/icons/chart/ThemedChartIcon.d.ts +20 -0
  226. package/types/src/icons/chart/ThemedChartIcon.d.ts.map +1 -0
  227. package/types/src/icons/chart/index.d.ts +50 -0
  228. package/types/src/icons/chart/index.d.ts.map +1 -0
  229. package/types/src/icons/index.d.ts +4 -0
  230. package/types/src/icons/index.d.ts.map +1 -0
  231. package/types/src/index.d.ts +27 -0
  232. package/types/src/index.d.ts.map +1 -0
  233. package/types/src/io/WorkbookIO.d.ts +50 -0
  234. package/types/src/io/WorkbookIO.d.ts.map +1 -0
  235. package/types/src/io/index.d.ts +2 -0
  236. package/types/src/io/index.d.ts.map +1 -0
  237. package/types/src/layer/BorderLayer.d.ts +14 -0
  238. package/types/src/layer/BorderLayer.d.ts.map +1 -0
  239. package/types/src/layer/CellErrorLayer.d.ts +49 -0
  240. package/types/src/layer/CellErrorLayer.d.ts.map +1 -0
  241. package/types/src/layer/CellFillLayer.d.ts +15 -0
  242. package/types/src/layer/CellFillLayer.d.ts.map +1 -0
  243. package/types/src/layer/ConditionalBarLayer.d.ts +41 -0
  244. package/types/src/layer/ConditionalBarLayer.d.ts.map +1 -0
  245. package/types/src/layer/ConditionalIcons.d.ts +34 -0
  246. package/types/src/layer/ConditionalIcons.d.ts.map +1 -0
  247. package/types/src/layer/ConditionalIconsLayer.d.ts +31 -0
  248. package/types/src/layer/ConditionalIconsLayer.d.ts.map +1 -0
  249. package/types/src/layer/ContextMenuLayer.d.ts +27 -0
  250. package/types/src/layer/ContextMenuLayer.d.ts.map +1 -0
  251. package/types/src/layer/HeaderResizerLayer.d.ts +28 -0
  252. package/types/src/layer/HeaderResizerLayer.d.ts.map +1 -0
  253. package/types/src/layer/HeaderSelectionLayer.d.ts +89 -0
  254. package/types/src/layer/HeaderSelectionLayer.d.ts.map +1 -0
  255. package/types/src/layer/ResizeIndicator.d.ts +19 -0
  256. package/types/src/layer/ResizeIndicator.d.ts.map +1 -0
  257. package/types/src/layer/SheetBackgroundLayer.d.ts +22 -0
  258. package/types/src/layer/SheetBackgroundLayer.d.ts.map +1 -0
  259. package/types/src/layer/SheetCellLayer.d.ts +49 -0
  260. package/types/src/layer/SheetCellLayer.d.ts.map +1 -0
  261. package/types/src/layer/SheetColumnButtonLayer.d.ts +23 -0
  262. package/types/src/layer/SheetColumnButtonLayer.d.ts.map +1 -0
  263. package/types/src/layer/SheetGridLineLayer.d.ts +22 -0
  264. package/types/src/layer/SheetGridLineLayer.d.ts.map +1 -0
  265. package/types/src/layer/SheetHeaderCellLayer.d.ts +30 -0
  266. package/types/src/layer/SheetHeaderCellLayer.d.ts.map +1 -0
  267. package/types/src/layer/SheetMovableLayer.d.ts +26 -0
  268. package/types/src/layer/SheetMovableLayer.d.ts.map +1 -0
  269. package/types/src/layer/SheetTableCommandLayer.d.ts +16 -0
  270. package/types/src/layer/SheetTableCommandLayer.d.ts.map +1 -0
  271. package/types/src/layer/SpillLayer.d.ts +22 -0
  272. package/types/src/layer/SpillLayer.d.ts.map +1 -0
  273. package/types/src/layer/TableLayer.d.ts +22 -0
  274. package/types/src/layer/TableLayer.d.ts.map +1 -0
  275. package/types/src/layer/ValidationIndicatorLayer.d.ts +41 -0
  276. package/types/src/layer/ValidationIndicatorLayer.d.ts.map +1 -0
  277. package/types/src/layer/index.d.ts +25 -0
  278. package/types/src/layer/index.d.ts.map +1 -0
  279. package/types/src/layer/resizeIndicatorState.d.ts +26 -0
  280. package/types/src/layer/resizeIndicatorState.d.ts.map +1 -0
  281. package/types/src/layer/useSheetFeatureRegions.d.ts +21 -0
  282. package/types/src/layer/useSheetFeatureRegions.d.ts.map +1 -0
  283. package/types/src/layer/useSheetVisibleCells.d.ts +60 -0
  284. package/types/src/layer/useSheetVisibleCells.d.ts.map +1 -0
  285. package/types/src/layer/useSheetVisibleDecorations.d.ts +42 -0
  286. package/types/src/layer/useSheetVisibleDecorations.d.ts.map +1 -0
  287. package/types/src/layer/useTableHeaderCells.d.ts +22 -0
  288. package/types/src/layer/useTableHeaderCells.d.ts.map +1 -0
  289. package/types/src/layer/useVisibleTables.d.ts +27 -0
  290. package/types/src/layer/useVisibleTables.d.ts.map +1 -0
  291. package/types/src/listener/index.d.ts +3 -0
  292. package/types/src/listener/index.d.ts.map +1 -0
  293. package/types/src/listener/useModelListener.d.ts +67 -0
  294. package/types/src/listener/useModelListener.d.ts.map +1 -0
  295. package/types/src/listener/useRangeListener.d.ts +15 -0
  296. package/types/src/listener/useRangeListener.d.ts.map +1 -0
  297. package/types/src/movable/EmptyFrame.d.ts +16 -0
  298. package/types/src/movable/EmptyFrame.d.ts.map +1 -0
  299. package/types/src/movable/IMovableArea.d.ts +34 -0
  300. package/types/src/movable/IMovableArea.d.ts.map +1 -0
  301. package/types/src/movable/MovableCommands.d.ts +22 -0
  302. package/types/src/movable/MovableCommands.d.ts.map +1 -0
  303. package/types/src/movable/MovableFrame.d.ts +48 -0
  304. package/types/src/movable/MovableFrame.d.ts.map +1 -0
  305. package/types/src/movable/MovableLayer.d.ts +77 -0
  306. package/types/src/movable/MovableLayer.d.ts.map +1 -0
  307. package/types/src/movable/MoveableBundle.d.ts +4 -0
  308. package/types/src/movable/MoveableBundle.d.ts.map +1 -0
  309. package/types/src/movable/index.d.ts +4 -0
  310. package/types/src/movable/index.d.ts.map +1 -0
  311. package/types/src/picture/IPictureEditor.d.ts +39 -0
  312. package/types/src/picture/IPictureEditor.d.ts.map +1 -0
  313. package/types/src/picture/PictureEditor.d.ts +4 -0
  314. package/types/src/picture/PictureEditor.d.ts.map +1 -0
  315. package/types/src/picture/index.d.ts +3 -0
  316. package/types/src/picture/index.d.ts.map +1 -0
  317. package/types/src/selection/SelectionCommands.d.ts +23 -0
  318. package/types/src/selection/SelectionCommands.d.ts.map +1 -0
  319. package/types/src/selection/SheetSelection.d.ts +53 -0
  320. package/types/src/selection/SheetSelection.d.ts.map +1 -0
  321. package/types/src/selection/SheetSelectionLayer.d.ts +30 -0
  322. package/types/src/selection/SheetSelectionLayer.d.ts.map +1 -0
  323. package/types/src/selection/index.d.ts +4 -0
  324. package/types/src/selection/index.d.ts.map +1 -0
  325. package/types/src/shape/ShapeEditor.d.ts +16 -0
  326. package/types/src/shape/ShapeEditor.d.ts.map +1 -0
  327. package/types/src/shape/index.d.ts +2 -0
  328. package/types/src/shape/index.d.ts.map +1 -0
  329. package/types/src/sheet/ConditionalFormatPresets.d.ts +56 -0
  330. package/types/src/sheet/ConditionalFormatPresets.d.ts.map +1 -0
  331. package/types/src/sheet/ISheetElement.d.ts +233 -0
  332. package/types/src/sheet/ISheetElement.d.ts.map +1 -0
  333. package/types/src/sheet/ISheetHeaderElement.d.ts +138 -0
  334. package/types/src/sheet/ISheetHeaderElement.d.ts.map +1 -0
  335. package/types/src/sheet/NotImplemented.d.ts +3 -0
  336. package/types/src/sheet/NotImplemented.d.ts.map +1 -0
  337. package/types/src/sheet/SheetCommandProvider.d.ts +57 -0
  338. package/types/src/sheet/SheetCommandProvider.d.ts.map +1 -0
  339. package/types/src/sheet/SheetCommands.d.ts +75 -0
  340. package/types/src/sheet/SheetCommands.d.ts.map +1 -0
  341. package/types/src/sheet/SheetElement.d.ts +15 -0
  342. package/types/src/sheet/SheetElement.d.ts.map +1 -0
  343. package/types/src/sheet/SheetHeaderElement.d.ts +4 -0
  344. package/types/src/sheet/SheetHeaderElement.d.ts.map +1 -0
  345. package/types/src/sheet/SheetScrollbar.d.ts +28 -0
  346. package/types/src/sheet/SheetScrollbar.d.ts.map +1 -0
  347. package/types/src/sheet/TopLeftCorner.d.ts +17 -0
  348. package/types/src/sheet/TopLeftCorner.d.ts.map +1 -0
  349. package/types/src/sheet/index.d.ts +7 -0
  350. package/types/src/sheet/index.d.ts.map +1 -0
  351. package/types/src/slicer/SlicerEditor.d.ts +16 -0
  352. package/types/src/slicer/SlicerEditor.d.ts.map +1 -0
  353. package/types/src/slicer/index.d.ts +2 -0
  354. package/types/src/slicer/index.d.ts.map +1 -0
  355. package/types/src/tabStrip/SheetTab.d.ts +41 -0
  356. package/types/src/tabStrip/SheetTab.d.ts.map +1 -0
  357. package/types/src/tabStrip/Sortable.d.ts +66 -0
  358. package/types/src/tabStrip/Sortable.d.ts.map +1 -0
  359. package/types/src/tabStrip/Tab.d.ts +19 -0
  360. package/types/src/tabStrip/Tab.d.ts.map +1 -0
  361. package/types/src/tabStrip/TabStrip.d.ts +41 -0
  362. package/types/src/tabStrip/TabStrip.d.ts.map +1 -0
  363. package/types/src/tabStrip/TabStripItem.d.ts +36 -0
  364. package/types/src/tabStrip/TabStripItem.d.ts.map +1 -0
  365. package/types/src/tabStrip/TabStripRow.d.ts +9 -0
  366. package/types/src/tabStrip/TabStripRow.d.ts.map +1 -0
  367. package/types/src/tabStrip/index.d.ts +7 -0
  368. package/types/src/tabStrip/index.d.ts.map +1 -0
  369. package/types/src/table/TableCommands.d.ts +16 -0
  370. package/types/src/table/TableCommands.d.ts.map +1 -0
  371. package/types/src/taskPane/ITaskPane.d.ts +72 -0
  372. package/types/src/taskPane/ITaskPane.d.ts.map +1 -0
  373. package/types/src/taskPane/TaskPaneArea.d.ts +144 -0
  374. package/types/src/taskPane/TaskPaneArea.d.ts.map +1 -0
  375. package/types/src/taskPane/TaskPaneFrame.d.ts +48 -0
  376. package/types/src/taskPane/TaskPaneFrame.d.ts.map +1 -0
  377. package/types/src/taskPane/TaskPaneRegistry.d.ts +108 -0
  378. package/types/src/taskPane/TaskPaneRegistry.d.ts.map +1 -0
  379. package/types/src/taskPane/TaskPaneStrip.d.ts +33 -0
  380. package/types/src/taskPane/TaskPaneStrip.d.ts.map +1 -0
  381. package/types/src/taskPane/TaskPaneTitle.d.ts +24 -0
  382. package/types/src/taskPane/TaskPaneTitle.d.ts.map +1 -0
  383. package/types/src/taskPane/index.d.ts +7 -0
  384. package/types/src/taskPane/index.d.ts.map +1 -0
  385. package/types/src/taskPane/useTaskPane.d.ts +29 -0
  386. package/types/src/taskPane/useTaskPane.d.ts.map +1 -0
  387. package/types/src/theme/DocThemesContext.d.ts +3 -0
  388. package/types/src/theme/DocThemesContext.d.ts.map +1 -0
  389. package/types/src/theme/DocThemesProvider.d.ts +15 -0
  390. package/types/src/theme/DocThemesProvider.d.ts.map +1 -0
  391. package/types/src/theme/ThemeState.d.ts +19 -0
  392. package/types/src/theme/ThemeState.d.ts.map +1 -0
  393. package/types/src/theme/buildDocThemeCSS.d.ts +16 -0
  394. package/types/src/theme/buildDocThemeCSS.d.ts.map +1 -0
  395. package/types/src/theme/buildOOXMLThemeCSS.d.ts +13 -0
  396. package/types/src/theme/buildOOXMLThemeCSS.d.ts.map +1 -0
  397. package/types/src/theme/createCSSSystemLookup.d.ts +51 -0
  398. package/types/src/theme/createCSSSystemLookup.d.ts.map +1 -0
  399. package/types/src/theme/index.d.ts +11 -0
  400. package/types/src/theme/index.d.ts.map +1 -0
  401. package/types/src/theme/useAppColorScheme.d.ts +15 -0
  402. package/types/src/theme/useAppColorScheme.d.ts.map +1 -0
  403. package/types/src/theme/useDocThemes.d.ts +3 -0
  404. package/types/src/theme/useDocThemes.d.ts.map +1 -0
  405. package/types/src/theme/useGridColorScheme.d.ts +20 -0
  406. package/types/src/theme/useGridColorScheme.d.ts.map +1 -0
  407. package/types/src/theme/useSystemColors.d.ts +44 -0
  408. package/types/src/theme/useSystemColors.d.ts.map +1 -0
  409. package/types/src/undo/UndoCommands.d.ts +28 -0
  410. package/types/src/undo/UndoCommands.d.ts.map +1 -0
  411. package/types/src/undo/UndoManagerContext.d.ts +14 -0
  412. package/types/src/undo/UndoManagerContext.d.ts.map +1 -0
  413. package/types/src/undo/index.d.ts +3 -0
  414. package/types/src/undo/index.d.ts.map +1 -0
  415. package/types/src/workbook/DefaultRenderers.d.ts +14 -0
  416. package/types/src/workbook/DefaultRenderers.d.ts.map +1 -0
  417. package/types/src/workbook/GlobalWorkbookElement.d.ts +10 -0
  418. package/types/src/workbook/GlobalWorkbookElement.d.ts.map +1 -0
  419. package/types/src/workbook/IWorkbookElement.d.ts +178 -0
  420. package/types/src/workbook/IWorkbookElement.d.ts.map +1 -0
  421. package/types/src/workbook/WindowChrome.d.ts +61 -0
  422. package/types/src/workbook/WindowChrome.d.ts.map +1 -0
  423. package/types/src/workbook/WorkbookCommandContributor.d.ts +24 -0
  424. package/types/src/workbook/WorkbookCommandContributor.d.ts.map +1 -0
  425. package/types/src/workbook/WorkbookCommands.d.ts +97 -0
  426. package/types/src/workbook/WorkbookCommands.d.ts.map +1 -0
  427. package/types/src/workbook/WorkbookElement.d.ts +9 -0
  428. package/types/src/workbook/WorkbookElement.d.ts.map +1 -0
  429. package/types/src/workbook/WorkbookStrip.d.ts +73 -0
  430. package/types/src/workbook/WorkbookStrip.d.ts.map +1 -0
  431. package/types/src/workbook/index.d.ts +17 -0
  432. package/types/src/workbook/index.d.ts.map +1 -0
  433. package/types/src/workbook/resolveWorkbookInput.d.ts +27 -0
  434. package/types/src/workbook/resolveWorkbookInput.d.ts.map +1 -0
  435. package/types/src/workbook/useResolvedWorkbook.d.ts +31 -0
  436. package/types/src/workbook/useResolvedWorkbook.d.ts.map +1 -0
  437. package/types/src/workbook/useWindowChrome.d.ts +24 -0
  438. package/types/src/workbook/useWindowChrome.d.ts.map +1 -0
  439. package/types/src/workbook/useWorkbookApp.d.ts +47 -0
  440. package/types/src/workbook/useWorkbookApp.d.ts.map +1 -0
  441. package/types/src/workbook/useWorkbookEncrypted.d.ts +15 -0
  442. package/types/src/workbook/useWorkbookEncrypted.d.ts.map +1 -0
  443. package/types/src/workbook/useWorkbookFormat.d.ts +18 -0
  444. package/types/src/workbook/useWorkbookFormat.d.ts.map +1 -0
  445. package/types/src/workbook/useWorkbookName.d.ts +13 -0
  446. package/types/src/workbook/useWorkbookName.d.ts.map +1 -0
  447. package/types/src/workbook/useWorkbookSaveState.d.ts +29 -0
  448. package/types/src/workbook/useWorkbookSaveState.d.ts.map +1 -0
  449. package/browser/cjs/Be13sRyTTTUvNIit.cjs +0 -161
  450. package/browser/cjs/KLgpeikeRSDp4tUK.cjs +0 -16
  451. package/browser/cjs/n4OQZCE7fVxRfX1r.cjs +0 -7
  452. package/browser/esm/ClLcB3xHul5RfTMr.mjs +0 -1377
  453. package/browser/esm/EUZRpu3SnHayUDBu.mjs +0 -3905
  454. package/browser/esm/Mz1Nj2KbO5FcE969.mjs +0 -394
  455. package/node/assets/style.css +0 -1
  456. package/node/esm/sKvpUJVdmYl8r9f6.mjs +0 -11
package/types/index.d.ts CHANGED
@@ -1,1815 +1,2 @@
1
- import { AnchorLocation } from '@sheetxl/utils';
2
- import { Bounds } from '@sheetxl/utils';
3
- import { CellEditorProps } from '@sheetxl/grid-react';
4
- import { CellRendererProps } from '@sheetxl/grid-react';
5
- import { CommandButtonProps } from '@sheetxl/utils-react';
6
- import { Context } from 'react';
7
- import { CopyPasteProps } from '@sheetxl/utils-react';
8
- import { CopyPasteResults } from '@sheetxl/utils-react';
9
- import { default as default_2 } from 'react';
10
- import { DraggableSyntheticListeners } from '@dnd-kit/core';
11
- import { EditState } from '@sheetxl/grid-react';
12
- import { FocusWindowOptions } from '@sheetxl/utils-react';
13
- import { FrozenEdge } from '@sheetxl/grid-react';
14
- import { GridProps } from '@sheetxl/grid-react';
15
- import { GridStyle } from '@sheetxl/grid-react';
16
- import { GridSurfaceStyle } from '@sheetxl/grid-react';
17
- import { IAutoFilter } from '@sheetxl/sdk';
18
- import { IBorder } from '@sheetxl/sdk';
19
- import { ICell } from '@sheetxl/sdk';
20
- import { ICellEditorElement } from '@sheetxl/grid-react';
21
- import { ICellLayout } from '@sheetxl/utils-react';
22
- import { ICellRange } from '@sheetxl/sdk';
23
- import { ICellRanges } from '@sheetxl/sdk';
24
- import { IChart } from '@sheetxl/sdk';
25
- import { IColor } from '@sheetxl/sdk';
26
- import { ICommand } from '@sheetxl/utils-react';
27
- import { ICommands } from '@sheetxl/utils-react';
28
- import { IFunction } from '@sheetxl/sdk';
29
- import { IGridElement } from '@sheetxl/grid-react';
30
- import { IGridView } from '@sheetxl/grid-react';
31
- import { IListener } from '@sheetxl/sdk';
32
- import { IModule } from '@sheetxl/sdk';
33
- import { IMovable } from '@sheetxl/sdk';
34
- import { IMovableCollection } from '@sheetxl/sdk';
35
- import { IMovableSelection } from '@sheetxl/sdk';
36
- import { INamedCollection } from '@sheetxl/sdk';
37
- import { IPicture } from '@sheetxl/sdk';
38
- import { IRange } from '@sheetxl/sdk';
39
- import { IScript } from '@sheetxl/sdk';
40
- import { IScrollbarElement } from '@sheetxl/utils-react';
41
- import { ISheet } from '@sheetxl/sdk';
42
- import { ISheetHeader } from '@sheetxl/sdk';
43
- import { ISheetView } from '@sheetxl/sdk';
44
- import { IShowToolTipProperties } from '@sheetxl/utils-react';
45
- import { IStyle } from '@sheetxl/sdk';
46
- import { IStyleCollection } from '@sheetxl/sdk';
47
- import { ITable } from '@sheetxl/sdk';
48
- import { ITheme } from '@sheetxl/sdk';
49
- import { IThemeCollection } from '@sheetxl/sdk';
50
- import { ITransaction } from '@sheetxl/sdk';
51
- import { IWorkbook } from '@sheetxl/sdk';
52
- import { JSX } from 'react/jsx-runtime';
53
- import { LicenseDetails } from '@sheetxl/sdk';
54
- import { LicenseManager } from '@sheetxl/sdk';
55
- import { ReactNode } from 'react';
56
- import { ReferenceableClipboard } from '@sheetxl/utils';
57
- import { RemoveListener } from '@sheetxl/utils';
58
- import { ScrollableViewport } from '@sheetxl/utils-react';
59
- import { ScrollbarOrientation } from '@sheetxl/utils-react';
60
- import { ScrollButtonProps } from '@sheetxl/utils-react';
61
- import { ScrollPaneProps } from '@sheetxl/utils-react';
62
- import { SelectionProps } from '@sheetxl/grid-react';
63
- import { SelectionResults } from '@sheetxl/grid-react';
64
- import { StartEditEvent } from '@sheetxl/grid-react';
65
- import { TopLeft } from '@sheetxl/utils';
66
- import { Transform } from '@dnd-kit/utilities';
67
- import { VirtualScrollbarProps } from '@sheetxl/utils-react';
68
-
69
- export declare interface ActivateFrameOptions {
70
- /**
71
- * If not provided then will drive autoFocus
72
- */
73
- autoFocus?: boolean | string | FocusWindowOptions;
74
- }
75
-
76
- declare interface Border {
77
- readonly darkMode: boolean;
78
- readonly autoColor: IColor;
79
- readonly autoStyle: IBorder.StrokeStyle;
80
- readonly quickBorder: Partial<IBorder.Properties>;
81
- readonly schemeLookup: IColor.SchemeLookup;
82
- createTemporaryBorder: (update: IBorder.Properties) => IBorder;
83
- onBorderSelect: (border: Partial<IBorder.Properties>) => void;
84
- }
85
-
86
- export declare interface BorderOverlayProps {
87
- /**
88
- * Returns a list of visible cells.
89
- *
90
- * @param view - {@link IGridView}
91
- * @returns An array of visible coords
92
- */
93
- getVisibleCells: (view: IGridView) => ({
94
- coords: ICell.Coords;
95
- value?: any;
96
- range?: IRange.Coords;
97
- })[];
98
- /**
99
- * For finding the border. The value is the value returned from getVisibleCells and the index is the index found.
100
- *
101
- * @param value - ?
102
- * @param index - ?
103
- * @returns The IBorder at the location.
104
- */
105
- getBorderAt: (value: any, index: number) => IBorder;
106
- /**
107
- * Allow users to customize border rendering.
108
- * Note - This is wrapped in a single SVG so must be an SVG Element type (like a path).
109
- */
110
- rendererBorder?: (props: BorderRenderProps) => default_2.ReactNode;
111
- defaultColor?: string;
112
- darkMode?: boolean;
113
- /**
114
- * Force all rendering to be a single border line.
115
- * Use for previews.
116
- */
117
- forceThinBorder?: boolean;
118
- /**
119
- * A special flag to shift large borders
120
- */
121
- shiftIfWide?: boolean;
122
- }
123
-
124
- export declare interface BorderRenderProps {
125
- stroke: IBorder.IStroke;
126
- range: IRange.Coords;
127
- points: number[];
128
- darkMode: boolean;
129
- /**
130
- * @deprecated
131
- */
132
- key: string;
133
- /**
134
- * Int Hint to tell the border the direction that it is rendering
135
- */
136
- isVertical?: boolean;
137
- /**
138
- * Shift the borders if greater than 2 width
139
- */
140
- shiftIfWide?: boolean;
141
- /**
142
- * Hint to tell render that we are rendering a small small
143
- */
144
- forceThinBorder?: boolean;
145
- /**
146
- * Used for generating corners for wide borders. If not provided then borders will simply overlap.
147
- */
148
- layout?: ICellLayout;
149
- /**
150
- * Used for generating corners for wide borders. If not provided then borders will simply overlap.
151
- */
152
- intersections?: {
153
- stroke: IBorder.IStroke;
154
- range: IRange.Coords;
155
- }[];
156
- }
157
-
158
- export declare interface BordersOverlayResults {
159
- /**
160
- * Array of functions that return components to overlay
161
- */
162
- renderOverlay?: (view: IGridView) => default_2.ReactNode;
163
- }
164
-
165
- export declare const ChartAreaIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
166
-
167
- export declare const ChartAreaStackedIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
168
-
169
- export declare const ChartAreaStackedPercentIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
170
-
171
- export declare const ChartBarIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
172
-
173
- export declare const ChartBarStackedIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
174
-
175
- export declare const ChartBarStackedPercentIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
176
-
177
- export declare const ChartBubble3DIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
178
-
179
- export declare const ChartBubbleIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
180
-
181
- export declare const ChartColumnIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
182
-
183
- export declare const ChartColumnStackedIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
184
-
185
- export declare const ChartColumnStackedPercentIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
186
-
187
- /**
188
- * Placeholder for chart editors.
189
- */
190
- export declare const ChartEditor: default_2.NamedExoticComponent<Omit<ChartEditorProps, "ref"> & default_2.RefAttributes<IChartEditorElement>>;
191
-
192
- export declare interface ChartEditorAttributes {
193
- isChartEditor: () => true;
194
- }
195
-
196
- export declare interface ChartEditorProps extends MovableElementProps {
197
- chart: IChart;
198
- ref?: default_2.Ref<IChartEditorElement>;
199
- }
200
-
201
- export declare const ChartLineIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
202
-
203
- export declare const ChartLineMarkersIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
204
-
205
- export declare const ChartLineStackedIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
206
-
207
- export declare const ChartLineStackedMarkersIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
208
-
209
- export declare const ChartLineStackedPercentIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
210
-
211
- export declare const ChartLineStackedPercentMarkersIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
212
-
213
- export declare const ChartPieDoughnutIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
214
-
215
- export declare const ChartPieIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
216
-
217
- export declare const ChartScatterLinesIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
218
-
219
- export declare const ChartScatterLinesMarkersIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
220
-
221
- export declare const ChartScatterLinesMarkersSmoothIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
222
-
223
- export declare const ChartScatterLinesSmoothIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
224
-
225
- export declare const ChartScatterMarkersIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
226
-
227
- /**
228
- * For providing Adjustable Color Commands additional rendering capabilities.
229
- */
230
- declare interface Color {
231
- readonly darkMode: boolean;
232
- readonly schemeLookup: IColor.SchemeLookup;
233
- readonly autoColor: IColor;
234
- readonly quickColor?: IColor;
235
- recentColors: readonly IColor[] | (() => readonly IColor[]);
236
- addRecentColor: (color: IColor) => readonly IColor[];
237
- clearRecentColors: () => void;
238
- onColorSelect: (color: IColor) => void;
239
- }
240
-
241
- export declare namespace CommandContext {
242
- export {
243
- Color,
244
- Border,
245
- NamedStyle,
246
- Table,
247
- Theme,
248
- NamedReference,
249
- ResizeHeaderOptions,
250
- ResizeHeaderContext,
251
- NewTable,
252
- SelectedRange,
253
- FormulaFunction,
254
- FindScopeOptions,
255
- FindReplaceOptions
256
- }
257
- }
258
-
259
- export declare const CornerTriangle: default_2.MemoExoticComponent<(props: CornerTriangleProps) => JSX.Element>;
260
-
261
- export declare interface CornerTriangleProps extends default_2.SVGProps<SVGSVGElement> {
262
- /**
263
- * @defaultValue AnchorLocation.TopLeft
264
- */
265
- anchorLocation?: AnchorLocation;
266
- /**
267
- * defaults based on corner
268
- */
269
- fill?: string;
270
- /**
271
- * The right sides of the triangle.
272
- * @defaultValue 7
273
- */
274
- size?: number;
275
- /**
276
- * inset within the cell
277
- * @defaultValue 1
278
- */
279
- inset?: number;
280
- cellWidth?: number;
281
- cellHeight?: number;
282
- darkMode?: boolean;
283
- propsPath?: default_2.SVGProps<SVGPathElement>;
284
- }
285
-
286
- export declare const createCellEditStateFromCell: (clean: () => ICell, dirty?: string) => EditState<() => ICell, string>;
287
-
288
- export declare const DefaultTaskPaneRegistry: TaskPaneRegistry;
289
-
290
- export declare const DocThemesContext: Context<IThemeCollection>;
291
-
292
- /**
293
- * This component takes a `themes` prop.
294
- * It makes the `themes` available down the React tree thanks to React context.
295
- * This component should preferably be used at **the root of your component tree**.
296
- */
297
- export declare const DocThemesProvider: (props: DocThemesProviderProps) => JSX.Element;
298
-
299
- export declare interface DocThemesProviderProps {
300
- /**
301
- * A custom list of DocThemes to use.
302
- */
303
- themes: IThemeCollection;
304
- children: default_2.ReactElement<any, string | default_2.JSXElementConstructor<any>>;
305
- }
306
-
307
- export declare const EditableLabel: default_2.NamedExoticComponent<Omit<EditableLabelProps, "ref"> & default_2.RefAttributes<IEditableLabelElement>>;
308
-
309
- export declare interface EditableLabelAttributes {
310
- startEdit(): void;
311
- cancel(): void;
312
- }
313
-
314
- export declare interface EditableLabelProps extends Omit<default_2.HTMLAttributes<HTMLDivElement>, "onSubmit" | "onChange"> {
315
- value?: string;
316
- styleHover?: default_2.CSSProperties;
317
- dragging?: boolean;
318
- disabled?: boolean;
319
- readOnly?: boolean;
320
- maxLength?: number;
321
- onChange?: (value: string) => void;
322
- onSubmit?: (value: string) => boolean | void;
323
- onCancel?: () => void;
324
- renderInput?: (props: any) => default_2.ReactElement<HTMLInputElement>;
325
- /**
326
- * Reference to the HTMLInputElement (or other) used for editing
327
- */
328
- ref?: default_2.Ref<IEditableLabelElement>;
329
- }
330
-
331
- export declare interface EditorStateAndCoords<CT, DT> {
332
- sheet: ISheet;
333
- coords: ICell.Coords;
334
- editState: EditState<CT, DT>;
335
- }
336
-
337
- /**
338
- * Placeholder for movable frames.
339
- */
340
- export declare const EmptyFrame: default_2.NamedExoticComponent<Omit<EmptyFrameProps, "ref"> & default_2.RefAttributes<IEmptyFrameElement>>;
341
-
342
- export declare interface EmptyFrameAttributes {
343
- isEmptyFrame: () => true;
344
- }
345
-
346
- export declare interface EmptyFrameProps extends MovableElementProps {
347
- description: string;
348
- ref?: default_2.Ref<IEmptyFrameElement>;
349
- }
350
-
351
- /**
352
- * The default FilterButton
353
- */
354
- export declare const FilterButton: (props: FilterButtonProps) => default_2.ReactElement;
355
-
356
- /**
357
- * Property for the filter button
358
- */
359
- export declare interface FilterButtonProps extends default_2.HTMLAttributes<HTMLElement> {
360
- renderBounds: Bounds;
361
- zoom: number;
362
- disabled: boolean;
363
- darkMode: boolean;
364
- filter: IAutoFilter.IColumn;
365
- onFilterButtonMouseDown: (e: default_2.MouseEvent<HTMLDivElement, MouseEvent>, filter: IAutoFilter.IColumn) => void;
366
- }
367
-
368
- /**
369
- * Used for the find/replace dialog.
370
- */
371
- declare interface FindReplaceOptions {
372
- /**
373
- * Options for find.
374
- */
375
- findOptions?: ICellRange.FindOptions;
376
- /**
377
- * If replacing with null then set to true.
378
- */
379
- replace?: boolean;
380
- /**
381
- * The text to replace the found text with.
382
- */
383
- replaceText?: string | null;
384
- /**
385
- * Options for replace.
386
- */
387
- replaceOptions?: IWorkbook.ReplaceOptions;
388
- /**
389
- * If true the operation will signal to the ui container to
390
- * autoFocus.
391
- *
392
- * @remarks
393
- * For replaceAll this is ignored.
394
- */
395
- autoFocus?: boolean;
396
- /**
397
- * Default value 'Sheet'
398
- */
399
- scope?: FindScopeOptions;
400
- }
401
-
402
- declare const FindScopeOptions: {
403
- /**
404
- * Search the entire workbook
405
- */
406
- readonly Workbook: "workbook";
407
- /**
408
- * Search the current sheet or range
409
- */
410
- readonly Sheet: "sheet";
411
- };
412
-
413
- declare type FindScopeOptions = typeof FindScopeOptions[keyof typeof FindScopeOptions];
414
-
415
- declare interface FormulaFunction {
416
- searchByCategory: (category: string) => Promise<IFunction[]>;
417
- }
418
-
419
- export declare interface IChartEditorElement extends HTMLDivElement, ChartEditorAttributes {
420
- }
421
-
422
- /**
423
- * Type returned via ref property
424
- */
425
- export declare interface IEditableLabelElement extends HTMLDivElement, EditableLabelAttributes {
426
- }
427
-
428
- export declare interface IEmptyFrameElement extends HTMLDivElement, EmptyFrameAttributes {
429
- }
430
-
431
- export declare interface IFrame {
432
- addListener: (listener: IFrameContainerListener) => RemoveListener;
433
- close: () => void;
434
- focus: (options?: FocusWindowOptions) => void;
435
- }
436
-
437
- export declare interface IFrameContainerListener {
438
- onShow?: () => void;
439
- onBeforeHide?: () => void | Promise<boolean>;
440
- onHide?: () => void;
441
- }
442
-
443
- export declare interface IMovableAreaElement extends HTMLDivElement, MovableAreaAttributes {
444
- }
445
-
446
- export declare interface IPictureEditorAttributes {
447
- isPictureEditor: () => true;
448
- }
449
-
450
- export declare interface IPictureEditorElement extends HTMLDivElement, IPictureEditorAttributes {
451
- }
452
-
453
- /**
454
- * Used by the Script editor to interface with the repo for the Scripts
455
- */
456
- export declare namespace IScriptEditor {
457
- /**
458
- * This is used by the Monaco Script editor and the command manager to enabled scripts to be
459
- * execute and saved.
460
- */
461
- export interface Context {
462
- /**
463
- * Add listeners to the container.
464
- *
465
- * @remarks
466
- * If this throws a listener save will be aborted.
467
- */
468
- addContainerListener(listener: IScriptEditor.ContainerListener): IListener.Remove;
469
- /**
470
- * Set by the script editor when a function is selected. This may be null.
471
- */
472
- setSelectedFunction(selected: Promise<IScriptEditor.SelectedFunction | null>): void;
473
- /**
474
- * Set by the script editor when a function is selected. This may be null.
475
- */
476
- quickInsertFunction(functionName: string): void;
477
- /**
478
- * Return the selected.
479
- *
480
- * @remarks
481
- * This is done because multiple clients share the same Context.
482
- */
483
- getSelectedFunction: () => Promise<IScriptEditor.SelectedFunction | null> | null;
484
- /**
485
- * The the script editor.
486
- */
487
- setEditor(editor: IScriptEditor.Editor): void;
488
- /**
489
- * Returns the script editor.
490
- *
491
- * @remarks
492
- * If the editor is not loaded this will return null.
493
- */
494
- getEditor: () => IScriptEditor.Editor | null;
495
- /**
496
- * Decode a range from an address. Will return null if unable to decode.
497
- *
498
- * @remarks
499
- * Used by the tooltips and range highlighting.
500
- */
501
- getRanges: (address: IWorkbook.RangesAddress) => ICellRanges | null;
502
- /**
503
- * Returns the IFunctionDescriptor Executable.
504
- *
505
- * @remarks
506
- * This is used to enable the UI to display the available functions.
507
- */
508
- getScripts(): IScript;
509
- /**
510
- * Save the source.
511
- *
512
- * @param source The source to save.
513
- */
514
- saveSource(source: string): Promise<IModule>;
515
- }
516
- export interface ContainerListener {
517
- /**
518
- * Hook to listen for save events.
519
- */
520
- onBeforeSave?: () => Promise<void> | void;
521
- /**
522
- * If the status of the script has changed.
523
- */
524
- onReadonlyChange?: () => void;
525
- /**
526
- * If the script has changed.
527
- */
528
- onScriptChange?: () => void;
529
- }
530
- /**
531
- * Implemented by the editor to allow for ui interactions.
532
- */
533
- export interface Editor {
534
- /**
535
- * Insert a snippet of text into the editor.
536
- *
537
- * @remarks
538
- * Inserts the snippet before the current function.
539
- */
540
- insertSnippet: (snippet: string) => void;
541
- /**
542
- * Closes the editor.
543
- * @returns A promise that resolves when the editor is closed.
544
- */
545
- close: () => Promise<void>;
546
- }
547
- /**
548
- * The current function that is selected.
549
- */
550
- export interface SelectedFunction {
551
- /**
552
- * The selected function.
553
- */
554
- name: string;
555
- /**
556
- * Needed for JIT.
557
- */
558
- source: string;
559
- }
560
- /**
561
- * Provides status of the editor.
562
- */
563
- export interface Status {
564
- /**
565
- * The message to display.
566
- */
567
- message: string;
568
- /**
569
- * The cursor position.
570
- */
571
- cursor: string;
572
- /**
573
- * If the script is unsaved.
574
- */
575
- dirty: boolean;
576
- }
577
- }
578
-
579
- /**
580
- * Type returned via ref property
581
- */
582
- export declare interface IScriptEditorElement extends ScriptEditorAttributes, HTMLDivElement {
583
- }
584
-
585
- /**
586
- * Attributes and methods available on the sheet element beyond the HTMLDivElement.
587
- */
588
- export declare type ISheetAttributes = {
589
- getGridElement: () => IGridElement;
590
- getRowHeaderElement: () => ISheetHeaderElement;
591
- getColumnHeaderElement: () => ISheetHeaderElement;
592
- rowHeaderHeight: () => number;
593
- colHeaderWidth: () => number;
594
- startEdit(event?: StartEditEvent): void;
595
- submitEdit(): void;
596
- cancelEdit(): void;
597
- isEditing: boolean;
598
- contains(element: Node | null): boolean;
599
- invalidate: (coords?: ICell.Coords | null) => void;
600
- /**
601
- * Focus the sheet
602
- */
603
- focusSheet(options?: FocusOptions): void;
604
- /**
605
- * Focus a specific float.
606
- * If not provided will focus the first selected float.
607
- *
608
- * @remarks
609
- * The focusMovable does not scroll.
610
- * TODO - have this honor focus scroll options.
611
- */
612
- focusMovable(movable?: IMovable): Promise<boolean>;
613
- getSheet: () => ISheet;
614
- /**
615
- * For runtime introspection
616
- */
617
- isSheetElement: () => true;
618
- };
619
-
620
- /**
621
- * Type returned via ref property
622
- */
623
- export declare interface ISheetElement extends HTMLDivElement, ISheetAttributes {
624
- }
625
-
626
- declare type ISheetHeaderAttributes = {
627
- forceRender: () => void;
628
- getGridElement: () => IGridElement;
629
- };
630
-
631
- /**
632
- * Type returned via ref property
633
- */
634
- declare interface ISheetHeaderElement extends HTMLDivElement, ISheetHeaderAttributes {
635
- }
636
-
637
- export declare interface ITaskPaneArea {
638
- /**
639
- * This will show and focus a task pane by key.
640
- * @param key The task pane key.
641
- */
642
- activateTaskPane: (key: string, options?: ActivateFrameOptions) => void;
643
- }
644
-
645
- export declare interface ITaskPaneAreaElement extends HTMLDivElement, ITaskPaneArea {
646
- }
647
-
648
- export declare interface ITaskPaneRegistry {
649
- /**
650
- * Registers a task pane container.
651
- * @param entry The task pane entry.
652
- * @param replace Whether to replace an existing task pane. Default is false.
653
- */
654
- registerTaskPane(entry: TaskPaneEntry, replace?: boolean): void;
655
- /**
656
- * Unregister a task pane container.
657
- *
658
- * @param key The unique key for the task pane.
659
- */
660
- unregisterTaskPane(key: string): void;
661
- /**
662
- * Gets a registered task pane container.
663
- *
664
- * @param key The unique key for the task pane.
665
- * @returns The registered task pane or null if not found.
666
- */
667
- getRegisteredTaskPane(key: string): TaskPaneEntry | null;
668
- /**
669
- * Finds contributions for a specific entry.
670
- * @param contributionKey
671
- */
672
- findContributions(contributionKey: string): TaskPaneEntry[];
673
- }
674
-
675
- export declare interface ITaskPaneStrip extends HTMLDivElement, TaskPaneStripAttributes {
676
- }
677
-
678
- export declare const Item: default_2.NamedExoticComponent<Props & default_2.RefAttributes<HTMLDivElement>>;
679
-
680
- export { LicenseDetails }
681
-
682
- export { LicenseManager }
683
-
684
- export declare const LogoNoPaddingIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
685
-
686
- export declare const LogoTextNoPaddingIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
687
-
688
- export declare interface ModalFrame extends IFrame {
689
- onCancel?: () => void;
690
- onDone?: (results?: any) => void;
691
- }
692
-
693
- export declare const MovableArea: default_2.NamedExoticComponent<Omit<MovableAreaProps, "ref"> & default_2.RefAttributes<IMovableAreaElement>>;
694
-
695
- export declare interface MovableAreaAttributes {
696
- /**
697
- * Will put focus on the the movable object.
698
- * @remarks
699
- * This does not handle scrolling. This must be done by the virtual container.
700
- */
701
- focusMovable: (movable: IMovable) => Promise<boolean>;
702
- /**
703
- * For runtime introspection.
704
- */
705
- isMovableArea: () => true;
706
- }
707
-
708
- export declare interface MovableAreaProps extends default_2.HTMLAttributes<HTMLDivElement> {
709
- /**
710
- * The container to retrieve movable objects
711
- */
712
- movables: IMovableCollection;
713
- /**
714
- * The container view to retrieve selection information about the movables.
715
- */
716
- movablesView: IMovableSelection;
717
- /**
718
- * Callback to render the movable.
719
- *
720
- * @param props MovableElementProps
721
- * @returns A React Element representing the IMovable.
722
- */
723
- renderMovable: (props: MovableElementProps) => default_2.ReactElement;
724
- /**
725
- * The gridView
726
- */
727
- view: IGridView;
728
- /**
729
- * If provided this will be used start and stop transactions on being/end move.
730
- */
731
- transactional: ITransaction.ITransactional;
732
- /**
733
- * Called when the final movable is unselected.
734
- */
735
- onUnFocus?: () => void;
736
- /**
737
- * Called when the final movable is unselected.
738
- */
739
- onFocus?: () => void;
740
- /**
741
- * If disabled then movable selection will not be allowed and frames will be passed disabled.
742
- * @defaultValue false
743
- */
744
- disabled?: boolean;
745
- /**
746
- * If disabled then unable to move.
747
- * @defaultValue false
748
- */
749
- disableDrag?: boolean;
750
- /**
751
- * If disabled then unable to resize.
752
- * @defaultValue false
753
- */
754
- disableResize?: boolean;
755
- /**
756
- * Provider the anchor element to render.
757
- */
758
- renderDirections?: string[];
759
- /**
760
- * Called after the first render of a movable.
761
- */
762
- onFirstRender?: () => void;
763
- /**
764
- * Forwards the ref to the underlying element.
765
- */
766
- ref?: default_2.Ref<IMovableAreaElement>;
767
- }
768
-
769
- export declare interface MovableElementProps extends React.HTMLAttributes<HTMLElement> {
770
- movable?: IMovable;
771
- /**
772
- * The view to use for the movable.
773
- * // TODO - this should not be the IGridView, rather a simpler interface that doesn't have a grid dependency.
774
- */
775
- view: IGridView;
776
- /**
777
- * Called when the movable is hidden from view.
778
- *
779
- * @remarks
780
- * * If this returns a false the movable will not be unmounted but will
781
- * still have a style opacity property of 0 (and pointerEvents of none).
782
- * * Keeping a movable mounted is useful for elements that take a long of time to render but
783
- * increase the memory footprint of the application.
784
- */
785
- onHide: (hide: (movable: IMovable) => boolean | Promise<boolean> | void) => void;
786
- /**
787
- * Call when the movable is returned to the view.
788
- */
789
- onShow: (show: (movable: IMovable) => void) => void;
790
- /**
791
- * If true then the component is disabled.
792
- * @defaultValue false
793
- * @remarks
794
- * To see if an element is readonly check the IMovable.isProtected() method.
795
- */
796
- disabled?: boolean;
797
- /**
798
- * Indicator for dragging.
799
- * @defaultValue false
800
- */
801
- isDragging?: boolean;
802
- }
803
-
804
- declare interface NamedReference {
805
- /** used when creating new names */
806
- selection: () => ICellRanges;
807
- getNames: () => INamedCollection;
808
- }
809
-
810
- declare interface NamedStyle {
811
- readonly named: () => IStyle.INamed;
812
- readonly styles: () => IStyleCollection;
813
- readonly bodyStyle: () => GridSurfaceStyle;
814
- createTemporaryCell: (update: ICell.Update) => ICell;
815
- }
816
-
817
- declare interface NewTable {
818
- ranges: ICellRanges;
819
- hasHeader?: boolean;
820
- }
821
-
822
- export declare const PictureEditor: default_2.NamedExoticComponent<Omit<PictureEditorProps, "ref"> & default_2.RefAttributes<IPictureEditorElement>>;
823
-
824
- export declare interface PictureEditorProps extends MovableElementProps {
825
- /**
826
- * The underlying model for the picture.
827
- */
828
- picture: IPicture;
829
- /**
830
- * Usable for alt text or loading
831
- */
832
- description?: string;
833
- /**
834
- * Provide an optional loading panel.
835
- */
836
- loadingPanel?: default_2.ReactNode;
837
- /**
838
- * Ref for the Element.
839
- */
840
- ref?: default_2.Ref<IPictureEditorElement>;
841
- }
842
-
843
- declare interface Props {
844
- dragOverlay?: boolean;
845
- color?: string;
846
- disabled?: boolean;
847
- dragging?: boolean;
848
- handle?: boolean;
849
- height?: number;
850
- index?: number;
851
- fadeIn?: boolean;
852
- transform?: Transform | null;
853
- listeners?: DraggableSyntheticListeners;
854
- sorting?: boolean;
855
- style?: default_2.CSSProperties;
856
- transition?: string | null;
857
- wrapperStyle?: default_2.CSSProperties;
858
- value: default_2.ReactNode;
859
- onRemove?(): void;
860
- renderItem?(args: {
861
- dragOverlay: boolean;
862
- dragging: boolean;
863
- sorting: boolean;
864
- index: number | undefined;
865
- fadeIn: boolean;
866
- listeners: DraggableSyntheticListeners;
867
- ref: default_2.Ref<HTMLElement>;
868
- style: default_2.CSSProperties | undefined;
869
- transform: Props['transform'];
870
- transition: Props['transition'];
871
- value: Props['value'];
872
- }): default_2.ReactElement;
873
- }
874
-
875
- declare interface Props_2 {
876
- children: default_2.ReactNode;
877
- columns?: number;
878
- style?: default_2.CSSProperties;
879
- horizontal?: boolean;
880
- }
881
-
882
- export declare interface RangeContainer {
883
- getRange(address: ICellRange.Address, options?: ICellRange.GetRangeOptions): ICellRange;
884
- }
885
-
886
- declare interface ResizeHeaderContext {
887
- getOrientation(): IRange.Orientation;
888
- getUnitText(): string;
889
- toUnits?(value: number): number;
890
- toPixels?(value: number): number;
891
- }
892
-
893
- declare interface ResizeHeaderOptions {
894
- size: number;
895
- unit?: string;
896
- }
897
-
898
- export declare const Row: default_2.NamedExoticComponent<Props_2 & default_2.RefAttributes<HTMLDivElement>>;
899
-
900
- /**
901
- * This tracks the selection of the sheet and
902
- * updates the a named range editor and a sheet cell editor.
903
- */
904
- export declare const ScriptEditor: default_2.FC<ScriptEditorProps & ScriptEditorAttribute>;
905
-
906
- export declare type ScriptEditorAttribute = {
907
- ref?: default_2.Ref<IScriptEditorElement>;
908
- };
909
-
910
- export declare interface ScriptEditorAttributes {
911
- getEditor(): IScriptEditor.Editor;
912
- isScriptEditorElement(): true;
913
- close(): void;
914
- }
915
-
916
- /**
917
- * Move this to another project. Automation-Editor
918
- */
919
- export declare interface ScriptEditorProps extends default_2.HTMLAttributes<HTMLElement> {
920
- /**
921
- * Command Map
922
- */
923
- commands?: ICommands.IGroup;
924
- /**
925
- * If the values can be modified
926
- */
927
- readOnly?: boolean;
928
- /**
929
- * Handle to the frame
930
- */
931
- frame?: IFrame;
932
- /**
933
- * Allows for component to be autoFocused.
934
- */
935
- /**
936
- * If provided then a custom loading panel will be used.
937
- */
938
- loadingPanel?: default_2.ReactElement;
939
- /**
940
- * Called for status change events.
941
- */
942
- onStatusChange?: (status: Partial<IScriptEditor.Status>) => void;
943
- /**
944
- * Monaco theme
945
- */
946
- darkMode?: boolean;
947
- }
948
-
949
- declare interface SelectedRange {
950
- range: ICellRange;
951
- cell?: ICell.Address;
952
- }
953
-
954
- /**
955
- * SheetCellEditor
956
- * Controlled cell editor for updating state.
957
- */
958
- export declare const SheetCellEditor: default_2.NamedExoticComponent<Omit<SheetCellEditorProps, "ref"> & default_2.RefAttributes<ICellEditorElement>>;
959
-
960
- export declare interface SheetCellEditorProps extends CellEditorProps<() => ICell, string> {
961
- /**
962
- * Used for commands will be removed.
963
- */
964
- sheet?: ISheet;
965
- /**
966
- * Used for commands will be removed.
967
- */
968
- activeCoords?: ICell.Coords | null;
969
- /**
970
- * The parent commandGroup
971
- */
972
- commands?: ICommands.IGroup;
973
- /**
974
- * Styling for the grid that this editor is one.
975
- * This is used to determine darkMode only but should be used for other items..
976
- */
977
- bodyStyle?: GridSurfaceStyle;
978
- /**
979
- * Returns the number of lines to display. The minimum is 1.
980
- * @defaultValue 'The number of lines required to display the text'
981
- */
982
- linesVisible?: number;
983
- }
984
-
985
- /**
986
- * CellRender that has advanced rendering for an ICell.
987
- * Some of the features are:
988
-
989
- * 1. Fill (Solid, Gradient, Pattern)
990
- * 2. Horizontal Alignment (Left, Right, Center, Justify)
991
- * 3. Vertical Alignment (Top, Middle, Bottom)
992
- * 4. Spacing formatting (*, ?)
993
- * 5. Decimal rounding
994
- * 6. Overflow Character
995
- * 7. Text Wrapping
996
- * 8. Text Rotation
997
- * 8. Indentions
998
- * 9. Text Color
999
- * 10. Underline (Accounting, Standard, Double, Single)
1000
- * 11. Scaling
1001
- * 12. Super/Subscript
1002
- * 13. Indicators (Warning, Comments, Error, etc)
1003
- * 14. Filter buttons
1004
- * 15. Formulas
1005
- *
1006
- * @param props
1007
- */
1008
- export declare const SheetCellRenderer: default_2.FC<SheetCellRendererProps>;
1009
-
1010
- export declare interface SheetCellRendererProps extends CellRendererProps<ICell> {
1011
- /**
1012
- * If true, prefer to show the formulas over values
1013
- */
1014
- showFormulas?: boolean;
1015
- /**
1016
- * If true, show zero values
1017
- */
1018
- showZeros?: boolean;
1019
- /**
1020
- * Ability to query the theme colors.
1021
- * Note - There are also css variables that can be used to style using doc theme colors
1022
- * @see https://www.sheetxl.com/docs
1023
- */
1024
- docTheme?: ITheme;
1025
- /**
1026
- * Generalize application theming. The docTheme is a specific theme for the sheet.
1027
- */
1028
- bodyStyle?: GridSurfaceStyle;
1029
- /**
1030
- * An optimization that tells the render all of the styling is normal. And doesn't need to
1031
- * be overwritten.
1032
- */
1033
- normalStyle?: IStyle;
1034
- /**
1035
- * Callback for when a link has been clicked.
1036
- *
1037
- * @param event - The mouse event
1038
- */
1039
- onLinkMouseDown?: (event: default_2.MouseEvent<HTMLDivElement, MouseEvent>) => void;
1040
- /**
1041
- * Callback for when a filter has been clicked.
1042
- *
1043
- * @param event - The mouse event
1044
- */
1045
- onFilterButtonMouseDown?: (event: default_2.MouseEvent<HTMLDivElement, MouseEvent>, filter: IAutoFilter.IColumn) => void;
1046
- /**
1047
- * Custom properties for the filter button
1048
- */
1049
- propsFilterButton?: FilterButtonProps;
1050
- /**
1051
- * Callback for creating a custom filter button.
1052
- *
1053
- * @returns A React Element representing the FilterButton.
1054
- */
1055
- renderFilterButton?: (props: FilterButtonProps) => default_2.ReactElement;
1056
- }
1057
-
1058
- export declare interface SheetCopyPasteProps extends Omit<CopyPasteProps, "source" | "target"> {
1059
- /**
1060
- * Sheet element
1061
- */
1062
- element: () => HTMLElement;
1063
- sheet: ISheet;
1064
- sheetView: ISheetView;
1065
- /**
1066
- * Allow users to customize selected cells design
1067
- */
1068
- renderSelection?: (props: SelectionProps) => default_2.ReactNode;
1069
- /**
1070
- * Color for the foreground
1071
- */
1072
- copyForegroundColor?: string;
1073
- cutForegroundColor?: string;
1074
- /**
1075
- * Color for the background
1076
- */
1077
- copyBackgroundColor?: string;
1078
- cutBackgroundColor?: string;
1079
- }
1080
-
1081
- export declare interface SheetCopyPasteResults extends CopyPasteResults {
1082
- /**
1083
- * Array of functions that return components to overlay
1084
- */
1085
- overlays?: (view: IGridView) => default_2.ReactNode[];
1086
- }
1087
-
1088
- /**
1089
- * @see ISheet
1090
- *
1091
- * UI representation for ISheet.
1092
- *
1093
- */
1094
- export declare const SheetElement: default_2.NamedExoticComponent<Omit<SheetProps, "ref"> & default_2.RefAttributes<ISheetElement>>;
1095
-
1096
- /**
1097
- * TODO - We may not need the grid ref if we use the headers directly to measure.
1098
- */
1099
- declare interface SheetHeaderProps extends default_2.HTMLAttributes<HTMLDivElement> {
1100
- /**
1101
- * The underlying data model for the SheetHeader.
1102
- */
1103
- sheetHeader: ISheetHeader;
1104
- /**
1105
- * Access grid functions
1106
- */
1107
- gridRef: default_2.RefObject<IGridElement | null>;
1108
- /**
1109
- * Allow the sheet to be accessed.
1110
- */
1111
- sheetElement: ISheetElement;
1112
- /**
1113
- * The height or width in the opposite direction (for example a column headers height)
1114
- */
1115
- oppositeSize: number;
1116
- containerWidth: number;
1117
- containerHeight: number;
1118
- /**
1119
- * FrozenEdge
1120
- */
1121
- freezeStart?: number | FrozenEdge;
1122
- /**
1123
- * Parent commands for the sheet
1124
- */
1125
- commands?: ICommands.IGroup;
1126
- /**
1127
- * The selectionResults from use hook
1128
- */
1129
- selectionMain?: SelectionResults;
1130
- gridStyle?: GridStyle;
1131
- /**
1132
- * @see HeaderRenderer#verticalPadding
1133
- */
1134
- verticalPadding?: number;
1135
- /**
1136
- * @see HeaderRenderer#horizontalPadding
1137
- */
1138
- horizontalPadding?: number;
1139
- /** Fired when a contentMenu is requested */
1140
- onSheetContextMenu?: (location: SheetLocation) => void;
1141
- onResizeHeadersStart?: (index: number, prevSize: number, description: string) => void;
1142
- /**
1143
- * Called during resize of a header.
1144
- * If there is a negative newSize then these headers will have been hidden
1145
- * This is for the specific header being resized.
1146
- * Note - Other headers may also have been resized if hiding
1147
- */
1148
- onResizeHeaders?: (index: number, newSize: number, prevSize: number) => void;
1149
- /**
1150
- * Called after resize of a header.
1151
- * If there is a positive newSize and a single selection then those
1152
- * headers will also have been resized.
1153
- *
1154
- * Note - Other colHeaderRuns may also have been resized if expanding
1155
- * Note - If this was autoFit then newSize and prevSize will be null.
1156
- */
1157
- onResizeHeadersEnd?: (index: number, newSize: number, description: string) => void;
1158
- onResizeHeadersDown?: (index: number, size: number) => void;
1159
- onResizeHeadersUp?: (index: number) => void;
1160
- /**
1161
- * Override the default headerText. If not provided then typical Sheet labeling is used.
1162
- */
1163
- headerText?: (index: number) => string;
1164
- /**
1165
- * Scroll location
1166
- */
1167
- scrollPoint?: Partial<TopLeft>;
1168
- /**
1169
- * Callback when selection is manually started
1170
- */
1171
- onSelectionStart?: () => void;
1172
- /**
1173
- * Callback when selection is manually changed
1174
- */
1175
- onSelectionEnd?: () => void;
1176
- /**
1177
- * Ref for the HTMLDivElement
1178
- */
1179
- ref?: default_2.Ref<ISheetHeaderElement>;
1180
- }
1181
-
1182
- export declare interface SheetLocation {
1183
- clientX: number;
1184
- clientY: number;
1185
- originalEvent?: any;
1186
- clientWidth?: number;
1187
- clientHeight?: number;
1188
- rowIndex?: number;
1189
- colIndex?: number;
1190
- }
1191
-
1192
- export declare interface SheetPasteOptions extends ReferenceableClipboard.PasteOptions, ICellRange.CopyOptions {
1193
- }
1194
-
1195
- /**
1196
- * Props for the SheetElement component.
1197
- */
1198
- export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement> {
1199
- /**
1200
- * The `ISheet` to render.
1201
- */
1202
- sheet: ISheet;
1203
- /**
1204
- * Style used for grid
1205
- */
1206
- gridStyle?: GridStyle;
1207
- /**
1208
- * Style used for headers
1209
- */
1210
- headersStyle?: GridStyle;
1211
- /**
1212
- * Show the row headers
1213
- */
1214
- showRowHeaders?: boolean;
1215
- /**
1216
- * Properties for the row headers
1217
- */
1218
- propsRowHeader?: Partial<SheetHeaderProps>;
1219
- /**
1220
- * Show the column headers
1221
- */
1222
- showColumnHeaders?: boolean;
1223
- /**
1224
- * Properties for the column headers
1225
- */
1226
- propsColumnHeader?: Partial<SheetHeaderProps>;
1227
- /**
1228
- * Show the scrollbars
1229
- */
1230
- showScrollbars?: boolean;
1231
- /**
1232
- * Allow for customizations of scrollbar
1233
- */
1234
- propsScrollPane?: ScrollPaneProps;
1235
- /**
1236
- * Fired when the view port changes.
1237
- * This is in pixel coordinates and slightly different then viewable cells because off screen location bounds could change
1238
- */
1239
- onViewportChange?: (view: ScrollableViewport) => void;
1240
- /**
1241
- * Fire when a contentMenu is requested
1242
- */
1243
- onSheetContextMenu?: (location: SheetLocation) => void;
1244
- /**
1245
- * Called once when the sheet has been loaded but before it is rendered.
1246
- */
1247
- onElementLoad?: () => void;
1248
- /**
1249
- * Inject custom editors based on a cell.
1250
- * This should not return null but rather can canEdit.
1251
- * This is called during placement after scrolling and other bookkeeping has occurred
1252
- */
1253
- getCellEditor?: (props: CellEditorProps<() => ICell, string>, coords: ICell.Coords) => React.ReactElement<CellEditorProps<() => ICell, string>>;
1254
- /**
1255
- * Parent commands for the sheet
1256
- */
1257
- commands?: ICommands.IGroup;
1258
- /**
1259
- * Notify that there is a new repeatable command
1260
- */
1261
- onRepeatCommandChange?: (command: ICommand<any, any>) => void;
1262
- /**
1263
- * Fixed component that is layered within the viewport.
1264
- *
1265
- * @remarks Useful for dialogs and items that you want to place relative to the grid.
1266
- */
1267
- viewportComponent?: React.ReactNode;
1268
- /**
1269
- * Render components for movable elements.
1270
- *
1271
- * @param props - {@link MovableElementProps}
1272
- * @returns A React Element representing the IMovable.
1273
- */
1274
- renderMovable?: (props: MovableElementProps) => React.ReactElement;
1275
- /**
1276
- * Render an element directly onto a gridView.
1277
- */
1278
- overlays?: ((view: IGridView) => React.ReactNode)[];
1279
- /**
1280
- * To show the tooltip
1281
- *
1282
- * @param props
1283
- */
1284
- onShowTooltip?: (props: IShowToolTipProperties) => void;
1285
- onShowColumnTooltip?: (props: IShowToolTipProperties) => void;
1286
- onShowRowTooltip?: (props: IShowToolTipProperties) => void;
1287
- onCloseTooltip?: () => void;
1288
- /**
1289
- * Customize the grid.
1290
- *
1291
- * @remarks
1292
- * Not all props are passed through.
1293
- */
1294
- propsGrid?: GridProps;
1295
- /**
1296
- * Allow for custom rendering of cell props.
1297
- *
1298
- * @remarks
1299
- * This is used to customize filterButton popup action and any other customizations desired.
1300
- * This does not invalidate the rendering
1301
- */
1302
- propsCellRender?: Partial<SheetCellRendererProps>;
1303
- /**
1304
- * Ref to the sheet element.
1305
- */
1306
- ref?: React.Ref<ISheetElement>;
1307
- }
1308
-
1309
- export declare const SheetScrollbar: default_2.NamedExoticComponent<Omit<SheetScrollbarProps, "ref"> & default_2.RefAttributes<IScrollbarElement>>;
1310
-
1311
- export declare interface SheetScrollbarProps extends VirtualScrollbarProps {
1312
- /**
1313
- * The `ISheet` for the given scrollbar.
1314
- */
1315
- sheet: ISheet;
1316
- /**
1317
- * The direction of the scrollbar.
1318
- */
1319
- orientation: ScrollbarOrientation;
1320
- /**
1321
- * @defaultValue false
1322
- */
1323
- showCustomScrollButtons?: boolean;
1324
- /**
1325
- * To show the tooltip
1326
- * @param properties
1327
- */
1328
- onShowTooltip?: (properties: IShowToolTipProperties) => void;
1329
- /**
1330
- * Called to close the tooltip. Required is onShowTip is provided
1331
- */
1332
- onCloseTooltip?: () => void;
1333
- }
1334
-
1335
- /**
1336
- * Render a grid border using a border property as an input. Useful
1337
- * when wanting to render either a single cell or a border template.
1338
- * All cells are the same height/width.
1339
- */
1340
- export declare const StaticBorderRenderer: default_2.MemoExoticComponent<(props: StaticBorderRendererProps) => JSX.Element>;
1341
-
1342
- export declare interface StaticBorderRendererProps extends default_2.HTMLAttributes<HTMLDivElement> {
1343
- /**
1344
- * Returns a border for the given value and index.
1345
- */
1346
- getBorderAt?: (value: any, index: number) => IBorder;
1347
- rowCount?: number;
1348
- columnCount?: number;
1349
- /**
1350
- * Allow for the border width to be set.
1351
- * If this is not set then the border width will be the same as the cell size.
1352
- * Note - Measuring the child will need to wait until a render which can cause a flicker
1353
- * @defaultValue childSize
1354
- */
1355
- width?: number;
1356
- /**
1357
- * Allow for the border height to be set.
1358
- * If this is not set then the border width will be the same as the cell size.
1359
- * Note - Measuring the child will need to wait until a render which can cause a flicker
1360
- * @defaultValue childSize
1361
- */
1362
- height?: number;
1363
- darkMode?: boolean;
1364
- forceThinBorder?: boolean;
1365
- }
1366
-
1367
- export declare const StyledStrokePath: (props: StyledStrokePathProps) => default_2.ReactElement;
1368
-
1369
- export declare interface StyledStrokePathProps extends default_2.SVGProps<SVGPathElement> {
1370
- dashArray?: number[];
1371
- isDouble?: boolean;
1372
- isAngled?: boolean;
1373
- dashArrayAdditional?: number[];
1374
- length?: number;
1375
- width?: number;
1376
- offsetX?: number;
1377
- offsetY?: number;
1378
- isVertical?: boolean;
1379
- }
1380
-
1381
- export declare const Tab: default_2.NamedExoticComponent<TabProps & default_2.RefAttributes<HTMLDivElement>>;
1382
-
1383
- declare interface Table {
1384
- readonly table: () => ITable;
1385
- readonly styles: () => IStyleCollection;
1386
- readonly bodyStyle: () => GridSurfaceStyle;
1387
- /**
1388
- * Need so that we can add the table to the names.
1389
- */
1390
- getNames: () => INamedCollection;
1391
- }
1392
-
1393
- export declare interface TabProps extends Omit<default_2.HTMLAttributes<HTMLElement>, "onSubmit" | "onChange"> {
1394
- value: any;
1395
- index: number;
1396
- editing: boolean;
1397
- editable: boolean;
1398
- disabled: boolean;
1399
- selectedIndex: number;
1400
- background: string;
1401
- activeColor?: IColor;
1402
- borderColor?: string | IColor;
1403
- borderWidth?: number;
1404
- dragging: boolean;
1405
- }
1406
-
1407
- /**
1408
- * TabStrip component for displaying and managing tabs.
1409
- */
1410
- export declare const TabStrip: default_2.NamedExoticComponent<TabStripProps & default_2.RefAttributes<TabStripRef>>;
1411
-
1412
- export declare interface TabStripProps extends Omit<default_2.HTMLAttributes<HTMLDivElement>, "onSubmit" | "onChange"> {
1413
- selectedTabIndex: number;
1414
- tabNames: string[];
1415
- onSelectedTabIndexChange?: (index: number) => void;
1416
- onTabNameChange?: (index: number, tabName: string) => void;
1417
- onTabMove?: (indexFrom: number, indexTo: number) => void;
1418
- renderScrollButtonStart?: (props: ScrollButtonProps) => default_2.ReactElement;
1419
- renderScrollButtonEnd?: (props: ScrollButtonProps) => default_2.ReactElement;
1420
- renderScrollButtonEdge?: (props: ScrollButtonProps) => default_2.ReactElement;
1421
- renderTabButton?: (props: TabProps) => default_2.ReactElement<any>;
1422
- renderTabDivider?: (props: default_2.HTMLAttributes<HTMLElement> & default_2.Attributes) => default_2.ReactElement;
1423
- propsEditLabel?: EditableLabelProps;
1424
- disabled?: boolean;
1425
- disableDrag?: boolean;
1426
- /**
1427
- * Default background color of tabs
1428
- */
1429
- background?: string;
1430
- /**
1431
- * Currently '2022' css does not allow for scrollPanes to be hidden in one axis and overflow in another.
1432
- * To support tab scrolling and create a visual notch for the selected tab
1433
- * We create a border/divider for all elements except the selected.
1434
- */
1435
- borderWidth?: number;
1436
- borderColor?: string;
1437
- activeColor?: IColor;
1438
- }
1439
-
1440
- export declare interface TabStripRef extends HTMLDivElement {
1441
- startEdit(index: number): void;
1442
- cancel(index: number): void;
1443
- }
1444
-
1445
- /**
1446
- * The TaskPaneArea is a React component that renders multiple task panes.
1447
- *
1448
- * Container component implements 2 interfaces. If
1449
- * implements the ITaskPaneArea interface to be given to the TaskPaneProvider
1450
- * and it implement the ITaskPaneParent to be given to the TaskPane component.
1451
- * This provides a simple implementation but can be swapped out later.
1452
- */
1453
- export declare const TaskPaneArea: default_2.NamedExoticComponent<Omit<TaskPaneAreaProps<any>, "ref"> & default_2.RefAttributes<ITaskPaneAreaElement>>;
1454
-
1455
- export declare interface TaskPaneAreaProps<T = any> extends default_2.HTMLAttributes<HTMLDivElement> {
1456
- /**
1457
- * The model to pass to taskpane
1458
- */
1459
- model?: T;
1460
- /**
1461
- * The commands to use for the toolbar.
1462
- */
1463
- commands?: ICommands.IGroup;
1464
- /**
1465
- * Called when the task pane is should open.
1466
- *
1467
- * @remarks
1468
- * This is called when the first task pane is activated but it does not actually open.
1469
- */
1470
- onOpen?: () => void;
1471
- /**
1472
- * Called when the task pane is closed.
1473
- *
1474
- * @remarks
1475
- * This is called when the last task pane is deactivated but it does not actually close.
1476
- */
1477
- onClose?: () => void;
1478
- /**
1479
- * Props that can be injected to pane
1480
- */
1481
- propsPane?: default_2.HTMLAttributes<HTMLDivElement>;
1482
- /**
1483
- * Allows users to Wrap pane children in Top level Context
1484
- */
1485
- wrapperPane?: (children: default_2.ReactNode) => default_2.ReactNode;
1486
- /**
1487
- * Wrap frame in a context
1488
- */
1489
- wrapperFrame?: (children: default_2.ReactNode) => default_2.ReactNode;
1490
- /**
1491
- * Props that can be injected to the frame
1492
- */
1493
- propsFrame?: default_2.HTMLAttributes<HTMLDivElement>;
1494
- /**
1495
- * Override the default title renderer.
1496
- *
1497
- * @remarks
1498
- * If the registry also provides a custom title renderer that will be used instead.
1499
- */
1500
- renderTaskPanelTitle?(props: TaskPaneTitleProps): default_2.ReactElement;
1501
- /**
1502
- * Override the default task pane strip renderer.
1503
- *
1504
- */
1505
- renderTaskPaneStrip?(props: TaskPaneStripProps): default_2.ReactElement;
1506
- /**
1507
- * Allow for custom registry of task panes.
1508
- */
1509
- registry?: ITaskPaneRegistry;
1510
- /**
1511
- * If true always show the strip even with one pane.
1512
- */
1513
- alwaysShowStrip?: boolean;
1514
- /**
1515
- * Reference to the underlying element.
1516
- */
1517
- ref?: default_2.Ref<ITaskPaneAreaElement>;
1518
- }
1519
-
1520
- export declare interface TaskPaneEntry {
1521
- /**
1522
- * The unique key for the task pane.
1523
- *
1524
- * @remarks
1525
- * * Must not change.
1526
- */
1527
- readonly key: string;
1528
- /**
1529
- * The command paths to use to open the task pane.
1530
- *
1531
- * @remarks
1532
- * * Must not change.
1533
- * If this is not provided the task pane can only be opened programmatically.
1534
- */
1535
- readonly contributionPoints?: string[];
1536
- /**
1537
- * The title to display to identify the task pane.
1538
- */
1539
- getTitle(): string;
1540
- /**
1541
- * The icon to display to identify the task pane.
1542
- *
1543
- * @remarks
1544
- * This can be either a string (iconKey) or a React element.
1545
- */
1546
- getIcon?(): React.ReactElement | string;
1547
- /**
1548
- * Renders the task pane.
1549
- *
1550
- * @param props The props for the task pane.
1551
- * @param ref The ref to the task pane container.
1552
- */
1553
- renderTaskPane(props: TaskPaneProps, ref: React.Ref<HTMLDivElement>): React.ReactElement;
1554
- /**
1555
- * Optional function to render a custom title for the task pane.
1556
- */
1557
- renderTaskPanelTitle?(props: TaskPaneTitleProps): React.ReactElement;
1558
- createCommand?(taskPaneArea: ITaskPaneArea): ICommand;
1559
- /**
1560
- * Optional function to create a button that can be placed in the command bar.
1561
- *
1562
- * @remarks
1563
- * If not provided a default button will be created.
1564
- */
1565
- createCommandButton?(props: CommandButtonProps): React.ReactElement;
1566
- }
1567
-
1568
- export declare interface TaskPaneProps<T = any> {
1569
- /**
1570
- * The key used to register the taskPane.
1571
- */
1572
- entryKey: string;
1573
- model?: T;
1574
- frame?: IFrame;
1575
- commands?: ICommands.IGroup;
1576
- }
1577
-
1578
- export declare const TaskPaneProvider: default_2.FC<TaskPaneProviderProps>;
1579
-
1580
- /**
1581
- * Context provider for task panes. Allows custom task pane manager
1582
- * to be provided to components within the provider tree.
1583
- *
1584
- * ```tsx
1585
- * <TaskPaneProvider
1586
- * renderArea={(props) => <TaskPaneArea {...props} />}
1587
- * onUpdateArea={(area) => { }}
1588
- * >
1589
- * <App />
1590
- * </TaskPaneProvider>
1591
- * ```
1592
- */
1593
- export declare interface TaskPaneProviderProps {
1594
- children: ReactNode;
1595
- renderArea: (props: TaskPaneAreaProps) => default_2.ReactElement<ITaskPaneAreaElement>;
1596
- onUpdateArea: (area: default_2.ReactElement<ITaskPaneAreaElement>) => void;
1597
- registry?: ITaskPaneRegistry;
1598
- }
1599
-
1600
- declare class TaskPaneRegistry implements ITaskPaneRegistry {
1601
- protected _taskPanes: Map<string, TaskPaneEntry>;
1602
- /** @inheritdoc ITaskPaneRegistry.registerTaskPane */
1603
- registerTaskPane(entry: TaskPaneEntry, replace?: boolean): void;
1604
- /** @inheritdoc ITaskPaneRegistry.unregisterTaskPane */
1605
- unregisterTaskPane(key: string): void;
1606
- /** @inheritdoc ITaskPaneRegistry.getRegisteredTaskPane */
1607
- getRegisteredTaskPane(key: string): TaskPaneEntry | null;
1608
- findContributions(contributionKey: string): TaskPaneEntry[];
1609
- }
1610
-
1611
- export declare const TaskPaneStrip: default_2.NamedExoticComponent<Omit<TaskPaneStripProps, "ref"> & default_2.RefAttributes<ITaskPaneStrip>>;
1612
-
1613
- export declare interface TaskPaneStripAttributes {
1614
- isTaskPaneStrip: () => true;
1615
- }
1616
-
1617
- export declare interface TaskPaneStripProps extends Omit<default_2.HTMLAttributes<HTMLElement>, 'onSelect' | 'selected'> {
1618
- taskPanes: string[];
1619
- onSelect(key: string): void;
1620
- selected: string;
1621
- /**
1622
- * Allow for custom registry of task panes.
1623
- */
1624
- registry?: ITaskPaneRegistry;
1625
- /**
1626
- * If true, only show icons in the strip (no text).
1627
- */
1628
- iconsOnly?: boolean;
1629
- /**
1630
- * Ref to the task pane strip element.
1631
- */
1632
- ref?: default_2.Ref<ITaskPaneStrip>;
1633
- }
1634
-
1635
- export declare const TaskPaneTitle: default_2.NamedExoticComponent<Omit<TaskPaneTitleProps, "ref"> & default_2.RefAttributes<HTMLDivElement>>;
1636
-
1637
- export declare interface TaskPaneTitleProps extends Omit<default_2.HTMLAttributes<HTMLElement>, 'title'> {
1638
- title: default_2.ReactNode;
1639
- icon: default_2.ReactNode;
1640
- onClose: () => void;
1641
- readOnly: boolean;
1642
- /**
1643
- * If the task pane is focused
1644
- */
1645
- focused: boolean;
1646
- /**
1647
- * Reference to the underlying element.
1648
- */
1649
- ref?: default_2.Ref<HTMLDivElement>;
1650
- }
1651
-
1652
- declare interface Theme {
1653
- readonly theme: ITheme;
1654
- readonly themes: IThemeCollection;
1655
- readonly darkMode: boolean;
1656
- }
1657
-
1658
- /**
1659
- * useBordersOverlay
1660
- * Renders borders by combining individual cells border attributes.
1661
- */
1662
- export declare const useBordersOverlay: ({ getBorderAt, rendererBorder, getVisibleCells: propGetVisibleCells, darkMode, forceThinBorder, defaultColor, shiftIfWide }: BorderOverlayProps) => BordersOverlayResults;
1663
-
1664
- export declare const useDocThemes: () => IThemeCollection;
1665
-
1666
- /**
1667
- * React hook for subscribing to model-level events (workbooks, sheets, etc.).
1668
- *
1669
- * @template SOURCE - The model type (e.g., IWorkbook, ISheet)
1670
- * @template EVENTS - The listener interface type (e.g., ISheet.IListeners)
1671
- *
1672
- * @param source - The model instance to listen to
1673
- * @param listeners - Object containing listener callbacks for various events
1674
- * @param options - Optional configuration
1675
- *
1676
- * @remarks
1677
- * This hook automatically manages the listener lifecycle:
1678
- * - Subscribes when the component mounts or `source` changes
1679
- * - Unsubscribes when the component unmounts or `source` changes
1680
- * - Prevents unnecessary re-subscriptions when the `listeners` object reference changes
1681
- * (as long as the shape/keys remain consistent)
1682
- *
1683
- * By default (`fireOnModelChange: true`), all listeners are called once immediately
1684
- * on mount with the current source state, allowing you to initialize component state
1685
- * based on the model's current values.
1686
- *
1687
- * @example
1688
- * ```tsx
1689
- * function SheetComponent({ sheet }: { sheet: ISheet }) {
1690
- * useModelListener<ISheet, ISheet.IListeners>(sheet, {
1691
- * onSave(source, json) {
1692
- * console.log('Sheet saved:', json);
1693
- * },
1694
- * });
1695
- *
1696
- * return <div>Sheet: {sheet.getName()}</div>;
1697
- * }
1698
- * ```
1699
- */
1700
- export declare const useModelListener: <SOURCE, EVENTS>(source: IListener.ISource<SOURCE>, listeners: IListener.Callbacks<SOURCE, EVENTS>, options?: useModelListenerOptions) => void;
1701
-
1702
- /**
1703
- * Options for `useModelListener` hook.
1704
- *
1705
- * @remarks
1706
- * This is extends IListener.Options but removes 'once' since hooks are
1707
- * evaluated on render and adds a `fireOnModelChange` option.
1708
- */
1709
- export declare interface useModelListenerOptions extends Omit<IListener.Options, 'once'> {
1710
- /**
1711
- * If `true` (default), fires all listeners once immediately when the component mounts
1712
- * or when the source changes, allowing initialization based on current model state.
1713
- *
1714
- * @defaultValue true
1715
- */
1716
- fireOnModelChange?: boolean;
1717
- }
1718
-
1719
- /**
1720
- * Hook for observing movable commands. This hook will observe a combination
1721
- * of sheet events and an options selection.
1722
- */
1723
- export declare const useMovableCommands: (props: useMovableCommandsOptions) => ICommands.IGroup;
1724
-
1725
- export declare interface useMovableCommandsOptions {
1726
- commands: ICommands.IGroup;
1727
- target: () => ICommands.ITarget;
1728
- /**
1729
- * Notify that there is a new repeatable command
1730
- */
1731
- onRepeatCommandChange?: (command: ICommand<any, any>) => void;
1732
- /**
1733
- * The collection to retrieve movable objects
1734
- */
1735
- movables: IMovableCollection;
1736
- /**
1737
- * The view to retrieve selection information about the movables.
1738
- */
1739
- movablesView: IMovableSelection;
1740
- /**
1741
- * If provided this will be used start and stop transactions on being/end move.
1742
- */
1743
- transactional: ITransaction.ITransactional;
1744
- }
1745
-
1746
- /**
1747
- * This hook delegates to the an model that contains a getRange(address) method.
1748
- *
1749
- * @param model
1750
- * @param listener
1751
- */
1752
- export declare const useRangeListener: (model: RangeContainer, address: ICellRange.Address, listener: ICellRange.Listener, options?: useSheetRangeListenerOptions) => void;
1753
-
1754
- /**
1755
- * Hook for observing sheet commands. This hook will observe a combination
1756
- * of sheet events and an options selection.
1757
- *
1758
- * Note -
1759
- * If a sheetSelection is provided then the commands will be confirmed using the provided selections.
1760
- * This is done to allow for context specific (right-click, etc) commands.
1761
- *
1762
- * Continue to review until we have them all.
1763
- * https://www.excelcampus.com/shortcuts/#:~:text=For%20example%2C%20to%20press%20the,Then%20release%20all%20keys. (great list)
1764
- * https://support.microsoft.com/en-us/office/keyboard-shortcuts-in-excel-1798d9d5-842a-42b8-9c99-9b7213f0040f
1765
- * https://corporatefinanceinstitute.com/resources/excel/shortcuts/excel-shortcuts-pc-mac/
1766
- *
1767
- * TODO -
1768
- * Insert Bullet - Alt 7/9 while in edit mode
1769
- * Ctrl+Shift+F / Ctrl+Shift+P - Open Font Dialog
1770
- * CTRL+SHIFT+DELETE === cut ? (not seeing this happen)
1771
- *
1772
- * Formulas
1773
- * Ctrl + / Select current array ?
1774
- * (other formula shortcuts)
1775
- */
1776
- export declare function useSheetCommands(props: useSheetCommandsOptions): ICommands.IGroup;
1777
-
1778
- export declare interface useSheetCommandsOptions {
1779
- /**
1780
- * The sheet.
1781
- */
1782
- sheet: ISheet;
1783
- commands: ICommands.IGroup;
1784
- target: () => ICommands.ITarget;
1785
- /**
1786
- * Notify that there is a new repeatable command
1787
- */
1788
- onRepeatCommandChange?: (command: ICommand<any, any>) => void;
1789
- onStartEdit?: (event: Partial<StartEditEvent>) => void;
1790
- bodyStyle?: GridSurfaceStyle;
1791
- /**
1792
- * Returns the current viewport.
1793
- */
1794
- getViewport?: () => ScrollableViewport;
1795
- }
1796
-
1797
- /**
1798
- * Copy paste hook for `ISheet`.
1799
- */
1800
- export declare const useSheetCopyPaste: ({ element, sheet, sheetView, commands, onClipboardUpdate: propOnClipboardUpdate, onPaste: propOnPaste, renderSelection: propRenderSelection, copyForegroundColor, cutForegroundColor, copyBackgroundColor, cutBackgroundColor, ...rest }: SheetCopyPasteProps) => SheetCopyPasteResults;
1801
-
1802
- export declare interface useSheetRangeListenerOptions extends ICellRange.ListenerOptions {
1803
- fireOnAddressChange: boolean;
1804
- }
1805
-
1806
- /**
1807
- * Hook to get the task pane manager directly.
1808
- * Useful for registering new task panes or managing instances.
1809
- */
1810
- export declare const useTaskPaneArea: () => ITaskPaneArea;
1811
-
1812
-
1813
- export * from "@sheetxl/utils-react";
1814
-
1815
- export { }
1
+ export * from './src/index'
2
+ export {}