@sheetxl/react 0.8.0-beta.7 → 1.0.0
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/LICENSE.md +8 -7
- package/browser/esm/2YDUWXaXpl9cdsk7.mjs +8 -0
- package/browser/esm/64NfoZ1s7Oe3vdpX.mjs +60 -0
- package/browser/esm/BJDz5J4gFUEYi1Wz.mjs +36 -0
- package/browser/esm/B_CI6xMNropeWGgr.mjs +134 -0
- package/browser/esm/BgA4Cz8iMysciFOb.mjs +45 -0
- package/browser/esm/BkG6VuJDmu_hfIo6.mjs +31 -0
- package/browser/esm/BmO7yh4NjxeJylOD.mjs +14092 -0
- package/browser/esm/BwFFSeqtE3TIuvtc.mjs +341 -0
- package/browser/esm/CENTtj0PnF_tvpST.mjs +79 -0
- package/browser/esm/CVY0-_x6IgpdUVNp.mjs +264 -0
- package/browser/esm/CdyivRoMgPXvRiiE.mjs +197 -0
- package/browser/esm/CiylJlRA7mt8yjPD.mjs +128 -0
- package/browser/esm/D9CTIGFUbVGJkeVE.mjs +401 -0
- package/browser/esm/D9NgFucLwPgAQNgf.mjs +19 -0
- package/browser/esm/DdFOaG09eksHtKwT.mjs +145 -0
- package/browser/esm/DdHdNjRkzo1iShOo.mjs +78 -0
- package/browser/esm/DfIvpHB7HDdmIYNm.mjs +9560 -0
- package/browser/esm/DfNDtzixfTPjmoW_.mjs +32 -0
- package/browser/esm/Dtb9bOBjtPdUAr8x.mjs +20 -0
- package/browser/esm/Dz5pGpL4XWXVdntj.mjs +323 -0
- package/browser/esm/SJAlYSFKC-5yNZ-C.mjs +2706 -0
- package/browser/esm/chart.mjs +41 -0
- package/browser/esm/control.mjs +217 -0
- package/browser/esm/group.mjs +123 -0
- package/browser/esm/index.mjs +22289 -13986
- package/browser/esm/jHqSboF5oFvzSM7a.mjs +63 -0
- package/browser/esm/note.mjs +112 -0
- package/browser/esm/oljQE8EpIzoxUjUz.mjs +323 -0
- package/browser/esm/picture.mjs +7 -0
- package/browser/esm/shape.mjs +7 -0
- package/browser/esm/slicer.mjs +282 -0
- package/browser/esm/w8MsScJSe7QxP6jL.mjs +67 -0
- package/browser/esm/yRqWQRSVyiR1kYh8.mjs +42 -0
- package/licenses/dependencies.txt +284 -565
- package/node/esm/1XOgrNXKQF__O9SV.mjs +8 -0
- package/node/esm/Aw6aaKE_YOA1Vi_V.mjs +146 -0
- package/node/esm/B6Oqu2Gw1pwWPf_N.mjs +328 -0
- package/node/esm/BizlElAhqg_Bc624.mjs +198 -0
- package/node/esm/C06Y1xPsbxgn3YX7.mjs +128 -0
- package/node/esm/C2dHN_gvhBxlFFnJ.mjs +45 -0
- package/node/esm/C4_5UcCdys1hzt5E.mjs +68 -0
- package/node/esm/CIidiDtqyubz13ys.mjs +80 -0
- package/node/esm/CTFb8PjwC1q6yilw.mjs +80 -0
- package/node/esm/C_GJPG-BTFhta8GD.mjs +265 -0
- package/node/esm/CdTeYrDgGp-s-KNG.mjs +134 -0
- package/node/esm/CeMKhq6cSxfWzN5H.mjs +2706 -0
- package/node/esm/DJIBAu8bEDmlVjtD.mjs +20 -0
- package/node/esm/DUQ1PY9P63cTe_Es.mjs +37 -0
- package/node/esm/Db8NRp_kZ-FfkZaO.mjs +32 -0
- package/node/esm/Dl2kdvb4G_ddqeDN.mjs +19 -0
- package/node/esm/DlDr-o5nAZgPbn6R.mjs +1697 -0
- package/node/esm/DvRLP1lEBfwHBrEC.mjs +63 -0
- package/node/esm/JVlPlE1ys7DM3yCP.mjs +35 -0
- package/node/esm/NSddS40Vqf1xKdDd.mjs +406 -0
- package/node/esm/QqwCS9GFuDnQausz.mjs +66 -0
- package/node/esm/chart.mjs +41 -0
- package/node/esm/control.mjs +217 -0
- package/node/esm/group.mjs +123 -0
- package/node/esm/index.mjs +18027 -9614
- package/node/esm/note.mjs +113 -0
- package/node/esm/picture.mjs +326 -0
- package/node/esm/shape.mjs +342 -0
- package/node/esm/slicer.mjs +284 -0
- package/package.json +56 -15
- package/resources/contents.json +36 -0
- package/resources/locales/contents.json +84 -0
- package/resources/locales/de/chart.cmd.json +82 -0
- package/resources/locales/de/movable.cmd.json +68 -0
- package/resources/locales/de/picture.cmd.json +188 -0
- package/resources/locales/de/pivot.cmd.json +79 -0
- package/resources/locales/de/shape.cmd.json +17 -0
- package/resources/locales/de/sheet.cmd.json +270 -16
- package/resources/locales/de/slicer.cmd.json +17 -0
- package/resources/locales/de/sparkline.cmd.json +301 -0
- package/resources/locales/de/table.cmd.json +13 -2
- package/resources/locales/de/ui.msg.json +358 -2
- package/resources/locales/de/workbook.cmd.json +8 -1
- package/resources/locales/en/chart.cmd.json +82 -0
- package/resources/locales/en/movable.cmd.json +68 -0
- package/resources/locales/en/picture.cmd.json +188 -0
- package/resources/locales/en/pivot.cmd.json +79 -0
- package/resources/locales/en/shape.cmd.json +17 -0
- package/resources/locales/en/sheet.cmd.json +283 -17
- package/resources/locales/en/slicer.cmd.json +17 -0
- package/resources/locales/en/sparkline.cmd.json +301 -0
- package/resources/locales/en/table.cmd.json +13 -2
- package/resources/locales/en/ui.msg.json +360 -2
- package/resources/locales/en/workbook.cmd.json +8 -1
- package/types/chart.d.ts +2 -0
- package/types/control.d.ts +2 -0
- package/types/group.d.ts +2 -0
- package/types/note.d.ts +2 -0
- package/types/picture.d.ts +2 -0
- package/types/shape.d.ts +2 -0
- package/types/slicer.d.ts +2 -0
- package/types/src/annotation/RangeAnnotationLayer.d.ts +110 -0
- package/types/src/annotation/RangeAnnotationTag.d.ts +23 -0
- package/types/src/annotation/RangeAnnotations.d.ts +180 -0
- package/types/src/annotation/index.d.ts +4 -0
- package/types/src/autoFill/FillMenu.d.ts +2 -2
- package/types/src/autoFill/FillSeries.d.ts +2 -2
- package/types/src/border/StaticBorderRenderer.d.ts +18 -1
- package/types/src/border/useBorders.d.ts +95 -3
- package/types/src/cell/CellCheckboxRenderer.d.ts +20 -0
- package/types/src/cell/CellContent.d.ts +68 -0
- package/types/src/cell/CellControlContext.d.ts +37 -0
- package/types/src/cell/{FormulaCellRenderer.d.ts → CellFormulaRenderer.d.ts} +10 -7
- package/types/src/cell/CellImageRenderer.d.ts +11 -0
- package/types/src/cell/CellRenderers.d.ts +190 -0
- package/types/src/cell/{SheetCellRenderer.d.ts → CellTextRenderer.d.ts} +11 -8
- package/types/src/cell/ColumnButton.d.ts +3 -3
- package/types/src/cell/CornerTriangle.d.ts +2 -1
- package/types/src/cell/OutlineButton.d.ts +123 -0
- package/types/src/cell/PivotButton.d.ts +55 -0
- package/types/src/cell/SheetHeaderRenderer.d.ts +1 -1
- package/types/src/cell/StaticCellRenderer.d.ts +3 -3
- package/types/src/cell/_DropdownFace.d.ts +29 -0
- package/types/src/cell/index.d.ts +10 -2
- package/types/src/cell/useFormulaViewAnchor.d.ts +3 -3
- package/types/src/cell/useInsertableCellControls.d.ts +25 -0
- package/types/src/chart/ChartCommands.d.ts +15 -0
- package/types/src/chart/ChartEditor.d.ts +12 -2
- package/types/src/chart/ChartElement.d.ts +122 -0
- package/types/src/chart/ChartKind.d.ts +7 -0
- package/types/src/chart/PresetChartTypeDescriptors.d.ts +3 -1
- package/types/src/chart/index.d.ts +2 -1
- package/types/src/chart/paint/_fills.d.ts +24 -0
- package/types/src/chart/paint/_graphics.d.ts +38 -0
- package/types/src/chart/paint/_mode.d.ts +6 -0
- package/types/src/chart/paint/echarts.d.ts +33 -0
- package/types/src/chart/paint/index.d.ts +12 -0
- package/types/src/chart/paint/kinds/ChartPaintKind.d.ts +140 -0
- package/types/src/chart/paint/kinds/_Area.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Bar.d.ts +3 -0
- package/types/src/chart/paint/kinds/_BoxWhisker.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Bubble.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Funnel.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Histogram.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Line.d.ts +10 -0
- package/types/src/chart/paint/kinds/_OfPie.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Pie.d.ts +21 -0
- package/types/src/chart/paint/kinds/_Placeholder.d.ts +7 -0
- package/types/src/chart/paint/kinds/_Radar.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Scatter.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Sunburst.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Surface.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Treemap.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Waterfall.d.ts +3 -0
- package/types/src/chart/paint/kinds/_builtIns.d.ts +3 -0
- package/types/src/chart/paint/toEChartsOption.d.ts +42 -0
- package/types/src/checklist/ValueChecklist.d.ts +59 -18
- package/types/src/clipboard/ClipboardCommands.d.ts +3 -3
- package/types/src/clipboard/SheetClipboardLayer.d.ts +2 -2
- package/types/src/commands/ContextualToolbar.d.ts +19 -0
- package/types/src/commands/createTransactionalMiddleware.d.ts +4 -1
- package/types/src/commands/index.d.ts +1 -0
- package/types/src/comment/CommentCardRequest.d.ts +9 -9
- package/types/src/comment/index.d.ts +0 -1
- package/types/src/comment/useSheetComments.d.ts +2 -2
- package/types/src/conditionalFormat/ConditionalFormatPresets.d.ts +6 -6
- package/types/src/context/WorksheetContext.d.ts +18 -0
- package/types/src/context/index.d.ts +1 -1
- package/types/src/control/FormControlRenderers.d.ts +22 -0
- package/types/src/editableLabel/EditableLabel.d.ts +3 -1
- package/types/src/editor/EditorCommands.d.ts +3 -3
- package/types/src/editor/SheetCellEditorLayer.d.ts +2 -7
- package/types/src/editor/SheetCellEditorStartLayer.d.ts +22 -5
- package/types/src/editor/SheetCellInput.d.ts +14 -0
- package/types/src/editor/SheetEditable.d.ts +6 -6
- package/types/src/editor/SheetReferenceHeaderLayer.d.ts +1 -1
- package/types/src/editor/SheetReferenceLayer.d.ts +4 -4
- package/types/src/editor/VirtualKeyboardLayer.d.ts +50 -0
- package/types/src/editor/formulaAnchor.d.ts +12 -0
- package/types/src/editor/formulaPresentation.d.ts +4 -3
- package/types/src/editor/index.d.ts +2 -0
- package/types/src/editor/pickedReference.d.ts +3 -3
- package/types/src/editor/useEditRejectedNotice.d.ts +3 -3
- package/types/src/editor/useFormulaHints.d.ts +3 -3
- package/types/src/editor/useFormulaInput.d.ts +6 -3
- package/types/src/editor/validationAlert.d.ts +24 -0
- package/types/src/form/FormulaInput.d.ts +5 -2
- package/types/src/form/useEditCommit.d.ts +23 -3
- package/types/src/form/useInputField.d.ts +2 -3
- package/types/src/frame/CommandContext.d.ts +101 -3
- package/types/src/group/GroupEditor.d.ts +25 -0
- package/types/src/index.d.ts +10 -1
- package/types/src/layer/BorderLayer.d.ts +5 -2
- package/types/src/layer/CellErrorLayer.d.ts +18 -7
- package/types/src/layer/CellFillLayer.d.ts +2 -2
- package/types/src/layer/CellIndicatorLayer.d.ts +31 -0
- package/types/src/layer/CellInsertLayer.d.ts +71 -0
- package/types/src/layer/CircularIndicatorLayer.d.ts +3 -3
- package/types/src/layer/CommentCardLayer.d.ts +7 -9
- package/types/src/layer/CommentsLayer.d.ts +2 -2
- package/types/src/layer/ConditionalBarLayer.d.ts +2 -2
- package/types/src/layer/ConditionalIcons.d.ts +4 -4
- package/types/src/layer/ConditionalIconsLayer.d.ts +2 -2
- package/types/src/layer/ContextMenuLayer.d.ts +2 -2
- package/types/src/layer/FreezeDragLines.d.ts +17 -0
- package/types/src/layer/GridFreezeLayer.d.ts +11 -0
- package/types/src/layer/HeaderFreezeLayer.d.ts +12 -0
- package/types/src/layer/HeaderResizerLayer.d.ts +2 -1
- package/types/src/layer/HeaderSelectionLayer.d.ts +4 -4
- package/types/src/layer/HyperlinkLayer.d.ts +116 -0
- package/types/src/layer/MovableKindScope.d.ts +17 -0
- package/types/src/layer/PivotLayer.d.ts +47 -0
- package/types/src/layer/PivotToolbar.d.ts +29 -0
- package/types/src/layer/ProtectionLayer.d.ts +4 -5
- package/types/src/layer/RangeToolbar.d.ts +75 -0
- package/types/src/layer/ResizeIndicator.d.ts +11 -10
- package/types/src/layer/ResizeTooltip.d.ts +13 -0
- package/types/src/layer/SheetBackgroundLayer.d.ts +3 -3
- package/types/src/layer/SheetCellLayer.d.ts +15 -8
- package/types/src/layer/SheetColumnButtonLayer.d.ts +2 -2
- package/types/src/layer/SheetGridLineLayer.d.ts +25 -15
- package/types/src/layer/SheetHeaderCellLayer.d.ts +10 -1
- package/types/src/layer/SheetLayers.d.ts +171 -0
- package/types/src/layer/SheetMovableLayer.d.ts +4 -3
- package/types/src/layer/SheetOutlineLayer.d.ts +40 -0
- package/types/src/layer/SheetPivotCommandLayer.d.ts +13 -0
- package/types/src/layer/SheetSparklineCommandLayer.d.ts +14 -0
- package/types/src/layer/SheetTableCommandLayer.d.ts +2 -2
- package/types/src/layer/SparklineLayer.d.ts +32 -0
- package/types/src/layer/SpillLayer.d.ts +2 -2
- package/types/src/layer/TableLayer.d.ts +6 -5
- package/types/src/layer/TableToolbar.d.ts +23 -0
- package/types/src/layer/ValidationDropdownLayer.d.ts +2 -2
- package/types/src/layer/ValidationIndicatorLayer.d.ts +2 -2
- package/types/src/layer/ValidationPromptLayer.d.ts +47 -16
- package/types/src/layer/_sheetBorders.d.ts +6 -0
- package/types/src/layer/_tableColor.d.ts +6 -0
- package/types/src/layer/_visibleCellFeatures.d.ts +11 -0
- package/types/src/layer/cellTip.d.ts +13 -0
- package/types/src/layer/freezeDragState.d.ts +21 -0
- package/types/src/layer/index.d.ts +15 -0
- package/types/src/layer/resizeIndicatorState.d.ts +3 -1
- package/types/src/layer/useFreezeDrag.d.ts +22 -0
- package/types/src/layer/useNormalBorderLines.d.ts +15 -0
- package/types/src/layer/useSheetFeatureRegions.d.ts +2 -2
- package/types/src/layer/useSheetVisibleCells.d.ts +5 -6
- package/types/src/layer/useSheetVisibleDecorations.d.ts +2 -2
- package/types/src/layer/useTableHeaderCells.d.ts +2 -2
- package/types/src/layer/useValidationPicker.d.ts +3 -3
- package/types/src/layer/useVisibleTables.d.ts +2 -2
- package/types/src/layer/validationMark.d.ts +3 -3
- package/types/src/listener/index.d.ts +5 -0
- package/types/src/listener/useCell.d.ts +29 -0
- package/types/src/listener/useCellRange.d.ts +23 -0
- package/types/src/listener/useCellValue.d.ts +26 -0
- package/types/src/listener/useModelListener.d.ts +4 -4
- package/types/src/listener/useRangeListener.d.ts +13 -7
- package/types/src/listener/useRangeSnapshot.d.ts +35 -0
- package/types/src/listener/useTable.d.ts +26 -0
- package/types/src/movable/ConnectionSites.d.ts +18 -0
- package/types/src/movable/DefaultMovable.d.ts +8 -0
- package/types/src/movable/IMovableArea.d.ts +38 -0
- package/types/src/movable/MovableAdornment.d.ts +26 -0
- package/types/src/movable/MovableCommandGroups.d.ts +22 -0
- package/types/src/movable/MovableCommands.d.ts +8 -3
- package/types/src/movable/MovableControl.d.ts +80 -0
- package/types/src/movable/MovableFrame.d.ts +18 -16
- package/types/src/movable/MovableLayer.d.ts +30 -5
- package/types/src/movable/MovableRenderers.d.ts +210 -0
- package/types/src/movable/PlaceholderFrames.d.ts +11 -0
- package/types/src/movable/RotateHandle.d.ts +37 -0
- package/types/src/movable/connect.d.ts +16 -0
- package/types/src/movable/framePlacement.d.ts +72 -0
- package/types/src/movable/geometry.d.ts +61 -0
- package/types/src/movable/index.d.ts +9 -0
- package/types/src/movable/pressTarget.d.ts +20 -0
- package/types/src/movable/useFramePreview.d.ts +17 -0
- package/types/src/picker/cellPickerOpen.d.ts +3 -3
- package/types/src/picker/useCellPicker.d.ts +7 -5
- package/types/src/picture/PictureCommands.d.ts +20 -0
- package/types/src/picture/PictureKind.d.ts +7 -0
- package/types/src/picture/_pictureHyperlink.d.ts +13 -0
- package/types/src/picture/index.d.ts +0 -1
- package/types/src/picture/pictureCrop.d.ts +32 -0
- package/types/src/pivot/PivotAreas.d.ts +16 -0
- package/types/src/pivot/PivotChip.d.ts +33 -0
- package/types/src/pivot/PivotChipMenu.d.ts +74 -0
- package/types/src/pivot/PivotCommands.d.ts +24 -0
- package/types/src/pivot/PivotFieldList.d.ts +14 -0
- package/types/src/pivot/PivotFields.d.ts +47 -0
- package/types/src/pivot/PivotFieldsModel.d.ts +143 -0
- package/types/src/pivot/PivotTablePane.d.ts +47 -0
- package/types/src/pivot/_PivotFieldsContext.d.ts +41 -0
- package/types/src/pivot/_pivotNew.d.ts +12 -0
- package/types/src/pivot/_pivotRegion.d.ts +14 -0
- package/types/src/pivot/index.d.ts +9 -0
- package/types/src/pivot/usePivotFields.d.ts +17 -0
- package/types/src/presence/PresenceCommands.d.ts +35 -0
- package/types/src/presence/PresenceHost.d.ts +58 -0
- package/types/src/presence/PresenceMessages.d.ts +42 -0
- package/types/src/presence/PresenceStore.d.ts +165 -0
- package/types/src/presence/PresenceTypes.d.ts +78 -0
- package/types/src/presence/index.d.ts +7 -0
- package/types/src/presence/usePresence.d.ts +20 -0
- package/types/src/richText/RichTextEditor.d.ts +2 -2
- package/types/src/selection/SelectionCommands.d.ts +2 -2
- package/types/src/selection/SheetSelectionLayer.d.ts +6 -12
- package/types/src/shape/ConnectorControl.d.ts +46 -0
- package/types/src/shape/ShapeCommands.d.ts +11 -0
- package/types/src/shape/ShapeControl.d.ts +8 -0
- package/types/src/shape/ShapeEditor.d.ts +15 -2
- package/types/src/shape/ShapeGallery.d.ts +31 -0
- package/types/src/shape/ShapeHandles.d.ts +28 -0
- package/types/src/shape/ShapeKind.d.ts +7 -0
- package/types/src/shape/ShapeSVG.d.ts +22 -0
- package/types/src/shape/ShapeText.d.ts +17 -0
- package/types/src/shape/icons/ShapeIcons.d.ts +16 -0
- package/types/src/shape/icons/_ShapeIconPack.d.ts +4 -0
- package/types/src/shape/index.d.ts +3 -1
- package/types/src/shape/shapeFrame.d.ts +50 -0
- package/types/src/shape/shapeStyle.d.ts +82 -0
- package/types/src/sheet/ISheetHeaderElement.d.ts +3 -3
- package/types/src/sheet/IWorksheetElement.d.ts +289 -0
- package/types/src/sheet/OpaqueSheetElement.d.ts +21 -0
- package/types/src/sheet/SheetCommandProvider.d.ts +14 -6
- package/types/src/sheet/SheetCommands.d.ts +18 -3
- package/types/src/sheet/SheetKindIcon.d.ts +14 -0
- package/types/src/sheet/SheetOutlineElement.d.ts +70 -0
- package/types/src/sheet/SheetPanels.d.ts +11 -0
- package/types/src/sheet/SheetScrollbar.d.ts +4 -13
- package/types/src/sheet/TopLeftCorner.d.ts +2 -2
- package/types/src/sheet/WorksheetElement.d.ts +12 -0
- package/types/src/sheet/_freezeAt.d.ts +10 -0
- package/types/src/sheet/_hyperlinkEdit.d.ts +7 -0
- package/types/src/sheet/_useHeaderMetrics.d.ts +11 -0
- package/types/src/sheet/circularReferences.d.ts +4 -4
- package/types/src/sheet/index.d.ts +5 -2
- package/types/src/sheet/useCycleHighlight.d.ts +2 -2
- package/types/src/slicer/SlicerCommands.d.ts +10 -0
- package/types/src/slicer/SlicerEditor.d.ts +8 -2
- package/types/src/slicer/SlicerKind.d.ts +7 -0
- package/types/src/slicer/SlicerStylePreview.d.ts +18 -0
- package/types/src/slicer/index.d.ts +2 -1
- package/types/src/slicer/slicerStyles.d.ts +32 -0
- package/types/src/sparkline/PictureCache.d.ts +37 -0
- package/types/src/sparkline/SparklineCommands.d.ts +23 -0
- package/types/src/sparkline/SparklinePictures.d.ts +7 -0
- package/types/src/sparkline/paint/_drawing.d.ts +24 -0
- package/types/src/sparkline/paint/echarts.d.ts +8 -0
- package/types/src/sparkline/paint/index.d.ts +8 -0
- package/types/src/tabStrip/SheetTab.d.ts +1 -1
- package/types/src/tabStrip/Sortable.d.ts +5 -5
- package/types/src/tabStrip/TabStrip.d.ts +13 -6
- package/types/src/tabStrip/TabStripItem.d.ts +15 -13
- package/types/src/table/TableCommands.d.ts +2 -2
- package/types/src/taskPane/CellControlPane.d.ts +15 -0
- package/types/src/taskPane/MovablePane.d.ts +15 -0
- package/types/src/taskPane/TaskPaneArea.d.ts +7 -0
- package/types/src/taskPane/TaskPaneFrame.d.ts +4 -4
- package/types/src/taskPane/TaskPaneKeys.d.ts +38 -0
- package/types/src/taskPane/TaskPaneRegistry.d.ts +32 -12
- package/types/src/taskPane/_paneReasons.d.ts +7 -0
- package/types/src/taskPane/index.d.ts +3 -0
- package/types/src/taskPane/useTaskPane.d.ts +6 -3
- package/types/src/theme/ExplicitTokens.d.ts +18 -0
- package/types/src/theme/GridColorSchemeContext.d.ts +8 -0
- package/types/src/theme/ThemeRootStyles.d.ts +31 -0
- package/types/src/theme/ThemeState.d.ts +2 -2
- package/types/src/theme/buildDocThemeCSS.d.ts +4 -1
- package/types/src/theme/buildOOXMLThemeCSS.d.ts +2 -2
- package/types/src/theme/buildTokensCSS.d.ts +15 -0
- package/types/src/theme/index.d.ts +2 -4
- package/types/src/theme/useAppColorScheme.d.ts +4 -1
- package/types/src/theme/useGridColorScheme.d.ts +9 -4
- package/types/src/theme/useSystemColors.d.ts +1 -15
- package/types/src/workbook/DefaultMovableRenderers.d.ts +20 -0
- package/types/src/workbook/DefaultRenderers.d.ts +5 -4
- package/types/src/workbook/IWorkbookElement.d.ts +176 -30
- package/types/src/workbook/WorkbookCommands.d.ts +6 -1
- package/types/src/workbook/WorkbookStrip.d.ts +14 -5
- package/browser/cjs/Bo9Kx3L_XQkGPBJ5.cjs +0 -1
- package/browser/cjs/Pl04-kDEQSO8_qFU.cjs +0 -156
- package/browser/cjs/index.cjs +0 -42
- package/browser/esm/CwXbsCWTrl3QB1t6.mjs +0 -6286
- package/node/esm/CZc8rKcLzArmqJz2.mjs +0 -9
- package/types/src/chart/templates/area-stacked-percent-template.json.d.ts +0 -10
- package/types/src/chart/templates/area-stacked-template.json.d.ts +0 -10
- package/types/src/chart/templates/area-template.json.d.ts +0 -9
- package/types/src/chart/templates/bar-stacked-percent-template.json.d.ts +0 -10
- package/types/src/chart/templates/bar-stacked-template.json.d.ts +0 -10
- package/types/src/chart/templates/bar-template.json.d.ts +0 -9
- package/types/src/chart/templates/column-stacked-percent-template.json.d.ts +0 -10
- package/types/src/chart/templates/column-stacked-template.json.d.ts +0 -10
- package/types/src/chart/templates/column-template.json.d.ts +0 -9
- package/types/src/chart/templates/line-markers-template.json.d.ts +0 -10
- package/types/src/chart/templates/line-stacked-markers-template.json.d.ts +0 -11
- package/types/src/chart/templates/line-stacked-percent-markers-template.json.d.ts +0 -11
- package/types/src/chart/templates/line-stacked-percent-template.json.d.ts +0 -10
- package/types/src/chart/templates/line-stacked-template.json.d.ts +0 -10
- package/types/src/chart/templates/line-template.json.d.ts +0 -9
- package/types/src/chart/templates/pie-doughnut-template.json.d.ts +0 -10
- package/types/src/chart/templates/pie-template.json.d.ts +0 -9
- package/types/src/chart/templates/scatter-lines-markers-smooth-template.json.d.ts +0 -10
- package/types/src/chart/templates/scatter-lines-markers-template.json.d.ts +0 -10
- package/types/src/chart/templates/scatter-lines-smooth-template.json.d.ts +0 -10
- package/types/src/chart/templates/scatter-lines-template.json.d.ts +0 -10
- package/types/src/chart/templates/scatter-markers-template.json.d.ts +0 -10
- package/types/src/context/SheetContext.d.ts +0 -18
- package/types/src/movable/MoveableBundle.d.ts +0 -4
- package/types/src/sheet/ISheetElement.d.ts +0 -258
- package/types/src/sheet/SheetElement.d.ts +0 -15
|
@@ -0,0 +1,289 @@
|
|
|
1
|
+
import { IWorksheet, ICell, IMovable } from '@sheetxl/sdk';
|
|
2
|
+
import { ViewportMetrics, ScrollPaneProps, Viewport, ThemeMode, LoadingPanelProps, ErrorPanelProps, RenderSlotFn } from '@sheetxl/utils-react';
|
|
3
|
+
import { GridSurfaceProps, IGridSurface, IEditable, LayerNode } from '@sheetxl/grid-react';
|
|
4
|
+
import { CellTextRendererProps, ColumnButtonConfigProps, PivotButtonConfigProps, OutlineProps } from '../cell';
|
|
5
|
+
import { MovableElementProps } from '../movable';
|
|
6
|
+
import { CommentCardRenderProps } from '../comment';
|
|
7
|
+
import { HyperlinkCardRenderProps, HyperlinkLayerProps } from '../layer/HyperlinkLayer';
|
|
8
|
+
import { CellErrorTip } from '../layer/CellErrorLayer';
|
|
9
|
+
import { ValidationPromptRenderProps, ValidationAlertRenderProps } from '../layer/ValidationPromptLayer';
|
|
10
|
+
import { TableToolbarRenderProps } from '../layer/TableToolbar';
|
|
11
|
+
import { PivotToolbarRenderProps } from '../layer/PivotToolbar';
|
|
12
|
+
import { CommandContext } from '../frame';
|
|
13
|
+
import { ExplicitTokens } from '../theme';
|
|
14
|
+
import { ISheetHeaderElement, SheetHeaderProps } from './ISheetHeaderElement';
|
|
15
|
+
export interface SheetLocation {
|
|
16
|
+
clientX: number;
|
|
17
|
+
clientY: number;
|
|
18
|
+
originalEvent?: React.MouseEvent<Element>;
|
|
19
|
+
clientWidth?: number;
|
|
20
|
+
clientHeight?: number;
|
|
21
|
+
rowIndex?: number;
|
|
22
|
+
colIndex?: number;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Props for the WorksheetElement component.
|
|
26
|
+
*/
|
|
27
|
+
export interface WorksheetElementProps extends React.HTMLAttributes<HTMLDivElement>, React.Attributes {
|
|
28
|
+
/**
|
|
29
|
+
* The sheet to render, or a `Promise` for one. The element is empty until the sheet resolves and
|
|
30
|
+
* its text can be measured; a later input keeps the current sheet showing until it resolves.
|
|
31
|
+
*/
|
|
32
|
+
sheet: IWorksheet | Promise<IWorksheet>;
|
|
33
|
+
/**
|
|
34
|
+
* Called with the sheet once {@link WorksheetElementProps.sheet} resolves, and again whenever a new
|
|
35
|
+
* input resolves to a different one. Until the first input resolves, or if an input fails, the
|
|
36
|
+
* sheet is `null`.
|
|
37
|
+
*
|
|
38
|
+
* @remarks
|
|
39
|
+
* Lets an app pass a `Promise` here and hold the live sheet in its own state, without awaiting or
|
|
40
|
+
* suspending.
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```tsx
|
|
44
|
+
* const [pending] = useState(() => createInvoice());
|
|
45
|
+
* const [sheet, setSheet] = useState<IWorksheet | null>(null);
|
|
46
|
+
* const [total] = useCellValue<number>(sheet, 'D23');
|
|
47
|
+
* return <WorksheetElement sheet={pending} onSheetChange={setSheet} />;
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
onSheetChange?: (sheet: IWorksheet | null) => void;
|
|
51
|
+
/**
|
|
52
|
+
* Props passed to the loading panel.
|
|
53
|
+
*/
|
|
54
|
+
propsSheetLoading?: Partial<LoadingPanelProps>;
|
|
55
|
+
/**
|
|
56
|
+
* Custom loading panel, shown while a `Promise` {@link WorksheetElementProps.sheet} resolves or the
|
|
57
|
+
* text engine loads. Defaults to a spinner.
|
|
58
|
+
*/
|
|
59
|
+
renderSheetLoading?: RenderSlotFn<LoadingPanelProps> | null;
|
|
60
|
+
/**
|
|
61
|
+
* Custom error panel, shown when a `Promise` {@link WorksheetElementProps.sheet} fails to resolve.
|
|
62
|
+
* Defaults to a minimal message.
|
|
63
|
+
*/
|
|
64
|
+
renderSheetError?: RenderSlotFn<ErrorPanelProps> | null;
|
|
65
|
+
/**
|
|
66
|
+
* The app (chrome / header) color scheme — selects the header/app surface mode. `'auto'` follows the
|
|
67
|
+
* page: a `dark`/`light` class on `<html>`/`<body>`, else the OS.
|
|
68
|
+
*/
|
|
69
|
+
colorScheme?: ThemeMode | 'auto';
|
|
70
|
+
/**
|
|
71
|
+
* The grid-body color scheme (stays light in a dark app when *Enable Dark Grid* is off) — drives the grid
|
|
72
|
+
* `darkMode` rendering intent and the grid surface mode. `'auto'` follows the page as
|
|
73
|
+
* {@link colorScheme} does.
|
|
74
|
+
*/
|
|
75
|
+
gridColorScheme?: ThemeMode | 'auto';
|
|
76
|
+
/**
|
|
77
|
+
* Token values for this sheet, per mode and surface: the React form of a stylesheet in
|
|
78
|
+
* `@layer sxl-overrides`, scoped to this instance. Same shape as the workbook's `tokens`; inside a
|
|
79
|
+
* workbook, set them there instead.
|
|
80
|
+
*/
|
|
81
|
+
tokens?: ExplicitTokens;
|
|
82
|
+
/**
|
|
83
|
+
* Show the column headers
|
|
84
|
+
*/
|
|
85
|
+
showColumnHeaders?: boolean;
|
|
86
|
+
/**
|
|
87
|
+
* Show the row headers
|
|
88
|
+
*/
|
|
89
|
+
showRowHeaders?: boolean;
|
|
90
|
+
/**
|
|
91
|
+
* Show the scrollbars
|
|
92
|
+
*/
|
|
93
|
+
showScrollbars?: boolean;
|
|
94
|
+
/**
|
|
95
|
+
* Show hover tooltips on cells that carry calc errors / warnings.
|
|
96
|
+
*
|
|
97
|
+
* @defaultValue true
|
|
98
|
+
*/
|
|
99
|
+
showCellErrors?: boolean;
|
|
100
|
+
/**
|
|
101
|
+
* Mark the cells that are in a circular reference (a corner glyph on each cycle member).
|
|
102
|
+
*
|
|
103
|
+
* @remarks
|
|
104
|
+
* The value of such a cell stays `0`, as in Excel; the mark is metadata beside it. Cells that
|
|
105
|
+
* merely read a cycle are not marked — hover them for the tooltip.
|
|
106
|
+
*
|
|
107
|
+
* @defaultValue true
|
|
108
|
+
*/
|
|
109
|
+
showCircularReferences?: boolean;
|
|
110
|
+
/**
|
|
111
|
+
* Properties for the column headers
|
|
112
|
+
*/
|
|
113
|
+
propsColumnHeader?: Partial<SheetHeaderProps>;
|
|
114
|
+
/**
|
|
115
|
+
* Properties for the row headers
|
|
116
|
+
*/
|
|
117
|
+
propsRowHeader?: Partial<SheetHeaderProps>;
|
|
118
|
+
/**
|
|
119
|
+
* Allow for customizations of scrollbar
|
|
120
|
+
*/
|
|
121
|
+
propsScrollPane?: ScrollPaneProps;
|
|
122
|
+
/**
|
|
123
|
+
* Share a scroll {@link Viewport}. Pass one to own/drive the sheet's scroll externally —
|
|
124
|
+
* e.g. WorkbookElement creates it and also hands it to its ScrollPane so they share one store (no
|
|
125
|
+
* `Viewport`-data round-trip). The sheet drives the main grid from it and hands it to its headers
|
|
126
|
+
* (each composes its own per-axis follower). When omitted, the sheet creates its own.
|
|
127
|
+
*/
|
|
128
|
+
viewport?: Viewport;
|
|
129
|
+
/**
|
|
130
|
+
* Fired when the view port changes.
|
|
131
|
+
* This is in pixel coordinates and slightly different then viewable cells because off screen location bounds could change
|
|
132
|
+
*/
|
|
133
|
+
onViewportChange?: (view: ViewportMetrics) => void;
|
|
134
|
+
/**
|
|
135
|
+
* Fire when a contentMenu is requested
|
|
136
|
+
*/
|
|
137
|
+
onSheetContextMenu?: (location: SheetLocation) => void;
|
|
138
|
+
/**
|
|
139
|
+
* Fired when a right-button drag of the fill handle is released — Excel's fill menu. Show a menu
|
|
140
|
+
* at `location` whose entries run `menu` (see {@link CommandContext.FillMenu}). Omit to leave the
|
|
141
|
+
* right-drag inert.
|
|
142
|
+
*/
|
|
143
|
+
onFillMenu?: (location: SheetLocation, menu: CommandContext.FillMenu) => void;
|
|
144
|
+
/**
|
|
145
|
+
* Called once when the sheet has been loaded but before it is rendered.
|
|
146
|
+
*/
|
|
147
|
+
onFirstRender?: () => void;
|
|
148
|
+
/**
|
|
149
|
+
* The app-created editor for the always-mounted cell editor. When provided, the grid edits through
|
|
150
|
+
* this shared {@link IEditable}; pass the SAME instance to the formula bar for free two-way sync. A
|
|
151
|
+
* stable reference. If omitted, a standalone WorksheetElement makes its own.
|
|
152
|
+
*/
|
|
153
|
+
editable?: IEditable<() => ICell, string>;
|
|
154
|
+
/**
|
|
155
|
+
* Fixed component that is layered within the viewport.
|
|
156
|
+
*
|
|
157
|
+
* @remarks Useful for dialogs and items that you want to place relative to the grid.
|
|
158
|
+
*/
|
|
159
|
+
viewportComponent?: React.ReactNode;
|
|
160
|
+
/**
|
|
161
|
+
* Render a movable element (a chart, shape or picture).
|
|
162
|
+
*
|
|
163
|
+
* @param props - {@link MovableElementProps}
|
|
164
|
+
*/
|
|
165
|
+
renderMovable?: RenderSlotFn<MovableElementProps>;
|
|
166
|
+
/**
|
|
167
|
+
* Renders the card of a threaded comment beside its cell: on hover, on selection, and as a draft
|
|
168
|
+
* when a command asks for one. The default shows no card; the indicators are drawn either way.
|
|
169
|
+
*
|
|
170
|
+
* @param props - {@link CommentCardRenderProps}
|
|
171
|
+
*/
|
|
172
|
+
renderCommentCard?: RenderSlotFn<CommentCardRenderProps> | null;
|
|
173
|
+
/**
|
|
174
|
+
* Renders the card beside a hovered hyperlink cell: its address, copy, edit and remove. Omit for the
|
|
175
|
+
* plain default card; `null` for none.
|
|
176
|
+
*
|
|
177
|
+
* @param props - {@link HyperlinkCardRenderProps}
|
|
178
|
+
*/
|
|
179
|
+
renderHyperlinkCard?: RenderSlotFn<HyperlinkCardRenderProps> | null;
|
|
180
|
+
/** The hyperlink card's options — e.g. `preview` to show a picture of the linked page. */
|
|
181
|
+
propsHyperlink?: Omit<HyperlinkLayerProps, 'sheet' | 'renderCard'>;
|
|
182
|
+
/**
|
|
183
|
+
* Renders the tip beside a hovered cell that carries an error, a warning, a reference cycle or a
|
|
184
|
+
* failed validation. Omit for the plain default tip; `null` for none.
|
|
185
|
+
*
|
|
186
|
+
* @param tip - {@link CellErrorTip}
|
|
187
|
+
*/
|
|
188
|
+
renderCellErrorTip?: RenderSlotFn<CellErrorTip> | null;
|
|
189
|
+
/**
|
|
190
|
+
* Renders the input prompt of a data validation under the selected cell. Spread `floatProps` on
|
|
191
|
+
* the returned element. Omit for the plain default box: the title in bold over the message; `null`
|
|
192
|
+
* for none.
|
|
193
|
+
*/
|
|
194
|
+
renderValidationPrompt?: RenderSlotFn<ValidationPromptRenderProps> | null;
|
|
195
|
+
/**
|
|
196
|
+
* Renders the alert a refused or questioned entry raises in the prompt's place. Spread `floatProps`
|
|
197
|
+
* on the returned element. Omit for the plain default card; `null` for none.
|
|
198
|
+
*/
|
|
199
|
+
renderValidationAlert?: RenderSlotFn<ValidationAlertRenderProps> | null;
|
|
200
|
+
/**
|
|
201
|
+
* Renders the toolbar that floats at a hovered table's top-right corner: a quick action and a
|
|
202
|
+
* dropdown of the table's commands. Omit for the plain default split button; `null` for none.
|
|
203
|
+
*
|
|
204
|
+
* @param props - {@link TableToolbarRenderProps}
|
|
205
|
+
*/
|
|
206
|
+
renderTableToolbar?: RenderSlotFn<TableToolbarRenderProps> | null;
|
|
207
|
+
/**
|
|
208
|
+
* Renders the toolbar that floats at a hovered pivot table's top-right corner: a quick action and a
|
|
209
|
+
* dropdown of the pivot table's commands. Omit for the plain default split button; `null` for none.
|
|
210
|
+
*
|
|
211
|
+
* @param props - {@link PivotToolbarRenderProps}
|
|
212
|
+
*/
|
|
213
|
+
renderPivotToolbar?: RenderSlotFn<PivotToolbarRenderProps> | null;
|
|
214
|
+
/**
|
|
215
|
+
* Render element(s) directly onto the `GridSurface`, bottom → top — the same {@link LayerNode} the
|
|
216
|
+
* grid takes for its children (a node or an array of them). Each layer reads its pane from context
|
|
217
|
+
* ({@link useGridPane}); for a layer that must be built from the pane, call it in a small wrapper.
|
|
218
|
+
*/
|
|
219
|
+
layers?: LayerNode;
|
|
220
|
+
/**
|
|
221
|
+
* Customize the grid.
|
|
222
|
+
*
|
|
223
|
+
* @remarks
|
|
224
|
+
* Not all props are passed through.
|
|
225
|
+
*/
|
|
226
|
+
propsGrid?: GridSurfaceProps;
|
|
227
|
+
/**
|
|
228
|
+
* Allow for custom rendering of cell props.
|
|
229
|
+
*
|
|
230
|
+
* @remarks
|
|
231
|
+
* This is used to customize columnButton popup action and any other customizations desired.
|
|
232
|
+
* This does not invalidate the rendering
|
|
233
|
+
*/
|
|
234
|
+
propsCellRender?: Partial<CellTextRendererProps> & ColumnButtonConfigProps & PivotButtonConfigProps;
|
|
235
|
+
/**
|
|
236
|
+
* Props for the outline: the gutters that show row and column groups, and their level buttons.
|
|
237
|
+
*
|
|
238
|
+
* @remarks
|
|
239
|
+
* Omitted renderers fall back to plain, unstyled buttons.
|
|
240
|
+
*/
|
|
241
|
+
propsOutline?: OutlineProps;
|
|
242
|
+
/**
|
|
243
|
+
* Ref to the sheet element.
|
|
244
|
+
*/
|
|
245
|
+
ref?: React.Ref<IWorksheetElement>;
|
|
246
|
+
}
|
|
247
|
+
/**
|
|
248
|
+
* Attributes and methods available on the sheet element beyond the HTMLDivElement.
|
|
249
|
+
*/
|
|
250
|
+
export type IWorksheetAttributes = {
|
|
251
|
+
getGridSurface: () => IGridSurface;
|
|
252
|
+
getRowHeaderElement: () => ISheetHeaderElement;
|
|
253
|
+
getColumnHeaderElement: () => ISheetHeaderElement;
|
|
254
|
+
contains(element: Node | null): boolean;
|
|
255
|
+
invalidate: (coords?: ICell.Coords | null) => void;
|
|
256
|
+
/**
|
|
257
|
+
* Focus the sheet or the movable based on last focus.
|
|
258
|
+
*
|
|
259
|
+
* @param options
|
|
260
|
+
*/
|
|
261
|
+
focus(options?: FocusOptions): void;
|
|
262
|
+
/**
|
|
263
|
+
* Focus the sheet.
|
|
264
|
+
*/
|
|
265
|
+
focusSheet(options?: FocusOptions): void;
|
|
266
|
+
/**
|
|
267
|
+
* Focus a specific float.
|
|
268
|
+
* If not provided will focus the first selected float.
|
|
269
|
+
*
|
|
270
|
+
* @remarks
|
|
271
|
+
* The focusMovable does not scroll.
|
|
272
|
+
* TODO - have this honor GridPanes scroll options.
|
|
273
|
+
*/
|
|
274
|
+
focusMovable(movable?: IMovable): Promise<boolean>;
|
|
275
|
+
/**
|
|
276
|
+
* Returns the attached `IWorksheet`.
|
|
277
|
+
*/
|
|
278
|
+
getWorksheet: () => IWorksheet;
|
|
279
|
+
/**
|
|
280
|
+
* For runtime introspection.
|
|
281
|
+
*/
|
|
282
|
+
isSheetElement: () => true;
|
|
283
|
+
};
|
|
284
|
+
/**
|
|
285
|
+
* Type returned via ref property
|
|
286
|
+
*/
|
|
287
|
+
export interface IWorksheetElement extends HTMLDivElement, IWorksheetAttributes {
|
|
288
|
+
}
|
|
289
|
+
//# sourceMappingURL=IWorksheetElement.d.ts.map
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IOpaqueSheet } from '@sheetxl/sdk';
|
|
3
|
+
export interface OpaqueSheetElementProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
4
|
+
/**
|
|
5
|
+
* The sheet.
|
|
6
|
+
*/
|
|
7
|
+
sheet: IOpaqueSheet;
|
|
8
|
+
/**
|
|
9
|
+
* Called once the pane has rendered, as a worksheet's grid calls it once it has.
|
|
10
|
+
*/
|
|
11
|
+
onFirstRender?: () => void;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* The pane shown for a chart sheet, a macro sheet or a dialog sheet while it is the active tab.
|
|
15
|
+
*
|
|
16
|
+
* @remarks
|
|
17
|
+
* Such a sheet is carried as read and saved unchanged; this names its kind and says so. A chart
|
|
18
|
+
* sheet's chart is drawn here once chart sheets have their chart.
|
|
19
|
+
*/
|
|
20
|
+
export declare const OpaqueSheetElement: React.FC<OpaqueSheetElementProps>;
|
|
21
|
+
//# sourceMappingURL=OpaqueSheetElement.d.ts.map
|
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
import { ReactNode } from 'react';
|
|
2
|
-
import {
|
|
3
|
-
import { Command } from '@sheetxl/utils-react';
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
import { Command, IViewport } from '@sheetxl/utils-react';
|
|
4
4
|
import { SheetEditable } from '../editor';
|
|
5
5
|
import { SheetCommandData } from './SheetCommands';
|
|
6
6
|
/** The `data` bundle for the sheet contributor — the sheet-command data plus the shared editable (for the
|
|
7
7
|
* ready-mode `'startEdit'` insert commands). */
|
|
8
8
|
export interface SheetCommandContributorData extends SheetCommandData {
|
|
9
9
|
editable?: SheetEditable | null;
|
|
10
|
+
/** Set when the sheet owns `manager` (no workbook above publishes one): the sheet then also contributes
|
|
11
|
+
* `undo`/`redo`, which a workbook otherwise authors. */
|
|
12
|
+
ownsUndo?: boolean;
|
|
10
13
|
}
|
|
11
14
|
/**
|
|
12
15
|
* The `sheet` feature's command contributor: `static` seeds the catalog presentation; `dynamic` attaches the
|
|
@@ -16,12 +19,12 @@ export interface SheetCommandContributorData extends SheetCommandData {
|
|
|
16
19
|
export declare const SheetCommandContributor: Command.CommandContributor<SheetCommandContributorData>;
|
|
17
20
|
interface SheetCommandProviderProps {
|
|
18
21
|
/** The active sheet the cell/format commands operate on. */
|
|
19
|
-
sheet:
|
|
22
|
+
sheet: IWorksheet | null;
|
|
20
23
|
/** The shared cell editable — the **ready-mode** insert commands (`insertCurrent*`/`insertFunction*`) seed
|
|
21
24
|
* an edit through it. `undefined` on a bare grid ⇒ those commands stay chrome-only (disabled). */
|
|
22
25
|
editable?: SheetEditable | null;
|
|
23
|
-
/** Hand the created `sheet` scope back to the parent (see {@link CommandScopeProvider.scopeRef})
|
|
24
|
-
*
|
|
26
|
+
/** Hand the created `sheet` scope back to the parent (see {@link CommandScopeProvider.scopeRef}), for a
|
|
27
|
+
* host that executes sheet commands directly without a provide/consume wrapper split. */
|
|
25
28
|
scopeRef?: {
|
|
26
29
|
current: Command.CommandScope | null;
|
|
27
30
|
};
|
|
@@ -38,6 +41,11 @@ interface SheetCommandProviderProps {
|
|
|
38
41
|
elementRef?: {
|
|
39
42
|
readonly current: Element | null;
|
|
40
43
|
};
|
|
44
|
+
/**
|
|
45
|
+
* The sheet's scroll controller. Zoom to Selection fits the selection into its client size (the
|
|
46
|
+
* model has no viewport size). Omitted ⇒ that command is a no-op.
|
|
47
|
+
*/
|
|
48
|
+
viewport?: IViewport;
|
|
41
49
|
children: ReactNode;
|
|
42
50
|
}
|
|
43
51
|
/**
|
|
@@ -52,6 +60,6 @@ interface SheetCommandProviderProps {
|
|
|
52
60
|
* Only the grid consumes the `sheet` scope, so it lives here (inside the workbook) rather than at studio
|
|
53
61
|
* level. Without an ambient command scope (a bare chromeless grid), this is a pass-through.
|
|
54
62
|
*/
|
|
55
|
-
export declare const SheetCommandProvider: ({ sheet, editable, scopeRef, elementRef, children }: SheetCommandProviderProps) => ReactNode;
|
|
63
|
+
export declare const SheetCommandProvider: ({ sheet, editable, scopeRef, elementRef, viewport, children }: SheetCommandProviderProps) => ReactNode;
|
|
56
64
|
export {};
|
|
57
65
|
//# sourceMappingURL=SheetCommandProvider.d.ts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { EditModeHandler, ReferenceableClipboard, RemoveListener, UndoManager } from '@sheetxl/utils';
|
|
2
|
-
import { IBorders,
|
|
3
|
-
import { Command, IReactNotifier } from '@sheetxl/utils-react';
|
|
2
|
+
import { IBorders, IRange, IColor, IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
import { Command, IReactNotifier, IViewport } from '@sheetxl/utils-react';
|
|
4
4
|
import { ActivateFrameOptions, ITaskPaneArea } from '../taskPane';
|
|
5
5
|
/** Minimal shape of the global clipboard handle the insert-copied-cells path reads. */
|
|
6
6
|
interface GlobalClipboardLike {
|
|
@@ -33,13 +33,28 @@ export interface ContributeSheetCommandsOptions {
|
|
|
33
33
|
globalClipboard?: GlobalClipboardLike;
|
|
34
34
|
/** Persistent last-used values for the style pickers (color quick swatch + border) + memory. From the bridge's `usePersistentState`. */
|
|
35
35
|
pickerMemory?: PickerMemory;
|
|
36
|
+
/**
|
|
37
|
+
* The sheet's scroll controller — the cell area's client size, which Zoom to Selection fits the
|
|
38
|
+
* selection into. The model has no viewport size, so it cannot do this itself. Omitted ⇒ the command
|
|
39
|
+
* is a no-op (a bare grid).
|
|
40
|
+
*/
|
|
41
|
+
viewport?: IViewport;
|
|
36
42
|
}
|
|
37
43
|
/**
|
|
38
44
|
* The single `data` bundle {@link contributeSheetCommands} takes — the sheet **and** its services
|
|
39
45
|
* together (the `DynamicCommandContributor` shape). `sheet` may be `null` on a bare grid (⇒ no behavior).
|
|
40
46
|
*/
|
|
41
47
|
export interface SheetCommandData extends ContributeSheetCommandsOptions {
|
|
42
|
-
sheet:
|
|
48
|
+
sheet: IWorksheet | null;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* The arguments of the `freezePanesAt` command.
|
|
52
|
+
*/
|
|
53
|
+
export interface FreezePanesAtArgs {
|
|
54
|
+
/** The axis to move: `Column` moves the vertical freeze line, `Row` the horizontal one. */
|
|
55
|
+
axis: IRange.Axis;
|
|
56
|
+
/** The number of rows or columns to freeze. `0` unfreezes the axis; the other axis is left as it is. */
|
|
57
|
+
index: number;
|
|
43
58
|
}
|
|
44
59
|
/**
|
|
45
60
|
* Persistent "last used" values for the style pickers — the quick swatch (`quickColor`/`quickBorder`) and the
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ISheet } from '@sheetxl/sdk';
|
|
3
|
+
export interface SheetKindIconProps extends React.HTMLAttributes<HTMLElement> {
|
|
4
|
+
/**
|
|
5
|
+
* The kind of sheet.
|
|
6
|
+
*/
|
|
7
|
+
kind: ISheet.Kind;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* The glyph that marks a sheet of a kind other than a worksheet: on its tab, in sheet lists, and on
|
|
11
|
+
* its pane. A worksheet has none, so it renders nothing.
|
|
12
|
+
*/
|
|
13
|
+
export declare const SheetKindIcon: React.FC<SheetKindIconProps>;
|
|
14
|
+
//# sourceMappingURL=SheetKindIcon.d.ts.map
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { FixedEdge } from '@sheetxl/utils';
|
|
3
|
+
import { IRange, IWorksheet } from '@sheetxl/sdk';
|
|
4
|
+
import { Viewport, ThemeMode } from '@sheetxl/utils-react';
|
|
5
|
+
import { OutlineButtonProps, OutlineLevelButtonProps } from '../cell/OutlineButton';
|
|
6
|
+
export interface SheetOutlineElementProps extends React.HTMLAttributes<HTMLElement> {
|
|
7
|
+
/** The sheet whose outline is drawn. */
|
|
8
|
+
sheet: IWorksheet;
|
|
9
|
+
/** Rows (the gutter left of the row headers) or columns (above the column headers). */
|
|
10
|
+
axis: IRange.Axis;
|
|
11
|
+
/** The lanes across the gutter: one per level, plus one. */
|
|
12
|
+
lanes: number;
|
|
13
|
+
/** The gutter's thickness across the axis, in pixels. */
|
|
14
|
+
thickness: number;
|
|
15
|
+
/** The headers frozen at the start of the axis. */
|
|
16
|
+
freezeStart?: number | FixedEdge;
|
|
17
|
+
/** The sheet's main viewport; the gutter follows it along the axis. */
|
|
18
|
+
viewport?: Viewport;
|
|
19
|
+
/** The app color scheme. */
|
|
20
|
+
colorScheme?: ThemeMode;
|
|
21
|
+
/** Renders a group's collapse / expand button. Defaults to `OutlineButton`. */
|
|
22
|
+
renderButton?: ((props: OutlineButtonProps) => React.ReactNode) | null;
|
|
23
|
+
/** The space around the buttons, in pixels: between neighbors, before the first and after the last. */
|
|
24
|
+
laneGap?: number;
|
|
25
|
+
/** Space between a bracket's end and its button, in pixels. */
|
|
26
|
+
bracketGap?: number;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* The outline gutter for one axis: the brackets and collapse buttons of the row or column groups.
|
|
30
|
+
*
|
|
31
|
+
* @remarks
|
|
32
|
+
* Built like `SheetHeaderElement` — its own `GridSurface` over the header's offsets, following the
|
|
33
|
+
* sheet's viewport along the axis, so it scrolls, zooms, hides and freezes with the headers. The
|
|
34
|
+
* owner decides whether there is one (see `IWorksheetView.isShowOutlineSymbols` and `getLevelCount`) and sizes
|
|
35
|
+
* it.
|
|
36
|
+
*
|
|
37
|
+
* It is app chrome, not header: it declares the `app` surface and paints no fill, so it shows what
|
|
38
|
+
* the sheet sits on, as the level buttons beside it do.
|
|
39
|
+
*/
|
|
40
|
+
export declare const SheetOutlineElement: React.MemoExoticComponent<(props: SheetOutlineElementProps) => React.JSX.Element>;
|
|
41
|
+
export interface SheetOutlineLevelsProps extends React.HTMLAttributes<HTMLElement> {
|
|
42
|
+
/** The sheet whose outline the buttons show levels of. */
|
|
43
|
+
sheet: IWorksheet;
|
|
44
|
+
/** Rows or columns. */
|
|
45
|
+
axis: IRange.Axis;
|
|
46
|
+
/** The number of buttons: one per level, plus one. */
|
|
47
|
+
lanes: number;
|
|
48
|
+
/** The size of one lane, in pixels. */
|
|
49
|
+
laneSize: number;
|
|
50
|
+
/**
|
|
51
|
+
* The space around the buttons, in pixels: between neighbors, before the first and after the last.
|
|
52
|
+
*
|
|
53
|
+
* @defaultValue 1
|
|
54
|
+
*/
|
|
55
|
+
laneGap?: number;
|
|
56
|
+
/** The app color scheme. */
|
|
57
|
+
colorScheme?: ThemeMode;
|
|
58
|
+
/** Renders a level button. Defaults to `OutlineLevelButton`. */
|
|
59
|
+
renderLevelButton?: ((props: OutlineLevelButtonProps) => React.ReactNode) | null;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* The level buttons `1`..`n` for one axis: button *k* shows the groups above level *k* and collapses
|
|
63
|
+
* the rest (`IOutline.setVisibleLevels`).
|
|
64
|
+
*
|
|
65
|
+
* @remarks
|
|
66
|
+
* Row buttons run across the row gutter (beside the column headers); column buttons run down the
|
|
67
|
+
* column gutter (beside the row headers), one per lane.
|
|
68
|
+
*/
|
|
69
|
+
export declare const SheetOutlineLevels: React.MemoExoticComponent<(props: SheetOutlineLevelsProps) => React.JSX.Element>;
|
|
70
|
+
//# sourceMappingURL=SheetOutlineElement.d.ts.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ErrorPanelProps, LoadingPanelProps } from '@sheetxl/utils-react';
|
|
3
|
+
/**
|
|
4
|
+
* The default loading panel of a sheet or workbook element: a spinner, centered.
|
|
5
|
+
*/
|
|
6
|
+
export declare const defaultRenderSheetLoading: (props: LoadingPanelProps) => React.ReactElement;
|
|
7
|
+
/**
|
|
8
|
+
* The default error panel of a sheet or workbook element: the error's message, centered.
|
|
9
|
+
*/
|
|
10
|
+
export declare const defaultRenderSheetError: (props: ErrorPanelProps) => React.ReactElement;
|
|
11
|
+
//# sourceMappingURL=SheetPanels.d.ts.map
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
3
|
-
import { ScrollbarOrientation, VirtualScrollbarProps, IScrollbarElement
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
import { ScrollbarOrientation, VirtualScrollbarProps, IScrollbarElement } from '@sheetxl/utils-react';
|
|
4
4
|
export interface SheetScrollbarProps extends VirtualScrollbarProps {
|
|
5
5
|
/**
|
|
6
|
-
* The `
|
|
6
|
+
* The `IWorksheet` for the given scrollbar.
|
|
7
7
|
*/
|
|
8
|
-
sheet:
|
|
8
|
+
sheet: IWorksheet;
|
|
9
9
|
/**
|
|
10
10
|
* The direction of the scrollbar.
|
|
11
11
|
*/
|
|
@@ -14,15 +14,6 @@ export interface SheetScrollbarProps extends VirtualScrollbarProps {
|
|
|
14
14
|
* @defaultValue false
|
|
15
15
|
*/
|
|
16
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
17
|
}
|
|
27
18
|
export declare const SheetScrollbar: React.NamedExoticComponent<Omit<SheetScrollbarProps, "ref"> & React.RefAttributes<IScrollbarElement>>;
|
|
28
19
|
//# sourceMappingURL=SheetScrollbar.d.ts.map
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
3
|
import { ThemeMode } from '@sheetxl/utils-react';
|
|
4
4
|
export interface TopLeftCornerProps extends React.HTMLProps<HTMLElement> {
|
|
5
|
-
sheet:
|
|
5
|
+
sheet: IWorksheet;
|
|
6
6
|
/** The app (header) color scheme — headers follow the app surface; colors come from the header-surface
|
|
7
7
|
* tokens. */
|
|
8
8
|
colorScheme?: ThemeMode;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IWorksheetElement, WorksheetElementProps } from './IWorksheetElement';
|
|
3
|
+
/**
|
|
4
|
+
* UI representation for IWorksheet.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* It draws once the sheet has resolved and the text engine has loaded, so a sheet with no workbook
|
|
8
|
+
* needs no `whenReady()` first. Until then its box shows the loading panel, or the error panel if the
|
|
9
|
+
* sheet fails.
|
|
10
|
+
*/
|
|
11
|
+
export declare const WorksheetElement: React.NamedExoticComponent<Omit<WorksheetElementProps, "ref"> & React.RefAttributes<IWorksheetElement>>;
|
|
12
|
+
//# sourceMappingURL=WorksheetElement.d.ts.map
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { IWorksheetView, IRange } from '@sheetxl/sdk';
|
|
2
|
+
/**
|
|
3
|
+
* Move one axis's freeze to `index` (`0` unfreezes that axis), leaving the other axis as it is.
|
|
4
|
+
*
|
|
5
|
+
* Each frozen area keeps the start it already has; an axis that becomes frozen starts at the scrolled
|
|
6
|
+
* position. Either way what is on screen stays put — provided the scrolling area starts exactly at the
|
|
7
|
+
* current freeze, which is when the freeze grip allows a drag.
|
|
8
|
+
*/
|
|
9
|
+
export declare const freezeAt: (view: IWorksheetView, axis: IRange.Axis, index: number) => void;
|
|
10
|
+
//# sourceMappingURL=_freezeAt.d.ts.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
2
|
+
/**
|
|
3
|
+
* Whether the sheet's protection lets a hyperlink be added, changed or removed: the two options
|
|
4
|
+
* `ICellRange.setHyperlink` asks for.
|
|
5
|
+
*/
|
|
6
|
+
export declare const isHyperlinkEditAllowed: (sheet: IWorksheet) => boolean;
|
|
7
|
+
//# sourceMappingURL=_hyperlinkEdit.d.ts.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { ISheetHeader } from '@sheetxl/sdk';
|
|
2
|
+
/**
|
|
3
|
+
* The header's metrics as last announced: replaced on `onMetricsChange` (heard once the operation that
|
|
4
|
+
* changed them closes), not read fresh on every render. Everything that lays out from the returned
|
|
5
|
+
* metrics agrees, whatever re-renders in between.
|
|
6
|
+
*
|
|
7
|
+
* @returns The held metrics, and `refresh` to take the header's current metrics early — e.g. on each
|
|
8
|
+
* move of a resize drag, while its operation is still open.
|
|
9
|
+
*/
|
|
10
|
+
export declare const useHeaderMetrics: (header: ISheetHeader) => [ISheetHeader.IMetrics, () => void];
|
|
11
|
+
//# sourceMappingURL=_useHeaderMetrics.d.ts.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IRange,
|
|
1
|
+
import { IRange, IWorksheet } from '@sheetxl/sdk';
|
|
2
2
|
/**
|
|
3
3
|
* The cell a sheet's status bar names for its UNRESOLVED circular references — Excel's
|
|
4
4
|
* `Worksheet.CircularReference`, one cell — or `null` when the sheet has none.
|
|
@@ -13,11 +13,11 @@ import { IRange, ISheet } from '@sheetxl/sdk';
|
|
|
13
13
|
* makes a cycle a computation rather than a mistake, and its result is what the user turned the
|
|
14
14
|
* setting on for. Excel is the same and this is the measurement it comes from — its
|
|
15
15
|
* `Worksheet.CircularReference` answers `(none)` while iterating and names the cell again the
|
|
16
|
-
* moment `Iteration` is turned off
|
|
16
|
+
* moment `Iteration` is turned off. The cell keeps its marker either
|
|
17
17
|
* way, so an iterated cycle stays discoverable where it is; what goes quiet is the workbook-level
|
|
18
18
|
* alarm, which is the same line `ICell.getErrors()` draws (§7.3).
|
|
19
19
|
*/
|
|
20
|
-
export declare const findSheetCircularReference: (sheet:
|
|
20
|
+
export declare const findSheetCircularReference: (sheet: IWorksheet) => IRange.CellCoords | null;
|
|
21
21
|
/**
|
|
22
22
|
* A cell address the way a formula on `sheetName` would write it: bare on its own sheet
|
|
23
23
|
* (`A1`), sheet-qualified elsewhere (`'Other Sheet'!A1`).
|
|
@@ -30,5 +30,5 @@ export declare const formatCellAddress: (coords: IRange.CellCoords, sheetName: s
|
|
|
30
30
|
* The "go to" behind a circular tooltip's link and the status bar's readout. A `scope` this
|
|
31
31
|
* workbook does not know (a cycle member in a named formula's body) selects nothing.
|
|
32
32
|
*/
|
|
33
|
-
export declare const selectCell: (sheet:
|
|
33
|
+
export declare const selectCell: (sheet: IWorksheet, target: IRange.CellCoords) => Promise<unknown> | null;
|
|
34
34
|
//# sourceMappingURL=circularReferences.d.ts.map
|
|
@@ -1,5 +1,8 @@
|
|
|
1
|
-
export type * from './
|
|
2
|
-
export * from './
|
|
1
|
+
export type * from './IWorksheetElement';
|
|
2
|
+
export * from './WorksheetElement';
|
|
3
|
+
export * from './OpaqueSheetElement';
|
|
4
|
+
export * from './SheetPanels';
|
|
5
|
+
export * from './SheetKindIcon';
|
|
3
6
|
export * from './SheetScrollbar';
|
|
4
7
|
export * from './SheetCommands';
|
|
5
8
|
export * from './SheetCommandProvider';
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ICalculation,
|
|
1
|
+
import { ICalculation, IWorksheet } from '@sheetxl/sdk';
|
|
2
2
|
/**
|
|
3
3
|
* Outlines a reference cycle's MEMBERS on the grid for as long as the caller is mounted — the
|
|
4
4
|
* highlight behind a circular tooltip.
|
|
@@ -17,5 +17,5 @@ import { ICalculation, ISheet } from '@sheetxl/sdk';
|
|
|
17
17
|
* (the cleanup then finds someone else's state and leaves it alone, rather than clearing a live
|
|
18
18
|
* edit's references out from under it). A cycle with no live members publishes nothing.
|
|
19
19
|
*/
|
|
20
|
-
export declare const useCycleHighlight: (sheet:
|
|
20
|
+
export declare const useCycleHighlight: (sheet: IWorksheet | null, cycle: ICalculation.ICircularReference | null | undefined) => void;
|
|
21
21
|
//# sourceMappingURL=useCycleHighlight.d.ts.map
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { Command } from '@sheetxl/utils-react';
|
|
2
|
+
import { MovableKindCommandData } from '../movable';
|
|
3
|
+
/**
|
|
4
|
+
* The slicer kind's commands, for the active slicer. Chrome is the `slicer` catalog.
|
|
5
|
+
*
|
|
6
|
+
* `formatSlicerStyle` takes a style name; its state is the slicer's style, and its context hands a
|
|
7
|
+
* gallery the slicer and the workbook's styles to draw previews with.
|
|
8
|
+
*/
|
|
9
|
+
export declare const contributeSlicerCommands: Command.DynamicCommandContributor<MovableKindCommandData>;
|
|
10
|
+
//# sourceMappingURL=SlicerCommands.d.ts.map
|