@sheetxl/studio-mui 0.7.19 → 0.7.20

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 (42) hide show
  1. package/browser/cjs/9A8PR69vLQMV7BcN.cjs +20 -0
  2. package/browser/cjs/{DdfZbPGZ8PPPUM_a.cjs → BQNV7GVR6JkMal0s.cjs} +1 -1
  3. package/browser/cjs/{CRfQidmKBQ4Osnbw.cjs → BU-c6ouMN5P9GFpC.cjs} +1 -1
  4. package/browser/cjs/{CnqcFtkhyr8c_vIx.cjs → CPXMzOdl6xxPLfPn.cjs} +6 -6
  5. package/browser/cjs/{Bewd3fxKZsnU-nNE.cjs → C_j6lCasu1t14O9Y.cjs} +1 -1
  6. package/browser/cjs/{DQDHzkk3uE69oOf1.cjs → CtrHMVYocAsdsdWM.cjs} +2 -2
  7. package/browser/cjs/{BGM5Egsh-nk8JoMR.cjs → DG1AUTzpqtpS_jVC.cjs} +1 -1
  8. package/browser/cjs/{O0u5_8LdiNZxf7nW.cjs → Dc9yE1yxW-8SY3Hv.cjs} +1 -1
  9. package/browser/cjs/{bHc9WXWuOLgCy20D.cjs → Dj9IHyA7WeKPeOcw.cjs} +1 -1
  10. package/browser/cjs/{DeVzYeQ2NQw772Pw.cjs → DncFK07jNQbBqKkM.cjs} +3 -3
  11. package/browser/cjs/{CDa5R5H06f0QGbLy.cjs → DoSWqHU9pvfHVYlj.cjs} +2 -2
  12. package/browser/cjs/{DLI8Ew9QZfYFQggZ.cjs → hW1tQx38Ra1unYqS.cjs} +2 -2
  13. package/browser/cjs/index.cjs +2 -2
  14. package/browser/esm/{B_99zP5rSV8EjlLY.mjs → BCJfGxexFSseQSX1.mjs} +1 -1
  15. package/browser/esm/{CW4BTiGS1PKWCRBT.mjs → BG8BFBORDGBJ3nhX.mjs} +2 -2
  16. package/browser/esm/{Epfu4gRj2jHk_aDB.mjs → BW4phvITufQ_VYkF.mjs} +524 -525
  17. package/browser/esm/{C4TtshZ7KhuiUGbn.mjs → BZ9mDgpYGUEkfYek.mjs} +3 -3
  18. package/browser/esm/{DDfXhHCLfmybPYNh.mjs → CCw88yjz7gsAET8V.mjs} +2 -2
  19. package/browser/esm/{CxSd30g44XJ8mnmj.mjs → CzI2pgZrodF1v9Qy.mjs} +2 -2
  20. package/browser/esm/{BdkP5a6d0ML7Y0b2.mjs → CzbyIwG_G4o6kvXx.mjs} +1 -1
  21. package/browser/esm/{Cmnwt2GoquorcXj3.mjs → DnnkEOAQ3T-BZ8YN.mjs} +1 -1
  22. package/browser/esm/DuBLWU88ClLWzYcS.mjs +4510 -0
  23. package/browser/esm/{DUKRC4tS-eJTCx_v.mjs → MNeM7EdplvhB32i_.mjs} +1 -1
  24. package/browser/esm/{jCtxuLpDj7wzHB8p.mjs → R5qqTNvjnM3WxJs7.mjs} +1 -1
  25. package/browser/esm/index.mjs +18 -19
  26. package/browser/esm/{CQRjYFZa4QbRTGg_.mjs → tHtBuu4Jh64s0gfO.mjs} +1 -1
  27. package/licenses/dependencies.txt +139 -139
  28. package/node/esm/{eZ7cx2YnaEfXyfU8.mjs → BCop3xTgurk_pOXZ.mjs} +1 -1
  29. package/node/esm/{BEnfb2SK8bA4gTFW.mjs → BFHAvoo6cadd7zYQ.mjs} +1 -1
  30. package/node/esm/{DNlKlusE8DeOTRuC.mjs → BScUpdKO-b4Gr5Xm.mjs} +1 -1
  31. package/node/esm/{BZDELNZUW344wqXt.mjs → BcKSdSKQD8WAIJsN.mjs} +1 -1
  32. package/node/esm/{CkTwDMf16gYei7o2.mjs → BrOlE1aJNCNuEX5e.mjs} +2 -3
  33. package/node/esm/{Id0KR5kK1ADVhWhD.mjs → Cy29Wsw-LIboDmIX.mjs} +1 -1
  34. package/node/esm/{DiTrdBQV2uxN3GKM.mjs → DxLeMhSCAbLseA57.mjs} +1 -1
  35. package/node/esm/{D3_AGbvzQKHFYZxn.mjs → DzH9wpTF59hEQ5jd.mjs} +1 -1
  36. package/node/esm/{B8fe0e-2ZKPkjmUL.mjs → QXAsw9Yj3OjQnfqS.mjs} +1 -1
  37. package/node/esm/index.mjs +1025 -1028
  38. package/node/esm/{BNP3QSlZuis44plx.mjs → xfteOmuy00dffn5q.mjs} +1 -1
  39. package/package.json +8 -8
  40. package/types/index.d.ts +87 -108
  41. package/browser/cjs/BZwSUqHASXkJlWax.cjs +0 -20
  42. package/browser/esm/D0Qe0M3MAH6Ya8_q.mjs +0 -4513
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @license @sheetxl/studio-mui - Studio - Spreadsheet UI built with SheetXL SDK using React & MUI. - v0.7.19
2
+ * @license @sheetxl/studio-mui - Studio - Spreadsheet UI built with SheetXL SDK using React & MUI. - v0.7.20
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.19",
4
+ "version": "0.7.20",
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.19",
52
- "@sheetxl/io": "^0.7.19",
53
- "@sheetxl/react": "^0.7.19",
54
- "@sheetxl/sdk": "^0.7.19",
55
- "@sheetxl/utils": "^0.7.19",
56
- "@sheetxl/utils-mui": "^0.7.19",
57
- "@sheetxl/utils-react": "^0.7.19",
51
+ "@sheetxl/grid-react": "^0.7.20",
52
+ "@sheetxl/io": "^0.7.20",
53
+ "@sheetxl/react": "^0.7.20",
54
+ "@sheetxl/sdk": "^0.7.20",
55
+ "@sheetxl/utils": "^0.7.20",
56
+ "@sheetxl/utils-mui": "^0.7.20",
57
+ "@sheetxl/utils-react": "^0.7.20",
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
@@ -7,7 +7,7 @@ import { CommandContext } from '@sheetxl/react';
7
7
  import { CommandPopupButtonProps } from '@sheetxl/utils-mui';
8
8
  import { default as default_2 } from 'react';
9
9
  import { DefaultTaskPaneRegistry } from '@sheetxl/react';
10
- import { ErrorPanelProps } from '@sheetxl/utils-mui';
10
+ import { ErrorPanelProps } from '@sheetxl/utils-react';
11
11
  import { ExhibitIconButtonProps } from '@sheetxl/utils-mui';
12
12
  import { ExhibitPopupButtonProps } from '@sheetxl/utils-mui';
13
13
  import { ExhibitPopupIconButtonProps } from '@sheetxl/utils-mui';
@@ -39,7 +39,7 @@ import { IWorkbookIO } from '@sheetxl/io';
39
39
  import { JSX } from 'react/jsx-runtime';
40
40
  import { LicenseDetails } from '@sheetxl/sdk';
41
41
  import { LicenseManager } from '@sheetxl/sdk';
42
- import { LoadingPanelProps } from '@sheetxl/utils-mui';
42
+ import { LoadingPanelProps } from '@sheetxl/utils-react';
43
43
  import { PaperProps } from '@mui/material';
44
44
  import { PopupButtonType } from '@sheetxl/utils-mui';
45
45
  import { ReadFormatType } from '@sheetxl/io';
@@ -57,7 +57,6 @@ import { ToolbarProps } from '@mui/material';
57
57
  import { UndoManager } from '@sheetxl/utils';
58
58
  import { useModelListener } from '@sheetxl/react';
59
59
  import { useRangeListener } from '@sheetxl/react';
60
- import { WorkbookHandle } from '@sheetxl/io';
61
60
  import { WriteFormatType } from '@sheetxl/io';
62
61
  import { WriteWorkbookOptions } from '@sheetxl/io';
63
62
 
@@ -200,7 +199,7 @@ export declare interface ClearCommandButtonProps extends CommandPopupButtonProps
200
199
  /**
201
200
  * Given a colorDef Provides a color preview as a swatch, a tooltip, and returns an adjusted color.
202
201
  */
203
- export declare const ColorButton: default_2.FC<ColorButtonProps>;
202
+ export declare const ColorButton: default_2.MemoExoticComponent<(props: ColorButtonProps) => JSX.Element>;
204
203
 
205
204
  export declare const ColorButtonList: default_2.FC<ColorButtonListProps>;
206
205
 
@@ -354,17 +353,6 @@ export declare interface ColorPopupButtonProps extends Omit<ExhibitPopupIconButt
354
353
  darkMode?: boolean;
355
354
  }
356
355
 
357
- /**
358
- * A set of ColorSpace from tinycolor
359
- */
360
- declare interface ColorSpace {
361
- hsl: any;
362
- hex: any;
363
- rgb: any;
364
- hsv: any;
365
- source: any;
366
- }
367
-
368
356
  /**
369
357
  * Creates a gridStyle from a MUI theme
370
358
  * @param appTheme The outer theme used for toolbars and any containing application.
@@ -388,8 +376,6 @@ export declare interface CustomColorPanelProps extends default_2.HTMLAttributes<
388
376
  renderers?: any;
389
377
  }
390
378
 
391
- export declare const defaultNewWorkbook: () => void;
392
-
393
379
  export { DefaultTaskPaneRegistry }
394
380
 
395
381
  export declare const DocThemeCommandButton: default_2.NamedExoticComponent<Omit<DocThemeCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
@@ -419,19 +405,23 @@ export declare interface DocThemeCommandButtonProps extends Omit<ThemeSelectPopu
419
405
  /**
420
406
  * Fully functional application. Wraps a workbook in a simple container for a standalone application.
421
407
  * Minimum usefulness is:
408
+ * * resolve initial workbook and loading panel
422
409
  * * workbook
423
410
  * * snackbar
424
411
  * * export/import to local file system
425
412
  * * file name
426
413
  * * material-ui theme for light/dark toggle
427
414
  */
428
- export declare const EagerStudio: default_2.FC<StudioProps & WorkbookRefAttribute>;
415
+ export declare const EagerStudio: default_2.NamedExoticComponent<Omit<StudioProps, "ref"> & default_2.RefAttributes<IWorkbookElement>>;
429
416
 
430
417
  export declare const FillCommandButton: default_2.NamedExoticComponent<Omit<FillCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
431
418
 
432
419
  export declare interface FillCommandButtonProps extends CommandPopupButtonProps {
433
420
  }
434
421
 
422
+ /**
423
+ * FilterColumnMenu component to provide a menu for filter column actions.
424
+ */
435
425
  export declare const FilterColumnMenu: default_2.NamedExoticComponent<FilterColumnMenuProps & default_2.RefAttributes<HTMLDivElement>>;
436
426
 
437
427
  export declare interface FilterColumnMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
@@ -526,11 +516,7 @@ export declare interface FontSizeCommandButtonProps extends Omit<ExhibitPopupIco
526
516
  * This tracks the selection of the sheet and
527
517
  * updates the a named range editor and a sheet cell editor.
528
518
  */
529
- export declare const FormulaBar: default_2.NamedExoticComponent<FormulaBarProps & default_2.RefAttributes<IFormulaBarElement>>;
530
-
531
- export declare type FormulaBarAttribute = {
532
- ref?: default_2.Ref<IFormulaBarElement>;
533
- };
519
+ export declare const FormulaBar: default_2.NamedExoticComponent<Omit<FormulaBarProps, "ref"> & default_2.RefAttributes<IFormulaBarElement>>;
534
520
 
535
521
  export declare interface FormulaBarAttributes {
536
522
  isFormulaBarElement: () => true;
@@ -575,6 +561,10 @@ export declare interface FormulaBarProps extends default_2.HTMLAttributes<HTMLDi
575
561
  * The grid style to use for the cell editor.
576
562
  */
577
563
  gridStyle?: GridStyle;
564
+ /**
565
+ * Ref for the FormulaBar element.
566
+ */
567
+ ref?: default_2.Ref<IFormulaBarElement>;
578
568
  }
579
569
 
580
570
  /**
@@ -644,10 +634,21 @@ export declare interface InsertImageCommandButtonProps extends CommandPopupButto
644
634
  showQuickButton?: boolean;
645
635
  }
646
636
 
637
+ /**
638
+ * Workbook specific attributes beyond HTMLDivElement.
639
+ */
640
+ export declare interface IWorkbookAttributes {
641
+ isWorkbookElement: () => true;
642
+ getWorkbook: () => IWorkbook;
643
+ getViewportElement: () => HTMLElement;
644
+ getSheetElement: () => ISheetElement;
645
+ getFormulaBarElement: () => IFormulaBarElement;
646
+ }
647
+
647
648
  /**
648
649
  * Type returned via ref property
649
650
  */
650
- export declare interface IWorkbookElement extends HTMLDivElement, WorkbookAttributes {
651
+ export declare interface IWorkbookElement extends HTMLDivElement, IWorkbookAttributes {
651
652
  }
652
653
 
653
654
  /**
@@ -682,7 +683,7 @@ declare interface MovableContextMenuProps extends default_2.HTMLAttributes<HTMLD
682
683
  /**
683
684
  * Editor used for selecting, editing, or removing named ranges.
684
685
  */
685
- export declare const NamedCollectionEditor: default_2.NamedExoticComponent<NamedCollectionEditorProps & default_2.RefAttributes<INamedCollectionEditorElement>>;
686
+ export declare const NamedCollectionEditor: default_2.NamedExoticComponent<Omit<NamedCollectionEditorProps, "ref"> & default_2.RefAttributes<INamedCollectionEditorElement>>;
686
687
 
687
688
  export declare interface NamedCollectionEditorAttributes {
688
689
  }
@@ -710,18 +711,16 @@ export declare interface NamedCollectionEditorProps extends default_2.HTMLAttrib
710
711
  readonly?: boolean;
711
712
  parentFloat?: FloatReference;
712
713
  commandPopupButtonProps?: CommandPopupButtonProps;
713
- }
714
-
715
- export declare type NamedCollectionEditorRefAttribute = {
714
+ /**
715
+ * Reference to the underlying element
716
+ */
716
717
  ref?: default_2.Ref<INamedCollectionEditorElement>;
717
- };
718
+ }
718
719
 
719
720
  /**
720
721
  * NamedItem input field.
721
722
  */
722
- export declare const NamedInput: default_2.FC<NamedInputProps & {
723
- ref?: default_2.Ref<HTMLDivElement>;
724
- }>;
723
+ export declare const NamedInput: default_2.NamedExoticComponent<Omit<NamedInputProps, "ref"> & default_2.RefAttributes<HTMLDivElement>>;
725
724
 
726
725
  export declare interface NamedInputProps extends FormControlProps {
727
726
  /**
@@ -756,6 +755,10 @@ export declare interface NamedInputProps extends FormControlProps {
756
755
  * This is only used if formName is provided.
757
756
  */
758
757
  formOptions?: RegisterOptions;
758
+ /**
759
+ * Underling reference to the input element.
760
+ */
761
+ ref?: default_2.Ref<HTMLDivElement>;
759
762
  }
760
763
 
761
764
  export declare const NumberFormatCommandButton: default_2.NamedExoticComponent<Omit<NumberFormatCommandButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
@@ -863,9 +866,13 @@ export declare interface RequestTitleOptions extends FocusOptions {
863
866
  * By default we will print examples message if dev and eval only
864
867
  *
865
868
  * @param forcePrintExamples
869
+ * @hidden
866
870
  */
867
871
  export declare const setPrintExamplesOnLoad: (forcePrintExamples: boolean) => void;
868
872
 
873
+ /**
874
+ * Menu showing all sheets in the workbook.
875
+ */
869
876
  export declare const SheetsAllMenu: default_2.NamedExoticComponent<SheetsAllMenuProps & default_2.RefAttributes<HTMLDivElement>>;
870
877
 
871
878
  export declare interface SheetsAllMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
@@ -882,9 +889,15 @@ export declare interface SheetsAllMenuProps extends default_2.HTMLAttributes<HTM
882
889
  closeFloatAll: () => void;
883
890
  }
884
891
 
892
+ /**
893
+ * A tab representing a sheet in a workbook.
894
+ */
885
895
  export declare const SheetTab: default_2.NamedExoticComponent<TabProps & default_2.RefAttributes<HTMLElement>>;
886
896
 
887
- export declare const SheetTabMenu: default_2.FC<SheetTabMenuProps>;
897
+ /**
898
+ * Menu for sheet tab operations such as renaming, deleting, and coloring.
899
+ */
900
+ export declare const SheetTabMenu: default_2.NamedExoticComponent<SheetTabMenuProps & default_2.RefAttributes<HTMLDivElement>>;
888
901
 
889
902
  export declare interface SheetTabMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
890
903
  /**
@@ -944,7 +957,13 @@ export declare const SortFilterCommandButton: default_2.NamedExoticComponent<Omi
944
957
  * This show the current cell state as an unstyled editable field.
945
958
  * This wraps this with material styling and submit and cancel buttons
946
959
  */
947
- export declare const StatusBar: default_2.FC<StatusBarProps & StatusBarRefAttribute>;
960
+ export declare const StatusBar: default_2.NamedExoticComponent<Omit<StatusBarProps, "ref"> & default_2.RefAttributes<StatusBarElement>>;
961
+
962
+ export declare interface StatusBarAttributes {
963
+ }
964
+
965
+ export declare interface StatusBarElement extends HTMLDivElement, StatusBarAttributes {
966
+ }
948
967
 
949
968
  export declare interface StatusBarItem {
950
969
  /**
@@ -974,15 +993,9 @@ export declare interface StatusBarProps extends default_2.HTMLAttributes<HTMLDiv
974
993
  sheet?: ISheet;
975
994
  gridStyle?: GridStyle;
976
995
  childrenEnd?: default_2.ReactNode | undefined;
996
+ ref?: default_2.Ref<StatusBarElement>;
977
997
  }
978
998
 
979
- export declare interface StatusBarRef {
980
- }
981
-
982
- export declare type StatusBarRefAttribute = {
983
- ref?: default_2.Ref<StatusBarRef>;
984
- };
985
-
986
999
  /**
987
1000
  * Studio
988
1001
  *
@@ -1002,7 +1015,7 @@ export declare type StatusBarRefAttribute = {
1002
1015
  *
1003
1016
  * - [Studio](https://api.sheetxl.com/variables/_sheetxl_studio-mui.Studio.html)
1004
1017
  */
1005
- declare const Studio: default_2.FC<StudioProps & WorkbookRefAttribute>;
1018
+ declare const Studio: default_2.NamedExoticComponent<Omit<StudioProps, "ref"> & default_2.RefAttributes<IWorkbookElement>>;
1006
1019
  export { Studio }
1007
1020
  export default Studio;
1008
1021
 
@@ -1015,36 +1028,36 @@ export declare interface StudioElement extends IWorkbookElement {
1015
1028
  /**
1016
1029
  * Properties for the Studio component.
1017
1030
  */
1018
- export declare interface StudioProps extends Omit<WorkbookElementProps, "workbook" | "onError"> {
1031
+ export declare interface StudioProps extends Omit<WorkbookElementProps, "workbook"> {
1019
1032
  /**
1020
1033
  * The model to use in the IWorkbookElement.
1021
1034
  *
1022
1035
  * @remarks
1023
1036
  * If not provided a default model will be created.
1024
1037
  */
1025
- workbook?: IWorkbook | Promise<IWorkbook> | WorkbookHandle | Promise<WorkbookHandle> | ReadWorkbookOptions;
1038
+ workbook?: IWorkbook | Promise<IWorkbook> | ReadWorkbookOptions;
1026
1039
  /**
1027
1040
  * Called if the `IWorkbook` changes.
1028
1041
  *
1029
1042
  * @param workbook - The workbook
1030
1043
  */
1031
1044
  onWorkbookChange?: (workbook: IWorkbook) => void;
1032
- /**
1033
- * Custom logo.
1034
- */
1035
- logo?: React.ReactNode;
1036
1045
  /**
1037
1046
  * Called if the workbook model is a promise that fails to load.
1038
1047
  *
1039
1048
  * @param error The error
1040
1049
  */
1041
- onError?: (error: any) => void;
1050
+ onWorkbookError?: (error: any) => void;
1042
1051
  /**
1043
- * Allow for a custom error panel to be used for errors.
1052
+ * Allow for a custom error panel if workbook load error occurs.
1044
1053
  *
1045
- * @defaultValue ErrorPanel
1054
+ * @defaultValue StackTraceErrorPanel
1055
+ */
1056
+ renderWorkbookError?: (props: ErrorPanelProps) => React.ReactElement;
1057
+ /**
1058
+ * Custom logo.
1046
1059
  */
1047
- errorPanel?: React.ComponentType<ErrorPanelProps>;
1060
+ logo?: React.ReactNode;
1048
1061
  /**
1049
1062
  * Title to display.
1050
1063
  *
@@ -1301,14 +1314,6 @@ export declare interface ThemeSelectPopupButtonProps extends Omit<ExhibitPopupIc
1301
1314
  darkMode?: boolean;
1302
1315
  }
1303
1316
 
1304
- export declare const toState: (data: ColorSpace | string, oldHue?: number) => {
1305
- hsl: any;
1306
- hex: string;
1307
- rgb: any;
1308
- hsv: any;
1309
- source: any;
1310
- };
1311
-
1312
1317
  /**
1313
1318
  * Menu for underline options
1314
1319
  */
@@ -1356,7 +1361,6 @@ export declare interface useWorkbookCommandsOptions {
1356
1361
  * The workbookElement. Only used for toggling fullscreen.
1357
1362
  */
1358
1363
  workbookElement: IWorkbookElement;
1359
- onNewWorkbook?: () => void;
1360
1364
  target: ICommands.ITarget | (() => ICommands.ITarget);
1361
1365
  commands: ICommands.IGroup;
1362
1366
  onExecute?: () => void;
@@ -1383,17 +1387,6 @@ export declare const WalkingCopyCommandButton: default_2.FC<WalkingCopyCommandBu
1383
1387
  export declare interface WalkingCopyCommandButtonProps extends CommandButtonProps {
1384
1388
  }
1385
1389
 
1386
- /**
1387
- * Workbook specific attributes
1388
- */
1389
- export declare interface WorkbookAttributes {
1390
- isWorkbookElement: () => true;
1391
- getWorkbook: () => IWorkbook;
1392
- getViewportElement: () => HTMLElement;
1393
- getSheetElement: () => ISheetElement;
1394
- getFormulaBarElement: () => IFormulaBarElement;
1395
- }
1396
-
1397
1390
  export declare const WorkbookContextMenu: default_2.FC<WorkbookContextMenuProps>;
1398
1391
 
1399
1392
  export declare interface WorkbookContextMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
@@ -1419,17 +1412,6 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
1419
1412
  * This can be accessed via the workbook ref.
1420
1413
  */
1421
1414
  workbook?: IWorkbook;
1422
- /**
1423
- * Options to use when a new Workbook is created.
1424
- * @remarks
1425
- * This is ignored if the model is provided externally.
1426
- * The default behavior is to use the options from the current workbook if provided.
1427
- */
1428
- createWorkbookOptions?: IWorkbook.ConstructorOptions;
1429
- /**
1430
- * Hook to perform a action on new workbook
1431
- */
1432
- onNewWorkbook?: () => void;
1433
1415
  /**
1434
1416
  * Callback for when the workbook is loaded. Useful for hiding/showing
1435
1417
  * loading panels.
@@ -1458,10 +1440,11 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
1458
1440
  formulaBarProps?: FormulaBarProps;
1459
1441
  /**
1460
1442
  * Render FormulaBar.
1461
- * @param props
1443
+ *
1444
+ * @param props The properties for the FormulaBar.
1462
1445
  * @returns A React Element representing the FormulaBar.
1463
1446
  */
1464
- renderFormulaBar?: (props: FormulaBarProps, ref: default_2.Ref<IFormulaBarElement>) => default_2.ReactElement;
1447
+ renderFormulaBar?: (props: FormulaBarProps) => default_2.ReactElement;
1465
1448
  /**
1466
1449
  * This doesn't influence # of tabs just the visibility of the widget.
1467
1450
  * @defaultValue 'workbook model but can be overridden'
@@ -1487,7 +1470,8 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
1487
1470
  */
1488
1471
  statusBarProps?: StatusBarProps;
1489
1472
  /**
1490
- * Pass in a custom toolbar.
1473
+ * Pass in a custom statusbar.
1474
+ *
1491
1475
  * @param props
1492
1476
  * @returns A React Element representing the StatusBar.
1493
1477
  */
@@ -1527,22 +1511,22 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
1527
1511
  */
1528
1512
  renderMovableMenu?: (props: MovableContextMenuProps) => default_2.ReactElement;
1529
1513
  /**
1530
- * Allow for customizations on loading panel.
1514
+ * Allow for customizations on loading panels.
1531
1515
  */
1532
- loadingPanelProps?: LoadingPanelProps;
1516
+ loadingProps?: LoadingPanelProps;
1533
1517
  /**
1534
- * Render custom loading panel.
1518
+ * Assign a custom loading panel.
1535
1519
  *
1536
- * @param props
1537
1520
  * @returns A React Element representing the LoadingPane.
1538
1521
  */
1539
- renderLoadingPanel?: (props: LoadingPanelProps) => default_2.ReactElement;
1522
+ renderLoading?: (props: LoadingPanelProps) => default_2.ReactElement;
1540
1523
  /**
1541
1524
  * Allow for customizations on loading panel.
1542
1525
  */
1543
1526
  sheetProps?: SheetProps;
1544
1527
  /**
1545
1528
  * Render custom ISheetElement.
1529
+ *
1546
1530
  * @param props
1547
1531
  * @returns A React Element representing the Sheet.
1548
1532
  */
@@ -1586,6 +1570,10 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
1586
1570
  * @defaultValue false
1587
1571
  */
1588
1572
  enableDarkImages?: boolean;
1573
+ /**
1574
+ * Ref for the workbook element
1575
+ */
1576
+ ref?: default_2.Ref<IWorkbookElement>;
1589
1577
  }
1590
1578
 
1591
1579
  /**
@@ -1594,7 +1582,8 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
1594
1582
  export declare const WorkbookIO: _WorkbookIO;
1595
1583
 
1596
1584
  /**
1597
- * Wraps the IO WorkbookIO class to provide lazy import.
1585
+ * Wraps the IO WorkbookIO class to provide lazy import and adds support for IReactNotifier
1586
+ * notification to the read method.
1598
1587
  *
1599
1588
  * @see '@sheetxl/io/IWorkbookIO'
1600
1589
  */
@@ -1612,7 +1601,7 @@ export declare class _WorkbookIO implements IWorkbookIO {
1612
1601
  *
1613
1602
  * @param options {@link ReadWorkbookOptions}
1614
1603
  */
1615
- read(options: ReadWorkbookOptions, notifier?: IReactNotifier): Promise<WorkbookHandle>;
1604
+ read(options: ReadWorkbookOptions, notifier?: IReactNotifier): Promise<IWorkbook>;
1616
1605
  /** @inheritdoc IWorkbookIO.writeFile */
1617
1606
  writeFile(fileName: string | null, workbook: IWorkbook, options?: WriteWorkbookOptions): Promise<boolean>;
1618
1607
  /** @inheritdoc IWorkbookIO.registerReadFormat */
@@ -1631,16 +1620,6 @@ export declare type WorkbookLoadEvent = {
1631
1620
  source: IWorkbookElement;
1632
1621
  };
1633
1622
 
1634
- export declare type WorkbookRefAttribute = {
1635
- ref?: default_2.Ref<IWorkbookElement>;
1636
- };
1637
-
1638
- /**
1639
- * For elements that also need the ref. Less common but some factory renderers
1640
- */
1641
- export declare interface WorkbookRefProps extends WorkbookElementProps {
1642
- }
1643
-
1644
1623
  export declare const WorkbookStrip: default_2.NamedExoticComponent<WorkbookStripProps & default_2.RefAttributes<HTMLElement>>;
1645
1624
 
1646
1625
  /**
@@ -1722,7 +1701,7 @@ export declare interface WorkbookStripProps extends default_2.HTMLAttributes<HTM
1722
1701
  gridStyle?: GridStyle;
1723
1702
  }
1724
1703
 
1725
- export declare const WorkbookTitle: default_2.FC<WorkbookTitleProps & WorkbookTitleRefAttribute>;
1704
+ export declare const WorkbookTitle: default_2.NamedExoticComponent<Omit<WorkbookTitleProps, "ref"> & default_2.RefAttributes<IWorkbookTitleElement>>;
1726
1705
 
1727
1706
  export declare interface WorkbookTitleAttributes {
1728
1707
  /**
@@ -1760,11 +1739,11 @@ export declare interface WorkbookTitleProps extends default_2.HTMLAttributes<HTM
1760
1739
  * @defaultValue false
1761
1740
  */
1762
1741
  hidden?: boolean;
1763
- }
1764
-
1765
- export declare type WorkbookTitleRefAttribute = {
1742
+ /**
1743
+ * Ref for the IWorkbookTitleElement
1744
+ */
1766
1745
  ref?: default_2.Ref<IWorkbookTitleElement>;
1767
- };
1746
+ }
1768
1747
 
1769
1748
  declare interface WorkbookToolbarsProps extends default_2.HTMLAttributes<HTMLDivElement> {
1770
1749
  commands: ICommands.IGroup;