@sheetxl/studio-mui 0.1.98

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 (178) hide show
  1. package/LICENSE.md +11 -0
  2. package/README.md +24 -0
  3. package/build/browser/cjs/4XrhSt2xtUIXkiCt.cjs +1516 -0
  4. package/build/browser/cjs/B3EvhaQf456RMc1Q.cjs +6 -0
  5. package/build/browser/cjs/B3kl467PN2cpvrfz.cjs +12 -0
  6. package/build/browser/cjs/B5LCoenQbQmzic16.cjs +314 -0
  7. package/build/browser/cjs/BBuyHZwFlDRvHzBH.cjs +7 -0
  8. package/build/browser/cjs/BGoG_ROASNB2owBR.cjs +28 -0
  9. package/build/browser/cjs/BJ6Da8vZLjAl44pz.cjs +6 -0
  10. package/build/browser/cjs/BL_UVvG75SFsFaT3.cjs +6 -0
  11. package/build/browser/cjs/BNDoTytIOGtVh5l9.cjs +6 -0
  12. package/build/browser/cjs/BQOyVCuOdwDja_VV.cjs +42 -0
  13. package/build/browser/cjs/BRiPktKUmeJipjaa.cjs +6 -0
  14. package/build/browser/cjs/BabbNVs5iKg49rfk.cjs +6 -0
  15. package/build/browser/cjs/BcOX5vODdThWbKrR.cjs +6 -0
  16. package/build/browser/cjs/BchlMljYmXDs0Ol2.cjs +6 -0
  17. package/build/browser/cjs/BmYZvm13acvbFhOu.cjs +6 -0
  18. package/build/browser/cjs/BmbsW1n0-CkF3ITF.cjs +6 -0
  19. package/build/browser/cjs/BnCUyGP_ERKmL3ZR.cjs +6 -0
  20. package/build/browser/cjs/BtP4E1_yhMjpfbr5.cjs +6 -0
  21. package/build/browser/cjs/C3E9wmSfmgYmXfJN.cjs +205 -0
  22. package/build/browser/cjs/C3Hl78e9qfEHxJYc.cjs +6 -0
  23. package/build/browser/cjs/CEvRH8aOx3etutK_.cjs +17 -0
  24. package/build/browser/cjs/CLZSdaBnKDfb142R.cjs +6 -0
  25. package/build/browser/cjs/CN1cS39WcNrcPVqS.cjs +129 -0
  26. package/build/browser/cjs/CSH1hUnHovjo8Lb8.cjs +6 -0
  27. package/build/browser/cjs/CTNt3asYQRA-MROc.cjs +47 -0
  28. package/build/browser/cjs/C_JZEtvgcli6T7Wg.cjs +11 -0
  29. package/build/browser/cjs/CbaYZmvS8u-p_Z8Z.cjs +6 -0
  30. package/build/browser/cjs/Cc-4c3DRm96wq5rj.cjs +12 -0
  31. package/build/browser/cjs/CnY6DbatGmPyylfU.cjs +20 -0
  32. package/build/browser/cjs/CqkQGfzNax6GmZFo.cjs +6 -0
  33. package/build/browser/cjs/D2AF0a4vbNKzFxzA.cjs +21 -0
  34. package/build/browser/cjs/D4y1iYdx8sdwQ50T.cjs +6 -0
  35. package/build/browser/cjs/D5cF1EnyvnPY2IxS.cjs +150 -0
  36. package/build/browser/cjs/DA1-OPTYQTepGKEg.cjs +11 -0
  37. package/build/browser/cjs/DJDMVDpUqlEKYLjt.cjs +6 -0
  38. package/build/browser/cjs/DLXLJ8SNNjwM5C-P.cjs +6 -0
  39. package/build/browser/cjs/DV8lOsZBgyx7MTBW.cjs +6 -0
  40. package/build/browser/cjs/DZAPn_d9mpvfRzsb.cjs +6 -0
  41. package/build/browser/cjs/DaicqO_9d1hYzyB_.cjs +11 -0
  42. package/build/browser/cjs/Dfh6eMCbAjW14fdh.cjs +6 -0
  43. package/build/browser/cjs/DhI2lgDZL8GqBejN.cjs +6 -0
  44. package/build/browser/cjs/Ds6s8fpzOZsd2m1r.cjs +6 -0
  45. package/build/browser/cjs/DvIWGmDT5uBVQ5zH.cjs +16 -0
  46. package/build/browser/cjs/DvLgu20RiaayrJcW.cjs +7 -0
  47. package/build/browser/cjs/Dvhwt25gyHzxQLrp.cjs +6 -0
  48. package/build/browser/cjs/DvwApJM_CVrlpLxn.cjs +6 -0
  49. package/build/browser/cjs/DwVYzo4a05DMfta_.cjs +28 -0
  50. package/build/browser/cjs/NYdqUauA5i2q33UZ.cjs +6 -0
  51. package/build/browser/cjs/S2Xfq-KDgoT7ipPC.cjs +25 -0
  52. package/build/browser/cjs/TOZQZr9ZZ_Q-jdQZ.cjs +6 -0
  53. package/build/browser/cjs/bJuLOalXTwrshZL3.cjs +16 -0
  54. package/build/browser/cjs/eh9refYW4Gm25cmW.cjs +6 -0
  55. package/build/browser/cjs/hKqcVeb_8_4M79xj.cjs +6 -0
  56. package/build/browser/cjs/index.cjs +7 -0
  57. package/build/browser/cjs/is17hbP-kpOIBRP3.cjs +6 -0
  58. package/build/browser/cjs/pNY789kHWwRQXqse.cjs +17 -0
  59. package/build/browser/cjs/qJcc3ALtLWml32LU.cjs +18 -0
  60. package/build/browser/cjs/vWgVoELLfZ2ff1xL.cjs +6 -0
  61. package/build/browser/esm/2kwF7RVUWBY1zsgG.mjs +16 -0
  62. package/build/browser/esm/7Imk0owJj7oNHR7v.mjs +48 -0
  63. package/build/browser/esm/AuNwPf0DXe0twn35.mjs +1592 -0
  64. package/build/browser/esm/B1Kw9U_AxCk0Aq9f.mjs +59 -0
  65. package/build/browser/esm/B9l1_Tfw_tMhKCNB.mjs +437 -0
  66. package/build/browser/esm/B9winT3ff8rc4sbn.mjs +490 -0
  67. package/build/browser/esm/BEo9XX1sHmVjScSm.mjs +16 -0
  68. package/build/browser/esm/BGTcOBCyrTTlov_i.mjs +13399 -0
  69. package/build/browser/esm/BMGddfMXtKQ9AXQS.mjs +16 -0
  70. package/build/browser/esm/BQSa7N7QMGysdZdU.mjs +3932 -0
  71. package/build/browser/esm/BVEuc_3fLG2GN34k.mjs +16 -0
  72. package/build/browser/esm/BVh9YUwiSov8wcyY.mjs +1708 -0
  73. package/build/browser/esm/BZt5yM_TvoPXqdeA.mjs +3867 -0
  74. package/build/browser/esm/BfU8KdaB9wrEPWM-.mjs +16 -0
  75. package/build/browser/esm/BjUaiSvRZnas-HJW.mjs +16 -0
  76. package/build/browser/esm/BqiVaoAYJJqPrCUZ.mjs +16 -0
  77. package/build/browser/esm/BtMqJ5CRpKuAC4UQ.mjs +1486 -0
  78. package/build/browser/esm/BwvMR2cgGwFn8hAL.mjs +36 -0
  79. package/build/browser/esm/BxU3eVA-Adrnq7ZJ.mjs +1372 -0
  80. package/build/browser/esm/C00coampLNiXjWJJ.mjs +436 -0
  81. package/build/browser/esm/C6nh1rvYnAg2w2V2.mjs +838 -0
  82. package/build/browser/esm/C8gc149K34Zi2lP2.mjs +16 -0
  83. package/build/browser/esm/CGSkuCZY1EmTUNlQ.mjs +52 -0
  84. package/build/browser/esm/CKXzosgZX8Xe3l59.mjs +16 -0
  85. package/build/browser/esm/CNYANG0Z7mhGYo00.mjs +859 -0
  86. package/build/browser/esm/CV_FNw2i_aEc5nwA.mjs +16 -0
  87. package/build/browser/esm/CYSj0-zys2FKWgnb.mjs +18 -0
  88. package/build/browser/esm/CbTs5cvVaP1vPCYD.mjs +2248 -0
  89. package/build/browser/esm/CfAob8gGydmX1xQu.mjs +16 -0
  90. package/build/browser/esm/ChGigf2OPu7d44Km.mjs +16 -0
  91. package/build/browser/esm/CnzGN0S6zOfL_3SS.mjs +1358 -0
  92. package/build/browser/esm/CpyeUtXgDmrcMESB.mjs +52 -0
  93. package/build/browser/esm/CrEGjvQKhAcdw5sY.mjs +16 -0
  94. package/build/browser/esm/CtrrmHx9YbrOithw.mjs +152 -0
  95. package/build/browser/esm/CzAM0pDdZ7sjGgn9.mjs +86 -0
  96. package/build/browser/esm/D0oVDcgRUMZ9MHzu.mjs +41 -0
  97. package/build/browser/esm/D54Fpmnd9MzCzp-Z.mjs +16 -0
  98. package/build/browser/esm/D78-3ghInxscHLVq.mjs +23 -0
  99. package/build/browser/esm/DEpR6b4DMs-va6RS.mjs +43734 -0
  100. package/build/browser/esm/DEsqE49cIQZ8AqCe.mjs +398 -0
  101. package/build/browser/esm/DGe70xvBhc62ZVZz.mjs +2410 -0
  102. package/build/browser/esm/DXapJ5_yR4E8vDaK.mjs +1685 -0
  103. package/build/browser/esm/DjAZeDxBIBZsRTm3.mjs +24 -0
  104. package/build/browser/esm/DttdPwwDTcRX4uwL.mjs +44 -0
  105. package/build/browser/esm/FXcO0MVElhw9cc3v.mjs +49 -0
  106. package/build/browser/esm/GpycqJcrwTRtjEqA.mjs +16 -0
  107. package/build/browser/esm/HCE-tMxyVd0m-PgN.mjs +16 -0
  108. package/build/browser/esm/OCdyQRicV8KxUwMt.mjs +16 -0
  109. package/build/browser/esm/UukTgmLv7or2mhlB.mjs +16 -0
  110. package/build/browser/esm/_cuE13TWr3oEoKGP.mjs +34 -0
  111. package/build/browser/esm/aIlK3Ybu-1T4WHPv.mjs +640 -0
  112. package/build/browser/esm/bFSkTthAEOn7gv5x.mjs +16 -0
  113. package/build/browser/esm/bOhN6up-rdLRp82s.mjs +5588 -0
  114. package/build/browser/esm/index.mjs +85 -0
  115. package/build/browser/esm/ng3JdG4_hi9SgtHk.mjs +16 -0
  116. package/build/browser/esm/o6U2z4gZ7GE4QKZD.mjs +16 -0
  117. package/build/browser/esm/psav3cvsBQQczhPL.mjs +16 -0
  118. package/build/browser/esm/vn0iS301yg2hAbYd.mjs +51 -0
  119. package/build/licenses/dependencies.txt +1341 -0
  120. package/build/node/assets/style.css +1 -0
  121. package/build/node/esm/2kwF7RVUWBY1zsgG.mjs +16 -0
  122. package/build/node/esm/B-Xlyl81h27-bnvO.mjs +16 -0
  123. package/build/node/esm/B1_NYsn5D8x9QedP.mjs +307 -0
  124. package/build/node/esm/BCA5bxOeDA8k1Bm1.mjs +16 -0
  125. package/build/node/esm/BEo9XX1sHmVjScSm.mjs +16 -0
  126. package/build/node/esm/BIfdVpnJR1TZwCPR.mjs +1378 -0
  127. package/build/node/esm/BIqDzNJtkm-dyH0v.mjs +154 -0
  128. package/build/node/esm/BMGddfMXtKQ9AXQS.mjs +16 -0
  129. package/build/node/esm/BUOdfqhtCh8lhOhm.mjs +4000 -0
  130. package/build/node/esm/BYbE15S73xgn7S5E.mjs +88 -0
  131. package/build/node/esm/BfU8KdaB9wrEPWM-.mjs +16 -0
  132. package/build/node/esm/BkyivirgeiDKFSjk.mjs +16 -0
  133. package/build/node/esm/Bm1RqNJ-XvHpJW9z.mjs +831 -0
  134. package/build/node/esm/BqiVaoAYJJqPrCUZ.mjs +16 -0
  135. package/build/node/esm/Bx-30HInllXS7M_J.mjs +41 -0
  136. package/build/node/esm/Bx3lQBEvcqhxffT-.mjs +1726 -0
  137. package/build/node/esm/BxsKlaBFnb5wNq6R.mjs +53 -0
  138. package/build/node/esm/C4PMhNAV0KpPsKFj.mjs +24 -0
  139. package/build/node/esm/C7x3L6HtPhZjSrrZ.mjs +471 -0
  140. package/build/node/esm/C8gc149K34Zi2lP2.mjs +16 -0
  141. package/build/node/esm/CK-kn1p9NGRVM_h7.mjs +16 -0
  142. package/build/node/esm/CKR6snAwSONs7kfL.mjs +19 -0
  143. package/build/node/esm/CKXzosgZX8Xe3l59.mjs +16 -0
  144. package/build/node/esm/CLE_RHHvsDeoZ9Zd.mjs +561 -0
  145. package/build/node/esm/CMKci_5THkcJ-w9a.mjs +80 -0
  146. package/build/node/esm/CVU9bu6AnxcgkEwq.mjs +13466 -0
  147. package/build/node/esm/CfAob8gGydmX1xQu.mjs +16 -0
  148. package/build/node/esm/ChGigf2OPu7d44Km.mjs +16 -0
  149. package/build/node/esm/CkvkuPSf4R_DqArg.mjs +5648 -0
  150. package/build/node/esm/CnBMj0oJAyr9ZbjP.mjs +23 -0
  151. package/build/node/esm/CrEGjvQKhAcdw5sY.mjs +16 -0
  152. package/build/node/esm/Crx9i_8dm3OQsk_T.mjs +28 -0
  153. package/build/node/esm/CwUulbiMQH11aF4x.mjs +16 -0
  154. package/build/node/esm/D0Lh0V1tkdJPxZnI.mjs +392 -0
  155. package/build/node/esm/D54Fpmnd9MzCzp-Z.mjs +16 -0
  156. package/build/node/esm/D5bg3v_W8K9MVp0j.mjs +1711 -0
  157. package/build/node/esm/D8F08tiG98tM_voL.mjs +16 -0
  158. package/build/node/esm/DR7o1DOIK9zdiBgS.mjs +50 -0
  159. package/build/node/esm/DYEgm2kd3haV-Ml8.mjs +1246 -0
  160. package/build/node/esm/DfzhmhZ4I0Zurcqn.mjs +44 -0
  161. package/build/node/esm/Dg_ERnlsy5hwbzMA.mjs +1498 -0
  162. package/build/node/esm/Dt4cj_0sWgvt4FGj.mjs +92 -0
  163. package/build/node/esm/GpycqJcrwTRtjEqA.mjs +16 -0
  164. package/build/node/esm/LlkIFFfAjLiQ5Or6.mjs +3840 -0
  165. package/build/node/esm/OCdyQRicV8KxUwMt.mjs +16 -0
  166. package/build/node/esm/QATDL2FGAYcVnd33.mjs +49 -0
  167. package/build/node/esm/SvgA2TyqJYOzheuf.mjs +26 -0
  168. package/build/node/esm/VZ150KIUh5JVRqpk.mjs +52 -0
  169. package/build/node/esm/XRLHatWlgABiuBDS.mjs +52 -0
  170. package/build/node/esm/bFSkTthAEOn7gv5x.mjs +16 -0
  171. package/build/node/esm/index.mjs +44754 -0
  172. package/build/node/esm/lgtVRbg712G5Ba-x.mjs +60 -0
  173. package/build/node/esm/ng3JdG4_hi9SgtHk.mjs +16 -0
  174. package/build/node/esm/psav3cvsBQQczhPL.mjs +16 -0
  175. package/build/node/esm/zWnN2OzbhzCc6T7u.mjs +86 -0
  176. package/build/package.json +84 -0
  177. package/build/types/index.d.ts +1848 -0
  178. package/package.json +100 -0
@@ -0,0 +1,1848 @@
1
+ import { BoxProps } from '@mui/material';
2
+ import { Command } from '@sheetxl/utils-react';
3
+ import { CommandButtonOptions } from '@sheetxl/utils-mui';
4
+ import { CommandButtonProps } from '@sheetxl/utils-mui';
5
+ import { CommandButtonType } from '@sheetxl/utils-react';
6
+ import { CommandContext } from '@sheetxl/react';
7
+ import { CommandPopupButtonProps } from '@sheetxl/utils-mui';
8
+ import { CommandToolbarProps } from '@sheetxl/utils-mui';
9
+ import { default as default_2 } from 'react';
10
+ import { ErrorPanelProps } from '@sheetxl/utils-mui';
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 { GridStyle } from '@sheetxl/grid-react';
17
+ import { GridSurfaceStyle } from '@sheetxl/grid-react';
18
+ import { IAutoFilter } from '@sheetxl/sdk';
19
+ import { IBorder } from '@sheetxl/sdk';
20
+ import { ICellRanges } from '@sheetxl/sdk';
21
+ import { IColor } from '@sheetxl/sdk';
22
+ import { ICommand } from '@sheetxl/utils-react';
23
+ import { ICommandHook } 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 { IScript } from '@sheetxl/sdk';
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 { LicenseDetails } from '@sheetxl/sdk';
38
+ import { LicenseManager } from '@sheetxl/sdk';
39
+ import { LoadingPanelProps } from '@sheetxl/utils-mui';
40
+ import { Notifier } from '@sheetxl/utils-react';
41
+ import { PaperProps } from '@mui/material';
42
+ import { PopupButtonType } from '@sheetxl/utils-mui';
43
+ import { ReadFormatType } from '@sheetxl/io';
44
+ import { ReadWorkbookOptions } from '@sheetxl/io';
45
+ import { RegisterOptions } from 'react-hook-form';
46
+ import { ScriptEditorProps } from '@sheetxl/react';
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 { Theme } from '@mui/material/styles';
53
+ import { ThemeOptions } from '@mui/material/styles';
54
+ import { ToolbarProps } from '@mui/material';
55
+ import { UndoManager } from '@sheetxl/utils';
56
+ import { WorkbookHandle } from '@sheetxl/io';
57
+ import { WriteFormatType } from '@sheetxl/io';
58
+ import { WriteWorkbookOptions } from '@sheetxl/io';
59
+
60
+ export declare const AppearanceCommandButton: default_2.FC<CommandPopupButtonProps>;
61
+
62
+ export declare const AutoColorPosition: {
63
+ readonly Start: "start";
64
+ readonly End: "end";
65
+ };
66
+
67
+ export declare type AutoColorPosition = typeof AutoColorPosition[keyof typeof AutoColorPosition];
68
+
69
+ /**
70
+ * Implement disabled
71
+ * Set command on selected
72
+ */
73
+ export declare const BorderCommandButton: default_2.FC<BorderCommandButtonProps>;
74
+
75
+ export declare interface BorderCommandButtonProps extends Partial<BorderPopupButtonProps> {
76
+ commands?: ICommands.IGroup;
77
+ command?: ICommand<Partial<IBorder.Properties>, CommandContext.Border>;
78
+ /**
79
+ * Allow for listeners against a specific buttons execute rather than the command.
80
+ *
81
+ * @remarks
82
+ * Useful when knowing the specific button that executed a command is required.
83
+ * (For example when closing menus or restoring focus)
84
+ */
85
+ commandHook?: ICommandHook<any, any>;
86
+ /**
87
+ * Styling
88
+ * @defaultValue CommandButtonType.Toolbar
89
+ */
90
+ variant?: CommandButtonType;
91
+ darkMode?: boolean;
92
+ }
93
+
94
+ export declare const BorderPopupButton: default_2.FC<BorderPopupButtonProps>;
95
+
96
+ export declare interface BorderPopupButtonProps extends Omit<ExhibitPopupIconButtonProps, "color" | "icon" | "createPopupPanel"> {
97
+ selectedBorder: Partial<IBorder.Properties>;
98
+ /**
99
+ * Create a border.
100
+ */
101
+ createTemporaryBorder: (props: Partial<IBorder.Properties>) => IBorder;
102
+ /**
103
+ * For color picker.
104
+ */
105
+ schemeLookup: IColor.SchemeLookup;
106
+ /**
107
+ * If autoColor is set the a special Swatch is create that will
108
+ * disable this color. When it is selected or previewed the color
109
+ * passed will be null any consumer will then know to use the auto color
110
+ */
111
+ autoColor?: IColor;
112
+ darkMode?: boolean;
113
+ /**
114
+ * If no values are specified
115
+ */
116
+ autoStrokeStyle?: IBorder.StrokeStyle;
117
+ showStylingBefore?: boolean;
118
+ onSelectBorder?: (border: Partial<IBorder.Properties> | null) => void;
119
+ onPreviewBorder?: (border: Partial<IBorder.Properties> | null) => void;
120
+ }
121
+
122
+ export declare const BorderStyleButton: default_2.FC<BorderStyleButtonProps>;
123
+
124
+ export declare interface BorderStyleButtonProps extends ExhibitPopupButtonProps {
125
+ selectedStyle: IBorder.StrokeStyle;
126
+ onSelectStyle?: (style: IBorder.StrokeStyle | null) => void;
127
+ /**
128
+ * Rendering styles
129
+ * @defaultValue to Toolbar
130
+ */
131
+ variant?: PopupButtonType;
132
+ /**
133
+ * @defaultValue false
134
+ */
135
+ showLabels?: boolean;
136
+ /**
137
+ * Where there are any custom borders
138
+ * @remarks
139
+ * None does not mean there is no gridline just no custom border. Excel doesn't have a way to partially remove gridlines.
140
+ * We could accomplish this by adding a transparent border.
141
+ *
142
+ * @defaultValue true
143
+ */
144
+ showNone?: boolean;
145
+ styleColor?: IColor;
146
+ darkMode?: boolean;
147
+ }
148
+
149
+ export declare const ClearCommandButton: default_2.FC<ClearCommandButtonProps>;
150
+
151
+ export declare interface ClearCommandButtonProps extends CommandPopupButtonProps {
152
+ }
153
+
154
+ /**
155
+ * Given a colorDef Provides a color preview as a swatch, a tooltip, and returns an adjusted color.
156
+ */
157
+ export declare const ColorButton: default_2.FC<ColorButtonProps>;
158
+
159
+ export declare interface ColorButtonListProps extends default_2.HTMLAttributes<HTMLElement> {
160
+ title?: string;
161
+ colorDefs: IColor.DefinitionWithLabel[] | IColor.DefinitionWithLabel[][];
162
+ schemeColorLookup: IColor.SchemeLookup;
163
+ selectedColor?: IColor;
164
+ previewColor?: IColor;
165
+ onSelectColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
166
+ onPreviewColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
167
+ swatchProps?: Partial<SwatchProps>;
168
+ compareRGB?: boolean;
169
+ darkMode?: boolean;
170
+ }
171
+
172
+ export declare interface ColorButtonProps extends default_2.HTMLAttributes<HTMLElement> {
173
+ colorDef: IColor.DefinitionWithLabel;
174
+ schemeColorLookup: IColor.SchemeLookup;
175
+ selectedColor: IColor;
176
+ previewColor?: IColor;
177
+ onSelectColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
178
+ onPreviewColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
179
+ swatchProps?: Partial<SwatchProps>;
180
+ defaultButtonSize?: number;
181
+ isLarge?: boolean;
182
+ compareRGB?: boolean;
183
+ darkMode?: boolean;
184
+ }
185
+
186
+ export declare const ColorCommandButton: default_2.FC<ColorCommandButtonProps>;
187
+
188
+ /**
189
+ * Wraps ColorPopupButton with a command.
190
+ */
191
+ export declare interface ColorCommandButtonProps extends Omit<ColorPopupButtonProps, "selectedColor" | "variant"> {
192
+ command: Command<IColor, CommandContext.Color>;
193
+ /**
194
+ * Allow for listeners against a specific buttons execute rather than the command.
195
+ *
196
+ * @remarks
197
+ * Useful when knowing the specific button that executed a command is required.
198
+ * (For example when closing menus or restoring focus)
199
+ */
200
+ commandHook?: ICommandHook<any, any>;
201
+ /**
202
+ * Popup button icon.
203
+ *
204
+ */
205
+ icon?: default_2.ReactNode;
206
+ /**
207
+ * Styling
208
+ * @defaultValue CommandButtonType.Toolbar
209
+ */
210
+ variant?: CommandButtonType;
211
+ /**
212
+ * Hint to indicate to the popup to behave like a split button even if no commands is available.
213
+ */
214
+ isSplit?: boolean;
215
+ darkMode?: boolean;
216
+ }
217
+
218
+ /**
219
+ * A color panel that has a list of presets and a way to make custom colors.
220
+ */
221
+ export declare const ColorPanel: default_2.NamedExoticComponent<ColorPanelProps & default_2.RefAttributes<any>>;
222
+
223
+ export declare interface ColorPanelProps extends default_2.HTMLAttributes<HTMLElement> {
224
+ width?: number;
225
+ /**
226
+ * Defaults to 24px
227
+ */
228
+ defaultButtonSize?: number;
229
+ /**
230
+ * Required to generate theme palettes. If not specified then DocTheme colors are used
231
+ */
232
+ schemeLookup?: IColor.SchemeLookup;
233
+ recentColors?: readonly IColor[] | (() => readonly IColor[]);
234
+ /**
235
+ * Defaults to false
236
+ */
237
+ disableAlpha?: boolean;
238
+ darkMode?: boolean;
239
+ selectedColor: IColor;
240
+ previewColor?: IColor;
241
+ onSelectColor?: (color: IColor | null, isCustom: boolean) => void;
242
+ onPreviewColor?: (color: IColor | null) => void;
243
+ onPreviewColorImmediate?: (color: IColor | null) => void;
244
+ previewDebounceTime?: number;
245
+ /**
246
+ * If autoColor is set then a special Swatch is created that will
247
+ * use this color. When it is selected or previewed the color
248
+ * passed will be null any consumer will then know to use the auto color
249
+ */
250
+ autoColor?: IColor;
251
+ /**
252
+ * If autoColor is specified then a label will be shown.
253
+ * This is ignored if autoColor is not specified.
254
+ * @defaultValue Automatic
255
+ */
256
+ autoColorLabel?: NonNullable<default_2.ReactNode>;
257
+ /**
258
+ * If autoColor is specified then a label will be shown.
259
+ * This is ignored if autoColor is not specified.
260
+ * @defaultValue AutoColorPosition.Start
261
+ */
262
+ autoColorPosition?: AutoColorPosition;
263
+ /**
264
+ * If not specified or null then this will be determined based on whether the selected color is available in the
265
+ * presets (not include recent)
266
+ */
267
+ initialPanelType?: ColorPanelType;
268
+ onEyeDropStart?: () => void;
269
+ onEyeDropStop?: () => void;
270
+ onDone?: () => void;
271
+ onElementLoad?: () => void;
272
+ /**
273
+ * Determines if Adjustable colors with similar RGB values are considered the same.
274
+ * @defaultValue false
275
+ */
276
+ compareRGB?: boolean;
277
+ }
278
+
279
+ export declare const ColorPanelType: {
280
+ readonly Preset: "preset";
281
+ readonly Custom: "custom";
282
+ };
283
+
284
+ export declare type ColorPanelType = typeof ColorPanelType[keyof typeof ColorPanelType];
285
+
286
+ export declare const ColorPopupButton: default_2.FC<ColorPopupButtonProps>;
287
+
288
+ export declare interface ColorPopupButtonProps extends Omit<ExhibitPopupIconButtonProps, "color" | "icon" | "createPopupPanel"> {
289
+ selectedColor: IColor;
290
+ onSelectColor?: (color: IColor | null, isCustom: boolean) => void;
291
+ onPreviewColor?: (color: IColor | null) => void;
292
+ onPreviewColorImmediate?: (color: IColor | null) => void;
293
+ /**
294
+ * A short cut for a quick color. This is generally the last color chosen
295
+ */
296
+ quickColor?: IColor;
297
+ icon?: default_2.ReactNode;
298
+ label?: default_2.ReactNode;
299
+ /**
300
+ * Rendering styles
301
+ * @defaultValue to Toolbar
302
+ */
303
+ variant?: PopupButtonType;
304
+ panelProps?: Partial<ColorPanelProps>;
305
+ /**
306
+ * When closing the popup closeAll movables or just the current.
307
+ * @defaultValue true
308
+ */
309
+ shouldCloseFloatAll?: boolean;
310
+ compareRGB?: boolean;
311
+ darkMode?: boolean;
312
+ }
313
+
314
+ /**
315
+ * A set of ColorSpace from tinycolor
316
+ */
317
+ declare interface ColorSpace {
318
+ hsl: any;
319
+ hex: any;
320
+ rgb: any;
321
+ hsv: any;
322
+ source: any;
323
+ }
324
+
325
+ /**
326
+ * Creates a gridStyle from a MUI theme
327
+ * @param appTheme The outer theme used for toolbars and any containing application.
328
+ * @param bodyTheme The theme used specifically for the grid.
329
+ * @returns A `GridStyle` that merges appTheme and bodyTheme.
330
+ */
331
+ export declare const createGridStyleFromMUITheme: (appTheme: Theme, bodyTheme?: Theme) => GridStyle;
332
+
333
+ export declare const CustomColorPanel: default_2.FC<CustomColorPanelProps>;
334
+
335
+ /**
336
+ * This is a standard color panel.
337
+ */
338
+ export declare interface CustomColorPanelProps extends default_2.HTMLAttributes<HTMLElement> {
339
+ selectedColor: string;
340
+ onColorChange: (color: string) => void;
341
+ /**
342
+ * Defaults to false
343
+ */
344
+ disableAlpha?: boolean;
345
+ renderers?: any;
346
+ }
347
+
348
+ export declare const defaultNewWorkbook: () => void;
349
+
350
+ export declare const DeleteCellsCommandButton: default_2.FC<DeleteCellsCommandButtonProps>;
351
+
352
+ export declare interface DeleteCellsCommandButtonProps extends CommandPopupButtonProps {
353
+ disableSheet?: boolean;
354
+ /**
355
+ * If set to `true` only a single menu will be shown instead of a popup if
356
+ * only one command is enabled. Useful for adding or removing rows/column on headers.
357
+ *
358
+ * @remarks
359
+ * This is only considered for the `MenuButton` Variant.
360
+ */
361
+ preferSingleMenu?: boolean;
362
+ showQuickButton?: boolean;
363
+ }
364
+
365
+ export declare const DocThemeCommandButton: default_2.FC<DocThemeCommandButtonProps>;
366
+
367
+ export declare interface DocThemeCommandButtonProps extends Omit<ThemeSelectPopupButtonProps, "createPopupPanel" | "variant" | "themes" | "icon"> {
368
+ command: ICommand<ITheme, CommandContext.Theme>;
369
+ /**
370
+ * Allow for listeners against a specific buttons execute rather than the command.
371
+ *
372
+ * @remarks
373
+ * Useful when knowing the specific button that executed a command is required.
374
+ * (For example when closing menus or restoring focus)
375
+ */
376
+ commandHook?: ICommandHook<any, any>;
377
+ selectedTheme?: ITheme;
378
+ onSelectTheme?: (docTheme: ITheme) => void;
379
+ /**
380
+ * Styling
381
+ * @defaultValue CommandButtonType.Toolbar
382
+ */
383
+ variant?: CommandButtonType;
384
+ darkMode?: boolean;
385
+ }
386
+
387
+ export declare const FillCommandButton: default_2.FC<FillCommandButtonProps>;
388
+
389
+ export declare interface FillCommandButtonProps extends CommandPopupButtonProps {
390
+ }
391
+
392
+ export declare const FilterColumnMenu: default_2.FC<FilterColumnMenuProps>;
393
+
394
+ export declare interface FilterColumnMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
395
+ filter: IAutoFilter.IColumn;
396
+ commands?: ICommands.IGroup;
397
+ disabled?: boolean;
398
+ /**
399
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
400
+ */
401
+ sx?: SxProps<Theme>;
402
+ floatReference: FloatReference;
403
+ }
404
+
405
+ /**
406
+ * PLACEHOLDER for FilterCommandButton.
407
+ *
408
+ * Popup menu on the Filter button. (should we merge this with the sort menu?)
409
+ */
410
+ export declare const FilterCommandButton: default_2.FC<CommandPopupButtonProps>;
411
+
412
+ export declare interface FilterRefProps extends FiltersProps {
413
+ ref?: default_2.Ref<HTMLDivElement>;
414
+ }
415
+
416
+ export declare const Filters: default_2.FC<FiltersProps & {
417
+ ref?: default_2.Ref<IFiltersElement>;
418
+ }>;
419
+
420
+ export declare interface FiltersAttributes {
421
+ isFilters: () => true;
422
+ }
423
+
424
+ export declare interface FiltersProps extends default_2.HTMLAttributes<HTMLDivElement> {
425
+ filter: IAutoFilter.IColumn;
426
+ disabled?: boolean;
427
+ }
428
+
429
+ /**
430
+ * Menu for Find options
431
+ */
432
+ export declare const FindCommandButton: default_2.FC<FindCommandButtonProps>;
433
+
434
+ export declare interface FindCommandButtonProps extends CommandPopupButtonProps {
435
+ }
436
+
437
+ export declare const FontFamilyCommandButton: default_2.FC<FontFamilyCommandButtonProps>;
438
+
439
+ export declare interface FontFamilyCommandButtonProps extends Omit<ExhibitPopupIconButtonProps, "color" | "icon" | "createPopupPanel"> {
440
+ command: Command<string>;
441
+ /**
442
+ * Allow for listeners against a specific buttons execute rather than the command.
443
+ *
444
+ * @remarks
445
+ * Useful when knowing the specific button that executed a command is required.
446
+ * (For example when closing menus or restoring focus)
447
+ */
448
+ commandHook?: ICommandHook<any, any>;
449
+ }
450
+
451
+ /**
452
+ * TODO - add divider and increase/decrease as quick buttons??
453
+ */
454
+ export declare const FontSizeCommandButton: default_2.FC<FontSizeCommandButtonProps>;
455
+
456
+ export declare interface FontSizeCommandButtonProps extends Omit<ExhibitPopupIconButtonProps, "color" | "icon" | "createPopupPanel"> {
457
+ command?: Command<number>;
458
+ /**
459
+ * Allow for listeners against a specific buttons execute rather than the command.
460
+ *
461
+ * @remarks
462
+ * Useful when knowing the specific button that executed a command is required.
463
+ * (For example when closing menus or restoring focus)
464
+ */
465
+ commandHook?: ICommandHook<any, any>;
466
+ /**
467
+ * defaults the the Excel fontSizes
468
+ */
469
+ fontSizes?: number[];
470
+ /**
471
+ * Show quickButtons. Requires commands to be set.
472
+ * @defaultValue false
473
+ */
474
+ showQuickButtons?: boolean;
475
+ commands?: ICommands.IGroup;
476
+ }
477
+
478
+ /**
479
+ * This tracks the selection of the sheet and
480
+ * updates the a named range editor and a sheet cell editor.
481
+ */
482
+ export declare const FormulaBar: default_2.FC<FormulaBarProps & FormulaBarAttribute>;
483
+
484
+ export declare type FormulaBarAttribute = {
485
+ ref?: default_2.Ref<IFormulaBarElement>;
486
+ };
487
+
488
+ export declare interface FormulaBarAttributes {
489
+ isFormulaBarElement: () => true;
490
+ getNamedCollectionEditorElement: () => INamedCollectionEditorElement;
491
+ }
492
+
493
+ export declare interface FormulaBarProps extends default_2.HTMLAttributes<HTMLDivElement> {
494
+ /**
495
+ * The workbook that is used for the range.use
496
+ */
497
+ workbook?: IWorkbook;
498
+ /**
499
+ * Used for startEdit and focus
500
+ */
501
+ sheetElement?: ISheetElement;
502
+ /**
503
+ * If the NamedCollectionEditor should be shown.
504
+ * @defaultValue true
505
+ */
506
+ showNamedCollectionEditor?: boolean;
507
+ /**
508
+ * Allow for customizations on NamedCollectionEditor
509
+ */
510
+ NamedCollectionEditorProps?: NamedCollectionEditorProps;
511
+ /**
512
+ * Override the default NamedCollectionEditor
513
+ */
514
+ renderNamedCollectionEditor?: (props: NamedCollectionEditorProps, ref: default_2.Ref<INamedCollectionEditorElement>) => default_2.ReactElement;
515
+ /**
516
+ * Key down listeners
517
+ */
518
+ commands?: ICommands.IGroup;
519
+ /**
520
+ * Disabled the ui.
521
+ */
522
+ disabled?: boolean;
523
+ /**
524
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
525
+ */
526
+ sx?: SxProps<Theme>;
527
+ /**
528
+ * The grid style to use for the cell editor.
529
+ */
530
+ gridStyle?: GridStyle;
531
+ }
532
+
533
+ /**
534
+ * Menu for freeze options
535
+ */
536
+ export declare const FreezeCommandButton: default_2.FC<CommandPopupButtonProps>;
537
+
538
+ export declare const HelpCommandButton: default_2.FC<HelpCommandButtonProps>;
539
+
540
+ export declare interface HelpCommandButtonProps extends CommandPopupButtonProps {
541
+ }
542
+
543
+ export declare const HorizontalAlignCommandButton: default_2.FC<CommandPopupButtonProps>;
544
+
545
+ export declare interface IFiltersElement extends HTMLDivElement, FiltersAttributes {
546
+ }
547
+
548
+ /**
549
+ * Type returned via ref property
550
+ */
551
+ export declare interface IFormulaBarElement extends FormulaBarAttributes, HTMLElement {
552
+ }
553
+
554
+ /**
555
+ * Type returned via ref property
556
+ */
557
+ export declare interface INamedCollectionEditorElement extends NamedCollectionEditorAttributes, HTMLDivElement {
558
+ }
559
+
560
+ export declare const InsertCellsCommandButton: default_2.FC<InsertCellsCommandButtonProps>;
561
+
562
+ export declare interface InsertCellsCommandButtonProps extends CommandPopupButtonProps {
563
+ disableSheet?: boolean;
564
+ /**
565
+ * If set to `true` only a single menu will be shown instead of a popup if
566
+ * only one command is enabled. Useful for adding or removing rows/column on headers.
567
+ *
568
+ * @remarks
569
+ * This is only considered for the `MenuButton` Variant.
570
+ */
571
+ preferSingleMenu?: boolean;
572
+ showQuickButton?: boolean;
573
+ }
574
+
575
+ export declare const InsertImageCommandButton: default_2.FC<InsertImageCommandButtonProps>;
576
+
577
+ export declare interface InsertImageCommandButtonProps extends CommandPopupButtonProps {
578
+ /**
579
+ * If set to `true` only a single menu will be shown instead of a popup if
580
+ * only one command is enabled. Useful for adding or removing rows/column on headers.
581
+ *
582
+ * @remarks
583
+ * This is only considered for `MenuButton` Variant.
584
+ */
585
+ preferSingleMenu?: boolean;
586
+ showQuickButton?: boolean;
587
+ }
588
+
589
+ /**
590
+ * Menu for Inserting new Scripts
591
+ */
592
+ export declare const InsertScriptCommandButton: default_2.FC<InsertScriptCommandButtonProps>;
593
+
594
+ export declare interface InsertScriptCommandButtonProps extends CommandPopupButtonProps {
595
+ /**
596
+ * Path to fetch directory scripts from.
597
+ */
598
+ scriptPath?: string;
599
+ }
600
+
601
+ /**
602
+ * Type returned via ref property
603
+ */
604
+ export declare interface IScriptWorkspaceElement extends ScriptWorkspaceAttributes, HTMLElement {
605
+ }
606
+
607
+ /**
608
+ * Type returned via ref property
609
+ */
610
+ export declare interface IWorkbookElement extends HTMLDivElement, WorkbookAttributes {
611
+ }
612
+
613
+ /**
614
+ * Type returned via ref property
615
+ */
616
+ export declare interface IWorkbookTitleElement extends HTMLDivElement, WorkbookTitleAttributes {
617
+ }
618
+
619
+ export { LicenseDetails }
620
+
621
+ export { LicenseManager }
622
+
623
+ /**
624
+ * Menu for merge options
625
+ */
626
+ export declare const MergeCommandButton: default_2.FC<MergeCommandButtonProps>;
627
+
628
+ export declare interface MergeCommandButtonProps extends CommandPopupButtonProps {
629
+ }
630
+
631
+ declare interface MovableContextMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
632
+ movable: IMovable;
633
+ commands?: ICommands.IGroup;
634
+ disabled?: boolean;
635
+ /**
636
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
637
+ */
638
+ sx?: SxProps<Theme>;
639
+ floatReference: FloatReference;
640
+ }
641
+
642
+ /**
643
+ * Editor used for selecting, editing, or removing named ranges.
644
+ */
645
+ export declare const NamedCollectionEditor: default_2.FC<NamedCollectionEditorProps & NamedCollectionEditorRefAttribute>;
646
+
647
+ export declare interface NamedCollectionEditorAttributes {
648
+ }
649
+
650
+ export declare interface NamedCollectionEditorProps extends default_2.HTMLAttributes<HTMLDivElement> {
651
+ /**
652
+ * The named ranges
653
+ */
654
+ names: INamedCollection;
655
+ /**
656
+ * The workbook
657
+ */
658
+ workbook: IWorkbook;
659
+ /**
660
+ * Returns focus to primary.
661
+ * @remarks
662
+ * Removes the FloatReference is used.
663
+ */
664
+ restoreFocus?: (options?: FocusOptions) => void;
665
+ /**
666
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
667
+ */
668
+ sx?: SxProps<Theme>;
669
+ disabled?: boolean;
670
+ parentFloat?: FloatReference;
671
+ commandPopupButtonProps?: CommandPopupButtonProps;
672
+ notifier?: Notifier;
673
+ }
674
+
675
+ export declare type NamedCollectionEditorRefAttribute = {
676
+ ref?: default_2.Ref<INamedCollectionEditorElement>;
677
+ };
678
+
679
+ /**
680
+ * NamedItem input field.
681
+ */
682
+ export declare const NamedInput: default_2.FC<NamedInputProps & {
683
+ ref?: default_2.Ref<HTMLDivElement>;
684
+ }>;
685
+
686
+ export declare interface NamedInputProps extends FormControlProps {
687
+ /**
688
+ * The current value
689
+ */
690
+ value?: string;
691
+ /**
692
+ * Notification of the value change
693
+ */
694
+ onChangeInput?: (value: string) => void;
695
+ /**
696
+ * If exception then throw error.
697
+ *
698
+ * @param text
699
+ */
700
+ onValidate?: (text: string) => void;
701
+ /**
702
+ * A default value.
703
+ */
704
+ defaultInput?: string;
705
+ /**
706
+ * If provided will register with react-hook-form.
707
+ *
708
+ * @remarks
709
+ * We don't support changing the formName once rendered.
710
+ * @see {@link https://react-hook-form.com}
711
+ */
712
+ formName?: string;
713
+ /**
714
+ * React-hook-form options.
715
+ * @remarks
716
+ * This is only used if formName is provided.
717
+ */
718
+ formOptions?: RegisterOptions;
719
+ }
720
+
721
+ export declare const NumberFormatCommandButton: default_2.FC<NumberFormatCommandButtonProps>;
722
+
723
+ export declare interface NumberFormatCommandButtonProps extends CommandPopupButtonProps {
724
+ }
725
+
726
+ /**
727
+ * Menu for paste options
728
+ */
729
+ export declare const PasteCommandButton: default_2.FC<PasteCommandButtonProps>;
730
+
731
+ export declare interface PasteCommandButtonProps extends CommandPopupButtonProps {
732
+ command: Command<void>;
733
+ /**
734
+ * Duplicate the paste all in the popup as well as the quick button
735
+ * @defaultValue true
736
+ */
737
+ includePasteAllInPopup?: boolean;
738
+ }
739
+
740
+ export declare const PresetCellStylesCommandButton: default_2.FC<PresetCellStylesCommandButtonProps>;
741
+
742
+ export declare interface PresetCellStylesCommandButtonProps extends CommandPopupButtonProps {
743
+ command: ICommand<IStyle.INamed, CommandContext.NamedStyle>;
744
+ /**
745
+ * Allow for listeners against a specific buttons execute rather than the command.
746
+ *
747
+ * @remarks
748
+ * Useful when knowing the specific button that executed a command is required.
749
+ * (For example when closing menus or restoring focus)
750
+ */
751
+ commandHook?: ICommandHook<any, any>;
752
+ selectedNamed?: IStyle.INamed;
753
+ onSelectNamed?: (style: IStyle.INamed) => void;
754
+ bodyStyle?: GridSurfaceStyle;
755
+ usePreviewIcon?: boolean;
756
+ }
757
+
758
+ export declare const PresetTableStylesCommandButton: default_2.FC<PresetTableStylesCommandButtonProps>;
759
+
760
+ export declare interface PresetTableStylesCommandButtonProps extends CommandPopupButtonProps {
761
+ command: ICommand<ITableStyle.StyleOptions, CommandContext.Table>;
762
+ /**
763
+ * Allow for listeners against a specific buttons execute rather than the command.
764
+ *
765
+ * @remarks
766
+ * Useful when knowing the specific button that executed a command is required.
767
+ * (For example when closing menus or restoring focus)
768
+ */
769
+ commandHook?: ICommandHook<any, any>;
770
+ selectedTable?: ITable;
771
+ onSelectTableStyleName?: (styleName: string) => void;
772
+ bodyStyle?: GridSurfaceStyle;
773
+ usePreviewIcon?: boolean;
774
+ }
775
+
776
+ /**
777
+ * Menu for quick formula sum
778
+ */
779
+ export declare const QuickFormulaSumCommandPopupButton: default_2.FC<QuickFormulaSumCommandPopupButtonProps>;
780
+
781
+ export declare interface QuickFormulaSumCommandPopupButtonProps extends CommandButtonOptions {
782
+ parentFloat: FloatReference;
783
+ commands: ICommands.IGroup;
784
+ }
785
+
786
+ /**
787
+ * Range input field.
788
+ */
789
+ export declare const RangeInput: default_2.FC<RangeInputProps & {
790
+ ref?: default_2.Ref<HTMLDivElement>;
791
+ }>;
792
+
793
+ export declare interface RangeInputProps extends FormControlProps {
794
+ /**
795
+ * If provided will be register with react-hook-form.
796
+ *
797
+ * @remarks
798
+ * We don't support changing the formName once rendered.
799
+ * @see
800
+ * {@link https://react-hook-form.com/}
801
+ */
802
+ formName?: string;
803
+ /**
804
+ * React-hook-form options.
805
+ *
806
+ * @remarks
807
+ * Only used if formName is provided.
808
+ */
809
+ formOptions?: RegisterOptions;
810
+ /**
811
+ * The current value.
812
+ */
813
+ value: ICellRanges;
814
+ /**
815
+ * Notification of the value change. If unable to parse the Range will notify with `null`.
816
+ */
817
+ onChangeInput?: (value: ICellRanges | null) => void;
818
+ /**
819
+ * Required to create ranges.
820
+ *
821
+ * @param address
822
+ */
823
+ resolvedAddress: (address: ICellRanges.Address) => ICellRanges;
824
+ }
825
+
826
+ export declare interface RequestTitleOptions extends FocusOptions {
827
+ selectAll?: boolean;
828
+ requestReason?: string;
829
+ }
830
+
831
+ /**
832
+ * Menu for Quick run of scripts.
833
+ */
834
+ export declare const RunScriptCommandButton: default_2.FC<RunScriptCommandButtonProps>;
835
+
836
+ export declare interface RunScriptCommandButtonProps extends CommandPopupButtonProps {
837
+ }
838
+
839
+ export declare const ScriptEditorToolbar: default_2.NamedExoticComponent<Omit<CommandToolbarProps, "ref"> & default_2.RefAttributes<HTMLDivElement>>;
840
+
841
+ /**
842
+ * This tracks the selection of the sheet and
843
+ * updates the a named range editor and a sheet cell editor.
844
+ */
845
+ export declare const ScriptWorkspace: default_2.FC<ScriptWorkspaceProps & ScriptWorkspaceAttribute>;
846
+
847
+ export declare type ScriptWorkspaceAttribute = {
848
+ ref?: default_2.Ref<IScriptWorkspaceElement>;
849
+ };
850
+
851
+ export declare interface ScriptWorkspaceAttributes {
852
+ isScriptWorkspaceElement: () => true;
853
+ }
854
+
855
+ /**
856
+ * Move this to another project. Automation-Editor
857
+ */
858
+ export declare interface ScriptWorkspaceProps extends default_2.HTMLAttributes<HTMLElement> {
859
+ /**
860
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
861
+ */
862
+ sx?: SxProps<Theme>;
863
+ /**
864
+ * The commands to use for the toolbar.
865
+ */
866
+ commands?: ICommands.IGroup;
867
+ /**
868
+ * If the values can be modified
869
+ */
870
+ readOnly?: boolean;
871
+ /**
872
+ * Called when the user request a close.
873
+ */
874
+ onClose?: () => void;
875
+ /**
876
+ * Allows for component to be autoFocused.
877
+ * @remarks
878
+ * If a string is provided this will be used as a querySelector to find the initial focusable component.
879
+ */
880
+ autoFocusSel?: string;
881
+ /**
882
+ * Props to pass to the editor.
883
+ */
884
+ editorProps?: ScriptEditorProps;
885
+ /**
886
+ * The script module to interact with.
887
+ */
888
+ scripts: IScript;
889
+ }
890
+
891
+ export declare const SheetsAllMenu: default_2.FC<SheetsAllMenuProps>;
892
+
893
+ export declare interface SheetsAllMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
894
+ /**
895
+ * The workbook
896
+ */
897
+ workbook: IWorkbook;
898
+ gridStyle?: GridStyle;
899
+ /**
900
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
901
+ */
902
+ sx?: SxProps<Theme>;
903
+ floatReference: FloatReference;
904
+ closeFloatAll: () => void;
905
+ }
906
+
907
+ export declare const SheetTab: default_2.NamedExoticComponent<TabProps & default_2.RefAttributes<HTMLElement>>;
908
+
909
+ export declare const SheetTabMenu: default_2.FC<SheetTabMenuProps>;
910
+
911
+ export declare interface SheetTabMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
912
+ /**
913
+ * The workbook.
914
+ */
915
+ workbook: IWorkbook;
916
+ index: number;
917
+ commands: ICommands.IGroup;
918
+ scope?: string;
919
+ disabled?: boolean;
920
+ floatReference: FloatReference;
921
+ /**
922
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
923
+ */
924
+ sx?: SxProps<Theme>;
925
+ tabStripRef?: TabStripRef;
926
+ }
927
+
928
+ export declare interface SheetTabProps extends TabProps {
929
+ /**
930
+ * The sheet
931
+ */
932
+ sheet: ISheet;
933
+ /**
934
+ * Allow you to specify a specific material ui theme for the grid.
935
+ *
936
+ * * @defaultValue - the current Theme.
937
+ *
938
+ * @remarks
939
+ * Useful for decorating the application with a single theme (such as dark mode) but render
940
+ * the main grid using a different theme (for example light mode).
941
+ */
942
+ gridTheme?: Theme;
943
+ /**
944
+ * The rounded tab radius
945
+ */
946
+ tabRadius?: number;
947
+ }
948
+
949
+ export declare const SheetZoomScale: default_2.NamedExoticComponent<Omit<SheetZoomScaleProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
950
+
951
+ export declare interface SheetZoomScaleProps extends BoxProps {
952
+ /**
953
+ * The Sheet
954
+ */
955
+ sheet: ISheet;
956
+ /**
957
+ * When dragging slider.
958
+ * @defaultValue 220
959
+ */
960
+ debounceDelay?: number;
961
+ }
962
+
963
+ export declare const SortFilterCommandButton: default_2.FC<CommandPopupButtonProps>;
964
+
965
+ declare type Source = 'prop' | 'class' | 'media';
966
+
967
+ /**
968
+ * Standalone Workbook
969
+ *
970
+ * Fully featured workbook component.
971
+ * * controlled/uncontrolled workbook
972
+ * * snackbar
973
+ * * export/import to local file system
974
+ * * workbook title
975
+ * * Material-ui theme width light/dark toggle
976
+ * * lazy loading
977
+ *
978
+ * Demos:
979
+ *
980
+ * - [SheetXL](https://storybook.sheetxl.com/)
981
+ *
982
+ * API:
983
+ *
984
+ * - [StandaloneWorkbook](https://api.sheetxl.com/functions/sheet_mui_src.StandaloneWorkbook.html)
985
+ */
986
+ export declare const StandaloneWorkbook: default_2.FC<StandaloneWorkbookProps & WorkbookRefAttribute>;
987
+
988
+ /**
989
+ * Properties for the StandaloneWorkbook component.
990
+ */
991
+ export declare interface StandaloneWorkbookProps extends Omit<WorkbookElementProps, "workbook" | "onError"> {
992
+ /**
993
+ * The model to use in the IWorkbookElement.
994
+ *
995
+ * @remarks
996
+ * If not provided a default model will be created.
997
+ */
998
+ workbook?: IWorkbook | Promise<IWorkbook> | WorkbookHandle | ReadWorkbookOptions;
999
+ /**
1000
+ * Called if the `IWorkbook` changes.
1001
+ *
1002
+ * @param workbook - The workbook
1003
+ */
1004
+ onWorkbookChange?: (workbook: IWorkbook) => void;
1005
+ /**
1006
+ * Custom logo.
1007
+ */
1008
+ logo?: React.ReactNode;
1009
+ /**
1010
+ * Called if the workbook model is a promise that fails to load.
1011
+ *
1012
+ * @param error The error
1013
+ */
1014
+ onError?: (error: any) => void;
1015
+ /**
1016
+ * Allow for a custom error panel to be used for errors.
1017
+ *
1018
+ * @defaultValue ErrorPanel
1019
+ */
1020
+ errorPanel?: React.ComponentType<ErrorPanelProps>;
1021
+ /**
1022
+ * Title to display.
1023
+ *
1024
+ * @defaultValue none
1025
+ *
1026
+ * @remarks
1027
+ * If title is null then it is hidden but if it is '' then it is shown with placeholder
1028
+ */
1029
+ title?: string;
1030
+ /**
1031
+ * Callback for title changes.
1032
+ *
1033
+ * @param title - The new title.
1034
+ */
1035
+ onTitleChange?: (title: string) => void;
1036
+ /**
1037
+ * Additional WorkbookTitle properties.
1038
+ *
1039
+ * @remarks
1040
+ * If onTitleChange or title is provided then the prop versions are ignored
1041
+ */
1042
+ titleProps?: WorkbookTitleProps;
1043
+ /**
1044
+ * Disable the import export options in the menu.
1045
+ */
1046
+ importExportDisabled?: boolean;
1047
+ /**
1048
+ * Standalone workbook will inherit the theme unless this is explicitly set.
1049
+ *
1050
+ * @remarks
1051
+ * If this is set then there are two additional options that can be provided:
1052
+ * * onForceModeChange(mode: ThemeMode);
1053
+ * * onForceLightGridChange(force: boolean);
1054
+ * * onForceLightImagesChange(force: boolean);
1055
+ */
1056
+ themeModeOptions?: ThemeModeOptions;
1057
+ /**
1058
+ * Autofocus on load. If loading multiple workbooks or using an a secondary component this
1059
+ * should be set to false.
1060
+ *
1061
+ * @defaultValue false
1062
+ */
1063
+ autoFocus?: boolean | FocusOptions;
1064
+ /**
1065
+ * Allow for a custom undo manager.
1066
+ *
1067
+ * @defaultValue a new undo manager for each standaloneWorkbook
1068
+ */
1069
+ undoManager?: UndoManager;
1070
+ /**
1071
+ * Set the license key via a property
1072
+ * @remarks
1073
+ * This will only be used the first time.
1074
+ */
1075
+ licenseKey?: string;
1076
+ }
1077
+
1078
+ /**
1079
+ * This show the current cell state as an unstyled editable field.
1080
+ * This wraps this with material styling and submit and cancel buttons
1081
+ */
1082
+ export declare const StatusBar: default_2.FC<StatusBarProps & StatusBarRefAttribute>;
1083
+
1084
+ export declare interface StatusBarItem {
1085
+ /**
1086
+ * Use for identifying the item
1087
+ */
1088
+ key: string;
1089
+ createElement(props: BoxProps): default_2.ReactElement;
1090
+ /**
1091
+ * If not provided, we will create a default menu item
1092
+ * @param props
1093
+ */
1094
+ createMenuItem?(props: BoxProps): default_2.ReactElement;
1095
+ /**
1096
+ * Should we show a divider before this item
1097
+ */
1098
+ hasDivider?: boolean;
1099
+ }
1100
+
1101
+ export declare interface StatusBarProps extends default_2.HTMLAttributes<HTMLDivElement> {
1102
+ /**
1103
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1104
+ */
1105
+ sx?: SxProps<Theme>;
1106
+ /**
1107
+ * The Sheet.
1108
+ */
1109
+ sheet?: ISheet;
1110
+ gridStyle?: GridStyle;
1111
+ childrenEnd?: default_2.ReactNode | undefined;
1112
+ }
1113
+
1114
+ export declare interface StatusBarRef {
1115
+ }
1116
+
1117
+ export declare type StatusBarRefAttribute = {
1118
+ ref?: default_2.Ref<StatusBarRef>;
1119
+ };
1120
+
1121
+ export declare const StyledStrokeIcon: (props: StyledStrokeIconProps) => default_2.ReactElement;
1122
+
1123
+ export declare interface StyledStrokeIconProps extends SvgIconProps {
1124
+ styleColor?: IColor;
1125
+ length: number;
1126
+ width?: number;
1127
+ dashArray?: number[];
1128
+ isDouble?: boolean;
1129
+ isAngled?: boolean;
1130
+ darkMode?: boolean;
1131
+ }
1132
+
1133
+ declare interface SwatchProps extends default_2.HTMLAttributes<HTMLElement> {
1134
+ selectedColor: IColor;
1135
+ onSelectColor?: (color: IColor.ISpace.RGBA) => void;
1136
+ onPreviewColor?: (color: IColor.ISpace.RGBA) => void;
1137
+ alphaWhite?: string;
1138
+ alphaGrey?: string;
1139
+ alphaCheckSize?: number;
1140
+ darkMode?: boolean;
1141
+ }
1142
+
1143
+ /**
1144
+ * This is a way to canvas based TableStylePreview. It has a simple rendering but is lightweight.
1145
+ */
1146
+ export declare const TableStyleCanvasPreview: default_2.FC<TableStyleCanvasPreviewProps & {
1147
+ ref?: default_2.Ref<HTMLDivElement>;
1148
+ }>;
1149
+
1150
+ export declare interface TableStyleCanvasPreviewProps extends default_2.HTMLAttributes<HTMLDivElement> {
1151
+ table: ITable;
1152
+ tableStyle: ITableStyle;
1153
+ styles: IStyleCollection;
1154
+ bodyStyle: GridSurfaceStyle;
1155
+ disabled?: boolean;
1156
+ /**
1157
+ * If provided then this context will be used.
1158
+ */
1159
+ canvas?: HTMLCanvasElement;
1160
+ }
1161
+
1162
+ export declare type TableStyleOptionsAttribute = {
1163
+ ref?: default_2.Ref<TableStyleOptionsElement>;
1164
+ };
1165
+
1166
+ export declare interface TableStyleOptionsAttributes {
1167
+ }
1168
+
1169
+ /**
1170
+ * Type returned via ref property
1171
+ */
1172
+ export declare interface TableStyleOptionsElement extends TableStyleOptionsAttributes, HTMLElement {
1173
+ }
1174
+
1175
+ /**
1176
+ * Shows options with tables.
1177
+ * TODO - We will later also have the options as commands.
1178
+ */
1179
+ export declare const TableStyleOptionsPanel: default_2.FC<TableStyleOptionsPanelProps & TableStyleOptionsAttribute>;
1180
+
1181
+ /**
1182
+ * This is a panel that is used to configure options for a table.
1183
+ */
1184
+ export declare interface TableStyleOptionsPanelProps extends default_2.HTMLAttributes<HTMLElement> {
1185
+ /**
1186
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1187
+ */
1188
+ sx?: SxProps<Theme>;
1189
+ styleOptions: ITableStyle.StyleOptions;
1190
+ showHeaderRow?: boolean;
1191
+ showTotalRow?: boolean;
1192
+ showFilterButton?: boolean;
1193
+ onStyleOptionsChange?: (options: ITableStyle.StyleOptions) => void;
1194
+ onShowHeaderRowChange?: (showHeaderRow: boolean) => void;
1195
+ onShowTotalRowChange?: (showTotalRow: boolean) => void;
1196
+ onShowFilterButtonChange?: (showFilterButton: boolean) => void;
1197
+ disabled?: boolean;
1198
+ }
1199
+
1200
+ /**
1201
+ * Component for rendering tableStyle previews.
1202
+ * This uses an html table and the TableStyle renderer.
1203
+ *
1204
+ * It has the ability to render borders and fills
1205
+ * with the their styles.
1206
+ * @remarks
1207
+ * This is intended to be used for the table options pane but is currently not in use.
1208
+ */
1209
+ export declare const TableStylePreview: default_2.NamedExoticComponent<Omit<TableStylePreviewProps, "ref"> & default_2.RefAttributes<unknown>>;
1210
+
1211
+ export declare interface TableStylePreviewProps extends BoxProps {
1212
+ /** Required */
1213
+ styles: IStyleCollection;
1214
+ /**
1215
+ * The table to render. If not provided then then a default table will be used.
1216
+ */
1217
+ table?: ITable;
1218
+ /**
1219
+ * Allows for table Style to be overwritten.
1220
+ */
1221
+ tableStyle?: ITableStyle;
1222
+ bodyStyle: GridSurfaceStyle;
1223
+ disabled?: boolean;
1224
+ /**
1225
+ * If `true` then the border will be forced to be thin.
1226
+ *
1227
+ * @remarks
1228
+ * Useful for small thumbnails and mimics Excel.
1229
+ */
1230
+ forceThinBorder?: boolean;
1231
+ /**
1232
+ * if `true` then listers will be added to track table changes.
1233
+ */
1234
+ isLive?: boolean;
1235
+ /**
1236
+ * Change the default width of the rendered table.
1237
+ * @defaultValue `10`
1238
+ */
1239
+ cellHeight?: number;
1240
+ }
1241
+
1242
+ /**
1243
+ * Menu for text effects options
1244
+ */
1245
+ export declare const TextEffectsCommandButton: default_2.FC<CommandPopupButtonProps>;
1246
+
1247
+ export declare const TextOverflowCommandButton: default_2.FC<CommandPopupButtonProps>;
1248
+
1249
+ export declare const TextRotateCommandButton: default_2.FC<CommandPopupButtonProps>;
1250
+
1251
+ export declare const ThemeMode: {
1252
+ readonly Light: "light";
1253
+ readonly Dark: "dark";
1254
+ };
1255
+
1256
+ export declare type ThemeMode = typeof ThemeMode[keyof typeof ThemeMode];
1257
+
1258
+ export declare interface ThemeModeOptions {
1259
+ /**
1260
+ * Customizations to the theme.
1261
+ *
1262
+ * @defaultValue `Theme`
1263
+ */
1264
+ theme?: ThemeOptions;
1265
+ /**
1266
+ * Customizations to the light theme.
1267
+ *
1268
+ * @defaultValue Theme values.
1269
+ */
1270
+ light?: ThemeOptions;
1271
+ /**
1272
+ * Customizations to the dark theme.
1273
+ *
1274
+ * @defaultValue Theme values
1275
+ */
1276
+ dark?: ThemeOptions;
1277
+ /**
1278
+ * The user doesn't want to use the default.
1279
+ *
1280
+ * @defaultValue null
1281
+ */
1282
+ forceMode?: ThemeMode;
1283
+ /**
1284
+ * By default the the standalone workbook grid will be the same theme as the workbook.
1285
+ * If forceGridLight is `true` then the grid will always use the light mode.
1286
+ *
1287
+ * When `true` the grid will behave consistent with current Excel (2023).
1288
+ *
1289
+ * @remarks
1290
+ * When the grid has a dark theme it will attempt to use DocTheme dark colors
1291
+ * but will 'force' non dark-themed colors to be light via an inversion algo.
1292
+ *
1293
+ * @defaultValue true
1294
+ */
1295
+ forceLightGrid?: boolean;
1296
+ /**
1297
+ * By default the the standalone workbook images will invert images if the grid
1298
+ * is in dark mode.
1299
+ *
1300
+ * @defaultValue false
1301
+ */
1302
+ forceLightImages?: boolean;
1303
+ /**
1304
+ * When theming also apply the MUI CssBaseline.
1305
+ *
1306
+ * @defaultValue false
1307
+ */
1308
+ cssBaseline?: boolean;
1309
+ /**
1310
+ * Called if the current mode changes for the AppTheme.
1311
+ *
1312
+ * @remarks
1313
+ * * This is only used if the themeOptions are not provided.
1314
+ * * If `null` is sent then the theme should inherit.
1315
+ */
1316
+ onForceModeChange?: (mode: ThemeMode | null) => void;
1317
+ onForceLightGridChange?: (force: boolean) => void;
1318
+ onForceLightImagesChange?: (force: boolean) => void;
1319
+ }
1320
+
1321
+ export declare const ThemeSelectButton: default_2.FC<ThemeSelectButtonProps>;
1322
+
1323
+ export declare interface ThemeSelectButtonProps extends ExhibitIconButtonProps {
1324
+ docTheme: ITheme;
1325
+ onSelectTheme: (theme: ITheme) => void;
1326
+ /**
1327
+ * Determines if the button is selected or not
1328
+ * @defaultValue false
1329
+ *
1330
+ */
1331
+ isSelected?: boolean;
1332
+ /**
1333
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1334
+ */
1335
+ sx?: SxProps<Theme>;
1336
+ outlined?: boolean;
1337
+ darkMode?: boolean;
1338
+ }
1339
+
1340
+ export declare const ThemeSelectPanel: default_2.FC<ThemeSelectPanelProps>;
1341
+
1342
+ export declare interface ThemeSelectPanelProps extends default_2.HTMLAttributes<HTMLElement> {
1343
+ themes: IThemeCollection;
1344
+ selectedTheme: ITheme;
1345
+ onSelectTheme: (docTheme: ITheme) => void;
1346
+ /**
1347
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1348
+ */
1349
+ sx?: SxProps<Theme>;
1350
+ disabled?: boolean;
1351
+ darkMode?: boolean;
1352
+ }
1353
+
1354
+ export declare const ThemeSelectPopupButton: default_2.FC<ThemeSelectPopupButtonProps>;
1355
+
1356
+ export declare interface ThemeSelectPopupButtonProps extends Omit<ExhibitPopupIconButtonProps, "color" | "icon" | "createPopupPanel"> {
1357
+ themes: IThemeCollection;
1358
+ selectedTheme?: ITheme;
1359
+ onSelectTheme?: (docTheme: ITheme) => void;
1360
+ icon?: default_2.ReactNode;
1361
+ label?: default_2.ReactNode;
1362
+ /**
1363
+ * Rendering styles
1364
+ * @defaultValue to Toolbar
1365
+ */
1366
+ variant?: PopupButtonType;
1367
+ panelProps?: Partial<ThemeSelectPanelProps>;
1368
+ darkMode?: boolean;
1369
+ }
1370
+
1371
+ export declare const toState: (data: ColorSpace | string, oldHue?: number) => {
1372
+ hsl: any;
1373
+ hex: string;
1374
+ rgb: any;
1375
+ hsv: any;
1376
+ source: any;
1377
+ };
1378
+
1379
+ /**
1380
+ * Menu for underline options
1381
+ */
1382
+ export declare const UnderlineCommandButton: default_2.FC<CommandPopupButtonProps>;
1383
+
1384
+ export declare const UndoRedoCommandButton: default_2.FC<UndoRedoCommandButtonProps>;
1385
+
1386
+ export declare interface UndoRedoCommandButtonProps extends CommandPopupButtonProps {
1387
+ quickCommand?: string;
1388
+ undoManager?: UndoManager;
1389
+ /**
1390
+ * If true will show redo instead of undo and change text accordingly
1391
+ */
1392
+ isRedo?: boolean;
1393
+ nestRedo?: boolean;
1394
+ }
1395
+
1396
+ export declare function useResolvedThemeMode(options?: UseThemeOptions): {
1397
+ themeMode: ThemeMode;
1398
+ source: Source;
1399
+ };
1400
+
1401
+ declare interface UseThemeOptions {
1402
+ mode?: ThemeMode;
1403
+ }
1404
+
1405
+ /**
1406
+ * Hook for observing workbook commands. This hook will observe a combination
1407
+ * of workbook events and an options selection.
1408
+
1409
+ * Continue to review until we have them all.
1410
+ * https://support.microsoft.com/en-us/office/keyboard-shortcuts-in-excel-1798d9d5-842a-42b8-9c99-9b7213f0040f
1411
+ * https://www.excelcampus.com/shortcuts/#:~:text=For%20example%2C%20to%20press%20the,Then%20release%20all%20keys.
1412
+ *
1413
+ *
1414
+ * F6 - Move focus through primary workbook elements (we can implement this by check each workbook element and moving through)
1415
+ * F8 - Extend Selection
1416
+ * F10 - Move focus to toolbar
1417
+ * F11 - Insert chart as a new tab
1418
+ *
1419
+ */
1420
+ export declare const useWorkbookCommands: (props: useWorkbookCommandsOptions) => ICommands.IGroup;
1421
+
1422
+ export declare interface useWorkbookCommandsOptions {
1423
+ /**
1424
+ * The workbook model.
1425
+ */
1426
+ workbook: IWorkbook;
1427
+ /**
1428
+ * The workbookElement. Only used for toggling fullscreen.
1429
+ */
1430
+ workbookElement: IWorkbookElement;
1431
+ notifier?: Notifier;
1432
+ onNewWorkbook?: () => void;
1433
+ commandTarget: ICommands.ITarget | (() => ICommands.ITarget);
1434
+ commands: ICommands.IGroup;
1435
+ onExecute?: () => void;
1436
+ /**
1437
+ * When the sidebar is being requested to be shown.
1438
+ */
1439
+ onShowSidebar?: () => void;
1440
+ darkMode?: boolean;
1441
+ }
1442
+
1443
+ export declare const VerticalAlignCommandButton: default_2.FC<CommandPopupButtonProps>;
1444
+
1445
+ /**
1446
+ * Menu for gridline options
1447
+ */
1448
+ export declare const ViewGridLinesCommandButton: default_2.FC<CommandPopupButtonProps>;
1449
+
1450
+ /**
1451
+ * Menu for heading options
1452
+ */
1453
+ export declare const ViewHeadingsCommandButton: default_2.FC<CommandPopupButtonProps>;
1454
+
1455
+ export declare const WalkingCopyCommandButton: default_2.FC<WalkingCopyCommandButtonProps>;
1456
+
1457
+ export declare interface WalkingCopyCommandButtonProps extends CommandButtonProps {
1458
+ }
1459
+
1460
+ /**
1461
+ * Workbook specific attributes
1462
+ */
1463
+ export declare interface WorkbookAttributes {
1464
+ isWorkbookElement: () => true;
1465
+ getWorkbook: () => IWorkbook;
1466
+ getViewportElement: () => HTMLElement;
1467
+ getSheetElement: () => ISheetElement;
1468
+ getFormulaBarElement: () => IFormulaBarElement;
1469
+ }
1470
+
1471
+ export declare const WorkbookContextMenu: default_2.FC<WorkbookContextMenuProps>;
1472
+
1473
+ export declare interface WorkbookContextMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
1474
+ /**
1475
+ * The workbook,
1476
+ */
1477
+ workbook: IWorkbook;
1478
+ commands?: ICommands.IGroup;
1479
+ disabled?: boolean;
1480
+ /**
1481
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1482
+ */
1483
+ sx?: SxProps<Theme>;
1484
+ floatReference: FloatReference;
1485
+ }
1486
+
1487
+ export declare const WorkbookElement: default_2.FC<WorkbookElementProps & WorkbookRefProps>;
1488
+
1489
+ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocus'> {
1490
+ /**
1491
+ * A memory model of the workbook.
1492
+ * If one is not provided a default workbook model will be used.
1493
+ * This can be accessed via the workbook ref.
1494
+ */
1495
+ workbook?: IWorkbook;
1496
+ /**
1497
+ * Options to use when a new Workbook is created.
1498
+ * @remarks
1499
+ * This is ignored if the model is provided externally.
1500
+ * The default behavior is to use the options from the current workbook if provided.
1501
+ */
1502
+ createWorkbookOptions?: IWorkbook.ConstructorOptions;
1503
+ /**
1504
+ * Hook to perform a action on new workbook
1505
+ * @returns
1506
+ */
1507
+ onNewWorkbook?: () => void;
1508
+ /**
1509
+ * Callback for when the workbook is loaded. Useful for hiding/showing
1510
+ * loading panels.
1511
+ */
1512
+ onElementLoad?: (event: WorkbookLoadEvent) => void;
1513
+ /**
1514
+ * Configure the notifier to use for alerts.
1515
+ */
1516
+ notifier?: Notifier;
1517
+ /**
1518
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1519
+ */
1520
+ sx?: SxProps<Theme>;
1521
+ /**
1522
+ * Additional commands provided by application.
1523
+ */
1524
+ commands?: ICommands.IGroup;
1525
+ /**
1526
+ * Notify that there is a new repeatable command.
1527
+ */
1528
+ onRepeatCommandChange?: (command: ICommand<any, any>) => void;
1529
+ /**
1530
+ * Indicate if the formulaBar should be showing.
1531
+ * @defaultValue 'workbook model but can be overridden'
1532
+ */
1533
+ showFormulaBar?: boolean;
1534
+ /**
1535
+ * Allow for customizations on FormulaBar.
1536
+ */
1537
+ formulaBarProps?: FormulaBarProps;
1538
+ /**
1539
+ * Render FormulaBar.
1540
+ * @param props
1541
+ * @returns A React Element representing the FormulaBar.
1542
+ */
1543
+ renderFormulaBar?: (props: FormulaBarProps, ref: default_2.Ref<IFormulaBarElement>) => default_2.ReactElement;
1544
+ /**
1545
+ * This doesn't influence # of tabs just the visibility of the widget.
1546
+ * @defaultValue 'workbook model but can be overridden'
1547
+ */
1548
+ showTabs?: boolean;
1549
+ /**
1550
+ * Allow for customizations on tabs.
1551
+ */
1552
+ tabsProps?: WorkbookStripProps;
1553
+ /**
1554
+ * Render custom tabs.
1555
+ * @param props
1556
+ * @returns A React Element representing the Tabs for the WorkbookStrip.
1557
+ */
1558
+ renderTabs?: (props: WorkbookStripProps) => default_2.ReactElement;
1559
+ /**
1560
+ * Shows the statusbar.
1561
+ * @defaultValue 'workbook model but can be overridden'
1562
+ */
1563
+ showStatusBar?: boolean;
1564
+ /**
1565
+ * Customizations for the status bar
1566
+ */
1567
+ statusBarProps?: StatusBarProps;
1568
+ /**
1569
+ * Pass in a custom toolbar.
1570
+ * @param props
1571
+ * @returns A React Element representing the StatusBar.
1572
+ */
1573
+ renderStatusBar?: (props: StatusBarProps) => default_2.ReactElement;
1574
+ /**
1575
+ * Props for the toolbar.
1576
+ */
1577
+ toolbarProps?: WorkbookToolbarsProps;
1578
+ /**
1579
+ * Pass in a custom toolbar.
1580
+ * @param props
1581
+ * @returns A React Element representing the Toolbar.
1582
+ */
1583
+ renderToolbar?: (props: WorkbookToolbarsProps) => default_2.ReactElement;
1584
+ /**
1585
+ * Allow for customizations on the context menu.
1586
+ */
1587
+ contextMenuSx?: SxProps<Theme>;
1588
+ /**
1589
+ * Render custom context menu.
1590
+ * @param props
1591
+ * @returns A React Element representing the ContextMenu.
1592
+ */
1593
+ renderContextMenu?: (props: WorkbookContextMenuProps) => default_2.ReactElement;
1594
+ /**
1595
+ * Render custom filter menu.
1596
+ *
1597
+ * @param props
1598
+ * @returns A React Element representing the FilterMenu.
1599
+ */
1600
+ renderFilterMenu?: (props: FilterColumnMenuProps) => default_2.ReactElement;
1601
+ /**
1602
+ * Render custom movable menu.
1603
+ *
1604
+ * @param props
1605
+ * @returns A React Element representing the MovableMenu.
1606
+ */
1607
+ renderMovableMenu?: (props: MovableContextMenuProps) => default_2.ReactElement;
1608
+ /**
1609
+ * Allow for customizations on loading panel.
1610
+ */
1611
+ loadingPanelProps?: LoadingPanelProps;
1612
+ /**
1613
+ * Render custom loading panel.
1614
+ *
1615
+ * @param props
1616
+ * @returns A React Element representing the LoadingPane.
1617
+ */
1618
+ renderLoadingPanel?: (props: LoadingPanelProps) => default_2.ReactElement;
1619
+ /**
1620
+ * Allow for customizations on loading panel.
1621
+ */
1622
+ sheetProps?: SheetProps;
1623
+ /**
1624
+ * Render custom ISheetElement.
1625
+ * @param props
1626
+ * @returns A React Element representing the Sheet.
1627
+ */
1628
+ renderSheet?: (props: SheetProps) => default_2.ReactElement;
1629
+ /**
1630
+ * Show the horizontal scrollbar
1631
+ */
1632
+ showHorizontalScrollbar?: boolean;
1633
+ /**
1634
+ * Show the vertical scrollbar
1635
+ */
1636
+ showVerticalScrollbar?: boolean;
1637
+ /**
1638
+ * Will autofocus to the sheet.
1639
+ * @defaultValue false
1640
+ */
1641
+ autoFocus?: boolean | FocusOptions;
1642
+ /**
1643
+ * Allow you to specify a specific material ui theme for the grid.
1644
+ *
1645
+ * * @defaultValue - The current Theme.
1646
+ *
1647
+ * @remarks
1648
+ * Useful for decorating the application with a single theme (such as dark mode) but render
1649
+ * the main grid using a different theme (for example light mode).
1650
+ */
1651
+ gridTheme?: Theme;
1652
+ /**
1653
+ * Allow you to specify a specific material ui theme for the headers.
1654
+ *
1655
+ * * @defaultValue - The grid theme.
1656
+ */
1657
+ headersTheme?: Theme;
1658
+ /**
1659
+ * If dark theme then the images will invert unless true.
1660
+ * @defaultValue false
1661
+ */
1662
+ forceLightImages?: boolean;
1663
+ }
1664
+
1665
+ /**
1666
+ * A Singleton instance that lazy wraps '@sheetxl/io/WorkbookIO'.
1667
+ */
1668
+ export declare const WorkbookIO: _WorkbookIO;
1669
+
1670
+ /* Excluded from this release type: _WorkbookIO */
1671
+
1672
+ export declare type WorkbookLoadEvent = {
1673
+ source: IWorkbookElement;
1674
+ };
1675
+
1676
+ export declare type WorkbookRefAttribute = {
1677
+ ref?: default_2.Ref<IWorkbookElement>;
1678
+ };
1679
+
1680
+ /**
1681
+ * For elements that also need the ref. Less common but some factory renderers
1682
+ */
1683
+ export declare interface WorkbookRefProps extends WorkbookElementProps {
1684
+ ref?: default_2.Ref<HTMLDivElement>;
1685
+ }
1686
+
1687
+ export declare const WorkbookStrip: default_2.NamedExoticComponent<WorkbookStripProps & default_2.RefAttributes<HTMLElement>>;
1688
+
1689
+ /**
1690
+ * Tab strip that operates on IWorkbook
1691
+ */
1692
+ export declare interface WorkbookStripProps extends default_2.HTMLAttributes<HTMLDivElement> {
1693
+ commands?: ICommands.IGroup;
1694
+ /**
1695
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1696
+ */
1697
+ sx?: SxProps<Theme>;
1698
+ /**
1699
+ * The workbook
1700
+ */
1701
+ workbook?: IWorkbook;
1702
+ /**
1703
+ * If true, the tab strip is disabled
1704
+ * @defaultValue false
1705
+ */
1706
+ disabled?: boolean;
1707
+ /**
1708
+ * If true then the tab strips can not be modified but can still be selected.
1709
+ *
1710
+ * @defaultValue !models.getProtection().isStructureAllowed()
1711
+ * @remarks
1712
+ * This can be set to `true` but if models.getProtection().isStructureAllowed() is `false`
1713
+ * then `false` is ignored.
1714
+ */
1715
+ readOnly?: boolean;
1716
+ /**
1717
+ * Allow for customizations on context menu
1718
+ */
1719
+ contextMenuProps?: Partial<SheetTabMenuProps>;
1720
+ /**
1721
+ * Render custom context menu.
1722
+ *
1723
+ * @param props
1724
+ * @returns A React Element representing the ContextMenu.
1725
+ */
1726
+ renderContextMenu?: (props: SheetTabMenuProps) => default_2.ReactElement;
1727
+ /**
1728
+ * Allow for customizations on context menu
1729
+ */
1730
+ sheetsAllProps?: SheetsAllMenuProps;
1731
+ /**
1732
+ * Render custom sheet all menu.
1733
+ *
1734
+ * @param props
1735
+ * @returns A React Element representing the SheetAllMenu.
1736
+ */
1737
+ renderSheetsAll?: (props: SheetsAllMenuProps) => default_2.ReactElement;
1738
+ /**
1739
+ * Allow for customizations om sheet tabs.
1740
+ */
1741
+ sheetTabProps?: Partial<SheetTabProps>;
1742
+ /**
1743
+ * Render custom sheet tabs.
1744
+ * @param props
1745
+ * @returns A React Element representing a Tab for a Sheet.
1746
+ */
1747
+ renderSheetTab?: (props: SheetTabProps) => default_2.ReactElement;
1748
+ /**
1749
+ * Called when the user has initiated a change to the active tab
1750
+ * but before it has been rendered. This allows for
1751
+ * cleanup events or a chance to cancel the change by
1752
+ * returning false.
1753
+ * @param index
1754
+ */
1755
+ onBeforeUserChange?(index: number): boolean | void;
1756
+ /**
1757
+ * Called after the tab has been changed.
1758
+ * @param index
1759
+ */
1760
+ onUserChange?(index: number): void;
1761
+ background?: string;
1762
+ borderColor?: string;
1763
+ borderWidth?: number;
1764
+ gridTheme?: Theme;
1765
+ gridStyle?: GridStyle;
1766
+ notifier?: Notifier;
1767
+ }
1768
+
1769
+ export declare const WorkbookTitle: default_2.FC<WorkbookTitleProps & WorkbookTitleRefAttribute>;
1770
+
1771
+ export declare interface WorkbookTitleAttributes {
1772
+ /**
1773
+ * Request focus with a callback that will be called on blur.
1774
+ *
1775
+ * @param onAccept - Callback when the user's focus leaves the title element after a request focus for a title.
1776
+ */
1777
+ requestWorkbookTitle: (onAccept?: (title: string, commitReason: string) => void, options?: RequestTitleOptions) => void;
1778
+ /**
1779
+ * Called when application wants to focus the workbook title.
1780
+ * @param options - `FocusOptions`
1781
+ */
1782
+ focus: (options?: FocusOptions) => void;
1783
+ }
1784
+
1785
+ export declare interface WorkbookTitleProps extends default_2.HTMLAttributes<HTMLDivElement> {
1786
+ /**
1787
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1788
+ */
1789
+ sx?: SxProps<Theme>;
1790
+ workbook?: IWorkbookElement;
1791
+ title?: string;
1792
+ onTitleChange?: (newTitle: string | null) => void;
1793
+ /**
1794
+ * Text to show if no values
1795
+ * @defaultValue 'Untitled'
1796
+ */
1797
+ placeHolder?: string;
1798
+ /**
1799
+ * If true the title will not be editable
1800
+ * @defaultValue false
1801
+ */
1802
+ readOnly?: boolean;
1803
+ /**
1804
+ * @defaultValue false
1805
+ */
1806
+ hidden?: boolean;
1807
+ }
1808
+
1809
+ export declare type WorkbookTitleRefAttribute = {
1810
+ ref?: default_2.Ref<IWorkbookTitleElement>;
1811
+ };
1812
+
1813
+ declare interface WorkbookToolbarsProps extends default_2.HTMLAttributes<HTMLDivElement> {
1814
+ commands: ICommands.IGroup;
1815
+ /**
1816
+ * Wrap the select with custom component
1817
+ * @param children
1818
+ */
1819
+ selectWrapper?: (children: default_2.ReactNode) => default_2.ReactNode;
1820
+ /**
1821
+ * Properties for the select
1822
+ */
1823
+ selectProps?: SxProps;
1824
+ /** If we need to render compact */
1825
+ renderCompact?: boolean;
1826
+ /**
1827
+ * Wrap the palette with custom component
1828
+ * @param children
1829
+ */
1830
+ paletteWrapper?: (children: default_2.ReactNode) => default_2.ReactNode;
1831
+ paletteProps?: PaperProps;
1832
+ toolbarsProps?: Record<string, ToolbarProps>;
1833
+ workbook?: IWorkbookElement;
1834
+ /**
1835
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1836
+ */
1837
+ sx?: SxProps;
1838
+ }
1839
+
1840
+ export declare const WorkbookViewCommandButton: default_2.FC<WorkbookViewCommandButtonProps>;
1841
+
1842
+ export declare interface WorkbookViewCommandButtonProps extends CommandPopupButtonProps {
1843
+ }
1844
+
1845
+
1846
+ export * from "@sheetxl/io";
1847
+
1848
+ export { }