@sheetxl/studio-mui 0.7.19 → 0.7.21

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 (41) hide show
  1. package/browser/cjs/{DQDHzkk3uE69oOf1.cjs → 7uRpnSJkNHg_E-KO.cjs} +2 -2
  2. package/browser/cjs/B-O26BvbKDImp7pm.cjs +20 -0
  3. package/browser/cjs/{bHc9WXWuOLgCy20D.cjs → B4j_sdzJNzq1ZPbT.cjs} +1 -1
  4. package/browser/cjs/{BGM5Egsh-nk8JoMR.cjs → BWS4gFWp8lDPvR9C.cjs} +1 -1
  5. package/browser/cjs/{CDa5R5H06f0QGbLy.cjs → CmSwD6NZAHhOcRi3.cjs} +2 -2
  6. package/browser/cjs/{DLI8Ew9QZfYFQggZ.cjs → DHwhTAQeNs4slttB.cjs} +2 -2
  7. package/browser/cjs/{Bewd3fxKZsnU-nNE.cjs → DMOT_ixtKqRvPULq.cjs} +1 -1
  8. package/browser/cjs/{CnqcFtkhyr8c_vIx.cjs → DX5ji_lT0Qlqznv7.cjs} +6 -6
  9. package/browser/cjs/{DdfZbPGZ8PPPUM_a.cjs → DbqHWelIXc-F2a9N.cjs} +1 -1
  10. package/browser/cjs/index.cjs +2 -2
  11. package/browser/cjs/{CRfQidmKBQ4Osnbw.cjs → muTJOFrCXh156rjc.cjs} +1 -1
  12. package/browser/cjs/{DeVzYeQ2NQw772Pw.cjs → rIy1Cx7HX-8zaQjY.cjs} +3 -3
  13. package/browser/cjs/{O0u5_8LdiNZxf7nW.cjs → saPH3d5fE-ugXp6m.cjs} +1 -1
  14. package/browser/esm/{B_99zP5rSV8EjlLY.mjs → 0D8VtNalLeBTB51a.mjs} +1 -1
  15. package/browser/esm/{C4TtshZ7KhuiUGbn.mjs → BMo7K5LaD7zuDVg9.mjs} +3 -3
  16. package/browser/esm/{CW4BTiGS1PKWCRBT.mjs → BNmwaUWz2DJqWumP.mjs} +2 -2
  17. package/browser/esm/{DDfXhHCLfmybPYNh.mjs → Btt4G85L5v01eySb.mjs} +2 -2
  18. package/browser/esm/{DUKRC4tS-eJTCx_v.mjs → C7jHdVMf6Yr4eH_B.mjs} +1 -1
  19. package/browser/esm/{CxSd30g44XJ8mnmj.mjs → CROTe62QHFVo8YMt.mjs} +2 -2
  20. package/browser/esm/{jCtxuLpDj7wzHB8p.mjs → D5XNYGaC4Yw6vCRL.mjs} +1 -1
  21. package/browser/esm/{Epfu4gRj2jHk_aDB.mjs → DUzVAMWTrS0u37LX.mjs} +524 -525
  22. package/browser/esm/{CQRjYFZa4QbRTGg_.mjs → DltuoFr9A-WJccbV.mjs} +1 -1
  23. package/browser/esm/{Cmnwt2GoquorcXj3.mjs → DtifaYF85GrfJ9_1.mjs} +1 -1
  24. package/browser/esm/{BdkP5a6d0ML7Y0b2.mjs → aUkJls9HzxnrZSof.mjs} +1 -1
  25. package/browser/esm/index.mjs +18 -19
  26. package/browser/esm/mqkuG-TcLS4nn4x0.mjs +4531 -0
  27. package/node/esm/{DiTrdBQV2uxN3GKM.mjs → BYjJIMFsheqJcsEI.mjs} +1 -1
  28. package/node/esm/{eZ7cx2YnaEfXyfU8.mjs → CACqTiBtxYlo1mu7.mjs} +1 -1
  29. package/node/esm/{D3_AGbvzQKHFYZxn.mjs → CJU8jJhxtR3PEj2I.mjs} +1 -1
  30. package/node/esm/{BEnfb2SK8bA4gTFW.mjs → CS0OWM24rZpAGRKU.mjs} +1 -1
  31. package/node/esm/{B8fe0e-2ZKPkjmUL.mjs → CdUceTAldsMTIFnD.mjs} +1 -1
  32. package/node/esm/{DNlKlusE8DeOTRuC.mjs → D6B7z_d11sd-U1fU.mjs} +1 -1
  33. package/node/esm/{BNP3QSlZuis44plx.mjs → DCngEQG4um0yTeoj.mjs} +1 -1
  34. package/node/esm/{CkTwDMf16gYei7o2.mjs → DQnCFz2zJgMwLou_.mjs} +2 -3
  35. package/node/esm/{Id0KR5kK1ADVhWhD.mjs → Do7ts-uMkQANfvhq.mjs} +1 -1
  36. package/node/esm/index.mjs +1194 -1177
  37. package/node/esm/{BZDELNZUW344wqXt.mjs → oYh6joioOWhFd_R3.mjs} +1 -1
  38. package/package.json +8 -8
  39. package/types/index.d.ts +165 -207
  40. package/browser/cjs/BZwSUqHASXkJlWax.cjs +0 -20
  41. package/browser/esm/D0Qe0M3MAH6Ya8_q.mjs +0 -4513
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
 
@@ -212,7 +211,7 @@ export declare interface ColorButtonListProps extends default_2.HTMLAttributes<H
212
211
  previewColor?: IColor;
213
212
  onSelectColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
214
213
  onPreviewColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
215
- swatchProps?: Partial<SwatchProps>;
214
+ propsSwatch?: Partial<SwatchProps>;
216
215
  compareRGB?: boolean;
217
216
  darkMode?: boolean;
218
217
  }
@@ -224,7 +223,7 @@ export declare interface ColorButtonProps extends default_2.HTMLAttributes<HTMLE
224
223
  previewColor?: IColor;
225
224
  onSelectColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
226
225
  onPreviewColorDef?: (colorDef: IColor.DefinitionWithLabel) => void;
227
- swatchProps?: Partial<SwatchProps>;
226
+ propsSwatch?: Partial<SwatchProps>;
228
227
  defaultButtonSize?: number;
229
228
  isLarge?: boolean;
230
229
  compareRGB?: boolean;
@@ -344,7 +343,7 @@ export declare interface ColorPopupButtonProps extends Omit<ExhibitPopupIconButt
344
343
  * @defaultValue to Toolbar
345
344
  */
346
345
  variant?: PopupButtonType;
347
- panelProps?: Partial<ColorPanelProps>;
346
+ propsPanel?: Partial<ColorPanelProps>;
348
347
  /**
349
348
  * When closing the popup closeAll movables or just the current.
350
349
  * @defaultValue true
@@ -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,29 +405,29 @@ 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> {
438
428
  filter: IAutoFilter.IColumn;
439
429
  commands?: ICommands.IGroup;
440
430
  disabled?: boolean;
441
- /**
442
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
443
- */
444
- sx?: SxProps<Theme>;
445
431
  floatReference: FloatReference;
446
432
  }
447
433
 
@@ -452,21 +438,25 @@ export declare interface FilterColumnMenuProps extends default_2.HTMLAttributes<
452
438
  */
453
439
  export declare const FilterCommandButton: default_2.NamedExoticComponent<Omit<CommandPopupButtonProps<any, any>, "ref"> & default_2.RefAttributes<HTMLElement>>;
454
440
 
455
- export declare interface FilterRefProps extends FiltersProps {
456
- ref?: default_2.Ref<HTMLDivElement>;
457
- }
458
-
459
- export declare const Filters: default_2.FC<FiltersProps & {
460
- ref?: default_2.Ref<IFiltersElement>;
461
- }>;
441
+ export declare const Filters: default_2.NamedExoticComponent<Omit<FiltersProps, "ref"> & default_2.RefAttributes<IFiltersElement>>;
462
442
 
463
443
  export declare interface FiltersAttributes {
464
444
  isFilters: () => true;
465
445
  }
466
446
 
467
447
  export declare interface FiltersProps extends default_2.HTMLAttributes<HTMLDivElement> {
448
+ /**
449
+ * The filter to display.
450
+ */
468
451
  filter: IAutoFilter.IColumn;
452
+ /**
453
+ * Disables the filter UI.
454
+ */
469
455
  disabled?: boolean;
456
+ /**
457
+ * Ref for the Element.
458
+ */
459
+ ref?: default_2.Ref<IFiltersElement>;
470
460
  }
471
461
 
472
462
  /**
@@ -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;
@@ -554,7 +540,7 @@ export declare interface FormulaBarProps extends default_2.HTMLAttributes<HTMLDi
554
540
  /**
555
541
  * Allow for customizations on NamedCollectionEditor
556
542
  */
557
- NamedCollectionEditorProps?: NamedCollectionEditorProps;
543
+ propsNamedCollectionEditor?: NamedCollectionEditorProps;
558
544
  /**
559
545
  * Override the default NamedCollectionEditor
560
546
  */
@@ -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
  }
@@ -709,19 +710,17 @@ export declare interface NamedCollectionEditorProps extends default_2.HTMLAttrib
709
710
  disabled?: boolean;
710
711
  readonly?: boolean;
711
712
  parentFloat?: FloatReference;
712
- commandPopupButtonProps?: CommandPopupButtonProps;
713
- }
714
-
715
- export declare type NamedCollectionEditorRefAttribute = {
713
+ propsCommandPopupButton?: CommandPopupButtonProps;
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>>;
@@ -817,9 +820,7 @@ export declare interface PresetTableStylesCommandButtonProps extends CommandPopu
817
820
  /**
818
821
  * Range input field.
819
822
  */
820
- export declare const RangeInput: default_2.FC<RangeInputProps & {
821
- ref?: default_2.Ref<HTMLDivElement>;
822
- }>;
823
+ export declare const RangeInput: default_2.NamedExoticComponent<Omit<RangeInputProps, "ref"> & default_2.RefAttributes<HTMLDivElement>>;
823
824
 
824
825
  export declare interface RangeInputProps extends FormControlProps {
825
826
  /**
@@ -852,6 +853,10 @@ export declare interface RangeInputProps extends FormControlProps {
852
853
  * @param address
853
854
  */
854
855
  resolvedAddress: (address: ICellRanges.Address) => ICellRanges;
856
+ /**
857
+ * Reference to the element.
858
+ */
859
+ ref?: default_2.Ref<HTMLDivElement>;
855
860
  }
856
861
 
857
862
  export declare interface RequestTitleOptions extends FocusOptions {
@@ -863,9 +868,13 @@ export declare interface RequestTitleOptions extends FocusOptions {
863
868
  * By default we will print examples message if dev and eval only
864
869
  *
865
870
  * @param forcePrintExamples
871
+ * @hidden
866
872
  */
867
873
  export declare const setPrintExamplesOnLoad: (forcePrintExamples: boolean) => void;
868
874
 
875
+ /**
876
+ * Menu showing all sheets in the workbook.
877
+ */
869
878
  export declare const SheetsAllMenu: default_2.NamedExoticComponent<SheetsAllMenuProps & default_2.RefAttributes<HTMLDivElement>>;
870
879
 
871
880
  export declare interface SheetsAllMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
@@ -882,9 +891,15 @@ export declare interface SheetsAllMenuProps extends default_2.HTMLAttributes<HTM
882
891
  closeFloatAll: () => void;
883
892
  }
884
893
 
894
+ /**
895
+ * A tab representing a sheet in a workbook.
896
+ */
885
897
  export declare const SheetTab: default_2.NamedExoticComponent<TabProps & default_2.RefAttributes<HTMLElement>>;
886
898
 
887
- export declare const SheetTabMenu: default_2.FC<SheetTabMenuProps>;
899
+ /**
900
+ * Menu for sheet tab operations such as renaming, deleting, and coloring.
901
+ */
902
+ export declare const SheetTabMenu: default_2.NamedExoticComponent<SheetTabMenuProps & default_2.RefAttributes<HTMLDivElement>>;
888
903
 
889
904
  export declare interface SheetTabMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
890
905
  /**
@@ -944,7 +959,13 @@ export declare const SortFilterCommandButton: default_2.NamedExoticComponent<Omi
944
959
  * This show the current cell state as an unstyled editable field.
945
960
  * This wraps this with material styling and submit and cancel buttons
946
961
  */
947
- export declare const StatusBar: default_2.FC<StatusBarProps & StatusBarRefAttribute>;
962
+ export declare const StatusBar: default_2.NamedExoticComponent<Omit<StatusBarProps, "ref"> & default_2.RefAttributes<StatusBarElement>>;
963
+
964
+ export declare interface StatusBarAttributes {
965
+ }
966
+
967
+ export declare interface StatusBarElement extends HTMLDivElement, StatusBarAttributes {
968
+ }
948
969
 
949
970
  export declare interface StatusBarItem {
950
971
  /**
@@ -974,15 +995,9 @@ export declare interface StatusBarProps extends default_2.HTMLAttributes<HTMLDiv
974
995
  sheet?: ISheet;
975
996
  gridStyle?: GridStyle;
976
997
  childrenEnd?: default_2.ReactNode | undefined;
998
+ ref?: default_2.Ref<StatusBarElement>;
977
999
  }
978
1000
 
979
- export declare interface StatusBarRef {
980
- }
981
-
982
- export declare type StatusBarRefAttribute = {
983
- ref?: default_2.Ref<StatusBarRef>;
984
- };
985
-
986
1001
  /**
987
1002
  * Studio
988
1003
  *
@@ -994,15 +1009,16 @@ export declare type StatusBarRefAttribute = {
994
1009
  * * Material-ui theme width light/dark toggle
995
1010
  * * lazy loading
996
1011
  *
997
- * Demos:
1012
+ * Demo:
998
1013
  *
999
- * - [SheetXL](https://storybook.sheetxl.com/)
1014
+ * - [SheetXL](https://storybook.sheetxl.com/?path=/story/studio--workbook-studio)
1000
1015
  *
1001
1016
  * API:
1002
1017
  *
1003
- * - [Studio](https://api.sheetxl.com/variables/_sheetxl_studio-mui.Studio.html)
1018
+ * - [StudioProps](https://api.sheetxl.com/interfaces/_sheetxl_studio-mui.StudioProps.html)
1019
+ * - [IWorkbookElement](https://api.sheetxl.com/interfaces/_sheetxl_studio-mui.IWorkbookElement.html)
1004
1020
  */
1005
- declare const Studio: default_2.FC<StudioProps & WorkbookRefAttribute>;
1021
+ declare const Studio: default_2.NamedExoticComponent<Omit<StudioProps, "ref"> & default_2.RefAttributes<IWorkbookElement>>;
1006
1022
  export { Studio }
1007
1023
  export default Studio;
1008
1024
 
@@ -1015,58 +1031,56 @@ export declare interface StudioElement extends IWorkbookElement {
1015
1031
  /**
1016
1032
  * Properties for the Studio component.
1017
1033
  */
1018
- export declare interface StudioProps extends Omit<WorkbookElementProps, "workbook" | "onError"> {
1034
+ export declare interface StudioProps extends Omit<WorkbookElementProps, "workbook">, Omit<PaperProps, 'autoFocus' | 'ref'> {
1019
1035
  /**
1020
- * The model to use in the IWorkbookElement.
1036
+ * The IWorkbook for the studio.
1021
1037
  *
1022
1038
  * @remarks
1023
- * If not provided a default model will be created.
1039
+ * This can be either an [IWorkbook](./_sheetxl_sdk.IWorkbook.html), a `Promise`
1040
+ * that resolves to an [IWorkbook](./_sheetxl_sdk.IWorkbook.html), or
1041
+ * a [ReadWorkbookOptions](./_sheetxl_io.ReadWorkbookOptions.html) object to create
1042
+ * the workbook from various sources.
1043
+ *
1044
+ * @see
1045
+ * * [IWorkbook](./_sheetxl_sdk.IWorkbook.html)
1046
+ * * [ReadWorkbookOptions](./_sheetxl_io.ReadWorkbookOptions.html)
1024
1047
  */
1025
- workbook?: IWorkbook | Promise<IWorkbook> | WorkbookHandle | Promise<WorkbookHandle> | ReadWorkbookOptions;
1048
+ workbook?: IWorkbook | Promise<IWorkbook> | ReadWorkbookOptions;
1026
1049
  /**
1027
1050
  * Called if the `IWorkbook` changes.
1028
1051
  *
1029
1052
  * @param workbook - The workbook
1030
1053
  */
1031
1054
  onWorkbookChange?: (workbook: IWorkbook) => void;
1032
- /**
1033
- * Custom logo.
1034
- */
1035
- logo?: React.ReactNode;
1036
1055
  /**
1037
1056
  * Called if the workbook model is a promise that fails to load.
1038
1057
  *
1039
1058
  * @param error The error
1040
1059
  */
1041
- onError?: (error: any) => void;
1060
+ onWorkbookError?: (error: any) => void;
1042
1061
  /**
1043
- * Allow for a custom error panel to be used for errors.
1062
+ * Allow for a custom error panel if workbook load error occurs.
1044
1063
  *
1045
- * @defaultValue ErrorPanel
1064
+ * @defaultValue StackTraceErrorPanel
1046
1065
  */
1047
- errorPanel?: React.ComponentType<ErrorPanelProps>;
1066
+ renderWorkbookError?: (props: ErrorPanelProps) => React.ReactElement;
1048
1067
  /**
1049
- * Title to display.
1050
- *
1051
- * @defaultValue none
1052
- *
1053
- * @remarks
1054
- * If title is null then it is hidden but if it is '' then it is shown with placeholder
1068
+ * Custom logo.
1055
1069
  */
1056
- title?: string;
1070
+ logo?: React.ReactNode;
1057
1071
  /**
1058
1072
  * Callback for title changes.
1059
1073
  *
1060
1074
  * @param title - The new title.
1061
1075
  */
1062
- onTitleChange?: (title: string) => void;
1076
+ onWorkbookTitleChange?: (title: string) => void;
1063
1077
  /**
1064
1078
  * Additional WorkbookTitle properties.
1065
1079
  *
1066
1080
  * @remarks
1067
1081
  * If onTitleChange or title is provided then the prop versions are ignored
1068
1082
  */
1069
- titleProps?: WorkbookTitleProps;
1083
+ propsWorkbookTitle?: WorkbookTitleProps;
1070
1084
  /**
1071
1085
  * Disable the import export options in the menu.
1072
1086
  */
@@ -1100,6 +1114,10 @@ export declare interface StudioProps extends Omit<WorkbookElementProps, "workboo
1100
1114
  * This will only be used the first time.
1101
1115
  */
1102
1116
  licenseKey?: string;
1117
+ /**
1118
+ * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1119
+ */
1120
+ sx?: SxProps<Theme>;
1103
1121
  }
1104
1122
 
1105
1123
  export declare const StyledStrokeIcon: (props: StyledStrokeIconProps) => default_2.ReactElement;
@@ -1144,9 +1162,7 @@ export declare const TablePlugin: () => void;
1144
1162
  /**
1145
1163
  * This is a way to canvas based TableStylePreview. It has a simple rendering but is lightweight.
1146
1164
  */
1147
- export declare const TableStyleCanvasPreview: default_2.FC<TableStyleCanvasPreviewProps & {
1148
- ref?: default_2.Ref<HTMLDivElement>;
1149
- }>;
1165
+ export declare const TableStyleCanvasPreview: default_2.NamedExoticComponent<Omit<TableStyleCanvasPreviewProps, "ref"> & default_2.RefAttributes<HTMLDivElement>>;
1150
1166
 
1151
1167
  export declare interface TableStyleCanvasPreviewProps extends default_2.HTMLAttributes<HTMLDivElement> {
1152
1168
  table: ITable;
@@ -1158,6 +1174,10 @@ export declare interface TableStyleCanvasPreviewProps extends default_2.HTMLAttr
1158
1174
  * If provided then this context will be used.
1159
1175
  */
1160
1176
  canvas?: HTMLCanvasElement;
1177
+ /**
1178
+ * Reference to the element.
1179
+ */
1180
+ ref?: default_2.Ref<HTMLDivElement>;
1161
1181
  }
1162
1182
 
1163
1183
  export declare type TableStyleOptionsAttribute = {
@@ -1282,9 +1302,7 @@ export declare interface ThemeSelectPanelProps extends default_2.HTMLAttributes<
1282
1302
  darkMode?: boolean;
1283
1303
  }
1284
1304
 
1285
- export declare const ThemeSelectPopupButton: default_2.FC<ThemeSelectPopupButtonProps & {
1286
- ref?: any;
1287
- }>;
1305
+ export declare const ThemeSelectPopupButton: default_2.NamedExoticComponent<Omit<ThemeSelectPopupButtonProps, "ref"> & default_2.RefAttributes<HTMLElement>>;
1288
1306
 
1289
1307
  export declare interface ThemeSelectPopupButtonProps extends Omit<ExhibitPopupIconButtonProps, "color" | "icon" | "createPopupPanel"> {
1290
1308
  themes: IThemeCollection;
@@ -1297,18 +1315,14 @@ export declare interface ThemeSelectPopupButtonProps extends Omit<ExhibitPopupIc
1297
1315
  * @defaultValue to Toolbar
1298
1316
  */
1299
1317
  variant?: PopupButtonType;
1300
- panelProps?: Partial<ThemeSelectPanelProps>;
1318
+ propsPanel?: Partial<ThemeSelectPanelProps>;
1301
1319
  darkMode?: boolean;
1320
+ /**
1321
+ * Ref to the underlying element
1322
+ */
1323
+ ref?: default_2.Ref<HTMLElement>;
1302
1324
  }
1303
1325
 
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
1326
  /**
1313
1327
  * Menu for underline options
1314
1328
  */
@@ -1356,7 +1370,6 @@ export declare interface useWorkbookCommandsOptions {
1356
1370
  * The workbookElement. Only used for toggling fullscreen.
1357
1371
  */
1358
1372
  workbookElement: IWorkbookElement;
1359
- onNewWorkbook?: () => void;
1360
1373
  target: ICommands.ITarget | (() => ICommands.ITarget);
1361
1374
  commands: ICommands.IGroup;
1362
1375
  onExecute?: () => void;
@@ -1383,17 +1396,6 @@ export declare const WalkingCopyCommandButton: default_2.FC<WalkingCopyCommandBu
1383
1396
  export declare interface WalkingCopyCommandButtonProps extends CommandButtonProps {
1384
1397
  }
1385
1398
 
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
1399
  export declare const WorkbookContextMenu: default_2.FC<WorkbookContextMenuProps>;
1398
1400
 
1399
1401
  export declare interface WorkbookContextMenuProps extends default_2.HTMLAttributes<HTMLDivElement> {
@@ -1410,35 +1412,26 @@ export declare interface WorkbookContextMenuProps extends default_2.HTMLAttribut
1410
1412
  floatReference: FloatReference;
1411
1413
  }
1412
1414
 
1415
+ /**
1416
+ * The main component for rendering a workbook.
1417
+ */
1413
1418
  export declare const WorkbookElement: default_2.NamedExoticComponent<Omit<WorkbookElementProps, "ref"> & default_2.RefAttributes<IWorkbookElement>>;
1414
1419
 
1415
- export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocus'> {
1420
+ /**
1421
+ * Properties and methods available on the workbook element.
1422
+ */
1423
+ export declare interface WorkbookElementProps extends Omit<default_2.HTMLAttributes<HTMLDivElement>, 'autoFocus'> {
1416
1424
  /**
1417
1425
  * A memory model of the workbook.
1418
1426
  * If one is not provided a default workbook model will be used.
1419
1427
  * This can be accessed via the workbook ref.
1420
1428
  */
1421
1429
  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
1430
  /**
1434
1431
  * Callback for when the workbook is loaded. Useful for hiding/showing
1435
1432
  * loading panels.
1436
1433
  */
1437
1434
  onElementLoad?: (event: WorkbookLoadEvent) => void | Promise<void>;
1438
- /**
1439
- * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
1440
- */
1441
- sx?: SxProps<Theme>;
1442
1435
  /**
1443
1436
  * Additional commands provided by application.
1444
1437
  */
@@ -1455,13 +1448,14 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
1455
1448
  /**
1456
1449
  * Allow for customizations on FormulaBar.
1457
1450
  */
1458
- formulaBarProps?: FormulaBarProps;
1451
+ propsFormulaBar?: FormulaBarProps;
1459
1452
  /**
1460
1453
  * Render FormulaBar.
1461
- * @param props
1454
+ *
1455
+ * @param props The properties for the FormulaBar.
1462
1456
  * @returns A React Element representing the FormulaBar.
1463
1457
  */
1464
- renderFormulaBar?: (props: FormulaBarProps, ref: default_2.Ref<IFormulaBarElement>) => default_2.ReactElement;
1458
+ renderFormulaBar?: (props: FormulaBarProps) => default_2.ReactElement;
1465
1459
  /**
1466
1460
  * This doesn't influence # of tabs just the visibility of the widget.
1467
1461
  * @defaultValue 'workbook model but can be overridden'
@@ -1470,7 +1464,7 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
1470
1464
  /**
1471
1465
  * Allow for customizations on tabs.
1472
1466
  */
1473
- tabsProps?: WorkbookStripProps;
1467
+ propsTabs?: WorkbookStripProps;
1474
1468
  /**
1475
1469
  * Render custom tabs.
1476
1470
  * @param props
@@ -1485,9 +1479,10 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
1485
1479
  /**
1486
1480
  * Customizations for the status bar
1487
1481
  */
1488
- statusBarProps?: StatusBarProps;
1482
+ propsStatusBar?: StatusBarProps;
1489
1483
  /**
1490
- * Pass in a custom toolbar.
1484
+ * Pass in a custom statusbar.
1485
+ *
1491
1486
  * @param props
1492
1487
  * @returns A React Element representing the StatusBar.
1493
1488
  */
@@ -1495,7 +1490,7 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
1495
1490
  /**
1496
1491
  * Props for the toolbar.
1497
1492
  */
1498
- toolbarProps?: WorkbookToolbarsProps;
1493
+ propsToolbar?: WorkbookToolbarsProps;
1499
1494
  /**
1500
1495
  * Pass in a custom toolbar.
1501
1496
  * @param props
@@ -1503,9 +1498,9 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
1503
1498
  */
1504
1499
  renderToolbar?: (props: WorkbookToolbarsProps) => default_2.ReactElement;
1505
1500
  /**
1506
- * Allow for customizations on the context menu.
1501
+ * Props for the context menu.
1507
1502
  */
1508
- contextMenuSx?: SxProps<Theme>;
1503
+ propsContextMenu?: WorkbookContextMenuProps;
1509
1504
  /**
1510
1505
  * Render custom context menu.
1511
1506
  * @param props
@@ -1527,22 +1522,22 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
1527
1522
  */
1528
1523
  renderMovableMenu?: (props: MovableContextMenuProps) => default_2.ReactElement;
1529
1524
  /**
1530
- * Allow for customizations on loading panel.
1525
+ * Allow for customizations on loading panels.
1531
1526
  */
1532
- loadingPanelProps?: LoadingPanelProps;
1527
+ propsLoading?: LoadingPanelProps;
1533
1528
  /**
1534
- * Render custom loading panel.
1529
+ * Assign a custom loading panel.
1535
1530
  *
1536
- * @param props
1537
1531
  * @returns A React Element representing the LoadingPane.
1538
1532
  */
1539
- renderLoadingPanel?: (props: LoadingPanelProps) => default_2.ReactElement;
1533
+ renderLoading?: (props: LoadingPanelProps) => default_2.ReactElement;
1540
1534
  /**
1541
1535
  * Allow for customizations on loading panel.
1542
1536
  */
1543
- sheetProps?: SheetProps;
1537
+ propsSheet?: SheetProps;
1544
1538
  /**
1545
1539
  * Render custom ISheetElement.
1540
+ *
1546
1541
  * @param props
1547
1542
  * @returns A React Element representing the Sheet.
1548
1543
  */
@@ -1550,7 +1545,7 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
1550
1545
  /**
1551
1546
  * Allows users to Wrap stage children in Top level Context
1552
1547
  */
1553
- mainWrapper?: (children: default_2.ReactNode) => default_2.ReactElement;
1548
+ wrapperMain?: (children: default_2.ReactNode) => default_2.ReactElement;
1554
1549
  /**
1555
1550
  * Show the horizontal scrollbar
1556
1551
  */
@@ -1586,6 +1581,10 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
1586
1581
  * @defaultValue false
1587
1582
  */
1588
1583
  enableDarkImages?: boolean;
1584
+ /**
1585
+ * Ref for the workbook element
1586
+ */
1587
+ ref?: default_2.Ref<IWorkbookElement>;
1589
1588
  }
1590
1589
 
1591
1590
  /**
@@ -1593,54 +1592,12 @@ export declare interface WorkbookElementProps extends Omit<PaperProps, 'autoFocu
1593
1592
  */
1594
1593
  export declare const WorkbookIO: _WorkbookIO;
1595
1594
 
1596
- /**
1597
- * Wraps the IO WorkbookIO class to provide lazy import.
1598
- *
1599
- * @see '@sheetxl/io/IWorkbookIO'
1600
- */
1601
- export declare class _WorkbookIO implements IWorkbookIO {
1602
- protected _loadedIO: IWorkbookIO;
1603
- protected _loadIO(): Promise<IWorkbookIO>;
1604
- /** @inheritdoc IWorkbookIO.getReadFormats */
1605
- getReadFormats(options?: GetFormatsOptions): Promise<ReadFormatType[]>;
1606
- /** @inheritdoc IWorkbookIO.getWriteFormats */
1607
- getWriteFormats(options?: GetFormatsOptions): Promise<WriteFormatType[]>;
1608
- /** @inheritdoc IWorkbookIO.writeArrayBuffer */
1609
- writeArrayBuffer(workbook: IWorkbook, options?: WriteWorkbookOptions): Promise<ArrayBufferLike>;
1610
- /**
1611
- * Override default IWorkbookIO to add notifier support.
1612
- *
1613
- * @param options {@link ReadWorkbookOptions}
1614
- */
1615
- read(options: ReadWorkbookOptions, notifier?: IReactNotifier): Promise<WorkbookHandle>;
1616
- /** @inheritdoc IWorkbookIO.writeFile */
1617
- writeFile(fileName: string | null, workbook: IWorkbook, options?: WriteWorkbookOptions): Promise<boolean>;
1618
- /** @inheritdoc IWorkbookIO.registerReadFormat */
1619
- registerReadFormat(format: ReadFormatType): Promise<void>;
1620
- /** @inheritdoc IWorkbookIO.registerWriteFormat */
1621
- registerWriteFormat(format: WriteFormatType): Promise<void>;
1622
- /**
1623
- * A string array of all the mimeTYpes. Used for the input accept attribute.
1624
- *
1625
- * @returns An array of strings for the input types.
1626
- */
1627
- getAllReadFormatsAsString(): Promise<string>;
1628
- }
1595
+ /* Excluded from this release type: _WorkbookIO */
1629
1596
 
1630
1597
  export declare type WorkbookLoadEvent = {
1631
1598
  source: IWorkbookElement;
1632
1599
  };
1633
1600
 
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
1601
  export declare const WorkbookStrip: default_2.NamedExoticComponent<WorkbookStripProps & default_2.RefAttributes<HTMLElement>>;
1645
1602
 
1646
1603
  /**
@@ -1673,7 +1630,7 @@ export declare interface WorkbookStripProps extends default_2.HTMLAttributes<HTM
1673
1630
  /**
1674
1631
  * Allow for customizations on context menu
1675
1632
  */
1676
- contextMenuProps?: Partial<SheetTabMenuProps>;
1633
+ propsContextMenu?: Partial<SheetTabMenuProps>;
1677
1634
  /**
1678
1635
  * Render custom context menu.
1679
1636
  *
@@ -1684,7 +1641,7 @@ export declare interface WorkbookStripProps extends default_2.HTMLAttributes<HTM
1684
1641
  /**
1685
1642
  * Allow for customizations on context menu
1686
1643
  */
1687
- sheetsAllProps?: SheetsAllMenuProps;
1644
+ propsSheetsAll?: SheetsAllMenuProps;
1688
1645
  /**
1689
1646
  * Render custom sheet all menu.
1690
1647
  *
@@ -1695,7 +1652,7 @@ export declare interface WorkbookStripProps extends default_2.HTMLAttributes<HTM
1695
1652
  /**
1696
1653
  * Allow for customizations om sheet tabs.
1697
1654
  */
1698
- sheetTabProps?: Partial<SheetTabProps>;
1655
+ propsSheetTab?: Partial<SheetTabProps>;
1699
1656
  /**
1700
1657
  * Render custom sheet tabs.
1701
1658
  * @param props
@@ -1722,7 +1679,7 @@ export declare interface WorkbookStripProps extends default_2.HTMLAttributes<HTM
1722
1679
  gridStyle?: GridStyle;
1723
1680
  }
1724
1681
 
1725
- export declare const WorkbookTitle: default_2.FC<WorkbookTitleProps & WorkbookTitleRefAttribute>;
1682
+ export declare const WorkbookTitle: default_2.NamedExoticComponent<Omit<WorkbookTitleProps, "ref"> & default_2.RefAttributes<IWorkbookTitleElement>>;
1726
1683
 
1727
1684
  export declare interface WorkbookTitleAttributes {
1728
1685
  /**
@@ -1760,32 +1717,36 @@ export declare interface WorkbookTitleProps extends default_2.HTMLAttributes<HTM
1760
1717
  * @defaultValue false
1761
1718
  */
1762
1719
  hidden?: boolean;
1763
- }
1764
-
1765
- export declare type WorkbookTitleRefAttribute = {
1720
+ /**
1721
+ * Ref for the IWorkbookTitleElement
1722
+ */
1766
1723
  ref?: default_2.Ref<IWorkbookTitleElement>;
1767
- };
1724
+ }
1768
1725
 
1769
1726
  declare interface WorkbookToolbarsProps extends default_2.HTMLAttributes<HTMLDivElement> {
1770
1727
  commands: ICommands.IGroup;
1771
1728
  /**
1772
- * Wrap the select with custom component
1729
+ * Wrap the select with custom component.
1730
+ *
1773
1731
  * @param children
1774
1732
  */
1775
- selectWrapper?: (children: default_2.ReactNode) => default_2.ReactNode;
1733
+ wrapperSelect?: (children: default_2.ReactNode) => default_2.ReactNode;
1776
1734
  /**
1777
1735
  * Properties for the select
1778
1736
  */
1779
- selectProps?: SxProps;
1780
- /** If we need to render compact */
1781
- renderCompact?: boolean;
1737
+ propsSelect?: SxProps;
1782
1738
  /**
1783
- * Wrap the palette with custom component
1739
+ * If we need to render compact.
1740
+ */
1741
+ isCompact?: boolean;
1742
+ /**
1743
+ * Wrap the palette with custom component.
1744
+ *
1784
1745
  * @param children
1785
1746
  */
1786
- paletteWrapper?: (children: default_2.ReactNode) => default_2.ReactNode;
1787
- paletteProps?: PaperProps;
1788
- toolbarsProps?: Record<string, ToolbarProps>;
1747
+ wrapperPalette?: (children: default_2.ReactNode) => default_2.ReactNode;
1748
+ propsPalette?: PaperProps;
1749
+ propsToolbars?: Record<string, ToolbarProps>;
1789
1750
  workbook?: IWorkbookElement;
1790
1751
  /**
1791
1752
  * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
@@ -1798,7 +1759,4 @@ export declare const WorkbookViewCommandButton: default_2.NamedExoticComponent<O
1798
1759
  export declare interface WorkbookViewCommandButtonProps extends CommandPopupButtonProps {
1799
1760
  }
1800
1761
 
1801
-
1802
- export * from "@sheetxl/io";
1803
-
1804
1762
  export { }