@sheetxl/react 0.7.20 → 0.7.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/browser/cjs/{BnOYc_JHwZOSLFGE.cjs → DE4tB6-rHLjtcP1D.cjs} +1 -1
- package/browser/cjs/{CLyN7mEMTjqdNl5I.cjs → DfFvH5gp0fyrdVBe.cjs} +1 -1
- package/browser/cjs/{U5U53xpMO6ip9Ek5.cjs → IsZqO9D9KfIS8rJK.cjs} +1 -1
- package/browser/cjs/index.cjs +17 -17
- package/browser/esm/{BL-CpofKvMjPlBkH.mjs → B-FEg36883DAwV11.mjs} +1 -1
- package/browser/esm/{BpZ6prPDKyAztE8a.mjs → C07OMiF-GZT09DE8.mjs} +1 -1
- package/browser/esm/{CA0GdmiuVihEbunL.mjs → DpetxHCqcdvCcpAe.mjs} +1 -1
- package/browser/esm/index.mjs +3573 -3577
- package/node/esm/{oGAX8M1XYc2XuiQW.mjs → BzmGjDsMnAeW7Hwa.mjs} +1 -1
- package/node/esm/index.mjs +1923 -1922
- package/package.json +5 -5
- package/types/index.d.ts +102 -151
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sheetxl/react",
|
|
3
3
|
"description": "React - React components needed to build advanced grid and spreadsheet UIs.",
|
|
4
|
-
"version": "0.7.
|
|
4
|
+
"version": "0.7.22",
|
|
5
5
|
"license": "SEE LICENSE IN <LICENSE>",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"exports": {
|
|
@@ -49,10 +49,10 @@
|
|
|
49
49
|
"@dnd-kit/sortable": "^10.0.0",
|
|
50
50
|
"@dnd-kit/utilities": "^3.2.2",
|
|
51
51
|
"@monaco-editor/react": "^4.6.0",
|
|
52
|
-
"@sheetxl/grid-react": "^0.7.
|
|
53
|
-
"@sheetxl/sdk": "^0.7.
|
|
54
|
-
"@sheetxl/utils": "^0.7.
|
|
55
|
-
"@sheetxl/utils-react": "^0.7.
|
|
52
|
+
"@sheetxl/grid-react": "^0.7.22",
|
|
53
|
+
"@sheetxl/sdk": "^0.7.22",
|
|
54
|
+
"@sheetxl/utils": "^0.7.22",
|
|
55
|
+
"@sheetxl/utils-react": "^0.7.22",
|
|
56
56
|
"clsx": "^2.1.1",
|
|
57
57
|
"monaco-editor-auto-typings": "^0.4.6",
|
|
58
58
|
"react-merge-refs": "^3.0.2",
|
package/types/index.d.ts
CHANGED
|
@@ -1,25 +1,23 @@
|
|
|
1
1
|
import { AnchorLocation } from '@sheetxl/utils';
|
|
2
2
|
import { Bounds } from '@sheetxl/utils';
|
|
3
3
|
import { CellEditorProps } from '@sheetxl/grid-react';
|
|
4
|
-
import { CellLayout } from '@sheetxl/utils-react';
|
|
5
4
|
import { CellRendererProps } from '@sheetxl/grid-react';
|
|
6
5
|
import { CommandButtonProps } from '@sheetxl/utils-react';
|
|
7
6
|
import { Context } from 'react';
|
|
8
7
|
import { CopyPasteProps } from '@sheetxl/utils-react';
|
|
9
8
|
import { CopyPasteResults } from '@sheetxl/utils-react';
|
|
10
9
|
import { default as default_2 } from 'react';
|
|
11
|
-
import { DraggableSyntheticListeners } from '@dnd-kit/core';
|
|
12
10
|
import { EditState } from '@sheetxl/grid-react';
|
|
13
11
|
import { FocusWindowOptions } from '@sheetxl/utils-react';
|
|
14
12
|
import { FrozenEdge } from '@sheetxl/grid-react';
|
|
15
13
|
import { GridProps } from '@sheetxl/grid-react';
|
|
16
14
|
import { GridStyle } from '@sheetxl/grid-react';
|
|
17
15
|
import { GridSurfaceStyle } from '@sheetxl/grid-react';
|
|
18
|
-
import { GridView } from '@sheetxl/grid-react';
|
|
19
16
|
import { IAutoFilter } from '@sheetxl/sdk';
|
|
20
17
|
import { IBorder } from '@sheetxl/sdk';
|
|
21
18
|
import { ICell } from '@sheetxl/sdk';
|
|
22
19
|
import { ICellEditorElement } from '@sheetxl/grid-react';
|
|
20
|
+
import { ICellLayout } from '@sheetxl/utils-react';
|
|
23
21
|
import { ICellRange } from '@sheetxl/sdk';
|
|
24
22
|
import { ICellRanges } from '@sheetxl/sdk';
|
|
25
23
|
import { IChart } from '@sheetxl/sdk';
|
|
@@ -28,6 +26,7 @@ import { ICommand } from '@sheetxl/utils-react';
|
|
|
28
26
|
import { ICommands } from '@sheetxl/utils-react';
|
|
29
27
|
import { IFunction } from '@sheetxl/sdk';
|
|
30
28
|
import { IGridElement } from '@sheetxl/grid-react';
|
|
29
|
+
import { IGridView } from '@sheetxl/grid-react';
|
|
31
30
|
import { IListener } from '@sheetxl/sdk';
|
|
32
31
|
import { IModule } from '@sheetxl/sdk';
|
|
33
32
|
import { IMovable } from '@sheetxl/sdk';
|
|
@@ -37,6 +36,7 @@ import { INamedCollection } from '@sheetxl/sdk';
|
|
|
37
36
|
import { IPicture } from '@sheetxl/sdk';
|
|
38
37
|
import { IRange } from '@sheetxl/sdk';
|
|
39
38
|
import { IScript } from '@sheetxl/sdk';
|
|
39
|
+
import { IScrollbarElement } from '@sheetxl/utils-react';
|
|
40
40
|
import { ISheet } from '@sheetxl/sdk';
|
|
41
41
|
import { ISheetHeader } from '@sheetxl/sdk';
|
|
42
42
|
import { ISheetView } from '@sheetxl/sdk';
|
|
@@ -62,7 +62,6 @@ import { SelectionProps } from '@sheetxl/grid-react';
|
|
|
62
62
|
import { SelectionResults } from '@sheetxl/grid-react';
|
|
63
63
|
import { StartEditEvent } from '@sheetxl/grid-react';
|
|
64
64
|
import { TopLeft } from '@sheetxl/utils';
|
|
65
|
-
import { Transform } from '@dnd-kit/utilities';
|
|
66
65
|
import { VirtualScrollbarProps } from '@sheetxl/utils-react';
|
|
67
66
|
|
|
68
67
|
export declare interface ActivateFrameOptions {
|
|
@@ -86,10 +85,10 @@ export declare interface BorderOverlayProps {
|
|
|
86
85
|
/**
|
|
87
86
|
* Returns a list of visible cells.
|
|
88
87
|
*
|
|
89
|
-
* @param view - {@link
|
|
88
|
+
* @param view - {@link IGridView}
|
|
90
89
|
* @returns An array of visible coords
|
|
91
90
|
*/
|
|
92
|
-
getVisibleCells: (view:
|
|
91
|
+
getVisibleCells: (view: IGridView) => ({
|
|
93
92
|
coords: ICell.Coords;
|
|
94
93
|
value?: any;
|
|
95
94
|
range?: IRange.Coords;
|
|
@@ -106,7 +105,7 @@ export declare interface BorderOverlayProps {
|
|
|
106
105
|
* Allow users to customize border rendering.
|
|
107
106
|
* Note - This is wrapped in a single SVG so must be an SVG Element type (like a path).
|
|
108
107
|
*/
|
|
109
|
-
|
|
108
|
+
rendererBorder?: (props: BorderRenderProps) => default_2.ReactNode;
|
|
110
109
|
defaultColor?: string;
|
|
111
110
|
darkMode?: boolean;
|
|
112
111
|
/**
|
|
@@ -144,7 +143,7 @@ export declare interface BorderRenderProps {
|
|
|
144
143
|
/**
|
|
145
144
|
* Used for generating corners for wide borders. If not provided then borders will simply overlap.
|
|
146
145
|
*/
|
|
147
|
-
layout?:
|
|
146
|
+
layout?: ICellLayout;
|
|
148
147
|
/**
|
|
149
148
|
* Used for generating corners for wide borders. If not provided then borders will simply overlap.
|
|
150
149
|
*/
|
|
@@ -158,37 +157,35 @@ export declare interface BordersOverlayResults {
|
|
|
158
157
|
/**
|
|
159
158
|
* Array of functions that return components to overlay
|
|
160
159
|
*/
|
|
161
|
-
|
|
160
|
+
renderOverlay?: (view: IGridView) => default_2.ReactNode;
|
|
162
161
|
}
|
|
163
162
|
|
|
164
|
-
|
|
163
|
+
/* Excluded from this release type: ChartAreaIcon */
|
|
165
164
|
|
|
166
|
-
|
|
165
|
+
/* Excluded from this release type: ChartAreaStackedIcon */
|
|
167
166
|
|
|
168
|
-
|
|
167
|
+
/* Excluded from this release type: ChartAreaStackedPercentIcon */
|
|
169
168
|
|
|
170
|
-
|
|
169
|
+
/* Excluded from this release type: ChartBarIcon */
|
|
171
170
|
|
|
172
|
-
|
|
171
|
+
/* Excluded from this release type: ChartBarStackedIcon */
|
|
173
172
|
|
|
174
|
-
|
|
173
|
+
/* Excluded from this release type: ChartBarStackedPercentIcon */
|
|
175
174
|
|
|
176
|
-
|
|
175
|
+
/* Excluded from this release type: ChartBubble3DIcon */
|
|
177
176
|
|
|
178
|
-
|
|
177
|
+
/* Excluded from this release type: ChartBubbleIcon */
|
|
179
178
|
|
|
180
|
-
|
|
179
|
+
/* Excluded from this release type: ChartColumnIcon */
|
|
181
180
|
|
|
182
|
-
|
|
181
|
+
/* Excluded from this release type: ChartColumnStackedIcon */
|
|
183
182
|
|
|
184
|
-
|
|
183
|
+
/* Excluded from this release type: ChartColumnStackedPercentIcon */
|
|
185
184
|
|
|
186
185
|
/**
|
|
187
186
|
* Placeholder for chart editors.
|
|
188
187
|
*/
|
|
189
|
-
export declare const ChartEditor: default_2.
|
|
190
|
-
ref?: default_2.Ref<IChartEditorElement>;
|
|
191
|
-
}>;
|
|
188
|
+
export declare const ChartEditor: default_2.NamedExoticComponent<Omit<ChartEditorProps, "ref"> & default_2.RefAttributes<IChartEditorElement>>;
|
|
192
189
|
|
|
193
190
|
export declare interface ChartEditorAttributes {
|
|
194
191
|
isChartEditor: () => true;
|
|
@@ -196,33 +193,34 @@ export declare interface ChartEditorAttributes {
|
|
|
196
193
|
|
|
197
194
|
export declare interface ChartEditorProps extends MovableElementProps {
|
|
198
195
|
chart: IChart;
|
|
196
|
+
ref?: default_2.Ref<IChartEditorElement>;
|
|
199
197
|
}
|
|
200
198
|
|
|
201
|
-
|
|
199
|
+
/* Excluded from this release type: ChartLineIcon */
|
|
202
200
|
|
|
203
|
-
|
|
201
|
+
/* Excluded from this release type: ChartLineMarkersIcon */
|
|
204
202
|
|
|
205
|
-
|
|
203
|
+
/* Excluded from this release type: ChartLineStackedIcon */
|
|
206
204
|
|
|
207
|
-
|
|
205
|
+
/* Excluded from this release type: ChartLineStackedMarkersIcon */
|
|
208
206
|
|
|
209
|
-
|
|
207
|
+
/* Excluded from this release type: ChartLineStackedPercentIcon */
|
|
210
208
|
|
|
211
|
-
|
|
209
|
+
/* Excluded from this release type: ChartLineStackedPercentMarkersIcon */
|
|
212
210
|
|
|
213
|
-
|
|
211
|
+
/* Excluded from this release type: ChartPieDoughnutIcon */
|
|
214
212
|
|
|
215
|
-
|
|
213
|
+
/* Excluded from this release type: ChartPieIcon */
|
|
216
214
|
|
|
217
|
-
|
|
215
|
+
/* Excluded from this release type: ChartScatterLinesIcon */
|
|
218
216
|
|
|
219
|
-
|
|
217
|
+
/* Excluded from this release type: ChartScatterLinesMarkersIcon */
|
|
220
218
|
|
|
221
|
-
|
|
219
|
+
/* Excluded from this release type: ChartScatterLinesMarkersSmoothIcon */
|
|
222
220
|
|
|
223
|
-
|
|
221
|
+
/* Excluded from this release type: ChartScatterLinesSmoothIcon */
|
|
224
222
|
|
|
225
|
-
|
|
223
|
+
/* Excluded from this release type: ChartScatterMarkersIcon */
|
|
226
224
|
|
|
227
225
|
/**
|
|
228
226
|
* For providing Adjustable Color Commands additional rendering capabilities.
|
|
@@ -280,7 +278,7 @@ export declare interface CornerTriangleProps extends default_2.SVGProps<SVGSVGEl
|
|
|
280
278
|
cellWidth?: number;
|
|
281
279
|
cellHeight?: number;
|
|
282
280
|
darkMode?: boolean;
|
|
283
|
-
|
|
281
|
+
propsPath?: default_2.SVGProps<SVGPathElement>;
|
|
284
282
|
}
|
|
285
283
|
|
|
286
284
|
export declare const createCellEditStateFromCell: (clean: () => ICell, dirty?: string) => EditState<() => ICell, string>;
|
|
@@ -321,7 +319,7 @@ export declare interface EditableLabelProps extends Omit<default_2.HTMLAttribute
|
|
|
321
319
|
onChange?: (value: string) => void;
|
|
322
320
|
onSubmit?: (value: string) => boolean | void;
|
|
323
321
|
onCancel?: () => void;
|
|
324
|
-
|
|
322
|
+
renderInput?: (props: any) => default_2.ReactElement<HTMLInputElement>;
|
|
325
323
|
/**
|
|
326
324
|
* Reference to the HTMLInputElement (or other) used for editing
|
|
327
325
|
*/
|
|
@@ -337,9 +335,7 @@ export declare interface EditorStateAndCoords<CT, DT> {
|
|
|
337
335
|
/**
|
|
338
336
|
* Placeholder for movable frames.
|
|
339
337
|
*/
|
|
340
|
-
export declare const EmptyFrame: default_2.
|
|
341
|
-
ref?: default_2.Ref<IEmptyFrameElement>;
|
|
342
|
-
}>;
|
|
338
|
+
export declare const EmptyFrame: default_2.NamedExoticComponent<Omit<EmptyFrameProps, "ref"> & default_2.RefAttributes<IEmptyFrameElement>>;
|
|
343
339
|
|
|
344
340
|
export declare interface EmptyFrameAttributes {
|
|
345
341
|
isEmptyFrame: () => true;
|
|
@@ -347,6 +343,7 @@ export declare interface EmptyFrameAttributes {
|
|
|
347
343
|
|
|
348
344
|
export declare interface EmptyFrameProps extends MovableElementProps {
|
|
349
345
|
description: string;
|
|
346
|
+
ref?: default_2.Ref<IEmptyFrameElement>;
|
|
350
347
|
}
|
|
351
348
|
|
|
352
349
|
/**
|
|
@@ -676,24 +673,20 @@ export declare interface ITaskPaneRegistry {
|
|
|
676
673
|
export declare interface ITaskPaneStrip extends HTMLDivElement, TaskPaneStripAttributes {
|
|
677
674
|
}
|
|
678
675
|
|
|
679
|
-
export declare const Item: default_2.NamedExoticComponent<Props & default_2.RefAttributes<HTMLDivElement>>;
|
|
680
|
-
|
|
681
676
|
export { LicenseDetails }
|
|
682
677
|
|
|
683
678
|
export { LicenseManager }
|
|
684
679
|
|
|
685
680
|
export declare const LogoNoPaddingIcon: (props: default_2.SVGProps<SVGSVGElement>) => JSX.Element;
|
|
686
681
|
|
|
687
|
-
|
|
682
|
+
/* Excluded from this release type: LogoTextNoPaddingIcon */
|
|
688
683
|
|
|
689
684
|
export declare interface ModalFrame extends IFrame {
|
|
690
685
|
onCancel?: () => void;
|
|
691
686
|
onDone?: (results?: any) => void;
|
|
692
687
|
}
|
|
693
688
|
|
|
694
|
-
export declare const MovableArea: default_2.
|
|
695
|
-
ref?: default_2.Ref<IMovableAreaElement>;
|
|
696
|
-
}>;
|
|
689
|
+
export declare const MovableArea: default_2.NamedExoticComponent<Omit<MovableAreaProps, "ref"> & default_2.RefAttributes<IMovableAreaElement>>;
|
|
697
690
|
|
|
698
691
|
export declare interface MovableAreaAttributes {
|
|
699
692
|
/**
|
|
@@ -727,7 +720,7 @@ export declare interface MovableAreaProps extends default_2.HTMLAttributes<HTMLD
|
|
|
727
720
|
/**
|
|
728
721
|
* The gridView
|
|
729
722
|
*/
|
|
730
|
-
view:
|
|
723
|
+
view: IGridView;
|
|
731
724
|
/**
|
|
732
725
|
* If provided this will be used start and stop transactions on being/end move.
|
|
733
726
|
*/
|
|
@@ -763,15 +756,19 @@ export declare interface MovableAreaProps extends default_2.HTMLAttributes<HTMLD
|
|
|
763
756
|
* Called after the first render of a movable.
|
|
764
757
|
*/
|
|
765
758
|
onFirstRender?: () => void;
|
|
759
|
+
/**
|
|
760
|
+
* Forwards the ref to the underlying element.
|
|
761
|
+
*/
|
|
762
|
+
ref?: default_2.Ref<IMovableAreaElement>;
|
|
766
763
|
}
|
|
767
764
|
|
|
768
765
|
export declare interface MovableElementProps extends React.HTMLAttributes<HTMLElement> {
|
|
769
766
|
movable?: IMovable;
|
|
770
767
|
/**
|
|
771
768
|
* The view to use for the movable.
|
|
772
|
-
* // TODO - this should not be the
|
|
769
|
+
* // TODO - this should not be the IGridView, rather a simpler interface that doesn't have a grid dependency.
|
|
773
770
|
*/
|
|
774
|
-
view:
|
|
771
|
+
view: IGridView;
|
|
775
772
|
/**
|
|
776
773
|
* Called when the movable is hidden from view.
|
|
777
774
|
*
|
|
@@ -818,9 +815,7 @@ declare interface NewTable {
|
|
|
818
815
|
hasHeader?: boolean;
|
|
819
816
|
}
|
|
820
817
|
|
|
821
|
-
export declare const PictureEditor: default_2.
|
|
822
|
-
ref?: default_2.Ref<IPictureEditorElement>;
|
|
823
|
-
}>;
|
|
818
|
+
export declare const PictureEditor: default_2.NamedExoticComponent<Omit<PictureEditorProps, "ref"> & default_2.RefAttributes<IPictureEditorElement>>;
|
|
824
819
|
|
|
825
820
|
export declare interface PictureEditorProps extends MovableElementProps {
|
|
826
821
|
/**
|
|
@@ -835,45 +830,10 @@ export declare interface PictureEditorProps extends MovableElementProps {
|
|
|
835
830
|
* Provide an optional loading panel.
|
|
836
831
|
*/
|
|
837
832
|
loadingPanel?: default_2.ReactNode;
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
color?: string;
|
|
843
|
-
disabled?: boolean;
|
|
844
|
-
dragging?: boolean;
|
|
845
|
-
handle?: boolean;
|
|
846
|
-
height?: number;
|
|
847
|
-
index?: number;
|
|
848
|
-
fadeIn?: boolean;
|
|
849
|
-
transform?: Transform | null;
|
|
850
|
-
listeners?: DraggableSyntheticListeners;
|
|
851
|
-
sorting?: boolean;
|
|
852
|
-
style?: default_2.CSSProperties;
|
|
853
|
-
transition?: string | null;
|
|
854
|
-
wrapperStyle?: default_2.CSSProperties;
|
|
855
|
-
value: default_2.ReactNode;
|
|
856
|
-
onRemove?(): void;
|
|
857
|
-
renderItem?(args: {
|
|
858
|
-
dragOverlay: boolean;
|
|
859
|
-
dragging: boolean;
|
|
860
|
-
sorting: boolean;
|
|
861
|
-
index: number | undefined;
|
|
862
|
-
fadeIn: boolean;
|
|
863
|
-
listeners: DraggableSyntheticListeners;
|
|
864
|
-
ref: default_2.Ref<HTMLElement>;
|
|
865
|
-
style: default_2.CSSProperties | undefined;
|
|
866
|
-
transform: Props['transform'];
|
|
867
|
-
transition: Props['transition'];
|
|
868
|
-
value: Props['value'];
|
|
869
|
-
}): default_2.ReactElement;
|
|
870
|
-
}
|
|
871
|
-
|
|
872
|
-
declare interface Props_2 {
|
|
873
|
-
children: default_2.ReactNode;
|
|
874
|
-
columns?: number;
|
|
875
|
-
style?: default_2.CSSProperties;
|
|
876
|
-
horizontal?: boolean;
|
|
833
|
+
/**
|
|
834
|
+
* Ref for the Element.
|
|
835
|
+
*/
|
|
836
|
+
ref?: default_2.Ref<IPictureEditorElement>;
|
|
877
837
|
}
|
|
878
838
|
|
|
879
839
|
export declare interface RangeContainer {
|
|
@@ -892,8 +852,6 @@ declare interface ResizeHeaderOptions {
|
|
|
892
852
|
unit?: string;
|
|
893
853
|
}
|
|
894
854
|
|
|
895
|
-
export declare const Row: default_2.NamedExoticComponent<Props_2 & default_2.RefAttributes<HTMLDivElement>>;
|
|
896
|
-
|
|
897
855
|
/**
|
|
898
856
|
* This tracks the selection of the sheet and
|
|
899
857
|
* updates the a named range editor and a sheet cell editor.
|
|
@@ -1043,13 +1001,13 @@ export declare interface SheetCellRendererProps extends CellRendererProps<ICell>
|
|
|
1043
1001
|
/**
|
|
1044
1002
|
* Custom properties for the filter button
|
|
1045
1003
|
*/
|
|
1046
|
-
|
|
1004
|
+
propsFilterButton?: FilterButtonProps;
|
|
1047
1005
|
/**
|
|
1048
1006
|
* Callback for creating a custom filter button.
|
|
1049
1007
|
*
|
|
1050
1008
|
* @returns A React Element representing the FilterButton.
|
|
1051
1009
|
*/
|
|
1052
|
-
|
|
1010
|
+
renderFilterButton?: (props: FilterButtonProps) => default_2.ReactElement;
|
|
1053
1011
|
}
|
|
1054
1012
|
|
|
1055
1013
|
export declare interface SheetCopyPasteProps extends Omit<CopyPasteProps, "source" | "target"> {
|
|
@@ -1062,7 +1020,7 @@ export declare interface SheetCopyPasteProps extends Omit<CopyPasteProps, "sourc
|
|
|
1062
1020
|
/**
|
|
1063
1021
|
* Allow users to customize selected cells design
|
|
1064
1022
|
*/
|
|
1065
|
-
|
|
1023
|
+
renderSelection?: (props: SelectionProps) => default_2.ReactNode;
|
|
1066
1024
|
/**
|
|
1067
1025
|
* Color for the foreground
|
|
1068
1026
|
*/
|
|
@@ -1079,7 +1037,7 @@ export declare interface SheetCopyPasteResults extends CopyPasteResults {
|
|
|
1079
1037
|
/**
|
|
1080
1038
|
* Array of functions that return components to overlay
|
|
1081
1039
|
*/
|
|
1082
|
-
overlays?: (view:
|
|
1040
|
+
overlays?: (view: IGridView) => default_2.ReactNode[];
|
|
1083
1041
|
}
|
|
1084
1042
|
|
|
1085
1043
|
/**
|
|
@@ -1189,6 +1147,9 @@ export declare interface SheetLocation {
|
|
|
1189
1147
|
export declare interface SheetPasteOptions extends ReferenceableClipboard.PasteOptions, ICellRange.CopyOptions {
|
|
1190
1148
|
}
|
|
1191
1149
|
|
|
1150
|
+
/**
|
|
1151
|
+
* Props for the SheetElement component.
|
|
1152
|
+
*/
|
|
1192
1153
|
export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
1193
1154
|
/**
|
|
1194
1155
|
* The `ISheet` to render.
|
|
@@ -1202,10 +1163,6 @@ export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement>
|
|
|
1202
1163
|
* Style used for headers
|
|
1203
1164
|
*/
|
|
1204
1165
|
headersStyle?: GridStyle;
|
|
1205
|
-
/**
|
|
1206
|
-
* Fire when a contentMenu is requested
|
|
1207
|
-
*/
|
|
1208
|
-
onSheetContextMenu?: (location: SheetLocation) => void;
|
|
1209
1166
|
/**
|
|
1210
1167
|
* Show the row headers
|
|
1211
1168
|
*/
|
|
@@ -1213,7 +1170,7 @@ export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement>
|
|
|
1213
1170
|
/**
|
|
1214
1171
|
* Properties for the row headers
|
|
1215
1172
|
*/
|
|
1216
|
-
|
|
1173
|
+
propsRowHeader?: Partial<SheetHeaderProps>;
|
|
1217
1174
|
/**
|
|
1218
1175
|
* Show the column headers
|
|
1219
1176
|
*/
|
|
@@ -1221,7 +1178,7 @@ export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement>
|
|
|
1221
1178
|
/**
|
|
1222
1179
|
* Properties for the column headers
|
|
1223
1180
|
*/
|
|
1224
|
-
|
|
1181
|
+
propsColumnHeader?: Partial<SheetHeaderProps>;
|
|
1225
1182
|
/**
|
|
1226
1183
|
* Show the scrollbars
|
|
1227
1184
|
*/
|
|
@@ -1229,16 +1186,16 @@ export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement>
|
|
|
1229
1186
|
/**
|
|
1230
1187
|
* Allow for customizations of scrollbar
|
|
1231
1188
|
*/
|
|
1232
|
-
|
|
1189
|
+
propsScrollPane?: ScrollPaneProps;
|
|
1233
1190
|
/**
|
|
1234
1191
|
* Fired when the view port changes.
|
|
1235
1192
|
* This is in pixel coordinates and slightly different then viewable cells because off screen location bounds could change
|
|
1236
1193
|
*/
|
|
1237
1194
|
onViewportChange?: (view: ScrollableViewport) => void;
|
|
1238
1195
|
/**
|
|
1239
|
-
*
|
|
1196
|
+
* Fire when a contentMenu is requested
|
|
1240
1197
|
*/
|
|
1241
|
-
|
|
1198
|
+
onSheetContextMenu?: (location: SheetLocation) => void;
|
|
1242
1199
|
/**
|
|
1243
1200
|
* Called once when the sheet has been loaded but before it is rendered.
|
|
1244
1201
|
*/
|
|
@@ -1265,7 +1222,6 @@ export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement>
|
|
|
1265
1222
|
viewportComponent?: React.ReactNode;
|
|
1266
1223
|
/**
|
|
1267
1224
|
* Render components for movable elements.
|
|
1268
|
-
* If not provided movables will not be rendered.
|
|
1269
1225
|
*
|
|
1270
1226
|
* @param props - {@link MovableElementProps}
|
|
1271
1227
|
* @returns A React Element representing the IMovable.
|
|
@@ -1274,21 +1230,23 @@ export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement>
|
|
|
1274
1230
|
/**
|
|
1275
1231
|
* Render an element directly onto a gridView.
|
|
1276
1232
|
*/
|
|
1277
|
-
overlays?: ((view:
|
|
1233
|
+
overlays?: ((view: IGridView) => React.ReactNode)[];
|
|
1278
1234
|
/**
|
|
1279
1235
|
* To show the tooltip
|
|
1280
|
-
*
|
|
1236
|
+
*
|
|
1237
|
+
* @param props
|
|
1281
1238
|
*/
|
|
1282
|
-
onShowTooltip?: (
|
|
1283
|
-
onShowColumnTooltip?: (
|
|
1284
|
-
onShowRowTooltip?: (
|
|
1239
|
+
onShowTooltip?: (props: IShowToolTipProperties) => void;
|
|
1240
|
+
onShowColumnTooltip?: (props: IShowToolTipProperties) => void;
|
|
1241
|
+
onShowRowTooltip?: (props: IShowToolTipProperties) => void;
|
|
1285
1242
|
onCloseTooltip?: () => void;
|
|
1286
1243
|
/**
|
|
1287
1244
|
* Customize the grid.
|
|
1245
|
+
*
|
|
1288
1246
|
* @remarks
|
|
1289
1247
|
* Not all props are passed through.
|
|
1290
1248
|
*/
|
|
1291
|
-
|
|
1249
|
+
propsGrid?: GridProps;
|
|
1292
1250
|
/**
|
|
1293
1251
|
* Allow for custom rendering of cell props.
|
|
1294
1252
|
*
|
|
@@ -1296,14 +1254,14 @@ export declare interface SheetProps extends React.HTMLAttributes<HTMLDivElement>
|
|
|
1296
1254
|
* This is used to customize filterButton popup action and any other customizations desired.
|
|
1297
1255
|
* This does not invalidate the rendering
|
|
1298
1256
|
*/
|
|
1299
|
-
|
|
1257
|
+
propsCellRender?: Partial<SheetCellRendererProps>;
|
|
1300
1258
|
/**
|
|
1301
1259
|
* Ref to the sheet element.
|
|
1302
1260
|
*/
|
|
1303
1261
|
ref?: React.Ref<ISheetElement>;
|
|
1304
1262
|
}
|
|
1305
1263
|
|
|
1306
|
-
export declare const SheetScrollbar: default_2.NamedExoticComponent<SheetScrollbarProps & default_2.RefAttributes<
|
|
1264
|
+
export declare const SheetScrollbar: default_2.NamedExoticComponent<Omit<SheetScrollbarProps, "ref"> & default_2.RefAttributes<IScrollbarElement>>;
|
|
1307
1265
|
|
|
1308
1266
|
export declare interface SheetScrollbarProps extends VirtualScrollbarProps {
|
|
1309
1267
|
/**
|
|
@@ -1412,14 +1370,12 @@ export declare interface TabStripProps extends Omit<default_2.HTMLAttributes<HTM
|
|
|
1412
1370
|
onSelectedTabIndexChange?: (index: number) => void;
|
|
1413
1371
|
onTabNameChange?: (index: number, tabName: string) => void;
|
|
1414
1372
|
onTabMove?: (indexFrom: number, indexTo: number) => void;
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
}) => default_2.ReactElement;
|
|
1422
|
-
editLabelProps?: EditableLabelProps;
|
|
1373
|
+
renderScrollButtonStart?: (props: ScrollButtonProps) => default_2.ReactElement;
|
|
1374
|
+
renderScrollButtonEnd?: (props: ScrollButtonProps) => default_2.ReactElement;
|
|
1375
|
+
renderScrollButtonEdge?: (props: ScrollButtonProps) => default_2.ReactElement;
|
|
1376
|
+
renderTabButton?: (props: TabProps) => default_2.ReactElement<any>;
|
|
1377
|
+
renderTabDivider?: (props: default_2.HTMLAttributes<HTMLElement> & default_2.Attributes) => default_2.ReactElement;
|
|
1378
|
+
propsEditLabel?: EditableLabelProps;
|
|
1423
1379
|
disabled?: boolean;
|
|
1424
1380
|
disableDrag?: boolean;
|
|
1425
1381
|
/**
|
|
@@ -1449,7 +1405,7 @@ export declare interface TabStripRef extends HTMLDivElement {
|
|
|
1449
1405
|
* and it implement the ITaskPaneParent to be given to the TaskPane component.
|
|
1450
1406
|
* This provides a simple implementation but can be swapped out later.
|
|
1451
1407
|
*/
|
|
1452
|
-
export declare const TaskPaneArea: default_2.NamedExoticComponent<TaskPaneAreaProps<any> & default_2.RefAttributes<ITaskPaneAreaElement>>;
|
|
1408
|
+
export declare const TaskPaneArea: default_2.NamedExoticComponent<Omit<TaskPaneAreaProps<any>, "ref"> & default_2.RefAttributes<ITaskPaneAreaElement>>;
|
|
1453
1409
|
|
|
1454
1410
|
export declare interface TaskPaneAreaProps<T = any> extends default_2.HTMLAttributes<HTMLDivElement> {
|
|
1455
1411
|
/**
|
|
@@ -1477,19 +1433,19 @@ export declare interface TaskPaneAreaProps<T = any> extends default_2.HTMLAttrib
|
|
|
1477
1433
|
/**
|
|
1478
1434
|
* Props that can be injected to pane
|
|
1479
1435
|
*/
|
|
1480
|
-
|
|
1436
|
+
propsPane?: default_2.HTMLAttributes<HTMLDivElement>;
|
|
1481
1437
|
/**
|
|
1482
1438
|
* Allows users to Wrap pane children in Top level Context
|
|
1483
1439
|
*/
|
|
1484
|
-
|
|
1440
|
+
wrapperPane?: (children: default_2.ReactNode) => default_2.ReactNode;
|
|
1485
1441
|
/**
|
|
1486
1442
|
* Wrap frame in a context
|
|
1487
1443
|
*/
|
|
1488
|
-
|
|
1444
|
+
wrapperFrame?: (children: default_2.ReactNode) => default_2.ReactNode;
|
|
1489
1445
|
/**
|
|
1490
1446
|
* Props that can be injected to the frame
|
|
1491
1447
|
*/
|
|
1492
|
-
|
|
1448
|
+
propsFrame?: default_2.HTMLAttributes<HTMLDivElement>;
|
|
1493
1449
|
/**
|
|
1494
1450
|
* Override the default title renderer.
|
|
1495
1451
|
*
|
|
@@ -1510,10 +1466,10 @@ export declare interface TaskPaneAreaProps<T = any> extends default_2.HTMLAttrib
|
|
|
1510
1466
|
* If true always show the strip even with one pane.
|
|
1511
1467
|
*/
|
|
1512
1468
|
alwaysShowStrip?: boolean;
|
|
1513
|
-
|
|
1514
|
-
|
|
1515
|
-
|
|
1516
|
-
ref?: default_2.Ref<
|
|
1469
|
+
/**
|
|
1470
|
+
* Reference to the underlying element.
|
|
1471
|
+
*/
|
|
1472
|
+
ref?: default_2.Ref<ITaskPaneAreaElement>;
|
|
1517
1473
|
}
|
|
1518
1474
|
|
|
1519
1475
|
export declare interface TaskPaneEntry {
|
|
@@ -1582,7 +1538,7 @@ export declare const TaskPaneProvider: default_2.FC<TaskPaneProviderProps>;
|
|
|
1582
1538
|
*
|
|
1583
1539
|
* ```tsx
|
|
1584
1540
|
* <TaskPaneProvider
|
|
1585
|
-
*
|
|
1541
|
+
* renderArea={(props) => <TaskPaneArea {...props} />}
|
|
1586
1542
|
* onUpdateArea={(area) => { }}
|
|
1587
1543
|
* >
|
|
1588
1544
|
* <App />
|
|
@@ -1591,8 +1547,8 @@ export declare const TaskPaneProvider: default_2.FC<TaskPaneProviderProps>;
|
|
|
1591
1547
|
*/
|
|
1592
1548
|
export declare interface TaskPaneProviderProps {
|
|
1593
1549
|
children: ReactNode;
|
|
1594
|
-
|
|
1595
|
-
onUpdateArea: (
|
|
1550
|
+
renderArea: (props: TaskPaneAreaProps) => default_2.ReactElement<ITaskPaneAreaElement>;
|
|
1551
|
+
onUpdateArea: (area: default_2.ReactElement<ITaskPaneAreaElement>) => void;
|
|
1596
1552
|
registry?: ITaskPaneRegistry;
|
|
1597
1553
|
}
|
|
1598
1554
|
|
|
@@ -1631,9 +1587,7 @@ export declare interface TaskPaneStripProps extends Omit<default_2.HTMLAttribute
|
|
|
1631
1587
|
ref?: default_2.Ref<ITaskPaneStrip>;
|
|
1632
1588
|
}
|
|
1633
1589
|
|
|
1634
|
-
export declare const TaskPaneTitle: default_2.
|
|
1635
|
-
ref?: default_2.Ref<HTMLDivElement>;
|
|
1636
|
-
}>;
|
|
1590
|
+
export declare const TaskPaneTitle: default_2.NamedExoticComponent<Omit<TaskPaneTitleProps, "ref"> & default_2.RefAttributes<HTMLDivElement>>;
|
|
1637
1591
|
|
|
1638
1592
|
export declare interface TaskPaneTitleProps extends Omit<default_2.HTMLAttributes<HTMLElement>, 'title'> {
|
|
1639
1593
|
title: default_2.ReactNode;
|
|
@@ -1660,7 +1614,7 @@ declare interface Theme {
|
|
|
1660
1614
|
* useBordersOverlay
|
|
1661
1615
|
* Renders borders by combining individual cells border attributes.
|
|
1662
1616
|
*/
|
|
1663
|
-
export declare const useBordersOverlay: ({ getBorderAt,
|
|
1617
|
+
export declare const useBordersOverlay: ({ getBorderAt, rendererBorder, getVisibleCells: propGetVisibleCells, darkMode, forceThinBorder, defaultColor, shiftIfWide }: BorderOverlayProps) => BordersOverlayResults;
|
|
1664
1618
|
|
|
1665
1619
|
export declare const useDocThemes: () => IThemeCollection;
|
|
1666
1620
|
|
|
@@ -1725,7 +1679,7 @@ export declare const useMovableCommands: (props: useMovableCommandsOptions) => I
|
|
|
1725
1679
|
|
|
1726
1680
|
export declare interface useMovableCommandsOptions {
|
|
1727
1681
|
commands: ICommands.IGroup;
|
|
1728
|
-
target: () =>
|
|
1682
|
+
target: () => ICommand.ITarget;
|
|
1729
1683
|
/**
|
|
1730
1684
|
* Notify that there is a new repeatable command
|
|
1731
1685
|
*/
|
|
@@ -1750,7 +1704,11 @@ export declare interface useMovableCommandsOptions {
|
|
|
1750
1704
|
* @param model
|
|
1751
1705
|
* @param listener
|
|
1752
1706
|
*/
|
|
1753
|
-
export declare const useRangeListener: (model: RangeContainer, address: ICellRange.Address, listener: ICellRange.Listener, options?:
|
|
1707
|
+
export declare const useRangeListener: (model: RangeContainer, address: ICellRange.Address, listener: ICellRange.Listener, options?: useRangeListenerOptions) => void;
|
|
1708
|
+
|
|
1709
|
+
export declare interface useRangeListenerOptions extends ICellRange.ListenerOptions {
|
|
1710
|
+
fireOnAddressChange: boolean;
|
|
1711
|
+
}
|
|
1754
1712
|
|
|
1755
1713
|
/**
|
|
1756
1714
|
* Hook for observing sheet commands. This hook will observe a combination
|
|
@@ -1782,7 +1740,7 @@ export declare interface useSheetCommandsOptions {
|
|
|
1782
1740
|
*/
|
|
1783
1741
|
sheet: ISheet;
|
|
1784
1742
|
commands: ICommands.IGroup;
|
|
1785
|
-
target: () =>
|
|
1743
|
+
target: () => ICommand.ITarget;
|
|
1786
1744
|
/**
|
|
1787
1745
|
* Notify that there is a new repeatable command
|
|
1788
1746
|
*/
|
|
@@ -1798,11 +1756,7 @@ export declare interface useSheetCommandsOptions {
|
|
|
1798
1756
|
/**
|
|
1799
1757
|
* Copy paste hook for `ISheet`.
|
|
1800
1758
|
*/
|
|
1801
|
-
export declare const useSheetCopyPaste: ({ element, sheet, sheetView, commands, onClipboardUpdate: propOnClipboardUpdate, onPaste: propOnPaste,
|
|
1802
|
-
|
|
1803
|
-
export declare interface useSheetRangeListenerOptions extends ICellRange.ListenerOptions {
|
|
1804
|
-
fireOnAddressChange: boolean;
|
|
1805
|
-
}
|
|
1759
|
+
export declare const useSheetCopyPaste: ({ element, sheet, sheetView, commands, onClipboardUpdate: propOnClipboardUpdate, onPaste: propOnPaste, renderSelection: propRenderSelection, copyForegroundColor, cutForegroundColor, copyBackgroundColor, cutBackgroundColor, ...rest }: SheetCopyPasteProps) => SheetCopyPasteResults;
|
|
1806
1760
|
|
|
1807
1761
|
/**
|
|
1808
1762
|
* Hook to get the task pane manager directly.
|
|
@@ -1810,7 +1764,4 @@ export declare interface useSheetRangeListenerOptions extends ICellRange.Listene
|
|
|
1810
1764
|
*/
|
|
1811
1765
|
export declare const useTaskPaneArea: () => ITaskPaneArea;
|
|
1812
1766
|
|
|
1813
|
-
|
|
1814
|
-
export * from "@sheetxl/utils-react";
|
|
1815
|
-
|
|
1816
1767
|
export { }
|