@sheetxl/studio-mui 0.7.20 → 0.7.22
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.
- package/browser/cjs/{DG1AUTzpqtpS_jVC.cjs → BCSkf7oG5MtK-XGZ.cjs} +1 -1
- package/browser/cjs/{CtrHMVYocAsdsdWM.cjs → BOj9VP_ZCebWTfxc.cjs} +2 -2
- package/browser/cjs/{hW1tQx38Ra1unYqS.cjs → Biy5SuviR3Cz0S4F.cjs} +2 -2
- package/browser/cjs/{DncFK07jNQbBqKkM.cjs → C1PlAY37pY831-YP.cjs} +7 -7
- package/browser/cjs/{BQNV7GVR6JkMal0s.cjs → Cc3dH2YOCi1SjPK4.cjs} +1 -1
- package/browser/cjs/{CPXMzOdl6xxPLfPn.cjs → Ccx9l-If3BC4K6LY.cjs} +2 -2
- package/browser/cjs/{DoSWqHU9pvfHVYlj.cjs → DR8b8OAx9_mnaJoN.cjs} +2 -2
- package/browser/cjs/{BU-c6ouMN5P9GFpC.cjs → D_R6KuQiPoJdxVa_.cjs} +1 -1
- package/browser/cjs/{Dc9yE1yxW-8SY3Hv.cjs → DkGstRdRpze8sHAr.cjs} +1 -1
- package/browser/cjs/{C_j6lCasu1t14O9Y.cjs → StW-maKM8OSYcle5.cjs} +1 -1
- package/browser/cjs/index.cjs +2 -2
- package/browser/cjs/{Dj9IHyA7WeKPeOcw.cjs → kjlgjQkY0fb-Rc-P.cjs} +1 -1
- package/browser/cjs/qoo14c2KOLE_IfIO.cjs +20 -0
- package/browser/esm/{MNeM7EdplvhB32i_.mjs → 0OyyoHlgiaso9tYr.mjs} +1 -1
- package/browser/esm/{BG8BFBORDGBJ3nhX.mjs → BE92YslAajVEiBuX.mjs} +2 -2
- package/browser/esm/{BZ9mDgpYGUEkfYek.mjs → BJO2iGA4QZN4Tzfv.mjs} +7 -7
- package/browser/esm/{R5qqTNvjnM3WxJs7.mjs → BQGW_5yvCb0eTpib.mjs} +1 -1
- package/browser/esm/{CzI2pgZrodF1v9Qy.mjs → BYAdBaegvg_SoS6K.mjs} +2 -2
- package/browser/esm/{BW4phvITufQ_VYkF.mjs → BsxSk3HxwjxRtPtZ.mjs} +2 -2
- package/browser/esm/{tHtBuu4Jh64s0gfO.mjs → D-9Ar2kzfZAziktn.mjs} +1 -1
- package/browser/esm/{BCJfGxexFSseQSX1.mjs → D4Z_3xY0vO_3FL6K.mjs} +1 -1
- package/browser/esm/DB1mGkEgnMnMQ8CH.mjs +4533 -0
- package/browser/esm/{CzbyIwG_G4o6kvXx.mjs → HmzSBdi0ej5oeXZ1.mjs} +1 -1
- package/browser/esm/{DnnkEOAQ3T-BZ8YN.mjs → ePSxe_g7wEvzmkJ7.mjs} +1 -1
- package/browser/esm/index.mjs +2 -2
- package/browser/esm/{CCw88yjz7gsAET8V.mjs → pshi0IoaQJ-EyVt3.mjs} +2 -2
- package/licenses/dependencies.txt +51 -51
- package/node/esm/{BcKSdSKQD8WAIJsN.mjs → B67HtQl_OohbFhFm.mjs} +1 -1
- package/node/esm/{BrOlE1aJNCNuEX5e.mjs → BD8iIgRl14sLSdN1.mjs} +1 -1
- package/node/esm/{Cy29Wsw-LIboDmIX.mjs → BKeEywP27oPbnpFS.mjs} +1 -1
- package/node/esm/{xfteOmuy00dffn5q.mjs → BkQRle53yjTwYnC4.mjs} +28 -28
- package/node/esm/{DxLeMhSCAbLseA57.mjs → Bl77xZWpq8Ix5EEF.mjs} +1 -1
- package/node/esm/{DzH9wpTF59hEQ5jd.mjs → C1HBS_UNswHQvckQ.mjs} +1 -1
- package/node/esm/{BFHAvoo6cadd7zYQ.mjs → C4wnaXAtg_BfPjQR.mjs} +1 -1
- package/node/esm/{BCop3xTgurk_pOXZ.mjs → Dhp7eefBNVIcSWf6.mjs} +1 -1
- package/node/esm/{BScUpdKO-b4Gr5Xm.mjs → bp_PxnEExWX_-i_8.mjs} +1 -1
- package/node/esm/index.mjs +1163 -1143
- package/node/esm/{QXAsw9Yj3OjQnfqS.mjs → j5ssn9j67ROjzwGT.mjs} +1 -1
- package/package.json +8 -8
- package/types/index.d.ts +94 -116
- package/browser/cjs/9A8PR69vLQMV7BcN.cjs +0 -20
- package/browser/esm/DuBLWU88ClLWzYcS.mjs +0 -4510
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @license @sheetxl/studio-mui - Studio - Spreadsheet UI built with SheetXL SDK using React & MUI. - v0.7.
|
|
2
|
+
* @license @sheetxl/studio-mui - Studio - Spreadsheet UI built with SheetXL SDK using React & MUI. - v0.7.22
|
|
3
3
|
*
|
|
4
4
|
* (C) 2025-present SheetXL Inc. & Michael T. Ford
|
|
5
5
|
* License: The license can be found at https://www.sheetxl.com/license.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sheetxl/studio-mui",
|
|
3
3
|
"description": "Studio - Spreadsheet UI built with SheetXL SDK using React & MUI.",
|
|
4
|
-
"version": "0.7.
|
|
4
|
+
"version": "0.7.22",
|
|
5
5
|
"license": "SEE LICENSE IN <LICENSE>",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"exports": {
|
|
@@ -48,13 +48,13 @@
|
|
|
48
48
|
"charting"
|
|
49
49
|
],
|
|
50
50
|
"dependencies": {
|
|
51
|
-
"@sheetxl/grid-react": "^0.7.
|
|
52
|
-
"@sheetxl/io": "^0.7.
|
|
53
|
-
"@sheetxl/react": "^0.7.
|
|
54
|
-
"@sheetxl/sdk": "^0.7.
|
|
55
|
-
"@sheetxl/utils": "^0.7.
|
|
56
|
-
"@sheetxl/utils-mui": "^0.7.
|
|
57
|
-
"@sheetxl/utils-react": "^0.7.
|
|
51
|
+
"@sheetxl/grid-react": "^0.7.22",
|
|
52
|
+
"@sheetxl/io": "^0.7.22",
|
|
53
|
+
"@sheetxl/react": "^0.7.22",
|
|
54
|
+
"@sheetxl/sdk": "^0.7.22",
|
|
55
|
+
"@sheetxl/utils": "^0.7.22",
|
|
56
|
+
"@sheetxl/utils-mui": "^0.7.22",
|
|
57
|
+
"@sheetxl/utils-react": "^0.7.22",
|
|
58
58
|
"clsx": "^2.1.1",
|
|
59
59
|
"csstype": "^3.1.3",
|
|
60
60
|
"file-saver": "^2.0.5",
|
package/types/index.d.ts
CHANGED
|
@@ -21,7 +21,6 @@ import { IBorder } from '@sheetxl/sdk';
|
|
|
21
21
|
import { ICellRanges } from '@sheetxl/sdk';
|
|
22
22
|
import { IColor } from '@sheetxl/sdk';
|
|
23
23
|
import { ICommand } from '@sheetxl/utils-react';
|
|
24
|
-
import { ICommandHook } from '@sheetxl/utils-react';
|
|
25
24
|
import { ICommands } from '@sheetxl/utils-react';
|
|
26
25
|
import { IMovable } from '@sheetxl/sdk';
|
|
27
26
|
import { INamedCollection } from '@sheetxl/sdk';
|
|
@@ -87,7 +86,7 @@ export declare interface BorderCommandButtonProps extends Omit<Partial<BorderPop
|
|
|
87
86
|
* Useful when knowing the specific button that executed a command is required.
|
|
88
87
|
* (For example when closing menus or restoring focus)
|
|
89
88
|
*/
|
|
90
|
-
commandHook?:
|
|
89
|
+
commandHook?: ICommand.Hook<any, any>;
|
|
91
90
|
/**
|
|
92
91
|
* Styling
|
|
93
92
|
* @defaultValue CommandButtonType.Toolbar
|
|
@@ -211,7 +210,7 @@ export declare interface ColorButtonListProps extends default_2.HTMLAttributes<H
|
|
|
211
210
|
previewColor?: IColor;
|
|
212
211
|
onSelectColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
|
|
213
212
|
onPreviewColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
|
|
214
|
-
|
|
213
|
+
propsSwatch?: Partial<SwatchProps>;
|
|
215
214
|
compareRGB?: boolean;
|
|
216
215
|
darkMode?: boolean;
|
|
217
216
|
}
|
|
@@ -223,7 +222,7 @@ export declare interface ColorButtonProps extends default_2.HTMLAttributes<HTMLE
|
|
|
223
222
|
previewColor?: IColor;
|
|
224
223
|
onSelectColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
|
|
225
224
|
onPreviewColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
|
|
226
|
-
|
|
225
|
+
propsSwatch?: Partial<SwatchProps>;
|
|
227
226
|
defaultButtonSize?: number;
|
|
228
227
|
isLarge?: boolean;
|
|
229
228
|
compareRGB?: boolean;
|
|
@@ -244,7 +243,7 @@ export declare interface ColorCommandButtonProps extends Omit<ColorPopupButtonPr
|
|
|
244
243
|
* Useful when knowing the specific button that executed a command is required.
|
|
245
244
|
* (For example when closing menus or restoring focus)
|
|
246
245
|
*/
|
|
247
|
-
commandHook?:
|
|
246
|
+
commandHook?: ICommand.Hook<any, any>;
|
|
248
247
|
icon?: default_2.ReactNode | ((command: ICommand) => default_2.ReactNode);
|
|
249
248
|
label?: default_2.ReactNode | ((command: ICommand) => default_2.ReactNode);
|
|
250
249
|
/**
|
|
@@ -343,7 +342,7 @@ export declare interface ColorPopupButtonProps extends Omit<ExhibitPopupIconButt
|
|
|
343
342
|
* @defaultValue to Toolbar
|
|
344
343
|
*/
|
|
345
344
|
variant?: PopupButtonType;
|
|
346
|
-
|
|
345
|
+
propsPanel?: Partial<ColorPanelProps>;
|
|
347
346
|
/**
|
|
348
347
|
* When closing the popup closeAll movables or just the current.
|
|
349
348
|
* @defaultValue true
|
|
@@ -391,7 +390,7 @@ export declare interface DocThemeCommandButtonProps extends Omit<ThemeSelectPopu
|
|
|
391
390
|
* Useful when knowing the specific button that executed a command is required.
|
|
392
391
|
* (For example when closing menus or restoring focus)
|
|
393
392
|
*/
|
|
394
|
-
commandHook?:
|
|
393
|
+
commandHook?: ICommand.Hook<any, any>;
|
|
395
394
|
selectedTheme?: ITheme;
|
|
396
395
|
onSelectTheme?: (docTheme: ITheme) => void;
|
|
397
396
|
/**
|
|
@@ -428,10 +427,6 @@ export declare interface FilterColumnMenuProps extends default_2.HTMLAttributes<
|
|
|
428
427
|
filter: IAutoFilter.IColumn;
|
|
429
428
|
commands?: ICommands.IGroup;
|
|
430
429
|
disabled?: boolean;
|
|
431
|
-
/**
|
|
432
|
-
* MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
|
|
433
|
-
*/
|
|
434
|
-
sx?: SxProps<Theme>;
|
|
435
430
|
floatReference: FloatReference;
|
|
436
431
|
}
|
|
437
432
|
|
|
@@ -442,21 +437,25 @@ export declare interface FilterColumnMenuProps extends default_2.HTMLAttributes<
|
|
|
442
437
|
*/
|
|
443
438
|
export declare const FilterCommandButton: default_2.NamedExoticComponent<Omit<CommandPopupButtonProps<any, any>, "ref"> & default_2.RefAttributes<HTMLElement>>;
|
|
444
439
|
|
|
445
|
-
export declare
|
|
446
|
-
ref?: default_2.Ref<HTMLDivElement>;
|
|
447
|
-
}
|
|
448
|
-
|
|
449
|
-
export declare const Filters: default_2.FC<FiltersProps & {
|
|
450
|
-
ref?: default_2.Ref<IFiltersElement>;
|
|
451
|
-
}>;
|
|
440
|
+
export declare const Filters: default_2.NamedExoticComponent<Omit<FiltersProps, "ref"> & default_2.RefAttributes<IFiltersElement>>;
|
|
452
441
|
|
|
453
442
|
export declare interface FiltersAttributes {
|
|
454
443
|
isFilters: () => true;
|
|
455
444
|
}
|
|
456
445
|
|
|
457
446
|
export declare interface FiltersProps extends default_2.HTMLAttributes<HTMLDivElement> {
|
|
447
|
+
/**
|
|
448
|
+
* The filter to display.
|
|
449
|
+
*/
|
|
458
450
|
filter: IAutoFilter.IColumn;
|
|
451
|
+
/**
|
|
452
|
+
* Disables the filter UI.
|
|
453
|
+
*/
|
|
459
454
|
disabled?: boolean;
|
|
455
|
+
/**
|
|
456
|
+
* Ref for the Element.
|
|
457
|
+
*/
|
|
458
|
+
ref?: default_2.Ref<IFiltersElement>;
|
|
460
459
|
}
|
|
461
460
|
|
|
462
461
|
/**
|
|
@@ -480,7 +479,7 @@ export declare interface FontFamilyCommandButtonProps extends Omit<ExhibitPopupI
|
|
|
480
479
|
* Useful when knowing the specific button that executed a command is required.
|
|
481
480
|
* (For example when closing menus or restoring focus)
|
|
482
481
|
*/
|
|
483
|
-
commandHook?:
|
|
482
|
+
commandHook?: ICommand.Hook<any, any>;
|
|
484
483
|
}
|
|
485
484
|
|
|
486
485
|
/**
|
|
@@ -499,7 +498,7 @@ export declare interface FontSizeCommandButtonProps extends Omit<ExhibitPopupIco
|
|
|
499
498
|
* Useful when knowing the specific button that executed a command is required.
|
|
500
499
|
* (For example when closing menus or restoring focus)
|
|
501
500
|
*/
|
|
502
|
-
commandHook?:
|
|
501
|
+
commandHook?: ICommand.Hook<any, any>;
|
|
503
502
|
/**
|
|
504
503
|
* defaults the the Excel fontSizes
|
|
505
504
|
*/
|
|
@@ -540,7 +539,7 @@ export declare interface FormulaBarProps extends default_2.HTMLAttributes<HTMLDi
|
|
|
540
539
|
/**
|
|
541
540
|
* Allow for customizations on NamedCollectionEditor
|
|
542
541
|
*/
|
|
543
|
-
|
|
542
|
+
propsNamedCollectionEditor?: NamedCollectionEditorProps;
|
|
544
543
|
/**
|
|
545
544
|
* Override the default NamedCollectionEditor
|
|
546
545
|
*/
|
|
@@ -605,7 +604,7 @@ export declare interface InsertFunctionCommandButtonProps extends CommandPopupBu
|
|
|
605
604
|
* Useful when knowing the specific button that executed a command is required.
|
|
606
605
|
* (For example when closing menus or restoring focus)
|
|
607
606
|
*/
|
|
608
|
-
commandHook?:
|
|
607
|
+
commandHook?: ICommand.Hook<any, any>;
|
|
609
608
|
}
|
|
610
609
|
|
|
611
610
|
export declare const InsertFunctionCommandPopupButton: default_2.NamedExoticComponent<Omit<InsertFunctionCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
|
|
@@ -710,7 +709,7 @@ export declare interface NamedCollectionEditorProps extends default_2.HTMLAttrib
|
|
|
710
709
|
disabled?: boolean;
|
|
711
710
|
readonly?: boolean;
|
|
712
711
|
parentFloat?: FloatReference;
|
|
713
|
-
|
|
712
|
+
propsCommandPopupButton?: CommandPopupButtonProps;
|
|
714
713
|
/**
|
|
715
714
|
* Reference to the underlying element
|
|
716
715
|
*/
|
|
@@ -791,7 +790,7 @@ export declare interface PresetCellStylesCommandButtonProps extends CommandPopup
|
|
|
791
790
|
* Useful when knowing the specific button that executed a command is required.
|
|
792
791
|
* (For example when closing menus or restoring focus)
|
|
793
792
|
*/
|
|
794
|
-
commandHook?:
|
|
793
|
+
commandHook?: ICommand.Hook<any, any>;
|
|
795
794
|
selectedNamed?: IStyle.INamed;
|
|
796
795
|
onSelectNamed?: (style: IStyle.INamed) => void;
|
|
797
796
|
bodyStyle?: GridSurfaceStyle;
|
|
@@ -809,7 +808,7 @@ export declare interface PresetTableStylesCommandButtonProps extends CommandPopu
|
|
|
809
808
|
* Useful when knowing the specific button that executed a command is required.
|
|
810
809
|
* (For example when closing menus or restoring focus)
|
|
811
810
|
*/
|
|
812
|
-
commandHook?:
|
|
811
|
+
commandHook?: ICommand.Hook<any, any>;
|
|
813
812
|
selectedTable?: ITable;
|
|
814
813
|
onSelectTableStyleName?: (styleName: string) => void;
|
|
815
814
|
bodyStyle?: GridSurfaceStyle;
|
|
@@ -820,9 +819,7 @@ export declare interface PresetTableStylesCommandButtonProps extends CommandPopu
|
|
|
820
819
|
/**
|
|
821
820
|
* Range input field.
|
|
822
821
|
*/
|
|
823
|
-
export declare const RangeInput: default_2.
|
|
824
|
-
ref?: default_2.Ref<HTMLDivElement>;
|
|
825
|
-
}>;
|
|
822
|
+
export declare const RangeInput: default_2.NamedExoticComponent<Omit<RangeInputProps, "ref"> & default_2.RefAttributes<HTMLDivElement>>;
|
|
826
823
|
|
|
827
824
|
export declare interface RangeInputProps extends FormControlProps {
|
|
828
825
|
/**
|
|
@@ -855,6 +852,10 @@ export declare interface RangeInputProps extends FormControlProps {
|
|
|
855
852
|
* @param address
|
|
856
853
|
*/
|
|
857
854
|
resolvedAddress: (address: ICellRanges.Address) => ICellRanges;
|
|
855
|
+
/**
|
|
856
|
+
* Reference to the element.
|
|
857
|
+
*/
|
|
858
|
+
ref?: default_2.Ref<HTMLDivElement>;
|
|
858
859
|
}
|
|
859
860
|
|
|
860
861
|
export declare interface RequestTitleOptions extends FocusOptions {
|
|
@@ -1007,13 +1008,14 @@ export declare interface StatusBarProps extends default_2.HTMLAttributes<HTMLDiv
|
|
|
1007
1008
|
* * Material-ui theme width light/dark toggle
|
|
1008
1009
|
* * lazy loading
|
|
1009
1010
|
*
|
|
1010
|
-
*
|
|
1011
|
+
* Demo:
|
|
1011
1012
|
*
|
|
1012
|
-
* - [SheetXL](https://storybook.sheetxl.com/)
|
|
1013
|
+
* - [SheetXL](https://storybook.sheetxl.com/?path=/story/studio--workbook-studio)
|
|
1013
1014
|
*
|
|
1014
1015
|
* API:
|
|
1015
1016
|
*
|
|
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)
|
|
1017
1019
|
*/
|
|
1018
1020
|
declare const Studio: default_2.NamedExoticComponent<Omit<StudioProps, "ref"> & default_2.RefAttributes<IWorkbookElement>>;
|
|
1019
1021
|
export { Studio }
|
|
@@ -1028,12 +1030,19 @@ export declare interface StudioElement extends IWorkbookElement {
|
|
|
1028
1030
|
/**
|
|
1029
1031
|
* Properties for the Studio component.
|
|
1030
1032
|
*/
|
|
1031
|
-
export declare interface StudioProps extends Omit<WorkbookElementProps, "workbook"> {
|
|
1033
|
+
export declare interface StudioProps extends Omit<WorkbookElementProps, "workbook">, Omit<PaperProps, 'autoFocus' | 'ref'> {
|
|
1032
1034
|
/**
|
|
1033
|
-
* The
|
|
1035
|
+
* The IWorkbook for the studio.
|
|
1034
1036
|
*
|
|
1035
1037
|
* @remarks
|
|
1036
|
-
*
|
|
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)
|
|
1037
1046
|
*/
|
|
1038
1047
|
workbook?: IWorkbook | Promise<IWorkbook> | ReadWorkbookOptions;
|
|
1039
1048
|
/**
|
|
@@ -1058,28 +1067,19 @@ export declare interface StudioProps extends Omit<WorkbookElementProps, "workboo
|
|
|
1058
1067
|
* Custom logo.
|
|
1059
1068
|
*/
|
|
1060
1069
|
logo?: React.ReactNode;
|
|
1061
|
-
/**
|
|
1062
|
-
* Title to display.
|
|
1063
|
-
*
|
|
1064
|
-
* @defaultValue none
|
|
1065
|
-
*
|
|
1066
|
-
* @remarks
|
|
1067
|
-
* If title is null then it is hidden but if it is '' then it is shown with placeholder
|
|
1068
|
-
*/
|
|
1069
|
-
title?: string;
|
|
1070
1070
|
/**
|
|
1071
1071
|
* Callback for title changes.
|
|
1072
1072
|
*
|
|
1073
1073
|
* @param title - The new title.
|
|
1074
1074
|
*/
|
|
1075
|
-
|
|
1075
|
+
onWorkbookTitleChange?: (title: string) => void;
|
|
1076
1076
|
/**
|
|
1077
1077
|
* Additional WorkbookTitle properties.
|
|
1078
1078
|
*
|
|
1079
1079
|
* @remarks
|
|
1080
1080
|
* If onTitleChange or title is provided then the prop versions are ignored
|
|
1081
1081
|
*/
|
|
1082
|
-
|
|
1082
|
+
propsWorkbookTitle?: WorkbookTitleProps;
|
|
1083
1083
|
/**
|
|
1084
1084
|
* Disable the import export options in the menu.
|
|
1085
1085
|
*/
|
|
@@ -1113,6 +1113,10 @@ export declare interface StudioProps extends Omit<WorkbookElementProps, "workboo
|
|
|
1113
1113
|
* This will only be used the first time.
|
|
1114
1114
|
*/
|
|
1115
1115
|
licenseKey?: string;
|
|
1116
|
+
/**
|
|
1117
|
+
* MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
|
|
1118
|
+
*/
|
|
1119
|
+
sx?: SxProps<Theme>;
|
|
1116
1120
|
}
|
|
1117
1121
|
|
|
1118
1122
|
export declare const StyledStrokeIcon: (props: StyledStrokeIconProps) => default_2.ReactElement;
|
|
@@ -1157,9 +1161,7 @@ export declare const TablePlugin: () => void;
|
|
|
1157
1161
|
/**
|
|
1158
1162
|
* This is a way to canvas based TableStylePreview. It has a simple rendering but is lightweight.
|
|
1159
1163
|
*/
|
|
1160
|
-
export declare const TableStyleCanvasPreview: default_2.
|
|
1161
|
-
ref?: default_2.Ref<HTMLDivElement>;
|
|
1162
|
-
}>;
|
|
1164
|
+
export declare const TableStyleCanvasPreview: default_2.NamedExoticComponent<Omit<TableStyleCanvasPreviewProps, "ref"> & default_2.RefAttributes<HTMLDivElement>>;
|
|
1163
1165
|
|
|
1164
1166
|
export declare interface TableStyleCanvasPreviewProps extends default_2.HTMLAttributes<HTMLDivElement> {
|
|
1165
1167
|
table: ITable;
|
|
@@ -1171,6 +1173,10 @@ export declare interface TableStyleCanvasPreviewProps extends default_2.HTMLAttr
|
|
|
1171
1173
|
* If provided then this context will be used.
|
|
1172
1174
|
*/
|
|
1173
1175
|
canvas?: HTMLCanvasElement;
|
|
1176
|
+
/**
|
|
1177
|
+
* Reference to the element.
|
|
1178
|
+
*/
|
|
1179
|
+
ref?: default_2.Ref<HTMLDivElement>;
|
|
1174
1180
|
}
|
|
1175
1181
|
|
|
1176
1182
|
export declare type TableStyleOptionsAttribute = {
|
|
@@ -1295,9 +1301,7 @@ export declare interface ThemeSelectPanelProps extends default_2.HTMLAttributes<
|
|
|
1295
1301
|
darkMode?: boolean;
|
|
1296
1302
|
}
|
|
1297
1303
|
|
|
1298
|
-
export declare const ThemeSelectPopupButton: default_2.
|
|
1299
|
-
ref?: any;
|
|
1300
|
-
}>;
|
|
1304
|
+
export declare const ThemeSelectPopupButton: default_2.NamedExoticComponent<Omit<ThemeSelectPopupButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
|
|
1301
1305
|
|
|
1302
1306
|
export declare interface ThemeSelectPopupButtonProps extends Omit<ExhibitPopupIconButtonProps, "color" | "icon" | "createPopupPanel"> {
|
|
1303
1307
|
themes: IThemeCollection;
|
|
@@ -1310,8 +1314,12 @@ export declare interface ThemeSelectPopupButtonProps extends Omit<ExhibitPopupIc
|
|
|
1310
1314
|
* @defaultValue to Toolbar
|
|
1311
1315
|
*/
|
|
1312
1316
|
variant?: PopupButtonType;
|
|
1313
|
-
|
|
1317
|
+
propsPanel?: Partial<ThemeSelectPanelProps>;
|
|
1314
1318
|
darkMode?: boolean;
|
|
1319
|
+
/**
|
|
1320
|
+
* Ref to the underlying element
|
|
1321
|
+
*/
|
|
1322
|
+
ref?: default_2.Ref<HTMLElement>;
|
|
1315
1323
|
}
|
|
1316
1324
|
|
|
1317
1325
|
/**
|
|
@@ -1361,7 +1369,7 @@ export declare interface useWorkbookCommandsOptions {
|
|
|
1361
1369
|
* The workbookElement. Only used for toggling fullscreen.
|
|
1362
1370
|
*/
|
|
1363
1371
|
workbookElement: IWorkbookElement;
|
|
1364
|
-
target:
|
|
1372
|
+
target: ICommand.ITarget | (() => ICommand.ITarget);
|
|
1365
1373
|
commands: ICommands.IGroup;
|
|
1366
1374
|
onExecute?: () => void;
|
|
1367
1375
|
/**
|
|
@@ -1403,9 +1411,15 @@ export declare interface WorkbookContextMenuProps extends default_2.HTMLAttribut
|
|
|
1403
1411
|
floatReference: FloatReference;
|
|
1404
1412
|
}
|
|
1405
1413
|
|
|
1414
|
+
/**
|
|
1415
|
+
* The main component for rendering a workbook.
|
|
1416
|
+
*/
|
|
1406
1417
|
export declare const WorkbookElement: default_2.NamedExoticComponent<Omit<WorkbookElementProps, "ref"> & default_2.RefAttributes<IWorkbookElement>>;
|
|
1407
1418
|
|
|
1408
|
-
|
|
1419
|
+
/**
|
|
1420
|
+
* Properties and methods available on the workbook element.
|
|
1421
|
+
*/
|
|
1422
|
+
export declare interface WorkbookElementProps extends Omit<default_2.HTMLAttributes<HTMLDivElement>, 'autoFocus'> {
|
|
1409
1423
|
/**
|
|
1410
1424
|
* A memory model of the workbook.
|
|
1411
1425
|
* If one is not provided a default workbook model will be used.
|
|
@@ -1417,10 +1431,6 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
|
|
|
1417
1431
|
* loading panels.
|
|
1418
1432
|
*/
|
|
1419
1433
|
onElementLoad?: (event: WorkbookLoadEvent) => void | Promise<void>;
|
|
1420
|
-
/**
|
|
1421
|
-
* MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
|
|
1422
|
-
*/
|
|
1423
|
-
sx?: SxProps<Theme>;
|
|
1424
1434
|
/**
|
|
1425
1435
|
* Additional commands provided by application.
|
|
1426
1436
|
*/
|
|
@@ -1437,7 +1447,7 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
|
|
|
1437
1447
|
/**
|
|
1438
1448
|
* Allow for customizations on FormulaBar.
|
|
1439
1449
|
*/
|
|
1440
|
-
|
|
1450
|
+
propsFormulaBar?: FormulaBarProps;
|
|
1441
1451
|
/**
|
|
1442
1452
|
* Render FormulaBar.
|
|
1443
1453
|
*
|
|
@@ -1453,7 +1463,7 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
|
|
|
1453
1463
|
/**
|
|
1454
1464
|
* Allow for customizations on tabs.
|
|
1455
1465
|
*/
|
|
1456
|
-
|
|
1466
|
+
propsTabs?: WorkbookStripProps;
|
|
1457
1467
|
/**
|
|
1458
1468
|
* Render custom tabs.
|
|
1459
1469
|
* @param props
|
|
@@ -1468,7 +1478,7 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
|
|
|
1468
1478
|
/**
|
|
1469
1479
|
* Customizations for the status bar
|
|
1470
1480
|
*/
|
|
1471
|
-
|
|
1481
|
+
propsStatusBar?: StatusBarProps;
|
|
1472
1482
|
/**
|
|
1473
1483
|
* Pass in a custom statusbar.
|
|
1474
1484
|
*
|
|
@@ -1479,7 +1489,7 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
|
|
|
1479
1489
|
/**
|
|
1480
1490
|
* Props for the toolbar.
|
|
1481
1491
|
*/
|
|
1482
|
-
|
|
1492
|
+
propsToolbar?: WorkbookToolbarsProps;
|
|
1483
1493
|
/**
|
|
1484
1494
|
* Pass in a custom toolbar.
|
|
1485
1495
|
* @param props
|
|
@@ -1487,9 +1497,9 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
|
|
|
1487
1497
|
*/
|
|
1488
1498
|
renderToolbar?: (props: WorkbookToolbarsProps) => default_2.ReactElement;
|
|
1489
1499
|
/**
|
|
1490
|
-
*
|
|
1500
|
+
* Props for the context menu.
|
|
1491
1501
|
*/
|
|
1492
|
-
|
|
1502
|
+
propsContextMenu?: WorkbookContextMenuProps;
|
|
1493
1503
|
/**
|
|
1494
1504
|
* Render custom context menu.
|
|
1495
1505
|
* @param props
|
|
@@ -1513,7 +1523,7 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
|
|
|
1513
1523
|
/**
|
|
1514
1524
|
* Allow for customizations on loading panels.
|
|
1515
1525
|
*/
|
|
1516
|
-
|
|
1526
|
+
propsLoading?: LoadingPanelProps;
|
|
1517
1527
|
/**
|
|
1518
1528
|
* Assign a custom loading panel.
|
|
1519
1529
|
*
|
|
@@ -1523,7 +1533,7 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
|
|
|
1523
1533
|
/**
|
|
1524
1534
|
* Allow for customizations on loading panel.
|
|
1525
1535
|
*/
|
|
1526
|
-
|
|
1536
|
+
propsSheet?: SheetProps;
|
|
1527
1537
|
/**
|
|
1528
1538
|
* Render custom ISheetElement.
|
|
1529
1539
|
*
|
|
@@ -1534,7 +1544,7 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
|
|
|
1534
1544
|
/**
|
|
1535
1545
|
* Allows users to Wrap stage children in Top level Context
|
|
1536
1546
|
*/
|
|
1537
|
-
|
|
1547
|
+
wrapperMain?: (children: default_2.ReactNode) => default_2.ReactElement;
|
|
1538
1548
|
/**
|
|
1539
1549
|
* Show the horizontal scrollbar
|
|
1540
1550
|
*/
|
|
@@ -1581,40 +1591,7 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
|
|
|
1581
1591
|
*/
|
|
1582
1592
|
export declare const WorkbookIO: _WorkbookIO;
|
|
1583
1593
|
|
|
1584
|
-
|
|
1585
|
-
* Wraps the IO WorkbookIO class to provide lazy import and adds support for IReactNotifier
|
|
1586
|
-
* notification to the read method.
|
|
1587
|
-
*
|
|
1588
|
-
* @see '@sheetxl/io/IWorkbookIO'
|
|
1589
|
-
*/
|
|
1590
|
-
export declare class _WorkbookIO implements IWorkbookIO {
|
|
1591
|
-
protected _loadedIO: IWorkbookIO;
|
|
1592
|
-
protected _loadIO(): Promise<IWorkbookIO>;
|
|
1593
|
-
/** @inheritdoc IWorkbookIO.getReadFormats */
|
|
1594
|
-
getReadFormats(options?: GetFormatsOptions): Promise<ReadFormatType[]>;
|
|
1595
|
-
/** @inheritdoc IWorkbookIO.getWriteFormats */
|
|
1596
|
-
getWriteFormats(options?: GetFormatsOptions): Promise<WriteFormatType[]>;
|
|
1597
|
-
/** @inheritdoc IWorkbookIO.writeArrayBuffer */
|
|
1598
|
-
writeArrayBuffer(workbook: IWorkbook, options?: WriteWorkbookOptions): Promise<ArrayBufferLike>;
|
|
1599
|
-
/**
|
|
1600
|
-
* Override default IWorkbookIO to add notifier support.
|
|
1601
|
-
*
|
|
1602
|
-
* @param options {@link ReadWorkbookOptions}
|
|
1603
|
-
*/
|
|
1604
|
-
read(options: ReadWorkbookOptions, notifier?: IReactNotifier): Promise<IWorkbook>;
|
|
1605
|
-
/** @inheritdoc IWorkbookIO.writeFile */
|
|
1606
|
-
writeFile(fileName: string | null, workbook: IWorkbook, options?: WriteWorkbookOptions): Promise<boolean>;
|
|
1607
|
-
/** @inheritdoc IWorkbookIO.registerReadFormat */
|
|
1608
|
-
registerReadFormat(format: ReadFormatType): Promise<void>;
|
|
1609
|
-
/** @inheritdoc IWorkbookIO.registerWriteFormat */
|
|
1610
|
-
registerWriteFormat(format: WriteFormatType): Promise<void>;
|
|
1611
|
-
/**
|
|
1612
|
-
* A string array of all the mimeTYpes. Used for the input accept attribute.
|
|
1613
|
-
*
|
|
1614
|
-
* @returns An array of strings for the input types.
|
|
1615
|
-
*/
|
|
1616
|
-
getAllReadFormatsAsString(): Promise<string>;
|
|
1617
|
-
}
|
|
1594
|
+
/* Excluded from this release type: _WorkbookIO */
|
|
1618
1595
|
|
|
1619
1596
|
export declare type WorkbookLoadEvent = {
|
|
1620
1597
|
source: IWorkbookElement;
|
|
@@ -1652,7 +1629,7 @@ export declare interface WorkbookStripProps extends default_2.HTMLAttributes<HTM
|
|
|
1652
1629
|
/**
|
|
1653
1630
|
* Allow for customizations on context menu
|
|
1654
1631
|
*/
|
|
1655
|
-
|
|
1632
|
+
propsContextMenu?: Partial<SheetTabMenuProps>;
|
|
1656
1633
|
/**
|
|
1657
1634
|
* Render custom context menu.
|
|
1658
1635
|
*
|
|
@@ -1663,7 +1640,7 @@ export declare interface WorkbookStripProps extends default_2.HTMLAttributes<HTM
|
|
|
1663
1640
|
/**
|
|
1664
1641
|
* Allow for customizations on context menu
|
|
1665
1642
|
*/
|
|
1666
|
-
|
|
1643
|
+
propsSheetsAll?: SheetsAllMenuProps;
|
|
1667
1644
|
/**
|
|
1668
1645
|
* Render custom sheet all menu.
|
|
1669
1646
|
*
|
|
@@ -1674,7 +1651,7 @@ export declare interface WorkbookStripProps extends default_2.HTMLAttributes<HTM
|
|
|
1674
1651
|
/**
|
|
1675
1652
|
* Allow for customizations om sheet tabs.
|
|
1676
1653
|
*/
|
|
1677
|
-
|
|
1654
|
+
propsSheetTab?: Partial<SheetTabProps>;
|
|
1678
1655
|
/**
|
|
1679
1656
|
* Render custom sheet tabs.
|
|
1680
1657
|
* @param props
|
|
@@ -1748,23 +1725,27 @@ export declare interface WorkbookTitleProps extends default_2.HTMLAttributes<HTM
|
|
|
1748
1725
|
declare interface WorkbookToolbarsProps extends default_2.HTMLAttributes<HTMLDivElement> {
|
|
1749
1726
|
commands: ICommands.IGroup;
|
|
1750
1727
|
/**
|
|
1751
|
-
* Wrap the select with custom component
|
|
1728
|
+
* Wrap the select with custom component.
|
|
1729
|
+
*
|
|
1752
1730
|
* @param children
|
|
1753
1731
|
*/
|
|
1754
|
-
|
|
1732
|
+
wrapperSelect?: (children: default_2.ReactNode) => default_2.ReactNode;
|
|
1755
1733
|
/**
|
|
1756
1734
|
* Properties for the select
|
|
1757
1735
|
*/
|
|
1758
|
-
|
|
1759
|
-
/**
|
|
1760
|
-
|
|
1736
|
+
propsSelect?: SxProps;
|
|
1737
|
+
/**
|
|
1738
|
+
* If we need to render compact.
|
|
1739
|
+
*/
|
|
1740
|
+
isCompact?: boolean;
|
|
1761
1741
|
/**
|
|
1762
|
-
* Wrap the palette with custom component
|
|
1742
|
+
* Wrap the palette with custom component.
|
|
1743
|
+
*
|
|
1763
1744
|
* @param children
|
|
1764
1745
|
*/
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
|
|
1746
|
+
wrapperPalette?: (children: default_2.ReactNode) => default_2.ReactNode;
|
|
1747
|
+
propsPalette?: PaperProps;
|
|
1748
|
+
propsToolbars?: Record<string, ToolbarProps>;
|
|
1768
1749
|
workbook?: IWorkbookElement;
|
|
1769
1750
|
/**
|
|
1770
1751
|
* MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
|
|
@@ -1777,7 +1758,4 @@ export declare const WorkbookViewCommandButton: default_2.NamedExoticComponent<O
|
|
|
1777
1758
|
export declare interface WorkbookViewCommandButtonProps extends CommandPopupButtonProps {
|
|
1778
1759
|
}
|
|
1779
1760
|
|
|
1780
|
-
|
|
1781
|
-
export * from "@sheetxl/io";
|
|
1782
|
-
|
|
1783
1761
|
export { }
|