@sheetxl/react 0.7.27 → 0.7.28-beta.1
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/Bo9Kx3L_XQkGPBJ5.cjs +1 -0
- package/browser/cjs/Pl04-kDEQSO8_qFU.cjs +156 -0
- package/browser/cjs/index.cjs +24 -24
- package/browser/esm/D_suN0U6XvrHxTak.mjs +6286 -0
- package/browser/esm/index.mjs +19258 -4911
- package/licenses/dependencies.txt +42 -214
- package/node/esm/CH084kteEgVy0a8H.mjs +9 -0
- package/node/esm/index.mjs +17035 -3691
- package/package.json +10 -11
- package/resources/contents.json +60 -0
- package/resources/locales/contents.json +114 -0
- package/resources/locales/de/clipboard.cmd.json +36 -0
- package/resources/locales/de/editor.cmd.json +128 -0
- package/resources/locales/de/movable.cmd.json +123 -0
- package/resources/locales/de/selection.cmd.json +373 -0
- package/resources/locales/de/sheet.cmd.json +1563 -0
- package/resources/locales/de/table.cmd.json +83 -0
- package/resources/locales/de/ui.msg.json +166 -0
- package/resources/locales/de/workbook.cmd.json +282 -0
- package/resources/locales/en/clipboard.cmd.json +36 -0
- package/resources/locales/en/editor.cmd.json +128 -0
- package/resources/locales/en/movable.cmd.json +123 -0
- package/resources/locales/en/selection.cmd.json +373 -0
- package/resources/locales/en/sheet.cmd.json +1563 -0
- package/resources/locales/en/table.cmd.json +83 -0
- package/resources/locales/en/ui.msg.json +166 -0
- package/resources/locales/en/workbook.cmd.json +282 -0
- package/types/index.d.ts +2 -1767
- package/types/src/border/StaticBorderRenderer.d.ts +32 -0
- package/types/src/border/StyledStrokePath.d.ts +14 -0
- package/types/src/border/index.d.ts +4 -0
- package/types/src/border/useBorders.d.ts +87 -0
- package/types/src/cell/ColumnButton.d.ts +45 -0
- package/types/src/cell/CornerTriangle.d.ts +27 -0
- package/types/src/cell/FormulaCellRenderer.d.ts +34 -0
- package/types/src/cell/SheetCellRenderer.d.ts +52 -0
- package/types/src/cell/SheetHeaderRenderer.d.ts +37 -0
- package/types/src/cell/index.d.ts +7 -0
- package/types/src/cell/useFormulaViewAnchor.d.ts +42 -0
- package/types/src/chart/ChartEditor.d.ts +17 -0
- package/types/src/chart/PresetChartTypeDescriptors.d.ts +35 -0
- package/types/src/chart/index.d.ts +3 -0
- package/types/src/chart/templates/area-stacked-percent-template.json.d.ts +10 -0
- package/types/src/chart/templates/area-stacked-template.json.d.ts +10 -0
- package/types/src/chart/templates/area-template.json.d.ts +9 -0
- package/types/src/chart/templates/bar-stacked-percent-template.json.d.ts +10 -0
- package/types/src/chart/templates/bar-stacked-template.json.d.ts +10 -0
- package/types/src/chart/templates/bar-template.json.d.ts +9 -0
- package/types/src/chart/templates/column-stacked-percent-template.json.d.ts +10 -0
- package/types/src/chart/templates/column-stacked-template.json.d.ts +10 -0
- package/types/src/chart/templates/column-template.json.d.ts +9 -0
- package/types/src/chart/templates/line-markers-template.json.d.ts +10 -0
- package/types/src/chart/templates/line-stacked-markers-template.json.d.ts +11 -0
- package/types/src/chart/templates/line-stacked-percent-markers-template.json.d.ts +11 -0
- package/types/src/chart/templates/line-stacked-percent-template.json.d.ts +10 -0
- package/types/src/chart/templates/line-stacked-template.json.d.ts +10 -0
- package/types/src/chart/templates/line-template.json.d.ts +9 -0
- package/types/src/chart/templates/pie-doughnut-template.json.d.ts +10 -0
- package/types/src/chart/templates/pie-template.json.d.ts +9 -0
- package/types/src/chart/templates/scatter-lines-markers-smooth-template.json.d.ts +10 -0
- package/types/src/chart/templates/scatter-lines-markers-template.json.d.ts +10 -0
- package/types/src/chart/templates/scatter-lines-smooth-template.json.d.ts +10 -0
- package/types/src/chart/templates/scatter-lines-template.json.d.ts +10 -0
- package/types/src/chart/templates/scatter-markers-template.json.d.ts +10 -0
- package/types/src/clipboard/ClipboardCommands.d.ts +68 -0
- package/types/src/clipboard/SheetClipboardLayer.d.ts +22 -0
- package/types/src/clipboard/index.d.ts +3 -0
- package/types/src/commands/Catalog.d.ts +8 -0
- package/types/src/commands/CommandRootProvider.d.ts +36 -0
- package/types/src/commands/InputClipboardCommands.d.ts +41 -0
- package/types/src/commands/InputClipboardInjector.d.ts +16 -0
- package/types/src/commands/MainFocusContext.d.ts +13 -0
- package/types/src/commands/PaneScopeProvider.d.ts +40 -0
- package/types/src/commands/createTransactionalMiddleware.d.ts +49 -0
- package/types/src/commands/index.d.ts +7 -0
- package/types/src/context/SheetContext.d.ts +18 -0
- package/types/src/context/WorkbookContext.d.ts +20 -0
- package/types/src/context/index.d.ts +3 -0
- package/types/src/editableLabel/EditableLabel.d.ts +28 -0
- package/types/src/editableLabel/index.d.ts +2 -0
- package/types/src/editor/EditorCommands.d.ts +98 -0
- package/types/src/editor/FunctionPreviewPanel.d.ts +166 -0
- package/types/src/editor/NamedHintPanel.d.ts +38 -0
- package/types/src/editor/NamedItemsPanel.d.ts +59 -0
- package/types/src/editor/SheetCellEditorLayer.d.ts +40 -0
- package/types/src/editor/SheetCellInput.d.ts +99 -0
- package/types/src/editor/SheetEditable.d.ts +53 -0
- package/types/src/editor/SheetReferenceHeaderLayer.d.ts +46 -0
- package/types/src/editor/SheetReferenceLayer.d.ts +55 -0
- package/types/src/editor/formulaCaret.d.ts +84 -0
- package/types/src/editor/formulaEval.d.ts +202 -0
- package/types/src/editor/formulaPresentation.d.ts +136 -0
- package/types/src/editor/formulaText.d.ts +80 -0
- package/types/src/editor/functionArgs.d.ts +111 -0
- package/types/src/editor/functionHint.d.ts +37 -0
- package/types/src/editor/index.d.ts +18 -0
- package/types/src/editor/referencePointNav.d.ts +39 -0
- package/types/src/editor/useFormulaHints.d.ts +126 -0
- package/types/src/editor/useFormulaInput.d.ts +326 -0
- package/types/src/editor/useProtectedEditNotice.d.ts +14 -0
- package/types/src/editor/useReferenceMode.d.ts +177 -0
- package/types/src/form/FormulaInput.d.ts +86 -0
- package/types/src/form/FormulaInputParts.d.ts +94 -0
- package/types/src/form/index.d.ts +5 -0
- package/types/src/form/useEditCommit.d.ts +174 -0
- package/types/src/form/useInputField.d.ts +86 -0
- package/types/src/frame/CommandContext.d.ts +179 -0
- package/types/src/frame/IFrame.d.ts +17 -0
- package/types/src/frame/index.d.ts +3 -0
- package/types/src/icons/LogoNoPaddingIcon.d.ts +3 -0
- package/types/src/icons/LogoTextNoPaddingIcon.d.ts +4 -0
- package/types/src/icons/WaterMark.d.ts +12 -0
- package/types/src/icons/chart/ChartAreaIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartAreaStackedIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartAreaStackedPercentIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartBarIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartBarStackedIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartBarStackedPercentIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartBubble3DIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartBubbleIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartColumnIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartColumnStackedIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartColumnStackedPercentIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartLineIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartLineMarkersIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartLineStackedIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartLineStackedMarkersIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartLineStackedPercentIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartLineStackedPercentMarkersIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartPieDoughnutIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartPieIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartScatterLinesIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartScatterLinesMarkersIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartScatterLinesMarkersSmoothIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartScatterLinesSmoothIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartScatterMarkersIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartWaterfallIcon.d.ts +5 -0
- package/types/src/icons/chart/ThemedChartIcon.d.ts +20 -0
- package/types/src/icons/chart/index.d.ts +50 -0
- package/types/src/icons/index.d.ts +4 -0
- package/types/src/index.d.ts +27 -0
- package/types/src/io/WorkbookIO.d.ts +50 -0
- package/types/src/io/index.d.ts +2 -0
- package/types/src/layer/BorderLayer.d.ts +14 -0
- package/types/src/layer/CellErrorLayer.d.ts +49 -0
- package/types/src/layer/CellFillLayer.d.ts +15 -0
- package/types/src/layer/ConditionalBarLayer.d.ts +41 -0
- package/types/src/layer/ConditionalIcons.d.ts +34 -0
- package/types/src/layer/ConditionalIconsLayer.d.ts +31 -0
- package/types/src/layer/ContextMenuLayer.d.ts +27 -0
- package/types/src/layer/HeaderResizerLayer.d.ts +28 -0
- package/types/src/layer/HeaderSelectionLayer.d.ts +89 -0
- package/types/src/layer/ResizeIndicator.d.ts +19 -0
- package/types/src/layer/SheetBackgroundLayer.d.ts +22 -0
- package/types/src/layer/SheetCellLayer.d.ts +49 -0
- package/types/src/layer/SheetColumnButtonLayer.d.ts +23 -0
- package/types/src/layer/SheetGridLineLayer.d.ts +22 -0
- package/types/src/layer/SheetHeaderCellLayer.d.ts +30 -0
- package/types/src/layer/SheetMovableLayer.d.ts +26 -0
- package/types/src/layer/SheetTableCommandLayer.d.ts +16 -0
- package/types/src/layer/SpillLayer.d.ts +22 -0
- package/types/src/layer/TableLayer.d.ts +22 -0
- package/types/src/layer/ValidationIndicatorLayer.d.ts +41 -0
- package/types/src/layer/index.d.ts +25 -0
- package/types/src/layer/resizeIndicatorState.d.ts +26 -0
- package/types/src/layer/useSheetFeatureRegions.d.ts +21 -0
- package/types/src/layer/useSheetVisibleCells.d.ts +60 -0
- package/types/src/layer/useSheetVisibleDecorations.d.ts +42 -0
- package/types/src/layer/useTableHeaderCells.d.ts +22 -0
- package/types/src/layer/useVisibleTables.d.ts +27 -0
- package/types/src/listener/index.d.ts +3 -0
- package/types/src/listener/useModelListener.d.ts +67 -0
- package/types/src/listener/useRangeListener.d.ts +15 -0
- package/types/src/movable/EmptyFrame.d.ts +16 -0
- package/types/src/movable/IMovableArea.d.ts +34 -0
- package/types/src/movable/MovableCommands.d.ts +22 -0
- package/types/src/movable/MovableFrame.d.ts +48 -0
- package/types/src/movable/MovableLayer.d.ts +77 -0
- package/types/src/movable/MoveableBundle.d.ts +4 -0
- package/types/src/movable/index.d.ts +4 -0
- package/types/src/picture/IPictureEditor.d.ts +39 -0
- package/types/src/picture/PictureEditor.d.ts +4 -0
- package/types/src/picture/index.d.ts +3 -0
- package/types/src/selection/SelectionCommands.d.ts +23 -0
- package/types/src/selection/SheetSelection.d.ts +53 -0
- package/types/src/selection/SheetSelectionLayer.d.ts +30 -0
- package/types/src/selection/index.d.ts +4 -0
- package/types/src/shape/ShapeEditor.d.ts +16 -0
- package/types/src/shape/index.d.ts +2 -0
- package/types/src/sheet/ConditionalFormatPresets.d.ts +56 -0
- package/types/src/sheet/ISheetElement.d.ts +233 -0
- package/types/src/sheet/ISheetHeaderElement.d.ts +138 -0
- package/types/src/sheet/NotImplemented.d.ts +3 -0
- package/types/src/sheet/SheetCommandProvider.d.ts +57 -0
- package/types/src/sheet/SheetCommands.d.ts +75 -0
- package/types/src/sheet/SheetElement.d.ts +15 -0
- package/types/src/sheet/SheetHeaderElement.d.ts +4 -0
- package/types/src/sheet/SheetScrollbar.d.ts +28 -0
- package/types/src/sheet/TopLeftCorner.d.ts +17 -0
- package/types/src/sheet/index.d.ts +7 -0
- package/types/src/slicer/SlicerEditor.d.ts +16 -0
- package/types/src/slicer/index.d.ts +2 -0
- package/types/src/tabStrip/SheetTab.d.ts +41 -0
- package/types/src/tabStrip/Sortable.d.ts +66 -0
- package/types/src/tabStrip/Tab.d.ts +19 -0
- package/types/src/tabStrip/TabStrip.d.ts +41 -0
- package/types/src/tabStrip/TabStripItem.d.ts +36 -0
- package/types/src/tabStrip/TabStripRow.d.ts +9 -0
- package/types/src/tabStrip/index.d.ts +7 -0
- package/types/src/table/TableCommands.d.ts +16 -0
- package/types/src/taskPane/ITaskPane.d.ts +72 -0
- package/types/src/taskPane/TaskPaneArea.d.ts +144 -0
- package/types/src/taskPane/TaskPaneFrame.d.ts +48 -0
- package/types/src/taskPane/TaskPaneRegistry.d.ts +108 -0
- package/types/src/taskPane/TaskPaneStrip.d.ts +33 -0
- package/types/src/taskPane/TaskPaneTitle.d.ts +24 -0
- package/types/src/taskPane/index.d.ts +7 -0
- package/types/src/taskPane/useTaskPane.d.ts +29 -0
- package/types/src/theme/DocThemesContext.d.ts +3 -0
- package/types/src/theme/DocThemesProvider.d.ts +15 -0
- package/types/src/theme/ThemeState.d.ts +19 -0
- package/types/src/theme/buildDocThemeCSS.d.ts +16 -0
- package/types/src/theme/buildOOXMLThemeCSS.d.ts +13 -0
- package/types/src/theme/createCSSSystemLookup.d.ts +51 -0
- package/types/src/theme/index.d.ts +11 -0
- package/types/src/theme/useAppColorScheme.d.ts +15 -0
- package/types/src/theme/useDocThemes.d.ts +3 -0
- package/types/src/theme/useGridColorScheme.d.ts +20 -0
- package/types/src/theme/useSystemColors.d.ts +44 -0
- package/types/src/undo/UndoCommands.d.ts +28 -0
- package/types/src/undo/UndoManagerContext.d.ts +14 -0
- package/types/src/undo/index.d.ts +3 -0
- package/types/src/workbook/DefaultRenderers.d.ts +14 -0
- package/types/src/workbook/GlobalWorkbookElement.d.ts +10 -0
- package/types/src/workbook/IWorkbookElement.d.ts +178 -0
- package/types/src/workbook/WindowChrome.d.ts +61 -0
- package/types/src/workbook/WorkbookCommandContributor.d.ts +24 -0
- package/types/src/workbook/WorkbookCommands.d.ts +97 -0
- package/types/src/workbook/WorkbookElement.d.ts +9 -0
- package/types/src/workbook/WorkbookStrip.d.ts +73 -0
- package/types/src/workbook/index.d.ts +17 -0
- package/types/src/workbook/resolveWorkbookInput.d.ts +27 -0
- package/types/src/workbook/useResolvedWorkbook.d.ts +31 -0
- package/types/src/workbook/useWindowChrome.d.ts +24 -0
- package/types/src/workbook/useWorkbookApp.d.ts +47 -0
- package/types/src/workbook/useWorkbookEncrypted.d.ts +15 -0
- package/types/src/workbook/useWorkbookFormat.d.ts +18 -0
- package/types/src/workbook/useWorkbookName.d.ts +13 -0
- package/types/src/workbook/useWorkbookSaveState.d.ts +29 -0
- package/browser/cjs/DNki9dGbSn_gUfd3.cjs +0 -7
- package/browser/cjs/Da611GSWMp5ncOGO.cjs +0 -16
- package/browser/cjs/F8ZECny0CwW2OV5X.cjs +0 -161
- package/browser/esm/BYGSBjns_83FWXAx.mjs +0 -3905
- package/browser/esm/CmObbQiLq9AAM7-q.mjs +0 -394
- package/browser/esm/Daa2g2QALCIHFgqP.mjs +0 -1377
- package/node/assets/style.css +0 -1
- package/node/esm/Bu9xI_rgkuupQ2AO.mjs +0 -11
|
@@ -0,0 +1,233 @@
|
|
|
1
|
+
import { ISheet, ICell, IMovable } from '@sheetxl/sdk';
|
|
2
|
+
import { CellCoords } from '@sheetxl/utils';
|
|
3
|
+
import { ViewportMetrics, IShowToolTipProperties, ScrollPaneProps, Viewport, ThemeMode } from '@sheetxl/utils-react';
|
|
4
|
+
import { GridSurfaceProps, IGridSurface, IEditable, LayerNode } from '@sheetxl/grid-react';
|
|
5
|
+
import { SheetCellRendererProps, ColumnButtonConfigProps } from '../cell';
|
|
6
|
+
import { MovableElementProps } from '../movable';
|
|
7
|
+
import { ISheetHeaderElement, SheetHeaderProps } from './ISheetHeaderElement';
|
|
8
|
+
/**
|
|
9
|
+
* Describes how to begin an edit — the imperative "start editing" request the sheet element exposes
|
|
10
|
+
* ({@link ISheetElement.startEdit}), e.g. from a command or the formula bar. The element maps it onto
|
|
11
|
+
* the shared editable's start options.
|
|
12
|
+
*
|
|
13
|
+
* @remarks
|
|
14
|
+
* Lives here (the host that owns the request) — grid-react's editor API takes `StartEditOptions`
|
|
15
|
+
* directly and does not carry this shape.
|
|
16
|
+
*/
|
|
17
|
+
export interface StartEditEvent {
|
|
18
|
+
/**
|
|
19
|
+
* Edit text. If this is null or undefined then this will not replace the text.
|
|
20
|
+
*
|
|
21
|
+
* @defaultValue null
|
|
22
|
+
*
|
|
23
|
+
* @remarks
|
|
24
|
+
* * A '' will clear the text.
|
|
25
|
+
*/
|
|
26
|
+
text?: string;
|
|
27
|
+
/**
|
|
28
|
+
* Is editor starting in edit mode.
|
|
29
|
+
*
|
|
30
|
+
* @defaultValue false
|
|
31
|
+
*/
|
|
32
|
+
editMode?: boolean;
|
|
33
|
+
/**
|
|
34
|
+
* Allows the initial selection position to be overridden. By default it's at the end
|
|
35
|
+
*/
|
|
36
|
+
initialSelection?: {
|
|
37
|
+
start: number;
|
|
38
|
+
end: number;
|
|
39
|
+
direction?: "forward" | "backward" | "none";
|
|
40
|
+
};
|
|
41
|
+
/**
|
|
42
|
+
* Should the editor take focus when the edit starts.
|
|
43
|
+
*
|
|
44
|
+
* @defaultValue true
|
|
45
|
+
*/
|
|
46
|
+
autoFocus?: boolean;
|
|
47
|
+
/**
|
|
48
|
+
* The cell that should be edited
|
|
49
|
+
*/
|
|
50
|
+
cell?: CellCoords;
|
|
51
|
+
}
|
|
52
|
+
export interface SheetLocation {
|
|
53
|
+
clientX: number;
|
|
54
|
+
clientY: number;
|
|
55
|
+
originalEvent?: React.MouseEvent<Element>;
|
|
56
|
+
clientWidth?: number;
|
|
57
|
+
clientHeight?: number;
|
|
58
|
+
rowIndex?: number;
|
|
59
|
+
colIndex?: number;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Props for the SheetElement component.
|
|
63
|
+
*/
|
|
64
|
+
export interface SheetElementProps extends React.HTMLAttributes<HTMLDivElement>, React.Attributes {
|
|
65
|
+
/**
|
|
66
|
+
* The `ISheet` to render.
|
|
67
|
+
*/
|
|
68
|
+
sheet: ISheet;
|
|
69
|
+
/**
|
|
70
|
+
* The app (chrome / header) color scheme — selects the header/app surface mode.
|
|
71
|
+
*/
|
|
72
|
+
colorScheme?: ThemeMode;
|
|
73
|
+
/**
|
|
74
|
+
* The grid-body color scheme (stays light in a dark app when *Enable Dark Grid* is off) — drives the grid
|
|
75
|
+
* `darkMode` rendering intent and the grid surface mode.
|
|
76
|
+
*/
|
|
77
|
+
gridColorScheme?: ThemeMode;
|
|
78
|
+
/**
|
|
79
|
+
* Show the column headers
|
|
80
|
+
*/
|
|
81
|
+
showColumnHeaders?: boolean;
|
|
82
|
+
/**
|
|
83
|
+
* Show the row headers
|
|
84
|
+
*/
|
|
85
|
+
showRowHeaders?: boolean;
|
|
86
|
+
/**
|
|
87
|
+
* Show the scrollbars
|
|
88
|
+
*/
|
|
89
|
+
showScrollbars?: boolean;
|
|
90
|
+
/**
|
|
91
|
+
* Show hover tooltips on cells that carry calc errors / warnings.
|
|
92
|
+
*
|
|
93
|
+
* @defaultValue true
|
|
94
|
+
*/
|
|
95
|
+
showCellErrors?: boolean;
|
|
96
|
+
/**
|
|
97
|
+
* Properties for the column headers
|
|
98
|
+
*/
|
|
99
|
+
propsColumnHeader?: Partial<SheetHeaderProps>;
|
|
100
|
+
/**
|
|
101
|
+
* Properties for the row headers
|
|
102
|
+
*/
|
|
103
|
+
propsRowHeader?: Partial<SheetHeaderProps>;
|
|
104
|
+
/**
|
|
105
|
+
* Allow for customizations of scrollbar
|
|
106
|
+
*/
|
|
107
|
+
propsScrollPane?: ScrollPaneProps;
|
|
108
|
+
/**
|
|
109
|
+
* Share a scroll {@link Viewport}. Pass one to own/drive the sheet's scroll externally —
|
|
110
|
+
* e.g. WorkbookElement creates it and also hands it to its ScrollPane so they share one store (no
|
|
111
|
+
* `Viewport`-data round-trip). The sheet drives the main grid from it and hands it to its headers
|
|
112
|
+
* (each composes its own per-axis follower). When omitted, the sheet creates its own.
|
|
113
|
+
*/
|
|
114
|
+
viewport?: Viewport;
|
|
115
|
+
/**
|
|
116
|
+
* Fired when the view port changes.
|
|
117
|
+
* This is in pixel coordinates and slightly different then viewable cells because off screen location bounds could change
|
|
118
|
+
*/
|
|
119
|
+
onViewportChange?: (view: ViewportMetrics) => void;
|
|
120
|
+
/**
|
|
121
|
+
* Fire when a contentMenu is requested
|
|
122
|
+
*/
|
|
123
|
+
onSheetContextMenu?: (location: SheetLocation) => void;
|
|
124
|
+
/**
|
|
125
|
+
* Called once when the sheet has been loaded but before it is rendered.
|
|
126
|
+
*/
|
|
127
|
+
onFirstRender?: () => void;
|
|
128
|
+
/**
|
|
129
|
+
* The app-created editor for the always-mounted cell editor. When provided, the grid edits through
|
|
130
|
+
* this shared {@link IEditable}; pass the SAME instance to the formula bar for free two-way sync. A
|
|
131
|
+
* stable reference. If omitted, a standalone SheetElement makes its own.
|
|
132
|
+
*/
|
|
133
|
+
editable?: IEditable<() => ICell, string>;
|
|
134
|
+
/**
|
|
135
|
+
* Fixed component that is layered within the viewport.
|
|
136
|
+
*
|
|
137
|
+
* @remarks Useful for dialogs and items that you want to place relative to the grid.
|
|
138
|
+
*/
|
|
139
|
+
viewportComponent?: React.ReactNode;
|
|
140
|
+
/**
|
|
141
|
+
* Render components for movable elements.
|
|
142
|
+
*
|
|
143
|
+
* @param props - {@link MovableElementProps}
|
|
144
|
+
* @returns A React Element representing the IMovable.
|
|
145
|
+
*/
|
|
146
|
+
renderMovable?: (props: MovableElementProps) => React.ReactElement;
|
|
147
|
+
/**
|
|
148
|
+
* Render element(s) directly onto the `GridSurface`, bottom → top — the same {@link LayerNode} the
|
|
149
|
+
* grid takes for its children (a node or an array of them). Each layer reads its pane from context
|
|
150
|
+
* ({@link useGridPane}); for a layer that must be built from the pane, call it in a small wrapper.
|
|
151
|
+
*/
|
|
152
|
+
layers?: LayerNode;
|
|
153
|
+
/**
|
|
154
|
+
* To show the tooltip
|
|
155
|
+
*
|
|
156
|
+
* @param props
|
|
157
|
+
*/
|
|
158
|
+
onShowTooltip?: (props: IShowToolTipProperties) => void;
|
|
159
|
+
onCloseTooltip?: () => void;
|
|
160
|
+
/**
|
|
161
|
+
* Customize the grid.
|
|
162
|
+
*
|
|
163
|
+
* @remarks
|
|
164
|
+
* Not all props are passed through.
|
|
165
|
+
*/
|
|
166
|
+
propsGrid?: GridSurfaceProps;
|
|
167
|
+
/**
|
|
168
|
+
* Allow for custom rendering of cell props.
|
|
169
|
+
*
|
|
170
|
+
* @remarks
|
|
171
|
+
* This is used to customize columnButton popup action and any other customizations desired.
|
|
172
|
+
* This does not invalidate the rendering
|
|
173
|
+
*/
|
|
174
|
+
propsCellRender?: Partial<SheetCellRendererProps> & ColumnButtonConfigProps;
|
|
175
|
+
/**
|
|
176
|
+
* Ref to the sheet element.
|
|
177
|
+
*/
|
|
178
|
+
ref?: React.Ref<ISheetElement>;
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* Attributes and methods available on the sheet element beyond the HTMLDivElement.
|
|
182
|
+
*/
|
|
183
|
+
export type ISheetAttributes = {
|
|
184
|
+
getGridSurface: () => IGridSurface;
|
|
185
|
+
getRowHeaderElement: () => ISheetHeaderElement;
|
|
186
|
+
getColumnHeaderElement: () => ISheetHeaderElement;
|
|
187
|
+
rowHeaderHeight: () => number;
|
|
188
|
+
colHeaderWidth: () => number;
|
|
189
|
+
startEdit(event?: StartEditEvent): void;
|
|
190
|
+
submitEdit(): void;
|
|
191
|
+
cancelEdit(): void;
|
|
192
|
+
isEditing: boolean;
|
|
193
|
+
contains(element: Node | null): boolean;
|
|
194
|
+
invalidate: (coords?: ICell.Coords | null) => void;
|
|
195
|
+
/**
|
|
196
|
+
* Focus the sheet or the movable based on last focus.
|
|
197
|
+
*
|
|
198
|
+
* @param options
|
|
199
|
+
*/
|
|
200
|
+
focus(options?: FocusOptions): void;
|
|
201
|
+
/**
|
|
202
|
+
* Focus the sheet.
|
|
203
|
+
*/
|
|
204
|
+
focusSheet(options?: FocusOptions): void;
|
|
205
|
+
/**
|
|
206
|
+
* Focus a specific float.
|
|
207
|
+
* If not provided will focus the first selected float.
|
|
208
|
+
*
|
|
209
|
+
* @remarks
|
|
210
|
+
* The focusMovable does not scroll.
|
|
211
|
+
* TODO - have this honor GridPanes scroll options.
|
|
212
|
+
*/
|
|
213
|
+
focusMovable(movable?: IMovable): Promise<boolean>;
|
|
214
|
+
/**
|
|
215
|
+
* Returns the attached `ISheet`.
|
|
216
|
+
*/
|
|
217
|
+
getSheet: () => ISheet;
|
|
218
|
+
/**
|
|
219
|
+
* Wheel intercept (ctrl/⌘+wheel ⇒ zoom). Return `false` to consume the event. Exposed so an outer
|
|
220
|
+
* scroll wrapper can route wheel through the sheet's zoom handling.
|
|
221
|
+
*/
|
|
222
|
+
onWheelScroll: (event: globalThis.WheelEvent) => boolean | void;
|
|
223
|
+
/**
|
|
224
|
+
* For runtime introspection.
|
|
225
|
+
*/
|
|
226
|
+
isSheetElement: () => true;
|
|
227
|
+
};
|
|
228
|
+
/**
|
|
229
|
+
* Type returned via ref property
|
|
230
|
+
*/
|
|
231
|
+
export interface ISheetElement extends HTMLDivElement, ISheetAttributes {
|
|
232
|
+
}
|
|
233
|
+
//# sourceMappingURL=ISheetElement.d.ts.map
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { FixedEdge } from '@sheetxl/utils';
|
|
3
|
+
import { ISheetHeader } from '@sheetxl/sdk';
|
|
4
|
+
import { Viewport, ThemeMode } from '@sheetxl/utils-react';
|
|
5
|
+
import { IGridSurface } from '@sheetxl/grid-react';
|
|
6
|
+
import { SheetCellRendererProps, ColumnButtonConfigProps } from '../cell';
|
|
7
|
+
import { SheetLocation } from './ISheetElement';
|
|
8
|
+
/**
|
|
9
|
+
* Props for the SheetHeaderElement component.
|
|
10
|
+
*/
|
|
11
|
+
export interface SheetHeaderProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
12
|
+
/**
|
|
13
|
+
* The underlying data model for the SheetHeader.
|
|
14
|
+
*/
|
|
15
|
+
sheetHeader: ISheetHeader;
|
|
16
|
+
/**
|
|
17
|
+
* The height or width in the opposite direction (for example a column headers height). This is the
|
|
18
|
+
* usable STAGE size (where labels draw); the separator edge ({@link edgeSize}) is added on top of it
|
|
19
|
+
* via a `border-box` border, so the rendered band is `oppositeSize + edgeSize`.
|
|
20
|
+
*/
|
|
21
|
+
oppositeSize: number;
|
|
22
|
+
/**
|
|
23
|
+
* The separator line drawn on the band's body-facing edge (the header's own `border-bottom` for a
|
|
24
|
+
* column header, `border-right` for a row header). Part of the `border-box`, so it lands between the
|
|
25
|
+
* stage and the body without stealing stage space. @defaultValue 1
|
|
26
|
+
*/
|
|
27
|
+
edgeSize?: number;
|
|
28
|
+
/**
|
|
29
|
+
* Color of the separator {@link edgeSize} line. Typically the gridline token. @defaultValue `var(--sxl-color-base-300)`
|
|
30
|
+
*/
|
|
31
|
+
edgeColor?: string;
|
|
32
|
+
/**
|
|
33
|
+
* Freeze start.
|
|
34
|
+
*/
|
|
35
|
+
freezeStart?: number | FixedEdge;
|
|
36
|
+
/**
|
|
37
|
+
* The app (header) color scheme — headers follow the app surface. Selects the header surface's mode; the
|
|
38
|
+
* surface's token VALUES come from the injected stylesheet.
|
|
39
|
+
*/
|
|
40
|
+
colorScheme?: ThemeMode;
|
|
41
|
+
/**
|
|
42
|
+
* @see
|
|
43
|
+
* {@link SheetHeaderRenderer#verticalPadding}
|
|
44
|
+
*/
|
|
45
|
+
verticalPadding?: number;
|
|
46
|
+
/**
|
|
47
|
+
* @see
|
|
48
|
+
* {@link SheetHeaderRenderer#horizontalPadding}
|
|
49
|
+
*/
|
|
50
|
+
horizontalPadding?: number;
|
|
51
|
+
/**
|
|
52
|
+
* Called when a contentMenu is requested.
|
|
53
|
+
*/
|
|
54
|
+
onSheetContextMenu?: (location: SheetLocation) => void;
|
|
55
|
+
/**
|
|
56
|
+
* Called when resize of a header starts.
|
|
57
|
+
*/
|
|
58
|
+
onResizeHeadersStart?: (index: number, prevSize: number, description: string) => void;
|
|
59
|
+
/**
|
|
60
|
+
* Called during resize of a header.
|
|
61
|
+
*
|
|
62
|
+
* @remarks
|
|
63
|
+
* If there is a negative newSize then these headers will have been hidden
|
|
64
|
+
* This is for the specific header being resized.
|
|
65
|
+
* Note - Other headers may also have been resized if hiding
|
|
66
|
+
*/
|
|
67
|
+
onResizeHeaders?: (index: number, newSize: number, prevSize: number) => void;
|
|
68
|
+
/**
|
|
69
|
+
* Called after resize of a header.
|
|
70
|
+
* If there is a positive newSize and a single selection then those
|
|
71
|
+
* headers will also have been resized.
|
|
72
|
+
*
|
|
73
|
+
* Note - Other colHeaderRuns may also have been resized if expanding
|
|
74
|
+
* Note - If this was autoFit then newSize and prevSize will be null.
|
|
75
|
+
*/
|
|
76
|
+
onResizeHeadersEnd?: (index: number, newSize: number, description: string) => void;
|
|
77
|
+
/**
|
|
78
|
+
* Called when a header resize starts.
|
|
79
|
+
*/
|
|
80
|
+
onResizeHeadersDown?: (index: number, size: number) => void;
|
|
81
|
+
/**
|
|
82
|
+
* Called when a header resize ends.
|
|
83
|
+
*/
|
|
84
|
+
onResizeHeadersUp?: (index: number) => void;
|
|
85
|
+
/**
|
|
86
|
+
* Override the default headerText. If not provided then typical Sheet labeling is used.
|
|
87
|
+
*/
|
|
88
|
+
headerText?: (index: number) => string;
|
|
89
|
+
/**
|
|
90
|
+
* The sheet's MAIN scroll viewport. The header composes its own per-axis follower internally (it
|
|
91
|
+
* knows its axis): it follows this viewport on its scrolling axis (read-only) and owns a throwaway
|
|
92
|
+
* controller for the trivial cross axis. Sharing the main controller's rAF ticker keeps the header
|
|
93
|
+
* frame-locked, including momentum.
|
|
94
|
+
*/
|
|
95
|
+
viewport?: Viewport;
|
|
96
|
+
/**
|
|
97
|
+
* Callback when selection is manually started.
|
|
98
|
+
*/
|
|
99
|
+
onSelectionStart?: () => void;
|
|
100
|
+
/**
|
|
101
|
+
* Callback when selection is manually changed.
|
|
102
|
+
*/
|
|
103
|
+
onSelectionEnd?: () => void;
|
|
104
|
+
/**
|
|
105
|
+
* Allow for custom rendering of cell props.
|
|
106
|
+
*
|
|
107
|
+
* @remarks
|
|
108
|
+
* This is used to customize columnButton popup action and any other customizations desired.
|
|
109
|
+
* This does not invalidate the rendering.
|
|
110
|
+
*/
|
|
111
|
+
propsCellRender?: Partial<SheetCellRendererProps> & ColumnButtonConfigProps;
|
|
112
|
+
/**
|
|
113
|
+
* Ref for the HTMLDivElement.
|
|
114
|
+
*/
|
|
115
|
+
ref?: React.Ref<ISheetHeaderElement>;
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* Additional methods exposed via ref on the SheetHeaderElement.
|
|
119
|
+
*/
|
|
120
|
+
export type ISheetHeaderAttributes = {
|
|
121
|
+
/**
|
|
122
|
+
* Force the header to re-render.
|
|
123
|
+
*
|
|
124
|
+
* @returns
|
|
125
|
+
* This is useful when the underlying data model changes and the header needs to update to reflect those changes.
|
|
126
|
+
*/
|
|
127
|
+
forceRender: () => void;
|
|
128
|
+
/**
|
|
129
|
+
* Get the grid surface associated with this header.
|
|
130
|
+
*/
|
|
131
|
+
getGridSurface: () => IGridSurface;
|
|
132
|
+
};
|
|
133
|
+
/**
|
|
134
|
+
* Type returned via ref property.
|
|
135
|
+
*/
|
|
136
|
+
export interface ISheetHeaderElement extends HTMLDivElement, ISheetHeaderAttributes {
|
|
137
|
+
}
|
|
138
|
+
//# sourceMappingURL=ISheetHeaderElement.d.ts.map
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { ReactNode } from 'react';
|
|
2
|
+
import { ISheet } from '@sheetxl/sdk';
|
|
3
|
+
import { Command } from '@sheetxl/utils-react';
|
|
4
|
+
import { SheetEditable } from '../editor';
|
|
5
|
+
import { SheetCommandData } from './SheetCommands';
|
|
6
|
+
/** The `data` bundle for the sheet contributor — the sheet-command data plus the shared editable (for the
|
|
7
|
+
* ready-mode `'startEdit'` insert commands). */
|
|
8
|
+
export interface SheetCommandContributorData extends SheetCommandData {
|
|
9
|
+
editable?: SheetEditable | null;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* The `sheet` feature's command contributor: `static` seeds the catalog presentation; `dynamic` attaches the
|
|
13
|
+
* behavior — cell/format (transactional middleware over the per-workbook undo manager) + the ready-mode
|
|
14
|
+
* `'startEdit'` insert commands. Stateless — the model + services ride in `data`.
|
|
15
|
+
*/
|
|
16
|
+
export declare const SheetCommandContributor: Command.CommandContributor<SheetCommandContributorData>;
|
|
17
|
+
interface SheetCommandProviderProps {
|
|
18
|
+
/** The active sheet the cell/format commands operate on. */
|
|
19
|
+
sheet: ISheet | null;
|
|
20
|
+
/** The shared cell editable — the **ready-mode** insert commands (`insertCurrent*`/`insertFunction*`) seed
|
|
21
|
+
* an edit through it. `undefined` on a bare grid ⇒ those commands stay chrome-only (disabled). */
|
|
22
|
+
editable?: SheetEditable | null;
|
|
23
|
+
/** Hand the created `sheet` scope back to the parent (see {@link CommandScopeProvider.scopeRef}) — so
|
|
24
|
+
* `SheetElement` can hold it for the direct-execute zoom gesture without a provide/consume wrapper split. */
|
|
25
|
+
scopeRef?: {
|
|
26
|
+
current: Command.CommandScope | null;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* The sheet's own root element — the scope's **region** for origin containment (see
|
|
30
|
+
* {@link CommandScope.attachBounds}). Every command this scope authors acts on the grid selection,
|
|
31
|
+
* so a keystroke born OUTSIDE this element (a task pane, a dialog field, the toolbar) must not
|
|
32
|
+
* dispatch one: unbounded, `Delete` in a comment box ran `clearContents`. Bounds only — focus inside
|
|
33
|
+
* the grid still anchors at the pane's z-stack, which is a deeper region.
|
|
34
|
+
*
|
|
35
|
+
* Omitting it leaves the scope unrestricted (the element-less default), which is what a bare
|
|
36
|
+
* chromeless grid — the whole app, one region — wants.
|
|
37
|
+
*/
|
|
38
|
+
elementRef?: {
|
|
39
|
+
readonly current: Element | null;
|
|
40
|
+
};
|
|
41
|
+
children: ReactNode;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* **Per-sheet command provider** — owned by `WorkbookElement` (mounted inside it, wrapping the grid). It
|
|
45
|
+
* declares a `sheet` scope as a child of the ambient `workbook` scope (owned by `WorkbookElement`)
|
|
46
|
+
* via {@link CommandScopeProvider}'s declarative form, so the anchor chain is `pane → sheet → workbook → app`.
|
|
47
|
+
* The pane's command **layers** (selection / clipboard / editor / movable) register as `sheet`-descendant
|
|
48
|
+
* leaves below it. Behavior is the {@link SheetCommandContributor}; the static chrome is seeded into the
|
|
49
|
+
* shared registry here.
|
|
50
|
+
*
|
|
51
|
+
* @remarks
|
|
52
|
+
* Only the grid consumes the `sheet` scope, so it lives here (inside the workbook) rather than at studio
|
|
53
|
+
* level. Without an ambient command scope (a bare chromeless grid), this is a pass-through.
|
|
54
|
+
*/
|
|
55
|
+
export declare const SheetCommandProvider: ({ sheet, editable, scopeRef, elementRef, children }: SheetCommandProviderProps) => ReactNode;
|
|
56
|
+
export {};
|
|
57
|
+
//# sourceMappingURL=SheetCommandProvider.d.ts.map
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { EditModeHandler, ReferenceableClipboard, RemoveListener, UndoManager } from '@sheetxl/utils';
|
|
2
|
+
import { IBorder, ISheet, IColor } from '@sheetxl/sdk';
|
|
3
|
+
import { Command, IReactNotifier } from '@sheetxl/utils-react';
|
|
4
|
+
import { ActivateFrameOptions, ITaskPaneArea } from '../taskPane';
|
|
5
|
+
/** Minimal shape of the global clipboard handle the insert-copied-cells path reads. */
|
|
6
|
+
interface GlobalClipboardLike {
|
|
7
|
+
getClipboard(): ReferenceableClipboard;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Options for {@link contributeSheetCommands}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ContributeSheetCommandsOptions {
|
|
13
|
+
/** Busy + error UI for the transactional middleware. */
|
|
14
|
+
notifier?: IReactNotifier;
|
|
15
|
+
/** Undo manager the sheet records into — enables F4 / redo-as-repeat (see the transactional middleware). */
|
|
16
|
+
manager?: UndoManager;
|
|
17
|
+
/**
|
|
18
|
+
* Activate a **task pane** by key (e.g. `dataValidationDetails`). Threaded from the bridge's
|
|
19
|
+
* `useTaskPaneArea()` — sheet commands that open a side pane (data validation, table details) can't
|
|
20
|
+
* reach the task-pane area themselves (it lives deeper in the tree). No-op if omitted.
|
|
21
|
+
*/
|
|
22
|
+
activateTaskPane?: (key: string, options?: ActivateFrameOptions) => void;
|
|
23
|
+
/**
|
|
24
|
+
* The **read** side of the same task-pane area `activateTaskPane` writes to — which pane is showing,
|
|
25
|
+
* plus the subscription that says when that changed. A command whose `state` is "my pane is the one
|
|
26
|
+
* on screen" (`editTable`) needs both; opening one only needs the writer above. Threaded from the
|
|
27
|
+
* bridge's `useTaskPaneArea()`; omitted ⇒ those commands carry no state.
|
|
28
|
+
*/
|
|
29
|
+
taskPaneArea?: ITaskPaneArea;
|
|
30
|
+
/** Edit-mode handler — insert-cells reads the copy/cut mode; image clears it. From `useEditMode()`. */
|
|
31
|
+
editModeHandler?: EditModeHandler;
|
|
32
|
+
/** Global clipboard — insert-cells reads a copied range reference to "insert copied cells". */
|
|
33
|
+
globalClipboard?: GlobalClipboardLike;
|
|
34
|
+
/** Persistent last-used values for the style pickers (color quick swatch + border) + memory. From the bridge's `usePersistenceState`. */
|
|
35
|
+
pickerMemory?: PickerMemory;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* The single `data` bundle {@link contributeSheetCommands} takes — the sheet **and** its services
|
|
39
|
+
* together (the `DynamicCommandContributor` shape). `sheet` may be `null` on a bare grid (⇒ no behavior).
|
|
40
|
+
*/
|
|
41
|
+
export interface SheetCommandData extends ContributeSheetCommandsOptions {
|
|
42
|
+
sheet: ISheet | null;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Persistent "last used" values for the style pickers — the quick swatch (`quickColor`/`quickBorder`) and the
|
|
46
|
+
* `onColorSelect`/`onBorderSelect` memory. Owned by the bridge (`usePersistenceState`) and passed as **live
|
|
47
|
+
* getters** so the lazy `context` closures read the current value without re-contributing. Only fill/font
|
|
48
|
+
* color + border persist; the tab/gridline color pickers don't (their `onColorSelect` is a no-op).
|
|
49
|
+
*/
|
|
50
|
+
export interface PickerMemory {
|
|
51
|
+
getLastFillColor?: () => IColor | null;
|
|
52
|
+
setLastFillColor?: (color: IColor | null) => void;
|
|
53
|
+
getLastFontColor?: () => IColor | null;
|
|
54
|
+
setLastFontColor?: (color: IColor | null) => void;
|
|
55
|
+
getLastBorder?: () => Partial<IBorder.Properties> | null;
|
|
56
|
+
setLastBorder?: (border: Partial<IBorder.Properties> | null) => void;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* The per-sheet command **behavior** (paired with {@link registerSheetDefinitions}). A plain
|
|
60
|
+
* contributor over the {@link Command.CommandContribution authoring facet}:
|
|
61
|
+
* 1. installs the **shared transactional middleware** (batch + busy + error + repeatable) via `use()`,
|
|
62
|
+
* so the command callbacks stay pure;
|
|
63
|
+
* 2. runs the **disable reducer** — recomputed on every model tick (the container debounce coalesces
|
|
64
|
+
* re-resolution, so the reducer's cheap `updateCommand`s can run per-tick).
|
|
65
|
+
*
|
|
66
|
+
* @remarks
|
|
67
|
+
* The reducer combines the **protection** reasons (the `mutator` tag → "sheet protected", plus the
|
|
68
|
+
* rotation commands' extra `isContinuousSpan` gate) with the **selection-shape** rules (sort needs
|
|
69
|
+
* a single range; insert/delete by whole-row/column + overlap; merge/header). Both must be computed
|
|
70
|
+
* *together* per command — within-scope `updateCommand` overrides, so reasons are combined in one
|
|
71
|
+
* call, not stacked. Returns a disposer that detaches the model + selection listeners.
|
|
72
|
+
*/
|
|
73
|
+
export declare function contributeSheetCommands(contribution: Command.CommandContribution, data: SheetCommandData): RemoveListener;
|
|
74
|
+
export {};
|
|
75
|
+
//# sourceMappingURL=SheetCommands.d.ts.map
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ISheetElement, SheetElementProps } from './ISheetElement';
|
|
3
|
+
/**
|
|
4
|
+
* @see ISheet
|
|
5
|
+
*
|
|
6
|
+
* UI representation for ISheet.
|
|
7
|
+
*
|
|
8
|
+
*/
|
|
9
|
+
/**
|
|
10
|
+
* The grid-facing body of {@link SheetElement} — **consumes** the ambient `sheet` command scope (provided by
|
|
11
|
+
* the outer {@link SheetElement} wrapper) to build the grid resolver + per-pane layer scopes. Split from the
|
|
12
|
+
* public component because a component can't consume in its body the scope it provides in its own JSX.
|
|
13
|
+
*/
|
|
14
|
+
export declare const SheetElement: React.NamedExoticComponent<Omit<SheetElementProps, "ref"> & React.RefAttributes<ISheetElement>>;
|
|
15
|
+
//# sourceMappingURL=SheetElement.d.ts.map
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ISheetHeaderElement, SheetHeaderProps } from './ISheetHeaderElement';
|
|
3
|
+
export declare const SheetHeaderElement: React.NamedExoticComponent<Omit<SheetHeaderProps, "ref"> & React.RefAttributes<ISheetHeaderElement>>;
|
|
4
|
+
//# sourceMappingURL=SheetHeaderElement.d.ts.map
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ISheet } from '@sheetxl/sdk';
|
|
3
|
+
import { ScrollbarOrientation, VirtualScrollbarProps, IScrollbarElement, IShowToolTipProperties } from '@sheetxl/utils-react';
|
|
4
|
+
export interface SheetScrollbarProps extends VirtualScrollbarProps {
|
|
5
|
+
/**
|
|
6
|
+
* The `ISheet` for the given scrollbar.
|
|
7
|
+
*/
|
|
8
|
+
sheet: ISheet;
|
|
9
|
+
/**
|
|
10
|
+
* The direction of the scrollbar.
|
|
11
|
+
*/
|
|
12
|
+
orientation: ScrollbarOrientation;
|
|
13
|
+
/**
|
|
14
|
+
* @defaultValue false
|
|
15
|
+
*/
|
|
16
|
+
showCustomScrollButtons?: boolean;
|
|
17
|
+
/**
|
|
18
|
+
* To show the tooltip
|
|
19
|
+
* @param properties
|
|
20
|
+
*/
|
|
21
|
+
onShowTooltip?: (properties: IShowToolTipProperties) => void;
|
|
22
|
+
/**
|
|
23
|
+
* Called to close the tooltip. Required is onShowTip is provided
|
|
24
|
+
*/
|
|
25
|
+
onCloseTooltip?: () => void;
|
|
26
|
+
}
|
|
27
|
+
export declare const SheetScrollbar: React.NamedExoticComponent<Omit<SheetScrollbarProps, "ref"> & React.RefAttributes<IScrollbarElement>>;
|
|
28
|
+
//# sourceMappingURL=SheetScrollbar.d.ts.map
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ISheet } from '@sheetxl/sdk';
|
|
3
|
+
import { ThemeMode } from '@sheetxl/utils-react';
|
|
4
|
+
export interface TopLeftCornerProps extends React.HTMLProps<HTMLElement> {
|
|
5
|
+
sheet: ISheet;
|
|
6
|
+
/** The app (header) color scheme — headers follow the app surface; colors come from the header-surface
|
|
7
|
+
* tokens. */
|
|
8
|
+
colorScheme?: ThemeMode;
|
|
9
|
+
width: number;
|
|
10
|
+
height: number;
|
|
11
|
+
onMouseDown?: (e: React.MouseEvent<HTMLElement, MouseEvent>) => void;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* UI representation for Top Left Corner of the sheet
|
|
15
|
+
*/
|
|
16
|
+
export declare const TopLeftCorner: React.NamedExoticComponent<Omit<TopLeftCornerProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
|
|
17
|
+
//# sourceMappingURL=TopLeftCorner.d.ts.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export type * from './ISheetElement';
|
|
2
|
+
export * from './SheetElement';
|
|
3
|
+
export * from './SheetScrollbar';
|
|
4
|
+
export * from './SheetCommands';
|
|
5
|
+
export * from './ConditionalFormatPresets';
|
|
6
|
+
export * from './SheetCommandProvider';
|
|
7
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { MovableElementProps } from '../movable';
|
|
3
|
+
export interface SlicerEditorAttributes {
|
|
4
|
+
isSlicerEditor: () => true;
|
|
5
|
+
}
|
|
6
|
+
export interface ISlicerEditorElement extends HTMLDivElement, SlicerEditorAttributes {
|
|
7
|
+
}
|
|
8
|
+
export interface SlicerEditorProps extends MovableElementProps {
|
|
9
|
+
slicer: any;
|
|
10
|
+
ref?: React.Ref<ISlicerEditorElement>;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Placeholder for chart editors.
|
|
14
|
+
*/
|
|
15
|
+
export declare const SlicerEditor: React.NamedExoticComponent<Omit<SlicerEditorProps, "ref"> & React.RefAttributes<ISlicerEditorElement>>;
|
|
16
|
+
//# sourceMappingURL=SlicerEditor.d.ts.map
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { ISheet } from '@sheetxl/sdk';
|
|
2
|
+
import { TabProps } from './Tab';
|
|
3
|
+
/**
|
|
4
|
+
* Props passed to the {@link SheetTabProps.slotSurface} element (the tab's
|
|
5
|
+
* clickable surface).
|
|
6
|
+
*/
|
|
7
|
+
export interface SheetTabSurfaceProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
8
|
+
/** The tab is disabled. */
|
|
9
|
+
disabled?: boolean;
|
|
10
|
+
/** The tab's label is being edited inline. */
|
|
11
|
+
editing?: boolean;
|
|
12
|
+
}
|
|
13
|
+
export interface SheetTabProps extends TabProps {
|
|
14
|
+
/**
|
|
15
|
+
* The sheet.
|
|
16
|
+
*/
|
|
17
|
+
sheet: ISheet;
|
|
18
|
+
/**
|
|
19
|
+
* The rounded tab radius.
|
|
20
|
+
* @defaultValue 4
|
|
21
|
+
*/
|
|
22
|
+
tabRadius?: number;
|
|
23
|
+
/**
|
|
24
|
+
* Allow for custom rendering of the tab's clickable surface. Defaults to a plain `div`.
|
|
25
|
+
*/
|
|
26
|
+
slotSurface?: React.ComponentType<SheetTabSurfaceProps>;
|
|
27
|
+
/**
|
|
28
|
+
* When `true` (default) the selected tab uses the inverted, open-top tab shape so it reads
|
|
29
|
+
* as part of the grid directly above it. When `false` it uses a plain rounded tab — for
|
|
30
|
+
* layouts where the strip is detached from the grid (e.g. stacked under the scrollbar on a
|
|
31
|
+
* small screen).
|
|
32
|
+
* @defaultValue true
|
|
33
|
+
*/
|
|
34
|
+
inverted?: boolean;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* A tab representing a sheet in a workbook — the rounded, Excel-style sheet tab
|
|
38
|
+
* (tab color, selected indicator and protection lock).
|
|
39
|
+
*/
|
|
40
|
+
export declare const SheetTab: import('react').NamedExoticComponent<SheetTabProps & import('react').RefAttributes<HTMLDivElement>>;
|
|
41
|
+
//# sourceMappingURL=SheetTab.d.ts.map
|