@sheetxl/studio-mui 0.7.27 → 0.7.28-beta.2

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 (302) hide show
  1. package/README.md +2 -2
  2. package/browser/cjs/BQJKf40kttQWOzLw.cjs +20 -0
  3. package/browser/cjs/BTZ5uzK0wHzpiZGC.cjs +1 -0
  4. package/browser/cjs/B_D3JKseVvpRyX-E.cjs +1 -0
  5. package/browser/cjs/B_WyRpeiesnEiNP4.cjs +11 -0
  6. package/browser/cjs/BeKpqOx8It0RD0Rf.cjs +2 -0
  7. package/browser/cjs/Bj-EvSYeDfqmU0V6.cjs +2 -0
  8. package/browser/cjs/Bo9Kx3L_XQkGPBJ5.cjs +1 -0
  9. package/browser/cjs/ByIEqNsvj52sihT9.cjs +5 -0
  10. package/browser/cjs/C3moehR3VOd0LnmM.cjs +1 -0
  11. package/browser/cjs/C97KHSuikAbr1qVM.cjs +1 -0
  12. package/browser/cjs/CJLwX_A3y3TQUmzj.cjs +1 -0
  13. package/browser/cjs/CPSc2VSYZeZ1B9mi.cjs +1 -0
  14. package/browser/cjs/CPcBvw4ZPwHVTUZF.cjs +1 -0
  15. package/browser/cjs/CZm1jVZaHQ246prW.cjs +1 -0
  16. package/browser/cjs/CdDYyAfccXme8w6m.cjs +1 -0
  17. package/browser/cjs/DBJLJGiCGXesx5n6.cjs +1 -0
  18. package/browser/cjs/DLScL5AOXhHu9O9H.cjs +7 -0
  19. package/browser/cjs/Djsiad0Qha1Y-YaS.cjs +1 -0
  20. package/browser/cjs/IASAYG6qgv7lJY7y.cjs +1 -0
  21. package/browser/cjs/KZvriGbhEOVkQD0b.cjs +1 -0
  22. package/browser/cjs/UnMhi28mbvLiOXQe.cjs +1 -0
  23. package/browser/cjs/Vbigo0kFP3PFfmeA.cjs +1 -0
  24. package/browser/cjs/iMWEL01eC83oU-YY.cjs +1 -0
  25. package/browser/cjs/index.cjs +2 -7
  26. package/browser/cjs/w2GjebPlOFv3pCbm.cjs +1 -0
  27. package/browser/cjs/zQsyZpeXAvcVXJMs.cjs +1 -0
  28. package/browser/esm/BFnJuOSao7TjbB-2.mjs +1150 -0
  29. package/browser/esm/BGngIqHYTFzsezh-.mjs +105 -0
  30. package/browser/esm/BH0fLaa4Vfda2U-T.mjs +155 -0
  31. package/browser/esm/BKadOi_4tf3UqilJ.mjs +8878 -0
  32. package/browser/esm/BNhUUeacBwGsPLBQ.mjs +42 -0
  33. package/browser/esm/BkP8c-zrLAqdNL5E.mjs +82 -0
  34. package/browser/esm/BlykPulAqes3JMee.mjs +1376 -0
  35. package/browser/esm/Bt_J_RX2M5EfualB.mjs +217 -0
  36. package/browser/esm/CIvpm_sHFmNjZQ7A.mjs +52 -0
  37. package/browser/esm/Cwku0NEsbyq9Q_RE.mjs +129 -0
  38. package/browser/esm/D4-E6nt8hrlNPIFy.mjs +5391 -0
  39. package/browser/esm/D5kzg7IfEtrExqiB.mjs +47 -0
  40. package/browser/esm/DLG0lDeb0t2L5dW4.mjs +468 -0
  41. package/browser/esm/DN5ACcUVdZeTSdLP.mjs +411 -0
  42. package/browser/esm/DP50mI7SOk1spPHv.mjs +516 -0
  43. package/browser/esm/DfZkO9tkYUlBUgXw.mjs +508 -0
  44. package/browser/esm/DhSHhyt16cHMvS_1.mjs +612 -0
  45. package/browser/esm/DxEzstNhMkJ0uzic.mjs +191 -0
  46. package/browser/esm/DxurARMNTQF7_rno.mjs +99 -0
  47. package/browser/esm/EK3JudzGAPbSIzUc.mjs +2207 -0
  48. package/browser/esm/Lds8JbV0rmFse8IO.mjs +113 -0
  49. package/browser/esm/gdfNDmwpOOPidxVx.mjs +20 -0
  50. package/browser/esm/gr4KpbaVpVfm8KOB.mjs +219 -0
  51. package/browser/esm/index.mjs +152 -91
  52. package/licenses/dependencies.txt +137 -627
  53. package/node/esm/-xXP4QK8hYGcJeug.mjs +509 -0
  54. package/node/esm/BVNe-px0vKah_sh2.mjs +516 -0
  55. package/node/esm/CLqRv2FWsGMrPoB0.mjs +47 -0
  56. package/node/esm/CSaiKMpmmQJY2xtl.mjs +113 -0
  57. package/node/esm/CTVMIjaQZQtJ05F8.mjs +129 -0
  58. package/node/esm/CWDr4rcpYux8bSQk.mjs +82 -0
  59. package/node/esm/CgDlduchq8t6DdhF.mjs +190 -0
  60. package/node/esm/Ck1Im-zWbwJqZNU1.mjs +470 -0
  61. package/node/esm/Ctakr7TocM8RykpC.mjs +679 -0
  62. package/node/esm/DMhU1sS3kX-Im83k.mjs +106 -0
  63. package/node/esm/Dh2MI-_NSwxjrRP8.mjs +99 -0
  64. package/node/esm/ED4g6Bsz9syAhAW3.mjs +155 -0
  65. package/node/esm/VuLRDpv46Yib6fpp.mjs +4536 -0
  66. package/node/esm/index.mjs +10603 -2832
  67. package/package.json +27 -27
  68. package/resources/contents.json +30 -0
  69. package/resources/locales/contents.json +44 -0
  70. package/resources/locales/de/groups.cmd.json +219 -0
  71. package/resources/locales/de/studio.cmd.json +159 -0
  72. package/resources/locales/de/ui.msg.json +507 -0
  73. package/resources/locales/en/groups.cmd.json +219 -0
  74. package/resources/locales/en/studio.cmd.json +159 -0
  75. package/resources/locales/en/ui.msg.json +508 -0
  76. package/types/index.d.ts +2 -1761
  77. package/types/src/anchorItems/AnchorItemsDescriptor.d.ts +131 -0
  78. package/types/src/anchorItems/AnchorItemsPanel.d.ts +29 -0
  79. package/types/src/anchorItems/index.d.ts +3 -0
  80. package/types/src/border/BorderPopupButton.d.ts +30 -0
  81. package/types/src/border/BorderStylePopupButton.d.ts +40 -0
  82. package/types/src/border/index.d.ts +3 -0
  83. package/types/src/chart/command/InsertChartCommandButton.d.ts +10 -0
  84. package/types/src/chart/command/index.d.ts +2 -0
  85. package/types/src/color/Alpha.d.ts +36 -0
  86. package/types/src/color/Checkboard.d.ts +11 -0
  87. package/types/src/color/CheckboardUtils.d.ts +3 -0
  88. package/types/src/color/ColorButton.d.ts +21 -0
  89. package/types/src/color/ColorButtonList.d.ts +17 -0
  90. package/types/src/color/ColorPanel.d.ts +71 -0
  91. package/types/src/color/ColorPopupButton.d.ts +29 -0
  92. package/types/src/color/CustomColorPanel.d.ts +16 -0
  93. package/types/src/color/EditableInput.d.ts +22 -0
  94. package/types/src/color/Hue.d.ts +29 -0
  95. package/types/src/color/Saturation.d.ts +45 -0
  96. package/types/src/color/SketchFields.d.ts +9 -0
  97. package/types/src/color/Swatch.d.ts +16 -0
  98. package/types/src/color/Types.d.ts +11 -0
  99. package/types/src/color/_Utils.d.ts +4 -0
  100. package/types/src/color/index.d.ts +7 -0
  101. package/types/src/command/AccountingStyleCommandButton.d.ts +18 -0
  102. package/types/src/command/AppearanceCommandButton.d.ts +3 -0
  103. package/types/src/command/BorderCommandButton.d.ts +20 -0
  104. package/types/src/command/ColorCommandButton.d.ts +23 -0
  105. package/types/src/command/DocThemeCommandButton.d.ts +19 -0
  106. package/types/src/command/FileCommandButton.d.ts +8 -0
  107. package/types/src/command/FontFamilyCommandButton.d.ts +9 -0
  108. package/types/src/command/FontSizeCommandButton.d.ts +21 -0
  109. package/types/src/command/InsertFunctionCommandPopupButton.d.ts +9 -0
  110. package/types/src/command/InsertFunctionSumCommandPopupButton.d.ts +8 -0
  111. package/types/src/command/LanguageCommandButton.d.ts +19 -0
  112. package/types/src/command/LocaleCommandButton.d.ts +17 -0
  113. package/types/src/command/NumberFormatCommandButton.d.ts +6 -0
  114. package/types/src/command/PasteCommandButton.d.ts +14 -0
  115. package/types/src/command/PresetCellStylesCommandButton.d.ts +11 -0
  116. package/types/src/command/PresetTableStylesCommandButton.d.ts +12 -0
  117. package/types/src/command/RegisterCatalog.d.ts +3 -0
  118. package/types/src/command/SheetCommandGroups.d.ts +10 -0
  119. package/types/src/command/SheetZoomCommandButton.d.ts +9 -0
  120. package/types/src/command/StudioCommandGroups.d.ts +11 -0
  121. package/types/src/command/TextEffectsCommandButton.d.ts +6 -0
  122. package/types/src/command/TextRotateGroupButton.d.ts +14 -0
  123. package/types/src/command/UndoRedoCommandButton.d.ts +14 -0
  124. package/types/src/command/WalkingCopyCommandButton.d.ts +6 -0
  125. package/types/src/command/WorkbookCommandGroups.d.ts +11 -0
  126. package/types/src/command/index.d.ts +23 -0
  127. package/types/src/conditionalFormat/ColorScaleRulePanel.d.ts +18 -0
  128. package/types/src/conditionalFormat/ConditionalFormatDetailsPanel.d.ts +23 -0
  129. package/types/src/conditionalFormat/ConditionalFormatDetailsTaskPane.d.ts +4 -0
  130. package/types/src/conditionalFormat/ConditionalFormatEditorPanel.d.ts +20 -0
  131. package/types/src/conditionalFormat/ConditionalFormatPlugin.d.ts +2 -0
  132. package/types/src/conditionalFormat/ConditionalFormatRangeField.d.ts +32 -0
  133. package/types/src/conditionalFormat/ConditionalFormatStylePicker.d.ts +34 -0
  134. package/types/src/conditionalFormat/ConditionalFormatTitle.d.ts +10 -0
  135. package/types/src/conditionalFormat/DataBarRulePanel.d.ts +23 -0
  136. package/types/src/conditionalFormat/IconSetRulePanel.d.ts +23 -0
  137. package/types/src/conditionalFormat/PresetChip.d.ts +30 -0
  138. package/types/src/conditionalFormat/PresetScalesCommandButton.d.ts +20 -0
  139. package/types/src/conditionalFormat/RulePreview.d.ts +23 -0
  140. package/types/src/conditionalFormat/RuleSection.d.ts +20 -0
  141. package/types/src/conditionalFormat/ScaleMiniGrid.d.ts +59 -0
  142. package/types/src/conditionalFormat/ScaleStopRow.d.ts +34 -0
  143. package/types/src/conditionalFormat/index.d.ts +3 -0
  144. package/types/src/conditionalFormat/previewColor.d.ts +50 -0
  145. package/types/src/conditions/AverageOption.d.ts +25 -0
  146. package/types/src/conditions/BetweenOption.d.ts +25 -0
  147. package/types/src/conditions/BooleanOption.d.ts +24 -0
  148. package/types/src/conditions/CombinatorOption.d.ts +41 -0
  149. package/types/src/conditions/ConditionEditor.d.ts +57 -0
  150. package/types/src/conditions/ConditionUtils.d.ts +83 -0
  151. package/types/src/conditions/DateTimeOption.d.ts +43 -0
  152. package/types/src/conditions/ExpressionOption.d.ts +26 -0
  153. package/types/src/conditions/InSetOption.d.ts +37 -0
  154. package/types/src/conditions/NumberOption.d.ts +24 -0
  155. package/types/src/conditions/OperatorAndParamEditor.d.ts +55 -0
  156. package/types/src/conditions/OperatorSelect.d.ts +35 -0
  157. package/types/src/conditions/OperatorSelectPopupButton.d.ts +39 -0
  158. package/types/src/conditions/ScalarOption.d.ts +29 -0
  159. package/types/src/conditions/SelectorSelect.d.ts +43 -0
  160. package/types/src/conditions/StringOption.d.ts +24 -0
  161. package/types/src/conditions/TimePeriodOption.d.ts +25 -0
  162. package/types/src/conditions/TopNOption.d.ts +25 -0
  163. package/types/src/conditions/index.d.ts +13 -0
  164. package/types/src/dataValidation/DataValidationDetailsPanel.d.ts +16 -0
  165. package/types/src/dataValidation/DataValidationDetailsTaskPane.d.ts +3 -0
  166. package/types/src/dataValidation/DataValidationEditorPanel.d.ts +12 -0
  167. package/types/src/dataValidation/DataValidationPlugin.d.ts +2 -0
  168. package/types/src/dataValidation/index.d.ts +2 -0
  169. package/types/src/debug/DebugUtils.d.ts +4 -0
  170. package/types/src/debug/index.d.ts +2 -0
  171. package/types/src/dialog/CommentsDialog.d.ts +11 -0
  172. package/types/src/dialog/FindReplaceWindow.d.ts +13 -0
  173. package/types/src/dialog/HyperlinkDialog.d.ts +28 -0
  174. package/types/src/dialog/InsertFunctionDialog.d.ts +25 -0
  175. package/types/src/dialog/NamedReferenceDialog.d.ts +17 -0
  176. package/types/src/dialog/NumberFormatDialog.d.ts +12 -0
  177. package/types/src/dialog/ResizeHeaderDialog.d.ts +15 -0
  178. package/types/src/dialog/ShortcutKeysDialog.d.ts +9 -0
  179. package/types/src/dialog/ShortcutKeysPanel.d.ts +28 -0
  180. package/types/src/dialog/SortDialog.d.ts +9 -0
  181. package/types/src/dialog/TableNewDialog.d.ts +14 -0
  182. package/types/src/dialog/WorkbookStatisticsDialog.d.ts +13 -0
  183. package/types/src/dialog/index.d.ts +10 -0
  184. package/types/src/filter/ColumnMenu.d.ts +13 -0
  185. package/types/src/filter/FilterList.d.ts +28 -0
  186. package/types/src/filter/index.d.ts +3 -0
  187. package/types/src/form/FormulaField.d.ts +221 -0
  188. package/types/src/form/InputField.d.ts +89 -0
  189. package/types/src/form/index.d.ts +3 -0
  190. package/types/src/formulaBar/FormulaBar.d.ts +8 -0
  191. package/types/src/formulaBar/IFormulaBar.d.ts +51 -0
  192. package/types/src/formulaBar/index.d.ts +3 -0
  193. package/types/src/function/FunctionArgumentsPanel.d.ts +57 -0
  194. package/types/src/function/FunctionSearchPanel.d.ts +35 -0
  195. package/types/src/function/InsertFunctionWizard.d.ts +79 -0
  196. package/types/src/function/index.d.ts +4 -0
  197. package/types/src/function/paneMetrics.d.ts +33 -0
  198. package/types/src/index.d.ts +21 -0
  199. package/types/src/itemsPanel/EditorPanel.d.ts +21 -0
  200. package/types/src/itemsPanel/ItemCard.d.ts +57 -0
  201. package/types/src/itemsPanel/ItemsDescriptor.d.ts +215 -0
  202. package/types/src/itemsPanel/ItemsPanel.d.ts +45 -0
  203. package/types/src/itemsPanel/SortableCards.d.ts +67 -0
  204. package/types/src/itemsPanel/index.d.ts +6 -0
  205. package/types/src/movable/MovableContextMenu.d.ts +13 -0
  206. package/types/src/movable/index.d.ts +2 -0
  207. package/types/src/named/INamedCollectionEditor.d.ts +37 -0
  208. package/types/src/named/NamedCollectionEditor.d.ts +7 -0
  209. package/types/src/named/NamedDetailsPanel.d.ts +11 -0
  210. package/types/src/named/NamedDetailsTaskPane.d.ts +3 -0
  211. package/types/src/named/NamedDraft.d.ts +68 -0
  212. package/types/src/named/NamedEditorPanel.d.ts +19 -0
  213. package/types/src/named/NamedPlugin.d.ts +2 -0
  214. package/types/src/named/index.d.ts +8 -0
  215. package/types/src/numberFormat/NumberFormatPanel.d.ts +29 -0
  216. package/types/src/numberFormat/NumberFormatTaskPane.d.ts +12 -0
  217. package/types/src/numberFormat/index.d.ts +8 -0
  218. package/types/src/protectedRange/ProtectedRangeDetailsPanel.d.ts +20 -0
  219. package/types/src/protectedRange/ProtectedRangeDetailsTaskPane.d.ts +3 -0
  220. package/types/src/protectedRange/ProtectedRangeEditorPanel.d.ts +27 -0
  221. package/types/src/protectedRange/ProtectedRangePlugin.d.ts +2 -0
  222. package/types/src/protectedRange/index.d.ts +2 -0
  223. package/types/src/protection/WorkbookProtectionDialog.d.ts +23 -0
  224. package/types/src/protection/WorkbookProtectionPanel.d.ts +51 -0
  225. package/types/src/protection/index.d.ts +3 -0
  226. package/types/src/sheet/SheetTabMenu.d.ts +21 -0
  227. package/types/src/sheet/SheetsAllMenu.d.ts +16 -0
  228. package/types/src/sheet/index.d.ts +3 -0
  229. package/types/src/statusBar/NumberStats.d.ts +27 -0
  230. package/types/src/statusBar/SheetZoomScale.d.ts +11 -0
  231. package/types/src/statusBar/StatusBar.d.ts +35 -0
  232. package/types/src/statusBar/index.d.ts +4 -0
  233. package/types/src/studio/CommandsWrapper.d.ts +36 -0
  234. package/types/src/studio/DefaultLogo.d.ts +3 -0
  235. package/types/src/studio/EagerStudio.d.ts +5 -0
  236. package/types/src/studio/Studio.d.ts +26 -0
  237. package/types/src/studio/StudioCommandProvider.d.ts +26 -0
  238. package/types/src/studio/StudioCommands.d.ts +115 -0
  239. package/types/src/studio/StudioNotifierProvider.d.ts +10 -0
  240. package/types/src/studio/StudioProps.d.ts +372 -0
  241. package/types/src/studio/StudioSplitPane.d.ts +60 -0
  242. package/types/src/studio/StudioTaskPaneArea.d.ts +8 -0
  243. package/types/src/studio/StudioToolbar.d.ts +37 -0
  244. package/types/src/studio/index.d.ts +4 -0
  245. package/types/src/studio/useStudioApp.d.ts +51 -0
  246. package/types/src/table/TableDetailsPanel.d.ts +17 -0
  247. package/types/src/table/TableDetailsTaskPane.d.ts +3 -0
  248. package/types/src/table/TablePlugin.d.ts +2 -0
  249. package/types/src/table/TableStyleCanvasPreview.d.ts +21 -0
  250. package/types/src/table/TableStyleOptionsPanel.d.ts +38 -0
  251. package/types/src/table/TableStylePreview.d.ts +43 -0
  252. package/types/src/table/index.d.ts +7 -0
  253. package/types/src/theme/ThemeSelectButton.d.ts +23 -0
  254. package/types/src/theme/ThemeSelectPanel.d.ts +17 -0
  255. package/types/src/theme/ThemeSelectPopupButton.d.ts +24 -0
  256. package/types/src/theme/ThemeUtils.d.ts +57 -0
  257. package/types/src/theme/index.d.ts +5 -0
  258. package/types/src/toast/ToastError.d.ts +10 -0
  259. package/types/src/toast/index.d.ts +2 -0
  260. package/types/src/toolbar/WorkbookToolbars.d.ts +46 -0
  261. package/types/src/toolbar/index.d.ts +2 -0
  262. package/types/src/workbook/DefaultRenderers.d.ts +23 -0
  263. package/types/src/workbook/DocumentTitle.d.ts +69 -0
  264. package/types/src/workbook/WorkbookContextMenu.d.ts +13 -0
  265. package/types/src/workbook/WorkbookElement.d.ts +12 -0
  266. package/types/src/workbook/WorkbookStrip.d.ts +37 -0
  267. package/types/src/workbook/index.d.ts +7 -0
  268. package/browser/cjs/0DtrpXkQQehBmvSv.cjs +0 -6
  269. package/browser/cjs/6C3ia2nz4Zm-AdMZ.cjs +0 -7
  270. package/browser/cjs/BR_EGEaHisRrXAtK.cjs +0 -6
  271. package/browser/cjs/B_v_M4TiavtofChs.cjs +0 -42
  272. package/browser/cjs/C17p-h_nw582H7WD.cjs +0 -20
  273. package/browser/cjs/CInmVysdoHEvvW9h.cjs +0 -6
  274. package/browser/cjs/CMvQZPQsE7MuTMy_.cjs +0 -6
  275. package/browser/cjs/CkNt54AXVfJjIWja.cjs +0 -6
  276. package/browser/cjs/CtRvyhDzQxsk7dkI.cjs +0 -6
  277. package/browser/cjs/DN9cQ4_4ERQvzKn6.cjs +0 -6
  278. package/browser/cjs/DUTuBWUNF-w3Fxtb.cjs +0 -6
  279. package/browser/cjs/pTzEs1wlZj5Bb6xc.cjs +0 -18
  280. package/browser/esm/8ZnwcsRrGO3Nlw9Y.mjs +0 -54
  281. package/browser/esm/BFZ4oCbQukelEVLI.mjs +0 -53
  282. package/browser/esm/BP3nTf4-SLftsj61.mjs +0 -640
  283. package/browser/esm/BSMkBkXBQgZhX1xk.mjs +0 -2159
  284. package/browser/esm/CPLIJbynjEkwF2T0.mjs +0 -4533
  285. package/browser/esm/CuC13VFjBYFE7kub.mjs +0 -155
  286. package/browser/esm/Cw3i8T1tVnm8o6eB.mjs +0 -46
  287. package/browser/esm/D6E8W2KK4dGVRQO_.mjs +0 -25
  288. package/browser/esm/D8xc3AM9QHEqmpb9.mjs +0 -50
  289. package/browser/esm/DA_bEpA5kkn89fmW.mjs +0 -2411
  290. package/browser/esm/DVqOr-7nEXA7IjKJ.mjs +0 -26
  291. package/browser/esm/VAUOzclLs-dR9nt_.mjs +0 -50
  292. package/node/assets/style.css +0 -1
  293. package/node/esm/B9dvpdCD_p2q8aNP.mjs +0 -156
  294. package/node/esm/BBxZemzbmUkoOYdq.mjs +0 -46
  295. package/node/esm/BDdkV45Cf7BLs5jE.mjs +0 -25
  296. package/node/esm/BoX8OuVRgUNgw0Wb.mjs +0 -91
  297. package/node/esm/CPbwVoL6mq66TtTR.mjs +0 -53
  298. package/node/esm/DMd6h1vz-USluank.mjs +0 -88
  299. package/node/esm/DYgtaT_soTbSP8M9.mjs +0 -52
  300. package/node/esm/DxDGSRoOYlWydiwL.mjs +0 -57
  301. package/node/esm/OMgXBbHk-VRNKAop.mjs +0 -26
  302. package/node/esm/bGXLfLFngllNb8U1.mjs +0 -50
package/types/index.d.ts CHANGED
@@ -1,1761 +1,2 @@
1
- import { BoxProps } from '@mui/material';
2
- import { Command } from '@sheetxl/utils-react';
3
- import { CommandButtonOptions } from '@sheetxl/utils-react';
4
- import { CommandButtonProps } from '@sheetxl/utils-react';
5
- import { CommandButtonType } from '@sheetxl/utils-react';
6
- import { CommandContext } from '@sheetxl/react';
7
- import { CommandPopupButtonProps } from '@sheetxl/utils-mui';
8
- import { default as default_2 } from 'react';
9
- import { DefaultTaskPaneRegistry } from '@sheetxl/react';
10
- import { ErrorPanelProps } from '@sheetxl/utils-react';
11
- import { ExhibitIconButtonProps } from '@sheetxl/utils-mui';
12
- import { ExhibitPopupButtonProps } from '@sheetxl/utils-mui';
13
- import { ExhibitPopupIconButtonProps } from '@sheetxl/utils-mui';
14
- import { FloatReference } from '@sheetxl/utils-mui';
15
- import { FormControlProps } from '@mui/material';
16
- import { GetFormatsOptions } from '@sheetxl/io';
17
- import { GridStyle } from '@sheetxl/grid-react';
18
- import { GridSurfaceStyle } from '@sheetxl/grid-react';
19
- import { IAutoFilter } from '@sheetxl/sdk';
20
- import { IBorder } from '@sheetxl/sdk';
21
- import { ICellRanges } from '@sheetxl/sdk';
22
- import { IColor } from '@sheetxl/sdk';
23
- import { ICommand } from '@sheetxl/utils-react';
24
- import { ICommands } from '@sheetxl/utils-react';
25
- import { IMovable } from '@sheetxl/sdk';
26
- import { INamedCollection } from '@sheetxl/sdk';
27
- import { IReactNotifier } from '@sheetxl/utils-react';
28
- import { ISheet } from '@sheetxl/sdk';
29
- import { ISheetElement } from '@sheetxl/react';
30
- import { IStyle } from '@sheetxl/sdk';
31
- import { IStyleCollection } from '@sheetxl/sdk';
32
- import { ITable } from '@sheetxl/sdk';
33
- import { ITableStyle } from '@sheetxl/sdk';
34
- import { ITheme } from '@sheetxl/sdk';
35
- import { IThemeCollection } from '@sheetxl/sdk';
36
- import { IWorkbook } from '@sheetxl/sdk';
37
- import { IWorkbookIO } from '@sheetxl/io';
38
- import { JSX } from 'react/jsx-runtime';
39
- import { LicenseDetails } from '@sheetxl/sdk';
40
- import { LicenseManager } from '@sheetxl/sdk';
41
- import { LoadingPanelProps } from '@sheetxl/utils-react';
42
- import { PaperProps } from '@mui/material';
43
- import { PopupButtonType } from '@sheetxl/utils-mui';
44
- import { ReadFormatType } from '@sheetxl/io';
45
- import { ReadWorkbookOptions } from '@sheetxl/io';
46
- import { RegisterOptions } from 'react-hook-form';
47
- import { SheetProps } from '@sheetxl/react';
48
- import { SvgIconProps } from '@mui/material';
49
- import { SxProps } from '@mui/system';
50
- import { TabProps } from '@sheetxl/react';
51
- import { TabStripRef } from '@sheetxl/react';
52
- import { TaskPaneProps } from '@sheetxl/react';
53
- import { Theme } from '@mui/material/styles';
54
- import { ThemeModeOptions } from '@sheetxl/utils-mui';
55
- import { ToolbarProps } from '@mui/material';
56
- import { UndoManager } from '@sheetxl/utils';
57
- import { useModelListener } from '@sheetxl/react';
58
- import { useRangeListener } from '@sheetxl/react';
59
- import { WriteFormatType } from '@sheetxl/io';
60
- import { WriteWorkbookOptions } from '@sheetxl/io';
61
-
62
- export declare const AppearanceCommandButton: default_2.NamedExoticComponent<Omit<CommandPopupButtonProps<any, any>, "ref"> & default_2.RefAttributes<HTMLElement>>;
63
-
64
- export declare const AutoColorPosition: {
65
- readonly Start: "start";
66
- readonly End: "end";
67
- };
68
-
69
- export declare type AutoColorPosition = typeof AutoColorPosition[keyof typeof AutoColorPosition];
70
-
71
- /**
72
- * Implement disabled
73
- * Set command on selected
74
- */
75
- export declare const BorderCommandButton: default_2.NamedExoticComponent<Omit<BorderCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
76
-
77
- export declare interface BorderCommandButtonProps extends Omit<Partial<BorderPopupButtonProps>, "icon" | "label"> {
78
- commands?: ICommands.IGroup;
79
- command?: ICommand<Partial<IBorder.Properties>, CommandContext.Border>;
80
- icon?: default_2.ReactNode | ((command: ICommand) => default_2.ReactNode);
81
- label?: default_2.ReactNode | ((command: ICommand) => default_2.ReactNode);
82
- /**
83
- * Allow for listeners against a specific buttons execute rather than the command.
84
- *
85
- * @remarks
86
- * Useful when knowing the specific button that executed a command is required.
87
- * (For example when closing menus or restoring focus)
88
- */
89
- commandHook?: ICommand.Hook<any, any>;
90
- /**
91
- * Styling
92
- * @defaultValue CommandButtonType.Toolbar
93
- */
94
- variant?: CommandButtonType;
95
- darkMode?: boolean;
96
- }
97
-
98
- export declare const BorderPopupButton: default_2.NamedExoticComponent<Omit<BorderPopupButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
99
-
100
- export declare interface BorderPopupButtonProps extends Omit<ExhibitPopupIconButtonProps, "color" | "icon" | "createPopupPanel"> {
101
- selectedBorder: Partial<IBorder.Properties>;
102
- /**
103
- * Create a border.
104
- */
105
- createTemporaryBorder: (props: Partial<IBorder.Properties>) => IBorder;
106
- /**
107
- * For color picker.
108
- */
109
- schemeLookup: IColor.SchemeLookup;
110
- /**
111
- * If autoColor is set the a special Swatch is create that will
112
- * disable this color. When it is selected or previewed the color
113
- * passed will be null any consumer will then know to use the auto color
114
- */
115
- autoColor?: IColor;
116
- darkMode?: boolean;
117
- /**
118
- * If no values are specified
119
- */
120
- autoStrokeStyle?: IBorder.StrokeStyle;
121
- showStylingBefore?: boolean;
122
- onSelectBorder?: (border: Partial<IBorder.Properties> | null) => void;
123
- onPreviewBorder?: (border: Partial<IBorder.Properties> | null) => void;
124
- }
125
-
126
- export declare const BorderStylePopupButton: default_2.NamedExoticComponent<Omit<BorderStylePopupButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
127
-
128
- export declare interface BorderStylePopupButtonProps extends ExhibitPopupButtonProps {
129
- selectedStyle: IBorder.StrokeStyle;
130
- onSelectStyle?: (style: IBorder.StrokeStyle | null) => void;
131
- /**
132
- * Rendering styles
133
- * @defaultValue to Toolbar
134
- */
135
- variant?: PopupButtonType;
136
- /**
137
- * @defaultValue false
138
- */
139
- showLabels?: boolean;
140
- /**
141
- * Where there are any custom borders
142
- * @remarks
143
- * None does not mean there is no gridline just no custom border. Excel doesn't have a way to partially remove gridlines.
144
- * We could accomplish this by adding a transparent border.
145
- *
146
- * @defaultValue true
147
- */
148
- showNone?: boolean;
149
- styleColor?: IColor;
150
- darkMode?: boolean;
151
- }
152
-
153
- export declare const CellsDeleteCommandButton: default_2.NamedExoticComponent<Omit<CellsDeleteCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
154
-
155
- export declare interface CellsDeleteCommandButtonProps extends CommandPopupButtonProps {
156
- disableSheet?: boolean;
157
- /**
158
- * If set to `true` only a single menu will be shown instead of a popup if
159
- * only one command is enabled. Useful for adding or removing rows/column on headers.
160
- *
161
- * @remarks
162
- * This is only considered for the `MenuButton` Variant.
163
- */
164
- preferSingleMenu?: boolean;
165
- showQuickButton?: boolean;
166
- }
167
-
168
- /**
169
- * Menu for cell formatting
170
- */
171
- export declare const CellsFormatCommandButton: default_2.NamedExoticComponent<CellsFormatCommandButtonProps & default_2.RefAttributes<HTMLElement>>;
172
-
173
- export declare interface CellsFormatCommandButtonProps extends CommandButtonOptions {
174
- parentFloat: FloatReference;
175
- commands: ICommands.IGroup;
176
- }
177
-
178
- export declare const CellsInsertCommandButton: default_2.NamedExoticComponent<Omit<CellsInsertCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
179
-
180
- export declare interface CellsInsertCommandButtonProps extends CommandPopupButtonProps {
181
- disableSheet?: boolean;
182
- /**
183
- * If set to `true` only a single menu will be shown instead of a popup if
184
- * only one command is enabled. Useful for adding or removing rows/column on headers.
185
- *
186
- * @remarks
187
- * This is only considered for the `MenuButton` Variant.
188
- */
189
- preferSingleMenu?: boolean;
190
- showQuickButton?: boolean;
191
- }
192
-
193
- export declare const ClearCommandButton: default_2.NamedExoticComponent<Omit<ClearCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
194
-
195
- export declare interface ClearCommandButtonProps extends CommandPopupButtonProps {
196
- }
197
-
198
- /**
199
- * Given a colorDef Provides a color preview as a swatch, a tooltip, and returns an adjusted color.
200
- */
201
- export declare const ColorButton: default_2.MemoExoticComponent<(props: ColorButtonProps) => JSX.Element>;
202
-
203
- export declare const ColorButtonList: default_2.FC<ColorButtonListProps>;
204
-
205
- export declare interface ColorButtonListProps extends default_2.HTMLAttributes<HTMLElement> {
206
- title?: string;
207
- colorDefs: IColor.DefinitionWithLabel[] | IColor.DefinitionWithLabel[][];
208
- schemeColorLookup: IColor.SchemeLookup;
209
- selectedColor?: IColor;
210
- previewColor?: IColor;
211
- onSelectColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
212
- onPreviewColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
213
- propsSwatch?: Partial<SwatchProps>;
214
- compareRGB?: boolean;
215
- darkMode?: boolean;
216
- }
217
-
218
- export declare interface ColorButtonProps extends default_2.HTMLAttributes<HTMLElement> {
219
- colorDef: IColor.DefinitionWithLabel;
220
- schemeColorLookup: IColor.SchemeLookup;
221
- selectedColor: IColor;
222
- previewColor?: IColor;
223
- onSelectColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
224
- onPreviewColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
225
- propsSwatch?: Partial<SwatchProps>;
226
- defaultButtonSize?: number;
227
- isLarge?: boolean;
228
- compareRGB?: boolean;
229
- darkMode?: boolean;
230
- }
231
-
232
- export declare const ColorCommandButton: default_2.NamedExoticComponent<Omit<ColorCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
233
-
234
- /**
235
- * Wraps ColorPopupButton with a command.
236
- */
237
- export declare interface ColorCommandButtonProps extends Omit<ColorPopupButtonProps, "selectedColor" | "variant" | "icon" | "label"> {
238
- command: Command<IColor, CommandContext.Color>;
239
- /**
240
- * Allow for listeners against a specific buttons execute rather than the command.
241
- *
242
- * @remarks
243
- * Useful when knowing the specific button that executed a command is required.
244
- * (For example when closing menus or restoring focus)
245
- */
246
- commandHook?: ICommand.Hook<any, any>;
247
- icon?: default_2.ReactNode | ((command: ICommand) => default_2.ReactNode);
248
- label?: default_2.ReactNode | ((command: ICommand) => default_2.ReactNode);
249
- /**
250
- * Styling
251
- * @defaultValue CommandButtonType.Toolbar
252
- */
253
- variant?: CommandButtonType;
254
- /**
255
- * Hint to indicate to the popup to behave like a split button even if no commands is available.
256
- */
257
- isSplit?: boolean;
258
- darkMode?: boolean;
259
- }
260
-
261
- /**
262
- * A color panel that has a list of presets and a way to make custom colors.
263
- */
264
- export declare const ColorPanel: default_2.NamedExoticComponent<ColorPanelProps & default_2.RefAttributes<HTMLElement>>;
265
-
266
- export declare interface ColorPanelProps extends default_2.HTMLAttributes<HTMLElement> {
267
- width?: number;
268
- /**
269
- * Defaults to 24px
270
- */
271
- defaultButtonSize?: number;
272
- /**
273
- * Required to generate theme palettes. If not specified then DocTheme colors are used
274
- */
275
- schemeLookup?: IColor.SchemeLookup;
276
- recentColors?: readonly IColor[] | (() => readonly IColor[]);
277
- /**
278
- * Defaults to false
279
- */
280
- disableAlpha?: boolean;
281
- darkMode?: boolean;
282
- selectedColor: IColor;
283
- previewColor?: IColor;
284
- onSelectColor?: (color: IColor | null, isCustom: boolean) => void;
285
- onPreviewColor?: (color: IColor | null) => void;
286
- onPreviewColorImmediate?: (color: IColor | null) => void;
287
- previewDebounceTime?: number;
288
- /**
289
- * If autoColor is set then a special Swatch is created that will
290
- * use this color. When it is selected or previewed the color
291
- * passed will be null any consumer will then know to use the auto color
292
- */
293
- autoColor?: IColor;
294
- /**
295
- * If autoColor is specified then a label will be shown.
296
- * This is ignored if autoColor is not specified.
297
- * @defaultValue Automatic
298
- */
299
- autoColorLabel?: NonNullable<default_2.ReactNode>;
300
- /**
301
- * If autoColor is specified then a label will be shown.
302
- * This is ignored if autoColor is not specified.
303
- * @defaultValue AutoColorPosition.Start
304
- */
305
- autoColorPosition?: AutoColorPosition;
306
- /**
307
- * If not specified or null then this will be determined based on whether the selected color is available in the
308
- * presets (not include recent)
309
- */
310
- initialPanelType?: ColorPanelType;
311
- onEyeDropStart?: () => void;
312
- onEyeDropStop?: () => void;
313
- onDone?: () => void;
314
- onElementLoad?: () => void;
315
- /**
316
- * Determines if Adjustable colors with similar RGB values are considered the same.
317
- * @defaultValue false
318
- */
319
- compareRGB?: boolean;
320
- }
321
-
322
- export declare const ColorPanelType: {
323
- readonly Preset: "preset";
324
- readonly Custom: "custom";
325
- };
326
-
327
- export declare type ColorPanelType = typeof ColorPanelType[keyof typeof ColorPanelType];
328
-
329
- export declare const ColorPopupButton: default_2.NamedExoticComponent<Omit<ColorPopupButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
330
-
331
- export declare interface ColorPopupButtonProps extends Omit<ExhibitPopupIconButtonProps, "color" | "createPopupPanel"> {
332
- selectedColor: IColor;
333
- onSelectColor?: (color: IColor | null, isCustom: boolean) => void;
334
- onPreviewColor?: (color: IColor | null) => void;
335
- onPreviewColorImmediate?: (color: IColor | null) => void;
336
- /**
337
- * A short cut for a quick color. This is generally the last color chosen
338
- */
339
- quickColor?: IColor;
340
- /**
341
- * Rendering styles
342
- * @defaultValue to Toolbar
343
- */
344
- variant?: PopupButtonType;
345
- propsPanel?: Partial<ColorPanelProps>;
346
- /**
347
- * When closing the popup closeAll movables or just the current.
348
- * @defaultValue true
349
- */
350
- shouldCloseFloatAll?: boolean;
351
- compareRGB?: boolean;
352
- darkMode?: boolean;
353
- }
354
-
355
- /**
356
- * Creates a gridStyle from a MUI theme
357
- * @param appTheme The outer theme used for toolbars and any containing application.
358
- * @param bodyTheme The theme used specifically for the grid.
359
- * @returns A `GridStyle` that merges appTheme and bodyTheme.
360
- */
361
- export declare const createGridStyleFromMUITheme: (appTheme: Theme, bodyTheme?: Theme) => GridStyle;
362
-
363
- export declare const CustomColorPanel: default_2.FC<CustomColorPanelProps>;
364
-
365
- /**
366
- * This is a standard color panel.
367
- */
368
- export declare interface CustomColorPanelProps extends default_2.HTMLAttributes<HTMLElement> {
369
- selectedColor: string;
370
- onColorChange: (color: string) => void;
371
- /**
372
- * Defaults to false
373
- */
374
- disableAlpha?: boolean;
375
- renderers?: any;
376
- }
377
-
378
- export { DefaultTaskPaneRegistry }
379
-
380
- export declare const DocThemeCommandButton: default_2.NamedExoticComponent<Omit<DocThemeCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
381
-
382
- export declare interface DocThemeCommandButtonProps extends Omit<ThemeSelectPopupButtonProps, "createPopupPanel" | "variant" | "themes" | "icon" | "label"> {
383
- command: ICommand<ITheme, CommandContext.Theme>;
384
- icon?: default_2.ReactNode | ((command: ICommand) => default_2.ReactNode);
385
- label?: default_2.ReactNode | ((command: ICommand) => default_2.ReactNode);
386
- /**
387
- * Allow for listeners against a specific buttons execute rather than the command.
388
- *
389
- * @remarks
390
- * Useful when knowing the specific button that executed a command is required.
391
- * (For example when closing menus or restoring focus)
392
- */
393
- commandHook?: ICommand.Hook<any, any>;
394
- selectedTheme?: ITheme;
395
- onSelectTheme?: (docTheme: ITheme) => void;
396
- /**
397
- * Styling
398
- * @defaultValue CommandButtonType.Toolbar
399
- */
400
- variant?: CommandButtonType;
401
- darkMode?: boolean;
402
- }
403
-
404
- /**
405
- * Fully functional application. Wraps a workbook in a simple container for a standalone application.
406
- * Minimum usefulness is:
407
- * * resolve initial workbook and loading panel
408
- * * workbook
409
- * * snackbar
410
- * * export/import to local file system
411
- * * file name
412
- * * material-ui theme for light/dark toggle
413
- */
414
- export declare const EagerStudio: default_2.NamedExoticComponent<Omit<StudioProps, "ref"> & default_2.RefAttributes<IWorkbookElement>>;
415
-
416
- export declare const FillCommandButton: default_2.NamedExoticComponent<Omit<FillCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
417
-
418
- export declare interface FillCommandButtonProps extends CommandPopupButtonProps {
419
- }
420
-
421
- /**
422
- * FilterColumnMenu component to provide a menu for filter column actions.
423
- */
424
- export declare const FilterColumnMenu: default_2.NamedExoticComponent<FilterColumnMenuProps & default_2.RefAttributes<HTMLDivElement>>;
425
-
426
- export declare interface FilterColumnMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
427
- filter: IAutoFilter.IColumn;
428
- commands?: ICommands.IGroup;
429
- disabled?: boolean;
430
- floatReference: FloatReference;
431
- }
432
-
433
- /**
434
- * PLACEHOLDER for FilterCommandButton.
435
- *
436
- * Popup menu on the Filter button. (should we merge this with the sort menu?)
437
- */
438
- export declare const FilterCommandButton: default_2.NamedExoticComponent<Omit<CommandPopupButtonProps<any, any>, "ref"> & default_2.RefAttributes<HTMLElement>>;
439
-
440
- export declare const Filters: default_2.NamedExoticComponent<Omit<FiltersProps, "ref"> & default_2.RefAttributes<IFiltersElement>>;
441
-
442
- export declare interface FiltersAttributes {
443
- isFilters: () => true;
444
- }
445
-
446
- export declare interface FiltersProps extends default_2.HTMLAttributes<HTMLDivElement> {
447
- /**
448
- * The filter to display.
449
- */
450
- filter: IAutoFilter.IColumn;
451
- /**
452
- * Disables the filter UI.
453
- */
454
- disabled?: boolean;
455
- /**
456
- * Ref for the Element.
457
- */
458
- ref?: default_2.Ref<IFiltersElement>;
459
- }
460
-
461
- /**
462
- * Menu for Find options
463
- */
464
- export declare const FindCommandButton: default_2.NamedExoticComponent<Omit<FindCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
465
-
466
- export declare interface FindCommandButtonProps extends CommandPopupButtonProps {
467
- }
468
-
469
- export declare const FontFamilyCommandButton: default_2.NamedExoticComponent<Omit<FontFamilyCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
470
-
471
- export declare interface FontFamilyCommandButtonProps extends Omit<ExhibitPopupIconButtonProps, "color" | "icon" | "label" | "createPopupPanel"> {
472
- command: Command<string>;
473
- icon?: default_2.ReactNode | ((command: ICommand) => default_2.ReactNode);
474
- label?: default_2.ReactNode | ((command: ICommand) => default_2.ReactNode);
475
- /**
476
- * Allow for listeners against a specific buttons execute rather than the command.
477
- *
478
- * @remarks
479
- * Useful when knowing the specific button that executed a command is required.
480
- * (For example when closing menus or restoring focus)
481
- */
482
- commandHook?: ICommand.Hook<any, any>;
483
- }
484
-
485
- /**
486
- * TODO - add divider and increase/decrease as quick buttons??
487
- */
488
- export declare const FontSizeCommandButton: default_2.NamedExoticComponent<Omit<FontSizeCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
489
-
490
- export declare interface FontSizeCommandButtonProps extends Omit<ExhibitPopupIconButtonProps, "color" | "icon" | "label" | "createPopupPanel"> {
491
- command?: Command<number>;
492
- icon?: default_2.ReactNode | ((command: ICommand) => default_2.ReactNode);
493
- label?: default_2.ReactNode | ((command: ICommand) => default_2.ReactNode);
494
- /**
495
- * Allow for listeners against a specific buttons execute rather than the command.
496
- *
497
- * @remarks
498
- * Useful when knowing the specific button that executed a command is required.
499
- * (For example when closing menus or restoring focus)
500
- */
501
- commandHook?: ICommand.Hook<any, any>;
502
- /**
503
- * defaults the the Excel fontSizes
504
- */
505
- fontSizes?: number[];
506
- /**
507
- * Show quickButtons. Requires commands to be set.
508
- * @defaultValue false
509
- */
510
- showQuickButtons?: boolean;
511
- commands?: ICommands.IGroup;
512
- }
513
-
514
- /**
515
- * This tracks the selection of the sheet and
516
- * updates the a named range editor and a sheet cell editor.
517
- */
518
- export declare const FormulaBar: default_2.NamedExoticComponent<Omit<FormulaBarProps, "ref"> & default_2.RefAttributes<IFormulaBarElement>>;
519
-
520
- export declare interface FormulaBarAttributes {
521
- isFormulaBarElement: () => true;
522
- getNamedCollectionEditorElement: () => INamedCollectionEditorElement;
523
- }
524
-
525
- export declare interface FormulaBarProps extends default_2.HTMLAttributes<HTMLDivElement> {
526
- /**
527
- * The workbook that is used for the range.use
528
- */
529
- workbook?: IWorkbook;
530
- /**
531
- * Used for startEdit and focus
532
- */
533
- sheetElement?: ISheetElement;
534
- /**
535
- * If the NamedCollectionEditor should be shown.
536
- * @defaultValue true
537
- */
538
- showNamedCollectionEditor?: boolean;
539
- /**
540
- * Allow for customizations on NamedCollectionEditor
541
- */
542
- propsNamedCollectionEditor?: NamedCollectionEditorProps;
543
- /**
544
- * Override the default NamedCollectionEditor
545
- */
546
- renderNamedCollectionEditor?: (props: NamedCollectionEditorProps, ref: default_2.Ref<INamedCollectionEditorElement>) => default_2.ReactElement;
547
- /**
548
- * Key down listeners
549
- */
550
- commands?: ICommands.IGroup;
551
- /**
552
- * Disabled the ui.
553
- */
554
- disabled?: boolean;
555
- /**
556
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
557
- */
558
- sx?: SxProps<Theme>;
559
- /**
560
- * The grid style to use for the cell editor.
561
- */
562
- gridStyle?: GridStyle;
563
- /**
564
- * Ref for the FormulaBar element.
565
- */
566
- ref?: default_2.Ref<IFormulaBarElement>;
567
- }
568
-
569
- /**
570
- * Menu for freeze options
571
- */
572
- export declare const FreezeCommandButton: default_2.NamedExoticComponent<Omit<CommandPopupButtonProps<any, any>, "ref"> & default_2.RefAttributes<HTMLElement>>;
573
-
574
- export declare const HelpCommandButton: default_2.NamedExoticComponent<Omit<HelpCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
575
-
576
- export declare interface HelpCommandButtonProps extends CommandPopupButtonProps {
577
- }
578
-
579
- export declare const HorizontalAlignCommandButton: default_2.NamedExoticComponent<Omit<CommandPopupButtonProps<any, any>, "ref"> & default_2.RefAttributes<HTMLElement>>;
580
-
581
- export declare interface IFiltersElement extends HTMLDivElement, FiltersAttributes {
582
- }
583
-
584
- /**
585
- * Type returned via ref property
586
- */
587
- export declare interface IFormulaBarElement extends FormulaBarAttributes, HTMLElement {
588
- }
589
-
590
- /**
591
- * Type returned via ref property
592
- */
593
- export declare interface INamedCollectionEditorElement extends NamedCollectionEditorAttributes, HTMLDivElement {
594
- }
595
-
596
- export declare interface InsertFunctionCommandButtonProps extends CommandPopupButtonProps {
597
- category: string;
598
- icon?: default_2.ReactNode | ((command: ICommand) => default_2.ReactNode);
599
- label?: default_2.ReactNode | ((command: ICommand) => default_2.ReactNode);
600
- /**
601
- * Allow for listeners against a specific buttons execute rather than the command.
602
- *
603
- * @remarks
604
- * Useful when knowing the specific button that executed a command is required.
605
- * (For example when closing menus or restoring focus)
606
- */
607
- commandHook?: ICommand.Hook<any, any>;
608
- }
609
-
610
- export declare const InsertFunctionCommandPopupButton: default_2.NamedExoticComponent<Omit<InsertFunctionCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
611
-
612
- /**
613
- * Menu for quick function sum
614
- */
615
- export declare const InsertFunctionSumCommandPopupButton: default_2.NamedExoticComponent<InsertFunctionSumCommandPopupButtonProps & default_2.RefAttributes<HTMLElement>>;
616
-
617
- export declare interface InsertFunctionSumCommandPopupButtonProps extends CommandButtonOptions {
618
- parentFloat: FloatReference;
619
- commands: ICommands.IGroup;
620
- }
621
-
622
- export declare const InsertImageCommandButton: default_2.NamedExoticComponent<Omit<InsertImageCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
623
-
624
- export declare interface InsertImageCommandButtonProps extends CommandPopupButtonProps {
625
- /**
626
- * If set to `true` only a single menu will be shown instead of a popup if
627
- * only one command is enabled. Useful for adding or removing rows/column on headers.
628
- *
629
- * @remarks
630
- * This is only considered for `MenuButton` Variant.
631
- */
632
- preferSingleMenu?: boolean;
633
- showQuickButton?: boolean;
634
- }
635
-
636
- /**
637
- * Workbook specific attributes beyond HTMLDivElement.
638
- */
639
- export declare interface IWorkbookAttributes {
640
- isWorkbookElement: () => true;
641
- getWorkbook: () => IWorkbook;
642
- getViewportElement: () => HTMLElement;
643
- getSheetElement: () => ISheetElement;
644
- getFormulaBarElement: () => IFormulaBarElement;
645
- }
646
-
647
- /**
648
- * Type returned via ref property
649
- */
650
- export declare interface IWorkbookElement extends HTMLDivElement, IWorkbookAttributes {
651
- }
652
-
653
- /**
654
- * Type returned via ref property
655
- */
656
- export declare interface IWorkbookTitleElement extends HTMLDivElement, WorkbookTitleAttributes {
657
- }
658
-
659
- export { LicenseDetails }
660
-
661
- export { LicenseManager }
662
-
663
- /**
664
- * Menu for merge options
665
- */
666
- export declare const MergeCommandButton: default_2.NamedExoticComponent<Omit<MergeCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
667
-
668
- export declare interface MergeCommandButtonProps extends CommandPopupButtonProps {
669
- }
670
-
671
- declare interface MovableContextMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
672
- movable: IMovable;
673
- commands?: ICommands.IGroup;
674
- disabled?: boolean;
675
- /**
676
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
677
- */
678
- sx?: SxProps<Theme>;
679
- floatReference: FloatReference;
680
- }
681
-
682
- /**
683
- * Editor used for selecting, editing, or removing named ranges.
684
- */
685
- export declare const NamedCollectionEditor: default_2.NamedExoticComponent<Omit<NamedCollectionEditorProps, "ref"> & default_2.RefAttributes<INamedCollectionEditorElement>>;
686
-
687
- export declare interface NamedCollectionEditorAttributes {
688
- }
689
-
690
- export declare interface NamedCollectionEditorProps extends default_2.HTMLAttributes<HTMLDivElement> {
691
- /**
692
- * The named ranges
693
- */
694
- names: INamedCollection;
695
- /**
696
- * The workbook
697
- */
698
- workbook: IWorkbook;
699
- /**
700
- * Returns focus to primary.
701
- * @remarks
702
- * Removes the FloatReference is used.
703
- */
704
- restoreFocus?: (options?: FocusOptions) => void;
705
- /**
706
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
707
- */
708
- sx?: SxProps<Theme>;
709
- disabled?: boolean;
710
- readonly?: boolean;
711
- parentFloat?: FloatReference;
712
- propsCommandPopupButton?: CommandPopupButtonProps;
713
- /**
714
- * Reference to the underlying element
715
- */
716
- ref?: default_2.Ref<INamedCollectionEditorElement>;
717
- }
718
-
719
- /**
720
- * NamedItem input field.
721
- */
722
- export declare const NamedInput: default_2.NamedExoticComponent<Omit<NamedInputProps, "ref"> & default_2.RefAttributes<HTMLDivElement>>;
723
-
724
- export declare interface NamedInputProps extends FormControlProps {
725
- /**
726
- * The current value
727
- */
728
- value?: string;
729
- /**
730
- * INotifier of the value change
731
- */
732
- onChangeInput?: (value: string) => void;
733
- /**
734
- * If exception then throw error.
735
- *
736
- * @param text
737
- */
738
- onValidate?: (text: string) => void;
739
- /**
740
- * A default value.
741
- */
742
- defaultInput?: string;
743
- /**
744
- * If provided will register with react-hook-form.
745
- *
746
- * @remarks
747
- * We don't support changing the formName once rendered.
748
- * @see {@link https://react-hook-form.com}
749
- */
750
- formName?: string;
751
- /**
752
- * React-hook-form options.
753
- * @remarks
754
- * This is only used if formName is provided.
755
- */
756
- formOptions?: RegisterOptions;
757
- /**
758
- * Underling reference to the input element.
759
- */
760
- ref?: default_2.Ref<HTMLDivElement>;
761
- }
762
-
763
- export declare const NumberFormatCommandButton: default_2.NamedExoticComponent<Omit<NumberFormatCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
764
-
765
- export declare interface NumberFormatCommandButtonProps extends CommandPopupButtonProps {
766
- }
767
-
768
- /**
769
- * Menu for paste options
770
- */
771
- export declare const PasteCommandButton: default_2.NamedExoticComponent<Omit<PasteCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
772
-
773
- export declare interface PasteCommandButtonProps extends CommandPopupButtonProps {
774
- command: Command<void>;
775
- /**
776
- * Duplicate the paste all in the popup as well as the quick button
777
- * @defaultValue true
778
- */
779
- includePasteAllInPopup?: boolean;
780
- }
781
-
782
- export declare const PresetCellStylesCommandButton: default_2.NamedExoticComponent<Omit<PresetCellStylesCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
783
-
784
- export declare interface PresetCellStylesCommandButtonProps extends CommandPopupButtonProps {
785
- command: ICommand<IStyle.INamed, CommandContext.NamedStyle>;
786
- /**
787
- * Allow for listeners against a specific buttons execute rather than the command.
788
- *
789
- * @remarks
790
- * Useful when knowing the specific button that executed a command is required.
791
- * (For example when closing menus or restoring focus)
792
- */
793
- commandHook?: ICommand.Hook<any, any>;
794
- selectedNamed?: IStyle.INamed;
795
- onSelectNamed?: (style: IStyle.INamed) => void;
796
- bodyStyle?: GridSurfaceStyle;
797
- usePreviewIcon?: boolean;
798
- }
799
-
800
- export declare const PresetTableStylesCommandButton: default_2.NamedExoticComponent<Omit<PresetTableStylesCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
801
-
802
- export declare interface PresetTableStylesCommandButtonProps extends CommandPopupButtonProps {
803
- command: ICommand<ITableStyle.StyleOptions, CommandContext.Table>;
804
- /**
805
- * Allow for listeners against a specific buttons execute rather than the command.
806
- *
807
- * @remarks
808
- * Useful when knowing the specific button that executed a command is required.
809
- * (For example when closing menus or restoring focus)
810
- */
811
- commandHook?: ICommand.Hook<any, any>;
812
- selectedTable?: ITable;
813
- onSelectTableStyleName?: (styleName: string) => void;
814
- bodyStyle?: GridSurfaceStyle;
815
- usePreviewIcon?: boolean;
816
- disabledQuickKey?: boolean;
817
- }
818
-
819
- /**
820
- * Range input field.
821
- */
822
- export declare const RangeInput: default_2.NamedExoticComponent<Omit<RangeInputProps, "ref"> & default_2.RefAttributes<HTMLDivElement>>;
823
-
824
- export declare interface RangeInputProps extends FormControlProps {
825
- /**
826
- * If provided will be register with react-hook-form.
827
- *
828
- * @remarks
829
- * We don't support changing the formName once rendered.
830
- * @see
831
- * {@link https://react-hook-form.com/}
832
- */
833
- formName?: string;
834
- /**
835
- * React-hook-form options.
836
- *
837
- * @remarks
838
- * Only used if formName is provided.
839
- */
840
- formOptions?: RegisterOptions;
841
- /**
842
- * The current value.
843
- */
844
- value: ICellRanges;
845
- /**
846
- * INotifier of the value change. If unable to parse the Range will notify with `null`.
847
- */
848
- onChangeInput?: (value: ICellRanges | null) => void;
849
- /**
850
- * Required to create ranges.
851
- *
852
- * @param address
853
- */
854
- resolvedAddress: (address: ICellRanges.Address) => ICellRanges;
855
- /**
856
- * Reference to the element.
857
- */
858
- ref?: default_2.Ref<HTMLDivElement>;
859
- }
860
-
861
- export declare interface RequestTitleOptions extends FocusOptions {
862
- selectAll?: boolean;
863
- requestReason?: string;
864
- }
865
-
866
- /**
867
- * By default we will print examples message if dev and eval only
868
- *
869
- * @param forcePrintExamples
870
- * @hidden
871
- */
872
- export declare const setPrintExamplesOnLoad: (forcePrintExamples: boolean) => void;
873
-
874
- /**
875
- * Menu showing all sheets in the workbook.
876
- */
877
- export declare const SheetsAllMenu: default_2.NamedExoticComponent<SheetsAllMenuProps & default_2.RefAttributes<HTMLDivElement>>;
878
-
879
- export declare interface SheetsAllMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
880
- /**
881
- * The workbook
882
- */
883
- workbook: IWorkbook;
884
- gridStyle?: GridStyle;
885
- /**
886
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
887
- */
888
- sx?: SxProps<Theme>;
889
- floatReference: FloatReference;
890
- closeFloatAll: () => void;
891
- }
892
-
893
- /**
894
- * A tab representing a sheet in a workbook.
895
- */
896
- export declare const SheetTab: default_2.NamedExoticComponent<TabProps & default_2.RefAttributes<HTMLElement>>;
897
-
898
- /**
899
- * Menu for sheet tab operations such as renaming, deleting, and coloring.
900
- */
901
- export declare const SheetTabMenu: default_2.NamedExoticComponent<SheetTabMenuProps & default_2.RefAttributes<HTMLDivElement>>;
902
-
903
- export declare interface SheetTabMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
904
- /**
905
- * The workbook.
906
- */
907
- workbook: IWorkbook;
908
- index: number;
909
- commands: ICommands.IGroup;
910
- scope?: string;
911
- disabled?: boolean;
912
- floatReference: FloatReference;
913
- /**
914
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
915
- */
916
- sx?: SxProps<Theme>;
917
- tabStripRef?: TabStripRef;
918
- }
919
-
920
- export declare interface SheetTabProps extends TabProps {
921
- /**
922
- * The sheet
923
- */
924
- sheet: ISheet;
925
- /**
926
- * Allow you to specify a specific material ui theme for the grid.
927
- *
928
- * * @defaultValue - the current Theme.
929
- *
930
- * @remarks
931
- * Useful for decorating the application with a single theme (such as dark mode) but render
932
- * the main grid using a different theme (for example light mode).
933
- */
934
- gridTheme?: Theme;
935
- /**
936
- * The rounded tab radius
937
- */
938
- tabRadius?: number;
939
- }
940
-
941
- export declare const SheetZoomScale: default_2.NamedExoticComponent<Omit<SheetZoomScaleProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
942
-
943
- export declare interface SheetZoomScaleProps extends BoxProps {
944
- /**
945
- * The Sheet
946
- */
947
- sheet: ISheet;
948
- /**
949
- * When dragging slider.
950
- * @defaultValue 220
951
- */
952
- debounceDelay?: number;
953
- }
954
-
955
- export declare const SortFilterCommandButton: default_2.NamedExoticComponent<Omit<CommandPopupButtonProps<any, any>, "ref"> & default_2.RefAttributes<HTMLElement>>;
956
-
957
- /**
958
- * This show the current cell state as an unstyled editable field.
959
- * This wraps this with material styling and submit and cancel buttons
960
- */
961
- export declare const StatusBar: default_2.NamedExoticComponent<Omit<StatusBarProps, "ref"> & default_2.RefAttributes<StatusBarElement>>;
962
-
963
- export declare interface StatusBarAttributes {
964
- }
965
-
966
- export declare interface StatusBarElement extends HTMLDivElement, StatusBarAttributes {
967
- }
968
-
969
- export declare interface StatusBarItem {
970
- /**
971
- * Use for identifying the item
972
- */
973
- key: string;
974
- createElement(props: BoxProps): default_2.ReactElement;
975
- /**
976
- * If not provided, we will create a default menu item
977
- * @param props
978
- */
979
- createMenuItem?(props: BoxProps): default_2.ReactElement;
980
- /**
981
- * Should we show a divider before this item
982
- */
983
- hasDivider?: boolean;
984
- }
985
-
986
- export declare interface StatusBarProps extends default_2.HTMLAttributes<HTMLDivElement> {
987
- /**
988
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
989
- */
990
- sx?: SxProps<Theme>;
991
- /**
992
- * The Sheet.
993
- */
994
- sheet?: ISheet;
995
- gridStyle?: GridStyle;
996
- childrenEnd?: default_2.ReactNode | undefined;
997
- ref?: default_2.Ref<StatusBarElement>;
998
- }
999
-
1000
- /**
1001
- * Studio
1002
- *
1003
- * Fully featured workbook component.
1004
- * * controlled/uncontrolled workbook
1005
- * * snackbar
1006
- * * export/import to local file system
1007
- * * workbook title
1008
- * * Material-ui theme width light/dark toggle
1009
- * * lazy loading
1010
- *
1011
- * Demo:
1012
- *
1013
- * - [SheetXL](https://storybook.sheetxl.com/?path=/story/studio--workbook-studio)
1014
- *
1015
- * API:
1016
- *
1017
- * - [StudioProps](https://api.sheetxl.com/interfaces/_sheetxl_studio-mui.StudioProps.html)
1018
- * - [IWorkbookElement](https://api.sheetxl.com/interfaces/_sheetxl_studio-mui.IWorkbookElement.html)
1019
- */
1020
- declare const Studio: default_2.NamedExoticComponent<Omit<StudioProps, "ref"> & default_2.RefAttributes<IWorkbookElement>>;
1021
- export { Studio }
1022
- export default Studio;
1023
-
1024
- /**
1025
- * Extends the IWorkbookElement with additional properties for the Studio.
1026
- */
1027
- export declare interface StudioElement extends IWorkbookElement {
1028
- }
1029
-
1030
- /**
1031
- * Properties for the Studio component.
1032
- */
1033
- export declare interface StudioProps extends Omit<WorkbookElementProps, "workbook">, Omit<PaperProps, 'autoFocus' | 'ref'> {
1034
- /**
1035
- * The IWorkbook for the studio.
1036
- *
1037
- * @remarks
1038
- * This can be either an [IWorkbook](./_sheetxl_sdk.IWorkbook.html), a `Promise`
1039
- * that resolves to an [IWorkbook](./_sheetxl_sdk.IWorkbook.html), or
1040
- * a [ReadWorkbookOptions](./_sheetxl_io.ReadWorkbookOptions.html) object to create
1041
- * the workbook from various sources.
1042
- *
1043
- * @see
1044
- * * [IWorkbook](./_sheetxl_sdk.IWorkbook.html)
1045
- * * [ReadWorkbookOptions](./_sheetxl_io.ReadWorkbookOptions.html)
1046
- */
1047
- workbook?: IWorkbook | Promise<IWorkbook> | ReadWorkbookOptions;
1048
- /**
1049
- * Called if the `IWorkbook` changes.
1050
- *
1051
- * @param workbook - The workbook
1052
- */
1053
- onWorkbookChange?: (workbook: IWorkbook) => void;
1054
- /**
1055
- * Called if the workbook model is a promise that fails to load.
1056
- *
1057
- * @param error The error
1058
- */
1059
- onWorkbookError?: (error: any) => void;
1060
- /**
1061
- * Allow for a custom error panel if workbook load error occurs.
1062
- *
1063
- * @defaultValue StackTraceErrorPanel
1064
- */
1065
- renderWorkbookError?: (props: ErrorPanelProps) => React.ReactElement;
1066
- /**
1067
- * Custom logo.
1068
- */
1069
- logo?: React.ReactNode;
1070
- /**
1071
- * Callback for title changes.
1072
- *
1073
- * @param title - The new title.
1074
- */
1075
- onWorkbookTitleChange?: (title: string) => void;
1076
- /**
1077
- * Additional WorkbookTitle properties.
1078
- *
1079
- * @remarks
1080
- * If onTitleChange or title is provided then the prop versions are ignored
1081
- */
1082
- propsWorkbookTitle?: WorkbookTitleProps;
1083
- /**
1084
- * Disable the import export options in the menu.
1085
- */
1086
- importExportDisabled?: boolean;
1087
- /**
1088
- * Studio will inherit the theme unless this is explicitly set.
1089
- *
1090
- * @remarks
1091
- * If this is set then there are two additional options that can be provided:
1092
- * * onModeChange(mode: ThemeMode);
1093
- * * onDarkGridChange(allow: boolean);
1094
- * * onDarkImagesChange(allow: boolean);
1095
- */
1096
- themeOptions?: ThemeModeOptions;
1097
- /**
1098
- * Autofocus on load. If loading multiple workbooks or using an a secondary component this
1099
- * should be set to false.
1100
- *
1101
- * @defaultValue false
1102
- */
1103
- autoFocus?: boolean | FocusOptions;
1104
- /**
1105
- * Allow for a custom undo manager.
1106
- *
1107
- * @defaultValue a new undo manager for each standaloneWorkbook
1108
- */
1109
- undoManager?: UndoManager;
1110
- /**
1111
- * Set the license key via a property
1112
- * @remarks
1113
- * This will only be used the first time.
1114
- */
1115
- licenseKey?: string;
1116
- /**
1117
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1118
- */
1119
- sx?: SxProps<Theme>;
1120
- }
1121
-
1122
- export declare const StyledStrokeIcon: (props: StyledStrokeIconProps) => default_2.ReactElement;
1123
-
1124
- export declare interface StyledStrokeIconProps extends SvgIconProps {
1125
- styleColor?: IColor;
1126
- length: number;
1127
- width?: number;
1128
- dashArray?: number[];
1129
- isDouble?: boolean;
1130
- isAngled?: boolean;
1131
- darkMode?: boolean;
1132
- }
1133
-
1134
- declare interface SwatchProps extends default_2.HTMLAttributes<HTMLElement> {
1135
- selectedColor: IColor;
1136
- onSelectColor?: (color: IColor.ISpace.RGBA) => void;
1137
- onPreviewColor?: (color: IColor.ISpace.RGBA) => void;
1138
- alphaWhite?: string;
1139
- alphaGrey?: string;
1140
- alphaCheckSize?: number;
1141
- darkMode?: boolean;
1142
- }
1143
-
1144
- /**
1145
- * TODO
1146
- * - save last searches (up/down arrow to navigate) (in preferences/workbook?)
1147
- * - later add indexing so we can do real-time search and count
1148
- */
1149
- export declare const TableDetailsPanel: default_2.NamedExoticComponent<TableDetailsPanelProps & default_2.RefAttributes<HTMLDivElement>>;
1150
-
1151
- export declare interface TableDetailsPanelProps extends default_2.HTMLAttributes<HTMLDivElement> {
1152
- command?: ICommand<ITable, CommandContext.Table>;
1153
- commands: ICommands.IGroup;
1154
- context?: CommandContext.Table;
1155
- }
1156
-
1157
- export declare const TableDetailsTaskPane: (props: TaskPaneProps, ref: React.Ref<HTMLDivElement>) => JSX.Element;
1158
-
1159
- export declare const TablePlugin: () => void;
1160
-
1161
- /**
1162
- * This is a way to canvas based TableStylePreview. It has a simple rendering but is lightweight.
1163
- */
1164
- export declare const TableStyleCanvasPreview: default_2.NamedExoticComponent<Omit<TableStyleCanvasPreviewProps, "ref"> & default_2.RefAttributes<HTMLDivElement>>;
1165
-
1166
- export declare interface TableStyleCanvasPreviewProps extends default_2.HTMLAttributes<HTMLDivElement> {
1167
- table: ITable;
1168
- tableStyle: ITableStyle;
1169
- styles: IStyleCollection;
1170
- bodyStyle: GridSurfaceStyle;
1171
- disabled?: boolean;
1172
- /**
1173
- * If provided then this context will be used.
1174
- */
1175
- canvas?: HTMLCanvasElement;
1176
- /**
1177
- * Reference to the element.
1178
- */
1179
- ref?: default_2.Ref<HTMLDivElement>;
1180
- }
1181
-
1182
- export declare type TableStyleOptionsAttribute = {
1183
- ref?: default_2.Ref<TableStyleOptionsElement>;
1184
- };
1185
-
1186
- export declare interface TableStyleOptionsAttributes {
1187
- }
1188
-
1189
- /**
1190
- * Type returned via ref property
1191
- */
1192
- export declare interface TableStyleOptionsElement extends TableStyleOptionsAttributes, HTMLElement {
1193
- }
1194
-
1195
- /**
1196
- * Shows options with tables.
1197
- * TODO - We will later also have the options as commands.
1198
- */
1199
- export declare const TableStyleOptionsPanel: default_2.NamedExoticComponent<TableStyleOptionsPanelProps & default_2.RefAttributes<TableStyleOptionsElement>>;
1200
-
1201
- /**
1202
- * This is a panel that is used to configure options for a table.
1203
- */
1204
- export declare interface TableStyleOptionsPanelProps extends default_2.HTMLAttributes<HTMLElement> {
1205
- /**
1206
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1207
- */
1208
- sx?: SxProps<Theme>;
1209
- styleOptions: ITableStyle.StyleOptions;
1210
- showHeaderRow?: boolean;
1211
- showTotalRow?: boolean;
1212
- showFilterButton?: boolean;
1213
- onStyleOptionsChange?: (options: ITableStyle.StyleOptions) => void;
1214
- onShowHeaderRowChange?: (showHeaderRow: boolean) => void;
1215
- onShowTotalRowChange?: (showTotalRow: boolean) => void;
1216
- onShowFilterButtonChange?: (showFilterButton: boolean) => void;
1217
- disabled?: boolean;
1218
- }
1219
-
1220
- /**
1221
- * Component for rendering tableStyle previews.
1222
- * This uses an html table and the TableStyle renderer.
1223
- *
1224
- * It has the ability to render borders and fills
1225
- * with the their styles.
1226
- * @remarks
1227
- * This is intended to be used for the table options pane but is currently not in use.
1228
- */
1229
- export declare const TableStylePreview: default_2.NamedExoticComponent<Omit<TableStylePreviewProps, "ref"> & default_2.RefAttributes<unknown>>;
1230
-
1231
- export declare interface TableStylePreviewProps extends BoxProps {
1232
- /** Required */
1233
- styles: IStyleCollection;
1234
- /**
1235
- * The table to render. If not provided then then a default table will be used.
1236
- */
1237
- table?: ITable;
1238
- /**
1239
- * Allows for table Style to be overwritten.
1240
- */
1241
- tableStyle?: ITableStyle;
1242
- bodyStyle: GridSurfaceStyle;
1243
- disabled?: boolean;
1244
- /**
1245
- * If `true` then the border will be forced to be thin.
1246
- *
1247
- * @remarks
1248
- * Useful for small thumbnails and mimics Excel.
1249
- */
1250
- forceThinBorder?: boolean;
1251
- /**
1252
- * if `true` then listers will be added to track table changes.
1253
- */
1254
- isLive?: boolean;
1255
- /**
1256
- * Change the default width of the rendered table.
1257
- * @defaultValue `10`
1258
- */
1259
- cellHeight?: number;
1260
- }
1261
-
1262
- /**
1263
- * Menu for text effects options
1264
- */
1265
- export declare const TextEffectsCommandButton: default_2.NamedExoticComponent<Omit<CommandPopupButtonProps<any, any>, "ref"> & default_2.RefAttributes<HTMLElement>>;
1266
-
1267
- export declare const TextOverflowCommandButton: default_2.NamedExoticComponent<Omit<CommandPopupButtonProps<any, any>, "ref"> & default_2.RefAttributes<HTMLElement>>;
1268
-
1269
- export declare const TextRotateCommandButton: default_2.NamedExoticComponent<Omit<CommandPopupButtonProps<any, any>, "ref"> & default_2.RefAttributes<HTMLElement>>;
1270
-
1271
- export declare const ThemeSelectButton: default_2.FC<ThemeSelectButtonProps>;
1272
-
1273
- export declare interface ThemeSelectButtonProps extends ExhibitIconButtonProps {
1274
- docTheme: ITheme;
1275
- onSelectTheme: (theme: ITheme) => void;
1276
- /**
1277
- * Determines if the button is selected or not
1278
- * @defaultValue false
1279
- *
1280
- */
1281
- isSelected?: boolean;
1282
- /**
1283
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1284
- */
1285
- sx?: SxProps<Theme>;
1286
- outlined?: boolean;
1287
- darkMode?: boolean;
1288
- }
1289
-
1290
- export declare const ThemeSelectPanel: default_2.FC<ThemeSelectPanelProps>;
1291
-
1292
- export declare interface ThemeSelectPanelProps extends default_2.HTMLAttributes<HTMLElement> {
1293
- themes: IThemeCollection;
1294
- selectedTheme: ITheme;
1295
- onSelectTheme: (docTheme: ITheme) => void;
1296
- /**
1297
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1298
- */
1299
- sx?: SxProps<Theme>;
1300
- disabled?: boolean;
1301
- darkMode?: boolean;
1302
- }
1303
-
1304
- export declare const ThemeSelectPopupButton: default_2.NamedExoticComponent<Omit<ThemeSelectPopupButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
1305
-
1306
- export declare interface ThemeSelectPopupButtonProps extends Omit<ExhibitPopupIconButtonProps, "color" | "icon" | "createPopupPanel"> {
1307
- themes: IThemeCollection;
1308
- selectedTheme?: ITheme;
1309
- onSelectTheme?: (docTheme: ITheme) => void;
1310
- icon?: default_2.ReactNode;
1311
- label?: default_2.ReactNode;
1312
- /**
1313
- * Rendering styles
1314
- * @defaultValue to Toolbar
1315
- */
1316
- variant?: PopupButtonType;
1317
- propsPanel?: Partial<ThemeSelectPanelProps>;
1318
- darkMode?: boolean;
1319
- /**
1320
- * Ref to the underlying element
1321
- */
1322
- ref?: default_2.Ref<HTMLElement>;
1323
- }
1324
-
1325
- /**
1326
- * Menu for underline options
1327
- */
1328
- export declare const UnderlineCommandButton: default_2.NamedExoticComponent<Omit<CommandPopupButtonProps<any, any>, "ref"> & default_2.RefAttributes<HTMLElement>>;
1329
-
1330
- export declare const UndoRedoCommandButton: default_2.NamedExoticComponent<Omit<UndoRedoCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
1331
-
1332
- export declare interface UndoRedoCommandButtonProps extends CommandPopupButtonProps {
1333
- quickCommand?: string;
1334
- undoManager?: UndoManager;
1335
- /**
1336
- * If true will show redo instead of undo and change text accordingly
1337
- */
1338
- isRedo?: boolean;
1339
- nestRedo?: boolean;
1340
- }
1341
-
1342
- export { useModelListener }
1343
-
1344
- export { useRangeListener }
1345
-
1346
- /**
1347
- * Hook for observing workbook commands. This hook will observe a combination
1348
- * of workbook events and an options selection.
1349
-
1350
- * Continue to review until we have them all.
1351
- * https://support.microsoft.com/en-us/office/keyboard-shortcuts-in-excel-1798d9d5-842a-42b8-9c99-9b7213f0040f
1352
- * https://www.excelcampus.com/shortcuts/#:~:text=For%20example%2C%20to%20press%20the,Then%20release%20all%20keys.
1353
- *
1354
- *
1355
- * F6 - Move focus through primary workbook elements (we can implement this by check each workbook element and moving through)
1356
- * F8 - Extend Selection
1357
- * F10 - Move focus to toolbar
1358
- * F11 - Insert chart as a new tab
1359
- *
1360
- */
1361
- export declare const useWorkbookCommands: (props: useWorkbookCommandsOptions) => ICommands.IGroup;
1362
-
1363
- export declare interface useWorkbookCommandsOptions {
1364
- /**
1365
- * The workbook model.
1366
- */
1367
- workbook: IWorkbook;
1368
- /**
1369
- * The workbookElement. Only used for toggling fullscreen.
1370
- */
1371
- workbookElement: IWorkbookElement;
1372
- target: ICommand.ITarget | (() => ICommand.ITarget);
1373
- commands: ICommands.IGroup;
1374
- onExecute?: () => void;
1375
- /**
1376
- * Whether dark mode is enabled.
1377
- */
1378
- darkMode?: boolean;
1379
- }
1380
-
1381
- export declare const VerticalAlignCommandButton: default_2.NamedExoticComponent<Omit<CommandPopupButtonProps<any, any>, "ref"> & default_2.RefAttributes<HTMLElement>>;
1382
-
1383
- /**
1384
- * Menu for gridline options
1385
- */
1386
- export declare const ViewGridLinesCommandButton: default_2.NamedExoticComponent<Omit<CommandPopupButtonProps<any, any>, "ref"> & default_2.RefAttributes<HTMLElement>>;
1387
-
1388
- /**
1389
- * Menu for heading options
1390
- */
1391
- export declare const ViewHeadingsCommandButton: default_2.NamedExoticComponent<Omit<CommandPopupButtonProps<any, any>, "ref"> & default_2.RefAttributes<HTMLElement>>;
1392
-
1393
- export declare const WalkingCopyCommandButton: default_2.FC<WalkingCopyCommandButtonProps>;
1394
-
1395
- export declare interface WalkingCopyCommandButtonProps extends CommandButtonProps {
1396
- }
1397
-
1398
- export declare const WorkbookContextMenu: default_2.FC<WorkbookContextMenuProps>;
1399
-
1400
- export declare interface WorkbookContextMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
1401
- /**
1402
- * The workbook,
1403
- */
1404
- workbook: IWorkbook;
1405
- commands?: ICommands.IGroup;
1406
- disabled?: boolean;
1407
- /**
1408
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1409
- */
1410
- sx?: SxProps<Theme>;
1411
- floatReference: FloatReference;
1412
- }
1413
-
1414
- /**
1415
- * The main component for rendering a workbook.
1416
- */
1417
- export declare const WorkbookElement: default_2.NamedExoticComponent<Omit<WorkbookElementProps, "ref"> & default_2.RefAttributes<IWorkbookElement>>;
1418
-
1419
- /**
1420
- * Properties and methods available on the workbook element.
1421
- */
1422
- export declare interface WorkbookElementProps extends Omit<default_2.HTMLAttributes<HTMLDivElement>, 'autoFocus'> {
1423
- /**
1424
- * A memory model of the workbook.
1425
- * If one is not provided a default workbook model will be used.
1426
- * This can be accessed via the workbook ref.
1427
- */
1428
- workbook?: IWorkbook;
1429
- /**
1430
- * Callback for when the workbook is loaded. Useful for hiding/showing
1431
- * loading panels.
1432
- */
1433
- onElementLoad?: (event: WorkbookLoadEvent) => void | Promise<void>;
1434
- /**
1435
- * Additional commands provided by application.
1436
- */
1437
- commands?: ICommands.IGroup;
1438
- /**
1439
- * Notify that there is a new repeatable command.
1440
- */
1441
- onRepeatCommandChange?: (command: ICommand<any, any>) => void;
1442
- /**
1443
- * Indicate if the formulaBar should be showing.
1444
- * @defaultValue 'workbook model but can be overridden'
1445
- */
1446
- showFormulaBar?: boolean;
1447
- /**
1448
- * Allow for customizations on FormulaBar.
1449
- */
1450
- propsFormulaBar?: FormulaBarProps;
1451
- /**
1452
- * Render FormulaBar.
1453
- *
1454
- * @param props The properties for the FormulaBar.
1455
- * @returns A React Element representing the FormulaBar.
1456
- */
1457
- renderFormulaBar?: (props: FormulaBarProps) => default_2.ReactElement;
1458
- /**
1459
- * This doesn't influence # of tabs just the visibility of the widget.
1460
- * @defaultValue 'workbook model but can be overridden'
1461
- */
1462
- showTabs?: boolean;
1463
- /**
1464
- * Allow for customizations on tabs.
1465
- */
1466
- propsTabs?: WorkbookStripProps;
1467
- /**
1468
- * Render custom tabs.
1469
- * @param props
1470
- * @returns A React Element representing the Tabs for the WorkbookStrip.
1471
- */
1472
- renderTabs?: (props: WorkbookStripProps) => default_2.ReactElement;
1473
- /**
1474
- * Shows the statusbar.
1475
- * @defaultValue 'workbook model but can be overridden'
1476
- */
1477
- showStatusBar?: boolean;
1478
- /**
1479
- * Customizations for the status bar
1480
- */
1481
- propsStatusBar?: StatusBarProps;
1482
- /**
1483
- * Pass in a custom statusbar.
1484
- *
1485
- * @param props
1486
- * @returns A React Element representing the StatusBar.
1487
- */
1488
- renderStatusBar?: (props: StatusBarProps) => default_2.ReactElement;
1489
- /**
1490
- * Props for the toolbar.
1491
- */
1492
- propsToolbar?: WorkbookToolbarsProps;
1493
- /**
1494
- * Pass in a custom toolbar.
1495
- * @param props
1496
- * @returns A React Element representing the Toolbar.
1497
- */
1498
- renderToolbar?: (props: WorkbookToolbarsProps) => default_2.ReactElement;
1499
- /**
1500
- * Props for the context menu.
1501
- */
1502
- propsContextMenu?: WorkbookContextMenuProps;
1503
- /**
1504
- * Render custom context menu.
1505
- * @param props
1506
- * @returns A React Element representing the ContextMenu.
1507
- */
1508
- renderContextMenu?: (props: WorkbookContextMenuProps) => default_2.ReactElement;
1509
- /**
1510
- * Render custom filter menu.
1511
- *
1512
- * @param props
1513
- * @returns A React Element representing the FilterMenu.
1514
- */
1515
- renderFilterMenu?: (props: FilterColumnMenuProps) => default_2.ReactElement;
1516
- /**
1517
- * Render custom movable menu.
1518
- *
1519
- * @param props
1520
- * @returns A React Element representing the MovableMenu.
1521
- */
1522
- renderMovableMenu?: (props: MovableContextMenuProps) => default_2.ReactElement;
1523
- /**
1524
- * Allow for customizations on loading panels.
1525
- */
1526
- propsLoading?: LoadingPanelProps;
1527
- /**
1528
- * Assign a custom loading panel.
1529
- *
1530
- * @returns A React Element representing the LoadingPane.
1531
- */
1532
- renderLoading?: (props: LoadingPanelProps) => default_2.ReactElement;
1533
- /**
1534
- * Allow for customizations on loading panel.
1535
- */
1536
- propsSheet?: SheetProps;
1537
- /**
1538
- * Render custom ISheetElement.
1539
- *
1540
- * @param props
1541
- * @returns A React Element representing the Sheet.
1542
- */
1543
- renderSheet?: (props: SheetProps) => default_2.ReactElement;
1544
- /**
1545
- * Allows users to Wrap stage children in Top level Context
1546
- */
1547
- wrapperMain?: (children: default_2.ReactNode) => default_2.ReactElement;
1548
- /**
1549
- * Show the horizontal scrollbar
1550
- */
1551
- showHorizontalScrollbar?: boolean;
1552
- /**
1553
- * Show the vertical scrollbar
1554
- */
1555
- showVerticalScrollbar?: boolean;
1556
- /**
1557
- * Will autofocus to the sheet.
1558
- * @defaultValue false
1559
- */
1560
- autoFocus?: boolean | FocusOptions;
1561
- /**
1562
- * Allow you to specify a specific material ui theme for the grid.
1563
- *
1564
- * * @defaultValue - The current Theme.
1565
- *
1566
- * @remarks
1567
- * Useful for decorating the application with a single theme (such as dark mode) but render
1568
- * the main grid using a different theme (for example light mode).
1569
- */
1570
- gridTheme?: Theme;
1571
- /**
1572
- * Allow you to specify a specific material ui theme for the headers.
1573
- *
1574
- * * @defaultValue - The grid theme.
1575
- */
1576
- headersTheme?: Theme;
1577
- /**
1578
- * If dark theme then the images will invert unless true.
1579
- *
1580
- * @defaultValue false
1581
- */
1582
- enableDarkImages?: boolean;
1583
- /**
1584
- * Ref for the workbook element
1585
- */
1586
- ref?: default_2.Ref<IWorkbookElement>;
1587
- }
1588
-
1589
- /**
1590
- * A Singleton instance that lazy wraps '@sheetxl/io/WorkbookIO'.
1591
- */
1592
- export declare const WorkbookIO: _WorkbookIO;
1593
-
1594
- /* Excluded from this release type: _WorkbookIO */
1595
-
1596
- export declare type WorkbookLoadEvent = {
1597
- source: IWorkbookElement;
1598
- };
1599
-
1600
- export declare const WorkbookStrip: default_2.NamedExoticComponent<WorkbookStripProps & default_2.RefAttributes<HTMLElement>>;
1601
-
1602
- /**
1603
- * Tab strip that operates on IWorkbook
1604
- */
1605
- export declare interface WorkbookStripProps extends default_2.HTMLAttributes<HTMLDivElement> {
1606
- commands?: ICommands.IGroup;
1607
- /**
1608
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1609
- */
1610
- sx?: SxProps<Theme>;
1611
- /**
1612
- * The workbook
1613
- */
1614
- workbook?: IWorkbook;
1615
- /**
1616
- * If true, the tab strip is disabled
1617
- * @defaultValue false
1618
- */
1619
- disabled?: boolean;
1620
- /**
1621
- * If true then the tab strips can not be modified but can still be selected.
1622
- *
1623
- * @defaultValue !models.getProtection().isStructureAllowed()
1624
- * @remarks
1625
- * This can be set to `true` but if models.getProtection().isStructureAllowed() is `false`
1626
- * then `false` is ignored.
1627
- */
1628
- readOnly?: boolean;
1629
- /**
1630
- * Allow for customizations on context menu
1631
- */
1632
- propsContextMenu?: Partial<SheetTabMenuProps>;
1633
- /**
1634
- * Render custom context menu.
1635
- *
1636
- * @param props
1637
- * @returns A React Element representing the ContextMenu.
1638
- */
1639
- renderContextMenu?: (props: SheetTabMenuProps) => default_2.ReactElement;
1640
- /**
1641
- * Allow for customizations on context menu
1642
- */
1643
- propsSheetsAll?: SheetsAllMenuProps;
1644
- /**
1645
- * Render custom sheet all menu.
1646
- *
1647
- * @param props
1648
- * @returns A React Element representing the SheetAllMenu.
1649
- */
1650
- renderSheetsAll?: (props: SheetsAllMenuProps) => default_2.ReactElement;
1651
- /**
1652
- * Allow for customizations om sheet tabs.
1653
- */
1654
- propsSheetTab?: Partial<SheetTabProps>;
1655
- /**
1656
- * Render custom sheet tabs.
1657
- * @param props
1658
- * @returns A React Element representing a Tab for a Sheet.
1659
- */
1660
- renderSheetTab?: (props: SheetTabProps) => default_2.ReactElement;
1661
- /**
1662
- * Called when the user has initiated a change to the active tab
1663
- * but before it has been rendered. This allows for
1664
- * cleanup events or a chance to cancel the change by
1665
- * returning false.
1666
- * @param index
1667
- */
1668
- onBeforeUserChange?(index: number): boolean | void;
1669
- /**
1670
- * Called after the tab has been changed.
1671
- * @param index
1672
- */
1673
- onUserChange?(index: number): void;
1674
- background?: string;
1675
- borderColor?: string;
1676
- borderWidth?: number;
1677
- gridTheme?: Theme;
1678
- gridStyle?: GridStyle;
1679
- }
1680
-
1681
- export declare const WorkbookTitle: default_2.NamedExoticComponent<Omit<WorkbookTitleProps, "ref"> & default_2.RefAttributes<IWorkbookTitleElement>>;
1682
-
1683
- export declare interface WorkbookTitleAttributes {
1684
- /**
1685
- * Request focus with a callback that will be called on blur.
1686
- *
1687
- * @param onAccept - Callback when the user's focus leaves the title element after a request focus for a title.
1688
- */
1689
- requestWorkbookTitle: (onAccept?: (title: string, commitReason: string) => void, options?: RequestTitleOptions) => void;
1690
- /**
1691
- * Called when application wants to focus the workbook title.
1692
- * @param options - `FocusOptions`
1693
- */
1694
- focus: (options?: FocusOptions) => void;
1695
- }
1696
-
1697
- export declare interface WorkbookTitleProps extends default_2.HTMLAttributes<HTMLDivElement> {
1698
- /**
1699
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1700
- */
1701
- sx?: SxProps<Theme>;
1702
- workbook?: IWorkbookElement;
1703
- title?: string;
1704
- onTitleChange?: (newTitle: string | null) => void;
1705
- /**
1706
- * Text to show if no values
1707
- * @defaultValue 'Untitled'
1708
- */
1709
- placeHolder?: string;
1710
- /**
1711
- * If true the title will not be editable
1712
- * @defaultValue false
1713
- */
1714
- readOnly?: boolean;
1715
- /**
1716
- * @defaultValue false
1717
- */
1718
- hidden?: boolean;
1719
- /**
1720
- * Ref for the IWorkbookTitleElement
1721
- */
1722
- ref?: default_2.Ref<IWorkbookTitleElement>;
1723
- }
1724
-
1725
- declare interface WorkbookToolbarsProps extends default_2.HTMLAttributes<HTMLDivElement> {
1726
- commands: ICommands.IGroup;
1727
- /**
1728
- * Wrap the select with custom component.
1729
- *
1730
- * @param children
1731
- */
1732
- wrapperSelect?: (children: default_2.ReactNode) => default_2.ReactNode;
1733
- /**
1734
- * Properties for the select
1735
- */
1736
- propsSelect?: SxProps;
1737
- /**
1738
- * If we need to render compact.
1739
- */
1740
- isCompact?: boolean;
1741
- /**
1742
- * Wrap the palette with custom component.
1743
- *
1744
- * @param children
1745
- */
1746
- wrapperPalette?: (children: default_2.ReactNode) => default_2.ReactNode;
1747
- propsPalette?: PaperProps;
1748
- propsToolbars?: Record<string, ToolbarProps>;
1749
- workbook?: IWorkbookElement;
1750
- /**
1751
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1752
- */
1753
- sx?: SxProps;
1754
- }
1755
-
1756
- export declare const WorkbookViewCommandButton: default_2.NamedExoticComponent<Omit<WorkbookViewCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
1757
-
1758
- export declare interface WorkbookViewCommandButtonProps extends CommandPopupButtonProps {
1759
- }
1760
-
1761
- export { }
1
+ export * from './src/index'
2
+ export {}