@sheetxl/react 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.
- package/browser/cjs/{Bhsi0d5RKXBptVDn.cjs → Be13sRyTTTUvNIit.cjs} +1 -1
- package/browser/cjs/{DRzzcRNRxbiZXOXP.cjs → KLgpeikeRSDp4tUK.cjs} +1 -1
- package/browser/cjs/index.cjs +16 -16
- package/browser/cjs/{BuZc94wUrHygIzxH.cjs → n4OQZCE7fVxRfX1r.cjs} +1 -1
- package/browser/esm/{btjXQiR1z4Cuggt_.mjs → ClLcB3xHul5RfTMr.mjs} +1 -1
- package/browser/esm/{BfpgwUZO0tjFAtn7.mjs → EUZRpu3SnHayUDBu.mjs} +1 -1
- package/browser/esm/{ClA06sSv40DOG9dC.mjs → Mz1Nj2KbO5FcE969.mjs} +1 -1
- package/browser/esm/index.mjs +3458 -3459
- package/node/esm/index.mjs +1661 -1657
- package/node/esm/{DyynNlEdsc5XrmrT.mjs → sKvpUJVdmYl8r9f6.mjs} +1 -1
- package/package.json +5 -5
- package/types/index.d.ts +165 -138
package/types/index.d.ts
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
import { AnchorLocation } from '@sheetxl/utils';
|
|
2
2
|
import { Bounds } from '@sheetxl/utils';
|
|
3
3
|
import { CellEditorProps } from '@sheetxl/grid-react';
|
|
4
|
-
import { CellEditorRefAttribute } from '@sheetxl/grid-react';
|
|
5
|
-
import { CellLayout } from '@sheetxl/utils-react';
|
|
6
4
|
import { CellRendererProps } from '@sheetxl/grid-react';
|
|
7
5
|
import { CommandButtonProps } from '@sheetxl/utils-react';
|
|
8
6
|
import { Context } from 'react';
|
|
@@ -16,10 +14,11 @@ import { FrozenEdge } from '@sheetxl/grid-react';
|
|
|
16
14
|
import { GridProps } from '@sheetxl/grid-react';
|
|
17
15
|
import { GridStyle } from '@sheetxl/grid-react';
|
|
18
16
|
import { GridSurfaceStyle } from '@sheetxl/grid-react';
|
|
19
|
-
import { GridView } from '@sheetxl/grid-react';
|
|
20
17
|
import { IAutoFilter } from '@sheetxl/sdk';
|
|
21
18
|
import { IBorder } from '@sheetxl/sdk';
|
|
22
19
|
import { ICell } from '@sheetxl/sdk';
|
|
20
|
+
import { ICellEditorElement } from '@sheetxl/grid-react';
|
|
21
|
+
import { ICellLayout } from '@sheetxl/utils-react';
|
|
23
22
|
import { ICellRange } from '@sheetxl/sdk';
|
|
24
23
|
import { ICellRanges } from '@sheetxl/sdk';
|
|
25
24
|
import { IChart } from '@sheetxl/sdk';
|
|
@@ -28,6 +27,7 @@ import { ICommand } from '@sheetxl/utils-react';
|
|
|
28
27
|
import { ICommands } from '@sheetxl/utils-react';
|
|
29
28
|
import { IFunction } from '@sheetxl/sdk';
|
|
30
29
|
import { IGridElement } from '@sheetxl/grid-react';
|
|
30
|
+
import { IGridView } from '@sheetxl/grid-react';
|
|
31
31
|
import { IListener } from '@sheetxl/sdk';
|
|
32
32
|
import { IModule } from '@sheetxl/sdk';
|
|
33
33
|
import { IMovable } from '@sheetxl/sdk';
|
|
@@ -37,6 +37,7 @@ import { INamedCollection } from '@sheetxl/sdk';
|
|
|
37
37
|
import { IPicture } from '@sheetxl/sdk';
|
|
38
38
|
import { IRange } from '@sheetxl/sdk';
|
|
39
39
|
import { IScript } from '@sheetxl/sdk';
|
|
40
|
+
import { IScrollbarElement } from '@sheetxl/utils-react';
|
|
40
41
|
import { ISheet } from '@sheetxl/sdk';
|
|
41
42
|
import { ISheetHeader } from '@sheetxl/sdk';
|
|
42
43
|
import { ISheetView } from '@sheetxl/sdk';
|
|
@@ -86,10 +87,10 @@ export declare interface BorderOverlayProps {
|
|
|
86
87
|
/**
|
|
87
88
|
* Returns a list of visible cells.
|
|
88
89
|
*
|
|
89
|
-
* @param view - {@link
|
|
90
|
+
* @param view - {@link IGridView}
|
|
90
91
|
* @returns An array of visible coords
|
|
91
92
|
*/
|
|
92
|
-
getVisibleCells: (view:
|
|
93
|
+
getVisibleCells: (view: IGridView) => ({
|
|
93
94
|
coords: ICell.Coords;
|
|
94
95
|
value?: any;
|
|
95
96
|
range?: IRange.Coords;
|
|
@@ -106,7 +107,7 @@ export declare interface BorderOverlayProps {
|
|
|
106
107
|
* Allow users to customize border rendering.
|
|
107
108
|
* Note - This is wrapped in a single SVG so must be an SVG Element type (like a path).
|
|
108
109
|
*/
|
|
109
|
-
|
|
110
|
+
rendererBorder?: (props: BorderRenderProps) => default_2.ReactNode;
|
|
110
111
|
defaultColor?: string;
|
|
111
112
|
darkMode?: boolean;
|
|
112
113
|
/**
|
|
@@ -144,7 +145,7 @@ export declare interface BorderRenderProps {
|
|
|
144
145
|
/**
|
|
145
146
|
* Used for generating corners for wide borders. If not provided then borders will simply overlap.
|
|
146
147
|
*/
|
|
147
|
-
layout?:
|
|
148
|
+
layout?: ICellLayout;
|
|
148
149
|
/**
|
|
149
150
|
* Used for generating corners for wide borders. If not provided then borders will simply overlap.
|
|
150
151
|
*/
|
|
@@ -158,7 +159,7 @@ export declare interface BordersOverlayResults {
|
|
|
158
159
|
/**
|
|
159
160
|
* Array of functions that return components to overlay
|
|
160
161
|
*/
|
|
161
|
-
|
|
162
|
+
renderOverlay?: (view: IGridView) => default_2.ReactNode;
|
|
162
163
|
}
|
|
163
164
|
|
|
164
165
|
export declare const ChartAreaIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
|
|
@@ -186,9 +187,7 @@ export declare const ChartColumnStackedPercentIcon: (props: default_2.SVGProps<S
|
|
|
186
187
|
/**
|
|
187
188
|
* Placeholder for chart editors.
|
|
188
189
|
*/
|
|
189
|
-
export declare const ChartEditor: default_2.
|
|
190
|
-
ref?: default_2.Ref<IChartEditorElement>;
|
|
191
|
-
}>;
|
|
190
|
+
export declare const ChartEditor: default_2.NamedExoticComponent<Omit<ChartEditorProps, "ref"> & default_2.RefAttributes<IChartEditorElement>>;
|
|
192
191
|
|
|
193
192
|
export declare interface ChartEditorAttributes {
|
|
194
193
|
isChartEditor: () => true;
|
|
@@ -196,6 +195,7 @@ export declare interface ChartEditorAttributes {
|
|
|
196
195
|
|
|
197
196
|
export declare interface ChartEditorProps extends MovableElementProps {
|
|
198
197
|
chart: IChart;
|
|
198
|
+
ref?: default_2.Ref<IChartEditorElement>;
|
|
199
199
|
}
|
|
200
200
|
|
|
201
201
|
export declare const ChartLineIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
|
|
@@ -280,7 +280,7 @@ export declare interface CornerTriangleProps extends default_2.SVGProps<SVGSVGEl
|
|
|
280
280
|
cellWidth?: number;
|
|
281
281
|
cellHeight?: number;
|
|
282
282
|
darkMode?: boolean;
|
|
283
|
-
|
|
283
|
+
propsPath?: default_2.SVGProps<SVGPathElement>;
|
|
284
284
|
}
|
|
285
285
|
|
|
286
286
|
export declare const createCellEditStateFromCell: (clean: () => ICell, dirty?: string) => EditState<() => ICell, string>;
|
|
@@ -304,7 +304,7 @@ export declare interface DocThemesProviderProps {
|
|
|
304
304
|
children: default_2.ReactElement<any, string | default_2.JSXElementConstructor<any>>;
|
|
305
305
|
}
|
|
306
306
|
|
|
307
|
-
export declare const EditableLabel: default_2.
|
|
307
|
+
export declare const EditableLabel: default_2.NamedExoticComponent<Omit<EditableLabelProps, "ref"> & default_2.RefAttributes<IEditableLabelElement>>;
|
|
308
308
|
|
|
309
309
|
export declare interface EditableLabelAttributes {
|
|
310
310
|
startEdit(): void;
|
|
@@ -321,12 +321,12 @@ export declare interface EditableLabelProps extends Omit<default_2.HTMLAttribute
|
|
|
321
321
|
onChange?: (value: string) => void;
|
|
322
322
|
onSubmit?: (value: string) => boolean | void;
|
|
323
323
|
onCancel?: () => void;
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
324
|
+
renderInput?: (props: any) => default_2.ReactElement<HTMLInputElement>;
|
|
325
|
+
/**
|
|
326
|
+
* Reference to the HTMLInputElement (or other) used for editing
|
|
327
|
+
*/
|
|
328
328
|
ref?: default_2.Ref<IEditableLabelElement>;
|
|
329
|
-
}
|
|
329
|
+
}
|
|
330
330
|
|
|
331
331
|
export declare interface EditorStateAndCoords<CT, DT> {
|
|
332
332
|
sheet: ISheet;
|
|
@@ -337,9 +337,7 @@ export declare interface EditorStateAndCoords<CT, DT> {
|
|
|
337
337
|
/**
|
|
338
338
|
* Placeholder for movable frames.
|
|
339
339
|
*/
|
|
340
|
-
export declare const EmptyFrame: default_2.
|
|
341
|
-
ref?: default_2.Ref<IEmptyFrameElement>;
|
|
342
|
-
}>;
|
|
340
|
+
export declare const EmptyFrame: default_2.NamedExoticComponent<Omit<EmptyFrameProps, "ref"> & default_2.RefAttributes<IEmptyFrameElement>>;
|
|
343
341
|
|
|
344
342
|
export declare interface EmptyFrameAttributes {
|
|
345
343
|
isEmptyFrame: () => true;
|
|
@@ -347,6 +345,7 @@ export declare interface EmptyFrameAttributes {
|
|
|
347
345
|
|
|
348
346
|
export declare interface EmptyFrameProps extends MovableElementProps {
|
|
349
347
|
description: string;
|
|
348
|
+
ref?: default_2.Ref<IEmptyFrameElement>;
|
|
350
349
|
}
|
|
351
350
|
|
|
352
351
|
/**
|
|
@@ -444,7 +443,11 @@ export declare interface IFrameContainerListener {
|
|
|
444
443
|
export declare interface IMovableAreaElement extends HTMLDivElement, MovableAreaAttributes {
|
|
445
444
|
}
|
|
446
445
|
|
|
447
|
-
export declare interface
|
|
446
|
+
export declare interface IPictureEditorAttributes {
|
|
447
|
+
isPictureEditor: () => true;
|
|
448
|
+
}
|
|
449
|
+
|
|
450
|
+
export declare interface IPictureEditorElement extends HTMLDivElement, IPictureEditorAttributes {
|
|
448
451
|
}
|
|
449
452
|
|
|
450
453
|
/**
|
|
@@ -579,16 +582,56 @@ export declare namespace IScriptEditor {
|
|
|
579
582
|
export declare interface IScriptEditorElement extends ScriptEditorAttributes, HTMLDivElement {
|
|
580
583
|
}
|
|
581
584
|
|
|
585
|
+
/**
|
|
586
|
+
* Attributes and methods available on the sheet element beyond the HTMLDivElement.
|
|
587
|
+
*/
|
|
588
|
+
export declare type ISheetAttributes = {
|
|
589
|
+
getGridElement: () => IGridElement;
|
|
590
|
+
getRowHeaderElement: () => ISheetHeaderElement;
|
|
591
|
+
getColumnHeaderElement: () => ISheetHeaderElement;
|
|
592
|
+
rowHeaderHeight: () => number;
|
|
593
|
+
colHeaderWidth: () => number;
|
|
594
|
+
startEdit(event?: StartEditEvent): void;
|
|
595
|
+
submitEdit(): void;
|
|
596
|
+
cancelEdit(): void;
|
|
597
|
+
isEditing: boolean;
|
|
598
|
+
contains(element: Node | null): boolean;
|
|
599
|
+
invalidate: (coords?: ICell.Coords | null) => void;
|
|
600
|
+
/**
|
|
601
|
+
* Focus the sheet
|
|
602
|
+
*/
|
|
603
|
+
focusSheet(options?: FocusOptions): void;
|
|
604
|
+
/**
|
|
605
|
+
* Focus a specific float.
|
|
606
|
+
* If not provided will focus the first selected float.
|
|
607
|
+
*
|
|
608
|
+
* @remarks
|
|
609
|
+
* The focusMovable does not scroll.
|
|
610
|
+
* TODO - have this honor focus scroll options.
|
|
611
|
+
*/
|
|
612
|
+
focusMovable(movable?: IMovable): Promise<boolean>;
|
|
613
|
+
getSheet: () => ISheet;
|
|
614
|
+
/**
|
|
615
|
+
* For runtime introspection
|
|
616
|
+
*/
|
|
617
|
+
isSheetElement: () => true;
|
|
618
|
+
};
|
|
619
|
+
|
|
582
620
|
/**
|
|
583
621
|
* Type returned via ref property
|
|
584
622
|
*/
|
|
585
|
-
export declare interface ISheetElement extends HTMLDivElement,
|
|
623
|
+
export declare interface ISheetElement extends HTMLDivElement, ISheetAttributes {
|
|
586
624
|
}
|
|
587
625
|
|
|
626
|
+
declare type ISheetHeaderAttributes = {
|
|
627
|
+
forceRender: () => void;
|
|
628
|
+
getGridElement: () => IGridElement;
|
|
629
|
+
};
|
|
630
|
+
|
|
588
631
|
/**
|
|
589
632
|
* Type returned via ref property
|
|
590
633
|
*/
|
|
591
|
-
declare interface ISheetHeaderElement extends HTMLDivElement,
|
|
634
|
+
declare interface ISheetHeaderElement extends HTMLDivElement, ISheetHeaderAttributes {
|
|
592
635
|
}
|
|
593
636
|
|
|
594
637
|
export declare interface ITaskPaneArea {
|
|
@@ -647,9 +690,7 @@ export declare interface ModalFrame extends IFrame {
|
|
|
647
690
|
onDone?: (results?: any) => void;
|
|
648
691
|
}
|
|
649
692
|
|
|
650
|
-
export declare const MovableArea: default_2.
|
|
651
|
-
ref?: default_2.Ref<IMovableAreaElement>;
|
|
652
|
-
}>;
|
|
693
|
+
export declare const MovableArea: default_2.NamedExoticComponent<Omit<MovableAreaProps, "ref"> & default_2.RefAttributes<IMovableAreaElement>>;
|
|
653
694
|
|
|
654
695
|
export declare interface MovableAreaAttributes {
|
|
655
696
|
/**
|
|
@@ -683,7 +724,7 @@ export declare interface MovableAreaProps extends default_2.HTMLAttributes<HTMLD
|
|
|
683
724
|
/**
|
|
684
725
|
* The gridView
|
|
685
726
|
*/
|
|
686
|
-
view:
|
|
727
|
+
view: IGridView;
|
|
687
728
|
/**
|
|
688
729
|
* If provided this will be used start and stop transactions on being/end move.
|
|
689
730
|
*/
|
|
@@ -719,15 +760,19 @@ export declare interface MovableAreaProps extends default_2.HTMLAttributes<HTMLD
|
|
|
719
760
|
* Called after the first render of a movable.
|
|
720
761
|
*/
|
|
721
762
|
onFirstRender?: () => void;
|
|
763
|
+
/**
|
|
764
|
+
* Forwards the ref to the underlying element.
|
|
765
|
+
*/
|
|
766
|
+
ref?: default_2.Ref<IMovableAreaElement>;
|
|
722
767
|
}
|
|
723
768
|
|
|
724
769
|
export declare interface MovableElementProps extends React.HTMLAttributes<HTMLElement> {
|
|
725
770
|
movable?: IMovable;
|
|
726
771
|
/**
|
|
727
772
|
* The view to use for the movable.
|
|
728
|
-
* // TODO - this should not be the
|
|
773
|
+
* // TODO - this should not be the IGridView, rather a simpler interface that doesn't have a grid dependency.
|
|
729
774
|
*/
|
|
730
|
-
view:
|
|
775
|
+
view: IGridView;
|
|
731
776
|
/**
|
|
732
777
|
* Called when the movable is hidden from view.
|
|
733
778
|
*
|
|
@@ -774,13 +819,7 @@ declare interface NewTable {
|
|
|
774
819
|
hasHeader?: boolean;
|
|
775
820
|
}
|
|
776
821
|
|
|
777
|
-
export declare const PictureEditor: default_2.
|
|
778
|
-
ref?: default_2.Ref<IPictureEditorElement>;
|
|
779
|
-
}>;
|
|
780
|
-
|
|
781
|
-
export declare interface PictureEditorAttributes {
|
|
782
|
-
isPictureEditor: () => true;
|
|
783
|
-
}
|
|
822
|
+
export declare const PictureEditor: default_2.NamedExoticComponent<Omit<PictureEditorProps, "ref"> & default_2.RefAttributes<IPictureEditorElement>>;
|
|
784
823
|
|
|
785
824
|
export declare interface PictureEditorProps extends MovableElementProps {
|
|
786
825
|
/**
|
|
@@ -795,6 +834,10 @@ export declare interface PictureEditorProps extends MovableElementProps {
|
|
|
795
834
|
* Provide an optional loading panel.
|
|
796
835
|
*/
|
|
797
836
|
loadingPanel?: default_2.ReactNode;
|
|
837
|
+
/**
|
|
838
|
+
* Ref for the Element.
|
|
839
|
+
*/
|
|
840
|
+
ref?: default_2.Ref<IPictureEditorElement>;
|
|
798
841
|
}
|
|
799
842
|
|
|
800
843
|
declare interface Props {
|
|
@@ -908,43 +951,11 @@ declare interface SelectedRange {
|
|
|
908
951
|
cell?: ICell.Address;
|
|
909
952
|
}
|
|
910
953
|
|
|
911
|
-
export declare type SheetAttributes = {
|
|
912
|
-
getGridElement: () => IGridElement;
|
|
913
|
-
getRowHeaderElement: () => ISheetHeaderElement;
|
|
914
|
-
getColumnHeaderElement: () => ISheetHeaderElement;
|
|
915
|
-
rowHeaderHeight: () => number;
|
|
916
|
-
colHeaderWidth: () => number;
|
|
917
|
-
startEdit(event?: StartEditEvent): void;
|
|
918
|
-
submitEdit(): void;
|
|
919
|
-
cancelEdit(): void;
|
|
920
|
-
isEditing: boolean;
|
|
921
|
-
contains(element: Node | null): boolean;
|
|
922
|
-
invalidate: (coords?: ICell.Coords | null) => void;
|
|
923
|
-
/**
|
|
924
|
-
* Focus the sheet
|
|
925
|
-
*/
|
|
926
|
-
focusSheet(options?: FocusOptions): void;
|
|
927
|
-
/**
|
|
928
|
-
* Focus a specific float.
|
|
929
|
-
* If not provided will focus the first selected float.
|
|
930
|
-
*
|
|
931
|
-
* @remarks
|
|
932
|
-
* The focusMovable does not scroll.
|
|
933
|
-
* TODO - have this honor focus scroll options.
|
|
934
|
-
*/
|
|
935
|
-
focusMovable(movable?: IMovable): Promise<boolean>;
|
|
936
|
-
getSheet: () => ISheet;
|
|
937
|
-
/**
|
|
938
|
-
* For runtime introspection
|
|
939
|
-
*/
|
|
940
|
-
isSheetElement: () => true;
|
|
941
|
-
};
|
|
942
|
-
|
|
943
954
|
/**
|
|
944
955
|
* SheetCellEditor
|
|
945
956
|
* Controlled cell editor for updating state.
|
|
946
957
|
*/
|
|
947
|
-
export declare const SheetCellEditor: default_2.
|
|
958
|
+
export declare const SheetCellEditor: default_2.NamedExoticComponent<Omit<SheetCellEditorProps, "ref"> & default_2.RefAttributes<ICellEditorElement>>;
|
|
948
959
|
|
|
949
960
|
export declare interface SheetCellEditorProps extends CellEditorProps<() => ICell, string> {
|
|
950
961
|
/**
|
|
@@ -1035,13 +1046,13 @@ export declare interface SheetCellRendererProps extends CellRendererProps<ICell>
|
|
|
1035
1046
|
/**
|
|
1036
1047
|
* Custom properties for the filter button
|
|
1037
1048
|
*/
|
|
1038
|
-
|
|
1049
|
+
propsFilterButton?: FilterButtonProps;
|
|
1039
1050
|
/**
|
|
1040
1051
|
* Callback for creating a custom filter button.
|
|
1041
1052
|
*
|
|
1042
1053
|
* @returns A React Element representing the FilterButton.
|
|
1043
1054
|
*/
|
|
1044
|
-
|
|
1055
|
+
renderFilterButton?: (props: FilterButtonProps) => default_2.ReactElement;
|
|
1045
1056
|
}
|
|
1046
1057
|
|
|
1047
1058
|
export declare interface SheetCopyPasteProps extends Omit<CopyPasteProps, "source" | "target"> {
|
|
@@ -1054,7 +1065,7 @@ export declare interface SheetCopyPasteProps extends Omit<CopyPasteProps, "sourc
|
|
|
1054
1065
|
/**
|
|
1055
1066
|
* Allow users to customize selected cells design
|
|
1056
1067
|
*/
|
|
1057
|
-
|
|
1068
|
+
renderSelection?: (props: SelectionProps) => default_2.ReactNode;
|
|
1058
1069
|
/**
|
|
1059
1070
|
* Color for the foreground
|
|
1060
1071
|
*/
|
|
@@ -1071,7 +1082,7 @@ export declare interface SheetCopyPasteResults extends CopyPasteResults {
|
|
|
1071
1082
|
/**
|
|
1072
1083
|
* Array of functions that return components to overlay
|
|
1073
1084
|
*/
|
|
1074
|
-
overlays?: (view:
|
|
1085
|
+
overlays?: (view: IGridView) => default_2.ReactNode[];
|
|
1075
1086
|
}
|
|
1076
1087
|
|
|
1077
1088
|
/**
|
|
@@ -1080,12 +1091,7 @@ export declare interface SheetCopyPasteResults extends CopyPasteResults {
|
|
|
1080
1091
|
* UI representation for ISheet.
|
|
1081
1092
|
*
|
|
1082
1093
|
*/
|
|
1083
|
-
export declare const SheetElement: default_2.
|
|
1084
|
-
|
|
1085
|
-
declare type SheetHeaderAttributes = {
|
|
1086
|
-
forceRender: () => void;
|
|
1087
|
-
getGridElement: () => IGridElement;
|
|
1088
|
-
};
|
|
1094
|
+
export declare const SheetElement: default_2.NamedExoticComponent<Omit<SheetProps, "ref"> & default_2.RefAttributes<ISheetElement>>;
|
|
1089
1095
|
|
|
1090
1096
|
/**
|
|
1091
1097
|
* TODO - We may not need the grid ref if we use the headers directly to measure.
|
|
@@ -1167,6 +1173,10 @@ declare interface SheetHeaderProps extends default_2.HTMLAttributes<HTMLDivEleme
|
|
|
1167
1173
|
* Callback when selection is manually changed
|
|
1168
1174
|
*/
|
|
1169
1175
|
onSelectionEnd?: () => void;
|
|
1176
|
+
/**
|
|
1177
|
+
* Ref for the HTMLDivElement
|
|
1178
|
+
*/
|
|
1179
|
+
ref?: default_2.Ref<ISheetHeaderElement>;
|
|
1170
1180
|
}
|
|
1171
1181
|
|
|
1172
1182
|
export declare interface SheetLocation {
|
|
@@ -1182,14 +1192,22 @@ export declare interface SheetLocation {
|
|
|
1182
1192
|
export declare interface SheetPasteOptions extends ReferenceableClipboard.PasteOptions, ICellRange.CopyOptions {
|
|
1183
1193
|
}
|
|
1184
1194
|
|
|
1195
|
+
/**
|
|
1196
|
+
* Props for the SheetElement component.
|
|
1197
|
+
*/
|
|
1185
1198
|
export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
1199
|
+
/**
|
|
1200
|
+
* The `ISheet` to render.
|
|
1201
|
+
*/
|
|
1186
1202
|
sheet: ISheet;
|
|
1203
|
+
/**
|
|
1204
|
+
* Style used for grid
|
|
1205
|
+
*/
|
|
1187
1206
|
gridStyle?: GridStyle;
|
|
1188
|
-
headersStyle?: GridStyle;
|
|
1189
1207
|
/**
|
|
1190
|
-
*
|
|
1208
|
+
* Style used for headers
|
|
1191
1209
|
*/
|
|
1192
|
-
|
|
1210
|
+
headersStyle?: GridStyle;
|
|
1193
1211
|
/**
|
|
1194
1212
|
* Show the row headers
|
|
1195
1213
|
*/
|
|
@@ -1197,7 +1215,7 @@ export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement>
|
|
|
1197
1215
|
/**
|
|
1198
1216
|
* Properties for the row headers
|
|
1199
1217
|
*/
|
|
1200
|
-
|
|
1218
|
+
propsRowHeader?: Partial<SheetHeaderProps>;
|
|
1201
1219
|
/**
|
|
1202
1220
|
* Show the column headers
|
|
1203
1221
|
*/
|
|
@@ -1205,7 +1223,7 @@ export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement>
|
|
|
1205
1223
|
/**
|
|
1206
1224
|
* Properties for the column headers
|
|
1207
1225
|
*/
|
|
1208
|
-
|
|
1226
|
+
propsColumnHeader?: Partial<SheetHeaderProps>;
|
|
1209
1227
|
/**
|
|
1210
1228
|
* Show the scrollbars
|
|
1211
1229
|
*/
|
|
@@ -1213,16 +1231,16 @@ export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement>
|
|
|
1213
1231
|
/**
|
|
1214
1232
|
* Allow for customizations of scrollbar
|
|
1215
1233
|
*/
|
|
1216
|
-
|
|
1234
|
+
propsScrollPane?: ScrollPaneProps;
|
|
1217
1235
|
/**
|
|
1218
1236
|
* Fired when the view port changes.
|
|
1219
1237
|
* This is in pixel coordinates and slightly different then viewable cells because off screen location bounds could change
|
|
1220
1238
|
*/
|
|
1221
1239
|
onViewportChange?: (view: ScrollableViewport) => void;
|
|
1222
1240
|
/**
|
|
1223
|
-
*
|
|
1241
|
+
* Fire when a contentMenu is requested
|
|
1224
1242
|
*/
|
|
1225
|
-
|
|
1243
|
+
onSheetContextMenu?: (location: SheetLocation) => void;
|
|
1226
1244
|
/**
|
|
1227
1245
|
* Called once when the sheet has been loaded but before it is rendered.
|
|
1228
1246
|
*/
|
|
@@ -1232,7 +1250,7 @@ export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement>
|
|
|
1232
1250
|
* This should not return null but rather can canEdit.
|
|
1233
1251
|
* This is called during placement after scrolling and other bookkeeping has occurred
|
|
1234
1252
|
*/
|
|
1235
|
-
getCellEditor?: (props: CellEditorProps<() => ICell, string
|
|
1253
|
+
getCellEditor?: (props: CellEditorProps<() => ICell, string>, coords: ICell.Coords) => React.ReactElement<CellEditorProps<() => ICell, string>>;
|
|
1236
1254
|
/**
|
|
1237
1255
|
* Parent commands for the sheet
|
|
1238
1256
|
*/
|
|
@@ -1249,7 +1267,6 @@ export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement>
|
|
|
1249
1267
|
viewportComponent?: React.ReactNode;
|
|
1250
1268
|
/**
|
|
1251
1269
|
* Render components for movable elements.
|
|
1252
|
-
* If not provided movables will not be rendered.
|
|
1253
1270
|
*
|
|
1254
1271
|
* @param props - {@link MovableElementProps}
|
|
1255
1272
|
* @returns A React Element representing the IMovable.
|
|
@@ -1258,42 +1275,38 @@ export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement>
|
|
|
1258
1275
|
/**
|
|
1259
1276
|
* Render an element directly onto a gridView.
|
|
1260
1277
|
*/
|
|
1261
|
-
overlays?: ((view:
|
|
1278
|
+
overlays?: ((view: IGridView) => React.ReactNode)[];
|
|
1262
1279
|
/**
|
|
1263
1280
|
* To show the tooltip
|
|
1264
|
-
*
|
|
1281
|
+
*
|
|
1282
|
+
* @param props
|
|
1265
1283
|
*/
|
|
1266
|
-
onShowTooltip?: (
|
|
1267
|
-
onShowColumnTooltip?: (
|
|
1268
|
-
onShowRowTooltip?: (
|
|
1284
|
+
onShowTooltip?: (props: IShowToolTipProperties) => void;
|
|
1285
|
+
onShowColumnTooltip?: (props: IShowToolTipProperties) => void;
|
|
1286
|
+
onShowRowTooltip?: (props: IShowToolTipProperties) => void;
|
|
1269
1287
|
onCloseTooltip?: () => void;
|
|
1270
1288
|
/**
|
|
1271
1289
|
* Customize the grid.
|
|
1290
|
+
*
|
|
1272
1291
|
* @remarks
|
|
1273
1292
|
* Not all props are passed through.
|
|
1274
1293
|
*/
|
|
1275
|
-
|
|
1294
|
+
propsGrid?: GridProps;
|
|
1276
1295
|
/**
|
|
1277
1296
|
* Allow for custom rendering of cell props.
|
|
1297
|
+
*
|
|
1278
1298
|
* @remarks
|
|
1279
1299
|
* This is used to customize filterButton popup action and any other customizations desired.
|
|
1280
1300
|
* This does not invalidate the rendering
|
|
1281
1301
|
*/
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1302
|
+
propsCellRender?: Partial<SheetCellRendererProps>;
|
|
1303
|
+
/**
|
|
1304
|
+
* Ref to the sheet element.
|
|
1305
|
+
*/
|
|
1286
1306
|
ref?: React.Ref<ISheetElement>;
|
|
1287
|
-
};
|
|
1288
|
-
|
|
1289
|
-
/**
|
|
1290
|
-
* For elements that also need the ref. Less common but some factory renderers
|
|
1291
|
-
*/
|
|
1292
|
-
export declare interface SheetRefProps extends SheetProps {
|
|
1293
|
-
ref?: React.Ref<HTMLDivElement>;
|
|
1294
1307
|
}
|
|
1295
1308
|
|
|
1296
|
-
export declare const SheetScrollbar: default_2.NamedExoticComponent<SheetScrollbarProps & default_2.RefAttributes<
|
|
1309
|
+
export declare const SheetScrollbar: default_2.NamedExoticComponent<Omit<SheetScrollbarProps, "ref"> & default_2.RefAttributes<IScrollbarElement>>;
|
|
1297
1310
|
|
|
1298
1311
|
export declare interface SheetScrollbarProps extends VirtualScrollbarProps {
|
|
1299
1312
|
/**
|
|
@@ -1391,6 +1404,9 @@ export declare interface TabProps extends Omit<default_2.HTMLAttributes<HTMLElem
|
|
|
1391
1404
|
dragging: boolean;
|
|
1392
1405
|
}
|
|
1393
1406
|
|
|
1407
|
+
/**
|
|
1408
|
+
* TabStrip component for displaying and managing tabs.
|
|
1409
|
+
*/
|
|
1394
1410
|
export declare const TabStrip: default_2.NamedExoticComponent<TabStripProps & default_2.RefAttributes<TabStripRef>>;
|
|
1395
1411
|
|
|
1396
1412
|
export declare interface TabStripProps extends Omit<default_2.HTMLAttributes<HTMLDivElement>, "onSubmit" | "onChange"> {
|
|
@@ -1399,14 +1415,12 @@ export declare interface TabStripProps extends Omit<default_2.HTMLAttributes<HTM
|
|
|
1399
1415
|
onSelectedTabIndexChange?: (index: number) => void;
|
|
1400
1416
|
onTabNameChange?: (index: number, tabName: string) => void;
|
|
1401
1417
|
onTabMove?: (indexFrom: number, indexTo: number) => void;
|
|
1402
|
-
|
|
1403
|
-
|
|
1404
|
-
|
|
1405
|
-
|
|
1406
|
-
|
|
1407
|
-
|
|
1408
|
-
}) => default_2.ReactElement;
|
|
1409
|
-
editLabelProps?: EditableLabelProps;
|
|
1418
|
+
renderScrollButtonStart?: (props: ScrollButtonProps) => default_2.ReactElement;
|
|
1419
|
+
renderScrollButtonEnd?: (props: ScrollButtonProps) => default_2.ReactElement;
|
|
1420
|
+
renderScrollButtonEdge?: (props: ScrollButtonProps) => default_2.ReactElement;
|
|
1421
|
+
renderTabButton?: (props: TabProps) => default_2.ReactElement<any>;
|
|
1422
|
+
renderTabDivider?: (props: default_2.HTMLAttributes<HTMLElement> & default_2.Attributes) => default_2.ReactElement;
|
|
1423
|
+
propsEditLabel?: EditableLabelProps;
|
|
1410
1424
|
disabled?: boolean;
|
|
1411
1425
|
disableDrag?: boolean;
|
|
1412
1426
|
/**
|
|
@@ -1436,7 +1450,7 @@ export declare interface TabStripRef extends HTMLDivElement {
|
|
|
1436
1450
|
* and it implement the ITaskPaneParent to be given to the TaskPane component.
|
|
1437
1451
|
* This provides a simple implementation but can be swapped out later.
|
|
1438
1452
|
*/
|
|
1439
|
-
export declare const TaskPaneArea: default_2.NamedExoticComponent<TaskPaneAreaProps<any> & default_2.RefAttributes<ITaskPaneAreaElement>>;
|
|
1453
|
+
export declare const TaskPaneArea: default_2.NamedExoticComponent<Omit<TaskPaneAreaProps<any>, "ref"> & default_2.RefAttributes<ITaskPaneAreaElement>>;
|
|
1440
1454
|
|
|
1441
1455
|
export declare interface TaskPaneAreaProps<T = any> extends default_2.HTMLAttributes<HTMLDivElement> {
|
|
1442
1456
|
/**
|
|
@@ -1464,31 +1478,31 @@ export declare interface TaskPaneAreaProps<T = any> extends default_2.HTMLAttrib
|
|
|
1464
1478
|
/**
|
|
1465
1479
|
* Props that can be injected to pane
|
|
1466
1480
|
*/
|
|
1467
|
-
|
|
1481
|
+
propsPane?: default_2.HTMLAttributes<HTMLDivElement>;
|
|
1468
1482
|
/**
|
|
1469
1483
|
* Allows users to Wrap pane children in Top level Context
|
|
1470
1484
|
*/
|
|
1471
|
-
|
|
1485
|
+
wrapperPane?: (children: default_2.ReactNode) => default_2.ReactNode;
|
|
1472
1486
|
/**
|
|
1473
1487
|
* Wrap frame in a context
|
|
1474
1488
|
*/
|
|
1475
|
-
|
|
1489
|
+
wrapperFrame?: (children: default_2.ReactNode) => default_2.ReactNode;
|
|
1476
1490
|
/**
|
|
1477
1491
|
* Props that can be injected to the frame
|
|
1478
1492
|
*/
|
|
1479
|
-
|
|
1493
|
+
propsFrame?: default_2.HTMLAttributes<HTMLDivElement>;
|
|
1480
1494
|
/**
|
|
1481
1495
|
* Override the default title renderer.
|
|
1482
1496
|
*
|
|
1483
1497
|
* @remarks
|
|
1484
1498
|
* If the registry also provides a custom title renderer that will be used instead.
|
|
1485
1499
|
*/
|
|
1486
|
-
renderTaskPanelTitle?(props: TaskPaneTitleProps
|
|
1500
|
+
renderTaskPanelTitle?(props: TaskPaneTitleProps): default_2.ReactElement;
|
|
1487
1501
|
/**
|
|
1488
1502
|
* Override the default task pane strip renderer.
|
|
1489
1503
|
*
|
|
1490
1504
|
*/
|
|
1491
|
-
renderTaskPaneStrip?(props: TaskPaneStripProps
|
|
1505
|
+
renderTaskPaneStrip?(props: TaskPaneStripProps): default_2.ReactElement;
|
|
1492
1506
|
/**
|
|
1493
1507
|
* Allow for custom registry of task panes.
|
|
1494
1508
|
*/
|
|
@@ -1497,10 +1511,10 @@ export declare interface TaskPaneAreaProps<T = any> extends default_2.HTMLAttrib
|
|
|
1497
1511
|
* If true always show the strip even with one pane.
|
|
1498
1512
|
*/
|
|
1499
1513
|
alwaysShowStrip?: boolean;
|
|
1500
|
-
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
|
-
ref?: default_2.Ref<
|
|
1514
|
+
/**
|
|
1515
|
+
* Reference to the underlying element.
|
|
1516
|
+
*/
|
|
1517
|
+
ref?: default_2.Ref<ITaskPaneAreaElement>;
|
|
1504
1518
|
}
|
|
1505
1519
|
|
|
1506
1520
|
export declare interface TaskPaneEntry {
|
|
@@ -1540,7 +1554,7 @@ export declare interface TaskPaneEntry {
|
|
|
1540
1554
|
/**
|
|
1541
1555
|
* Optional function to render a custom title for the task pane.
|
|
1542
1556
|
*/
|
|
1543
|
-
renderTaskPanelTitle?(props: TaskPaneTitleProps
|
|
1557
|
+
renderTaskPanelTitle?(props: TaskPaneTitleProps): React.ReactElement;
|
|
1544
1558
|
createCommand?(taskPaneArea: ITaskPaneArea): ICommand;
|
|
1545
1559
|
/**
|
|
1546
1560
|
* Optional function to create a button that can be placed in the command bar.
|
|
@@ -1569,7 +1583,7 @@ export declare const TaskPaneProvider: default_2.FC<TaskPaneProviderProps>;
|
|
|
1569
1583
|
*
|
|
1570
1584
|
* ```tsx
|
|
1571
1585
|
* <TaskPaneProvider
|
|
1572
|
-
*
|
|
1586
|
+
* renderArea={(props) => <TaskPaneArea {...props} />}
|
|
1573
1587
|
* onUpdateArea={(area) => { }}
|
|
1574
1588
|
* >
|
|
1575
1589
|
* <App />
|
|
@@ -1578,8 +1592,8 @@ export declare const TaskPaneProvider: default_2.FC<TaskPaneProviderProps>;
|
|
|
1578
1592
|
*/
|
|
1579
1593
|
export declare interface TaskPaneProviderProps {
|
|
1580
1594
|
children: ReactNode;
|
|
1581
|
-
|
|
1582
|
-
onUpdateArea: (
|
|
1595
|
+
renderArea: (props: TaskPaneAreaProps) => default_2.ReactElement<ITaskPaneAreaElement>;
|
|
1596
|
+
onUpdateArea: (area: default_2.ReactElement<ITaskPaneAreaElement>) => void;
|
|
1583
1597
|
registry?: ITaskPaneRegistry;
|
|
1584
1598
|
}
|
|
1585
1599
|
|
|
@@ -1594,7 +1608,7 @@ declare class TaskPaneRegistry implements ITaskPaneRegistry {
|
|
|
1594
1608
|
findContributions(contributionKey: string): TaskPaneEntry[];
|
|
1595
1609
|
}
|
|
1596
1610
|
|
|
1597
|
-
export declare const TaskPaneStrip: default_2.NamedExoticComponent<TaskPaneStripProps & default_2.RefAttributes<ITaskPaneStrip>>;
|
|
1611
|
+
export declare const TaskPaneStrip: default_2.NamedExoticComponent<Omit<TaskPaneStripProps, "ref"> & default_2.RefAttributes<ITaskPaneStrip>>;
|
|
1598
1612
|
|
|
1599
1613
|
export declare interface TaskPaneStripAttributes {
|
|
1600
1614
|
isTaskPaneStrip: () => true;
|
|
@@ -1612,11 +1626,13 @@ export declare interface TaskPaneStripProps extends Omit<default_2.HTMLAttribute
|
|
|
1612
1626
|
* If true, only show icons in the strip (no text).
|
|
1613
1627
|
*/
|
|
1614
1628
|
iconsOnly?: boolean;
|
|
1629
|
+
/**
|
|
1630
|
+
* Ref to the task pane strip element.
|
|
1631
|
+
*/
|
|
1632
|
+
ref?: default_2.Ref<ITaskPaneStrip>;
|
|
1615
1633
|
}
|
|
1616
1634
|
|
|
1617
|
-
export declare const TaskPaneTitle: default_2.
|
|
1618
|
-
ref?: default_2.Ref<HTMLDivElement>;
|
|
1619
|
-
}>;
|
|
1635
|
+
export declare const TaskPaneTitle: default_2.NamedExoticComponent<Omit<TaskPaneTitleProps, "ref"> & default_2.RefAttributes<HTMLDivElement>>;
|
|
1620
1636
|
|
|
1621
1637
|
export declare interface TaskPaneTitleProps extends Omit<default_2.HTMLAttributes<HTMLElement>, 'title'> {
|
|
1622
1638
|
title: default_2.ReactNode;
|
|
@@ -1627,6 +1643,10 @@ export declare interface TaskPaneTitleProps extends Omit<default_2.HTMLAttribute
|
|
|
1627
1643
|
* If the task pane is focused
|
|
1628
1644
|
*/
|
|
1629
1645
|
focused: boolean;
|
|
1646
|
+
/**
|
|
1647
|
+
* Reference to the underlying element.
|
|
1648
|
+
*/
|
|
1649
|
+
ref?: default_2.Ref<HTMLDivElement>;
|
|
1630
1650
|
}
|
|
1631
1651
|
|
|
1632
1652
|
declare interface Theme {
|
|
@@ -1639,7 +1659,7 @@ declare interface Theme {
|
|
|
1639
1659
|
* useBordersOverlay
|
|
1640
1660
|
* Renders borders by combining individual cells border attributes.
|
|
1641
1661
|
*/
|
|
1642
|
-
export declare const useBordersOverlay: ({ getBorderAt,
|
|
1662
|
+
export declare const useBordersOverlay: ({ getBorderAt, rendererBorder, getVisibleCells: propGetVisibleCells, darkMode, forceThinBorder, defaultColor, shiftIfWide }: BorderOverlayProps) => BordersOverlayResults;
|
|
1643
1663
|
|
|
1644
1664
|
export declare const useDocThemes: () => IThemeCollection;
|
|
1645
1665
|
|
|
@@ -1679,7 +1699,14 @@ export declare const useDocThemes: () => IThemeCollection;
|
|
|
1679
1699
|
*/
|
|
1680
1700
|
export declare const useModelListener: <SOURCE, EVENTS>(source: IListener.ISource<SOURCE>, listeners: IListener.Callbacks<SOURCE, EVENTS>, options?: useModelListenerOptions) => void;
|
|
1681
1701
|
|
|
1682
|
-
|
|
1702
|
+
/**
|
|
1703
|
+
* Options for `useModelListener` hook.
|
|
1704
|
+
*
|
|
1705
|
+
* @remarks
|
|
1706
|
+
* This is extends IListener.Options but removes 'once' since hooks are
|
|
1707
|
+
* evaluated on render and adds a `fireOnModelChange` option.
|
|
1708
|
+
*/
|
|
1709
|
+
export declare interface useModelListenerOptions extends Omit<IListener.Options, 'once'> {
|
|
1683
1710
|
/**
|
|
1684
1711
|
* If `true` (default), fires all listeners once immediately when the component mounts
|
|
1685
1712
|
* or when the source changes, allowing initialization based on current model state.
|
|
@@ -1770,7 +1797,7 @@ export declare interface useSheetCommandsOptions {
|
|
|
1770
1797
|
/**
|
|
1771
1798
|
* Copy paste hook for `ISheet`.
|
|
1772
1799
|
*/
|
|
1773
|
-
export declare const useSheetCopyPaste: ({ element, sheet, sheetView, commands, onClipboardUpdate: propOnClipboardUpdate, onPaste: propOnPaste,
|
|
1800
|
+
export declare const useSheetCopyPaste: ({ element, sheet, sheetView, commands, onClipboardUpdate: propOnClipboardUpdate, onPaste: propOnPaste, renderSelection: propRenderSelection, copyForegroundColor, cutForegroundColor, copyBackgroundColor, cutBackgroundColor, ...rest }: SheetCopyPasteProps) => SheetCopyPasteResults;
|
|
1774
1801
|
|
|
1775
1802
|
export declare interface useSheetRangeListenerOptions extends ICellRange.ListenerOptions {
|
|
1776
1803
|
fireOnAddressChange: boolean;
|