@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
|
@@ -1,19 +1,20 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
import { LayerProps } from '@sheetxl/grid-react';
|
|
3
4
|
/**
|
|
4
5
|
* Props for {@link ResizeIndicator}.
|
|
5
6
|
*/
|
|
6
|
-
export interface ResizeIndicatorProps {
|
|
7
|
-
/** The sheet — for the
|
|
8
|
-
sheet:
|
|
7
|
+
export interface ResizeIndicatorProps extends Omit<LayerProps, 'children'> {
|
|
8
|
+
/** The sheet — for the entire-range extent. */
|
|
9
|
+
sheet: IWorksheet;
|
|
9
10
|
}
|
|
10
11
|
/**
|
|
11
12
|
* The **main-grid overlay** for an in-progress header resize: the before/after guide-lines that span the
|
|
12
|
-
* body
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
13
|
+
* body. It's a self-contained grid layer — it reads the gesture from `useSurfaceState` (published by
|
|
14
|
+
* {@link HeaderResizerLayer} in the header surface, shared via the sheet's `SurfaceStateProvider`) and the
|
|
15
|
+
* pane from context, so it mounts as a plain child of the grid with no render-prop bridge. Rendered once
|
|
16
|
+
* per pane; each pane draws its own clipped slice of the lines. The size tooltip belongs to the header
|
|
17
|
+
* ({@link ResizeTooltip}).
|
|
17
18
|
*/
|
|
18
|
-
export declare const ResizeIndicator: React.MemoExoticComponent<(props: ResizeIndicatorProps) => React.JSX.Element
|
|
19
|
+
export declare const ResizeIndicator: React.MemoExoticComponent<(props: ResizeIndicatorProps) => React.JSX.Element>;
|
|
19
20
|
//# sourceMappingURL=ResizeIndicator.d.ts.map
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { ISheetHeader } from '@sheetxl/sdk';
|
|
2
|
+
export interface ResizeTooltipProps {
|
|
3
|
+
/** The header being resized. */
|
|
4
|
+
sheetHeader: ISheetHeader;
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* The size tooltip of an in-progress header resize, anchored to the header being resized. Renders inside a
|
|
8
|
+
* header's layer: the header lays out every move of the drag, so the tooltip stays centered on the size
|
|
9
|
+
* being dragged. Reads the gesture published by {@link HeaderResizerLayer}. A {@link GestureTip}: it holds
|
|
10
|
+
* the tooltip group for the drag and self-gates to one owner pane.
|
|
11
|
+
*/
|
|
12
|
+
export declare const ResizeTooltip: import('react').MemoExoticComponent<(props: ResizeTooltipProps) => import("react").JSX.Element>;
|
|
13
|
+
//# sourceMappingURL=ResizeTooltip.d.ts.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
2
2
|
import { LayerProps } from '@sheetxl/grid-react';
|
|
3
3
|
export interface SheetBackgroundLayerProps extends LayerProps {
|
|
4
4
|
/** Class for the background box (devtools identification). */
|
|
@@ -6,7 +6,7 @@ export interface SheetBackgroundLayerProps extends LayerProps {
|
|
|
6
6
|
/** Style for the background box. */
|
|
7
7
|
style?: React.CSSProperties;
|
|
8
8
|
/** The sheet whose background picture (a tiled fill rendered behind the cells) is rendered. */
|
|
9
|
-
sheet:
|
|
9
|
+
sheet: IWorksheet;
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
12
|
* Renders the sheet's background.
|
|
@@ -16,7 +16,7 @@ export interface SheetBackgroundLayerProps extends LayerProps {
|
|
|
16
16
|
* through to the cells. The tile pattern is anchored to the sheet's A1 origin — the pane's screen
|
|
17
17
|
* position for cell `0,0` encodes the current scroll offset — so it scrolls with the content (one
|
|
18
18
|
* instance per pane). The caller adds this layer only when a picture is present (see
|
|
19
|
-
* `
|
|
19
|
+
* `IWorksheet.getPicture`) and places it FIRST, so it sits at the bottom of the z-stack.
|
|
20
20
|
*/
|
|
21
21
|
export declare const SheetBackgroundLayer: import('react').NamedExoticComponent<SheetBackgroundLayerProps & import('react').RefAttributes<HTMLDivElement>>;
|
|
22
22
|
//# sourceMappingURL=SheetBackgroundLayer.d.ts.map
|
|
@@ -1,16 +1,17 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet, IWorksheetView } from '@sheetxl/sdk';
|
|
3
3
|
import { CellRendererProps, IEditable, LayerProps } from '@sheetxl/grid-react';
|
|
4
|
-
import {
|
|
4
|
+
import { CellTextRendererProps, ColumnButtonConfigProps, PivotButtonConfigProps } from '../cell';
|
|
5
|
+
import { EditRejectedNotice } from '../editor/useEditRejectedNotice';
|
|
5
6
|
export interface SheetCellLayerProps extends LayerProps {
|
|
6
7
|
/** Class for the layer (devtools identification). */
|
|
7
8
|
className?: string;
|
|
8
9
|
/** The sheet whose cells are rendered. */
|
|
9
|
-
sheet:
|
|
10
|
+
sheet: IWorksheet;
|
|
10
11
|
/** The sheet view — drives show-zeros / show-formulas (which cells are worth rendering). */
|
|
11
|
-
sheetView:
|
|
12
|
+
sheetView: IWorksheetView;
|
|
12
13
|
/**
|
|
13
|
-
* Custom per-cell renderer. Default: {@link
|
|
14
|
+
* Custom per-cell renderer. Default: {@link CellTextRenderer} wired to the sheet (doc theme,
|
|
14
15
|
* hyperlink taps, formula-view flags) — the layer owns cell styling, so most hosts never pass this.
|
|
15
16
|
*/
|
|
16
17
|
renderCell?: (props: CellRendererProps) => React.ReactNode;
|
|
@@ -19,13 +20,19 @@ export interface SheetCellLayerProps extends LayerProps {
|
|
|
19
20
|
* column-button members ride along on the shared type but are consumed by
|
|
20
21
|
* `SheetColumnButtonLayer`, not here — they are stripped before the spread.
|
|
21
22
|
*/
|
|
22
|
-
propsCellRender?: Partial<
|
|
23
|
+
propsCellRender?: Partial<CellTextRendererProps> & ColumnButtonConfigProps & PivotButtonConfigProps;
|
|
23
24
|
/**
|
|
24
25
|
* The shared editable. Subscribed so the edited cell is suppressed while its editor is open —
|
|
25
26
|
* via the layer's live CSS channel (`suppressCell`), so no tile is ever invalidated by an edit
|
|
26
27
|
* start/stop and the grid above is never touched.
|
|
27
28
|
*/
|
|
28
29
|
editable: IEditable<any, any, any>;
|
|
30
|
+
/**
|
|
31
|
+
* Told when a cell control's write is refused, as a click on a checkbox in a locked cell is.
|
|
32
|
+
* Share the host's callback ({@link useEditRejectedNotice}) so every pane forms one notice scope.
|
|
33
|
+
* @defaultValue this layer's own {@link useEditRejectedNotice}
|
|
34
|
+
*/
|
|
35
|
+
onEditRejected?: EditRejectedNotice;
|
|
29
36
|
}
|
|
30
37
|
/**
|
|
31
38
|
* The sheet's cell layer.
|
|
@@ -39,9 +46,9 @@ export interface SheetCellLayerProps extends LayerProps {
|
|
|
39
46
|
* Beside the immutable tile snapshots ({@link CellTileDiv}) the layer owns the two LIVE per-cell
|
|
40
47
|
* concerns that must never touch a tile:
|
|
41
48
|
* - the edited cell is suppressed while its editor is open (live CSS `suppressCell` channel);
|
|
42
|
-
* - **formula view** ({@link
|
|
49
|
+
* - **formula view** ({@link IWorksheetView.isShowFormulas}): when the selection anchor sits on a
|
|
43
50
|
* formula cell, that cell's plain snapshot is suppressed through the SAME channel and a
|
|
44
|
-
* tokenized, syntax-colored {@link
|
|
51
|
+
* tokenized, syntax-colored {@link CellFormulaRenderer} overlay is drawn in its place — the
|
|
45
52
|
* references themselves are outlined by `SheetReferenceLayer`, both keyed off
|
|
46
53
|
* {@link useFormulaViewAnchor} so text and rectangles share colors.
|
|
47
54
|
*/
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
3
|
import { LayerProps } from '@sheetxl/grid-react';
|
|
4
4
|
import { ColumnButtonConfigProps } from '../cell/ColumnButton';
|
|
5
5
|
export interface SheetColumnButtonLayerProps extends LayerProps, ColumnButtonConfigProps {
|
|
6
6
|
/** The sheet whose table column (filter/sort) buttons are rendered. */
|
|
7
|
-
sheet:
|
|
7
|
+
sheet: IWorksheet;
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* The sheet's column (filter/sort) button layer — a {@link CellLayer} (which roots the {@link Layer})
|
|
@@ -1,22 +1,32 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
1
|
+
import { ICell, IRange, IWorksheet, IWorksheetView } from '@sheetxl/sdk';
|
|
2
|
+
import { IGridPane, LayerProps } from '@sheetxl/grid-react';
|
|
3
|
+
import { BordersCache } from '../border';
|
|
4
4
|
export interface SheetGridLineLayerProps extends LayerProps {
|
|
5
5
|
/** The sheet whose gridlines are rendered. */
|
|
6
|
-
sheet:
|
|
7
|
-
/** The sheet view — drives styling
|
|
8
|
-
sheetView:
|
|
6
|
+
sheet: IWorksheet;
|
|
7
|
+
/** The sheet view — drives styling and per-axis visibility. */
|
|
8
|
+
sheetView: IWorksheetView;
|
|
9
|
+
/**
|
|
10
|
+
* The cells in view, shared with the fill and border layers; their borders and their merges and
|
|
11
|
+
* overflow are what the lines break around.
|
|
12
|
+
*/
|
|
13
|
+
getVisibleCells: (pane: IGridPane) => {
|
|
14
|
+
cell: ICell.Coords;
|
|
15
|
+
value?: ICell;
|
|
16
|
+
range?: IRange.Coords;
|
|
17
|
+
}[];
|
|
18
|
+
/** Shared with the {@link BorderLayer} that draws the same cells. */
|
|
19
|
+
bordersCache?: BordersCache;
|
|
9
20
|
}
|
|
10
21
|
/**
|
|
11
|
-
* The sheet's gridline layer
|
|
22
|
+
* The sheet's gridline layer: the view's gridline wherever no cell border owns the edge, so a
|
|
23
|
+
* dashed or double border never has a gridline under it. Sits below the fills, so a filled cell
|
|
24
|
+
* hides it. An axis whose Normal style has a border draws that border instead, in the
|
|
25
|
+
* {@link BorderLayer} (it is a border on every cell, and draws above the fills).
|
|
12
26
|
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* (view) and derives them from the sheet's normal style and the view's gridline color / zoom / show flags —
|
|
17
|
-
* decoupled from the grid above it. The *merges* the lines break around are data, so it also self-subscribes
|
|
18
|
-
* to its pane's visible range via {@link useSheetVisibleCells} and re-renders itself on a data change (busting
|
|
19
|
-
* the underlying grid-react {@link GridlineLayer} with its own token). One per pane.
|
|
27
|
+
* Self-subscribes to `onStyleChange` and `onLayoutChange` (sheet) and `onZoomScaleChange` (view)
|
|
28
|
+
* for the styling, per-axis visibility, and the cells it breaks around, and to data changes in its
|
|
29
|
+
* pane's visible range. One per pane.
|
|
20
30
|
*/
|
|
21
|
-
export declare const SheetGridLineLayer:
|
|
31
|
+
export declare const SheetGridLineLayer: import('react').MemoExoticComponent<(props: SheetGridLineLayerProps) => import("react").JSX.Element | null>;
|
|
22
32
|
//# sourceMappingURL=SheetGridLineLayer.d.ts.map
|
|
@@ -8,6 +8,12 @@ export interface SheetHeaderCellLayerProps extends LayerProps {
|
|
|
8
8
|
header: ISheetHeader;
|
|
9
9
|
/** Per-header renderer (the sheet's `SheetHeaderRenderer` wrapping). */
|
|
10
10
|
renderCell: (props: CellRendererProps) => React.ReactNode;
|
|
11
|
+
/**
|
|
12
|
+
* A styling input the layer cannot watch itself: a new value busts the label cache. The header
|
|
13
|
+
* element passes its filtered runs' revision (a filter set or cleared may hide no row, so no
|
|
14
|
+
* size change repaints for it).
|
|
15
|
+
*/
|
|
16
|
+
invalidateToken?: unknown;
|
|
11
17
|
}
|
|
12
18
|
/**
|
|
13
19
|
* The header's cell layer.
|
|
@@ -17,9 +23,12 @@ export interface SheetHeaderCellLayerProps extends LayerProps {
|
|
|
17
23
|
* busting the underlying grid-react {@link CellLayer} with its own token — so it re-renders only itself,
|
|
18
24
|
* not the header grid. Two triggers bump the token:
|
|
19
25
|
*
|
|
20
|
-
* - **
|
|
26
|
+
* - **metrics change** (`onMetricsChange`) — alters what is visible/labeled;
|
|
21
27
|
* - **selection change** — header labels are styled by selection (fill / weight / color), but the tiled
|
|
22
28
|
* `CellLayer` cache survives scroll, so it must be dropped when *this header's* selected runs change.
|
|
29
|
+
*
|
|
30
|
+
* A third comes from the owner as `invalidateToken`: the rows a filter holds a condition over (the blue
|
|
31
|
+
* row numbers), which the header element reads and the layer cannot.
|
|
23
32
|
* Gated on the runs {@link selectedRunsSignature} so it busts only when the styling would differ (not
|
|
24
33
|
* on every active-cell move, and never on scroll — there is no per-frame range work).
|
|
25
34
|
*
|
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
/**
|
|
4
|
+
* A grid surface of a sheet: the cells, or one of the header strips. Each is its own grid, with its own
|
|
5
|
+
* layer stack.
|
|
6
|
+
*/
|
|
7
|
+
export type SheetSurface = 'cells' | 'rowHeaders' | 'columnHeaders';
|
|
8
|
+
/**
|
|
9
|
+
* Provides the {@link SheetSurface} a surface's layers are rendered on.
|
|
10
|
+
*
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
export declare const SheetSurfaceProvider: React.Provider<SheetSurface | null>;
|
|
14
|
+
/**
|
|
15
|
+
* The {@link SheetSurface} the calling layer is rendered on, or `null` outside a sheet's surfaces.
|
|
16
|
+
*
|
|
17
|
+
* @remarks
|
|
18
|
+
* Only a layer declared on more than one surface needs it, to render the part that belongs on each:
|
|
19
|
+
*
|
|
20
|
+
* ```tsx
|
|
21
|
+
* const surface = useGridSurface();
|
|
22
|
+
* if (surface === 'rowHeaders') return <MyButtons />;
|
|
23
|
+
* if (surface === 'cells') return <MyPreview />;
|
|
24
|
+
* return null;
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
export declare const useGridSurface: () => SheetSurface | null;
|
|
28
|
+
/**
|
|
29
|
+
* Which sheets a {@link SheetLayers} applies to: a sheet, sheets, or a test. Not names: a sheet can be
|
|
30
|
+
* renamed, and a name can be reused by another sheet.
|
|
31
|
+
*/
|
|
32
|
+
export type SheetLayersFilter = IWorksheet | readonly IWorksheet[] | ((sheet: IWorksheet) => boolean);
|
|
33
|
+
export interface SheetLayersProps {
|
|
34
|
+
/**
|
|
35
|
+
* The sheets whose surfaces get the layers. Omitted, every sheet's do.
|
|
36
|
+
*/
|
|
37
|
+
sheets?: SheetLayersFilter;
|
|
38
|
+
/**
|
|
39
|
+
* The surfaces the layers are rendered on. A layer on more than one reads which it is on with
|
|
40
|
+
* {@link useGridSurface}.
|
|
41
|
+
*
|
|
42
|
+
* @defaultValue 'cells'
|
|
43
|
+
*/
|
|
44
|
+
surface?: SheetSurface | readonly SheetSurface[] | 'all';
|
|
45
|
+
/**
|
|
46
|
+
* The layers: each a grid child rooted in a `Layer`, as in a sheet's `layers`.
|
|
47
|
+
*/
|
|
48
|
+
children?: React.ReactNode;
|
|
49
|
+
}
|
|
50
|
+
interface Entry {
|
|
51
|
+
sheets?: SheetLayersFilter;
|
|
52
|
+
surfaces: readonly SheetSurface[];
|
|
53
|
+
children: React.ReactNode;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* The {@link SheetLayers} declared under one scope, in declaration order.
|
|
57
|
+
*
|
|
58
|
+
* @internal
|
|
59
|
+
*/
|
|
60
|
+
export declare class SheetLayersRegistry {
|
|
61
|
+
private _entries;
|
|
62
|
+
private _listeners;
|
|
63
|
+
private _version;
|
|
64
|
+
set(id: string, entry: Entry): void;
|
|
65
|
+
delete(id: string): void;
|
|
66
|
+
get(id: string): Entry | undefined;
|
|
67
|
+
subscribe: (listener: () => void) => (() => void);
|
|
68
|
+
getVersion: () => number;
|
|
69
|
+
entries(): IterableIterator<[string, Entry]>;
|
|
70
|
+
private _changed;
|
|
71
|
+
}
|
|
72
|
+
/** Layers a plugin adds to sheets, through {@link DefaultSheetLayersRegistry}. */
|
|
73
|
+
export interface SheetLayersEntry {
|
|
74
|
+
/** Identifies the entry, for {@link ISheetLayersRegistry.unregister}. Case-insensitive. */
|
|
75
|
+
key: string;
|
|
76
|
+
/**
|
|
77
|
+
* The layers: one grid child or an array of them, each rooted in a `Layer` and each with its own
|
|
78
|
+
* `key`, as in a sheet's `layers`.
|
|
79
|
+
*/
|
|
80
|
+
layers: React.ReactNode;
|
|
81
|
+
/** The sheets whose surfaces get the layers. Omitted, every sheet's do. */
|
|
82
|
+
sheets?: SheetLayersFilter;
|
|
83
|
+
/**
|
|
84
|
+
* The surfaces the layers are rendered on. A layer on more than one reads which it is on with
|
|
85
|
+
* {@link useGridSurface}.
|
|
86
|
+
*
|
|
87
|
+
* @defaultValue 'cells'
|
|
88
|
+
*/
|
|
89
|
+
surface?: SheetSurface | readonly SheetSurface[] | 'all';
|
|
90
|
+
}
|
|
91
|
+
/** Adds layers to every sheet of every workbook element. */
|
|
92
|
+
export interface ISheetLayersRegistry {
|
|
93
|
+
/**
|
|
94
|
+
* Add layers to every sheet surface the entry names, for as long as it is registered.
|
|
95
|
+
*
|
|
96
|
+
* @param entry The layers, and where they go.
|
|
97
|
+
* @param replace Whether to replace an entry with the same key. Without it, a second entry with the
|
|
98
|
+
* same key throws. @defaultValue false
|
|
99
|
+
* @returns A function that removes this registration. It does nothing once the key is unregistered
|
|
100
|
+
* or registered again by someone else.
|
|
101
|
+
*/
|
|
102
|
+
register(entry: SheetLayersEntry, replace?: boolean): () => void;
|
|
103
|
+
/**
|
|
104
|
+
* Remove an entry's layers from every sheet.
|
|
105
|
+
*
|
|
106
|
+
* @param key The entry's key.
|
|
107
|
+
* @returns Whether the entry was registered.
|
|
108
|
+
*/
|
|
109
|
+
unregister(key: string): boolean;
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* The layers plugins add to sheets. Every sheet surface, in every workbook or sheet element, renders
|
|
113
|
+
* the registered layers that match it:
|
|
114
|
+
*
|
|
115
|
+
* ```tsx
|
|
116
|
+
* DefaultSheetLayersRegistry.register({ key: 'focus-cell', layers: <FocusCellLayer key="focus-cell" /> });
|
|
117
|
+
* ```
|
|
118
|
+
*
|
|
119
|
+
* @remarks
|
|
120
|
+
* A surface stacks its built-in layers, then the element's `layers`, then the registered layers in
|
|
121
|
+
* registration order, then those declared with {@link SheetLayers}. A layer's `zIndex` overrides that
|
|
122
|
+
* order. A registered layer is mounted on every sheet it matches, on each pane, so it renders an empty
|
|
123
|
+
* `Layer` while it has nothing to show.
|
|
124
|
+
*/
|
|
125
|
+
export declare const DefaultSheetLayersRegistry: ISheetLayersRegistry;
|
|
126
|
+
/**
|
|
127
|
+
* The registry the {@link SheetLayers} under an element register with: the one of a scope above it, or
|
|
128
|
+
* its own. A workbook element resolves one around both its children and its sheet, and the sheet
|
|
129
|
+
* element inherits it; a standalone sheet element has its own. Provide it with
|
|
130
|
+
* {@link SheetLayersScope}.
|
|
131
|
+
*
|
|
132
|
+
* @internal
|
|
133
|
+
*/
|
|
134
|
+
export declare const useSheetLayersRegistry: () => SheetLayersRegistry;
|
|
135
|
+
/**
|
|
136
|
+
* Provides a {@link SheetLayersRegistry} to the {@link SheetLayers} and surfaces under it.
|
|
137
|
+
*
|
|
138
|
+
* @internal
|
|
139
|
+
*/
|
|
140
|
+
export declare const SheetLayersScope: React.Provider<SheetLayersRegistry | null>;
|
|
141
|
+
/**
|
|
142
|
+
* Declares layers for a sheet's surfaces, as children of a sheet (or workbook) element:
|
|
143
|
+
*
|
|
144
|
+
* ```tsx
|
|
145
|
+
* <WorksheetElement sheet={sheet}>
|
|
146
|
+
* <SheetLayers surface={['rowHeaders', 'cells']}>
|
|
147
|
+
* <CellInsertLayer />
|
|
148
|
+
* </SheetLayers>
|
|
149
|
+
* </WorksheetElement>
|
|
150
|
+
* ```
|
|
151
|
+
*
|
|
152
|
+
* @remarks
|
|
153
|
+
* It renders nothing where it is declared: each matching surface renders the layers as its own, on top
|
|
154
|
+
* of its built-in ones, so they read that surface's pane, sheet and state. A layer declared on several
|
|
155
|
+
* surfaces is mounted on each (and on each pane of a frozen sheet); its copies share state through
|
|
156
|
+
* `useSurfaceState`, which spans all of a sheet's surfaces.
|
|
157
|
+
*
|
|
158
|
+
* Layers of separate `SheetLayers` stack in declaration order, unless a layer sets `zIndex`.
|
|
159
|
+
*/
|
|
160
|
+
export declare const SheetLayers: React.FC<SheetLayersProps>;
|
|
161
|
+
/**
|
|
162
|
+
* The layers added to one surface of a sheet, flattened into one list of grid children: those
|
|
163
|
+
* registered with {@link DefaultSheetLayersRegistry}, then those declared with {@link SheetLayers}.
|
|
164
|
+
*
|
|
165
|
+
* @internal
|
|
166
|
+
*/
|
|
167
|
+
export declare const useSheetLayers: (sheet: IWorksheet | null | undefined, surface: SheetSurface,
|
|
168
|
+
/** The registry, when the caller provides it rather than sits under it. */
|
|
169
|
+
propRegistry?: SheetLayersRegistry) => React.ReactNode[];
|
|
170
|
+
export {};
|
|
171
|
+
//# sourceMappingURL=SheetLayers.d.ts.map
|
|
@@ -1,18 +1,19 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
3
|
import { LayerProps } from '@sheetxl/grid-react';
|
|
4
|
+
import { RenderSlotFn } from '@sheetxl/utils-react';
|
|
4
5
|
import { IMovableLayerElement, MovableLayerProps, MovableElementProps } from '../movable';
|
|
5
6
|
export interface SheetMovableLayerProps extends LayerProps {
|
|
6
7
|
/** Class forwarded to the inner layer's host box (devtools identification). */
|
|
7
8
|
className?: string;
|
|
8
|
-
sheet:
|
|
9
|
+
sheet: IWorksheet;
|
|
9
10
|
/**
|
|
10
11
|
* Render a movable element
|
|
11
12
|
*
|
|
12
13
|
* @param props The props for the movable element
|
|
13
14
|
* @returns The rendered movable element
|
|
14
15
|
*/
|
|
15
|
-
renderMovable:
|
|
16
|
+
renderMovable: RenderSlotFn<MovableElementProps>;
|
|
16
17
|
/**
|
|
17
18
|
* Props to pass to MovableLayer
|
|
18
19
|
*/
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IRange, IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
import { LayerProps } from '@sheetxl/grid-react';
|
|
4
|
+
import { OutlineButtonProps } from '../cell/OutlineButton';
|
|
5
|
+
export interface SheetOutlineLayerProps extends LayerProps {
|
|
6
|
+
/** The sheet whose outline is drawn. */
|
|
7
|
+
sheet: IWorksheet;
|
|
8
|
+
/** Rows or columns. */
|
|
9
|
+
axis: IRange.Axis;
|
|
10
|
+
/** The lanes across the gutter: one per level, plus one. */
|
|
11
|
+
lanes: number;
|
|
12
|
+
/** Renders a group's collapse / expand button. Defaults to `OutlineButton`. */
|
|
13
|
+
renderButton?: ((props: OutlineButtonProps) => React.ReactNode) | null;
|
|
14
|
+
/**
|
|
15
|
+
* The space around the buttons, in pixels: between neighbors, before the first and after the last.
|
|
16
|
+
*
|
|
17
|
+
* @defaultValue 1
|
|
18
|
+
*/
|
|
19
|
+
laneGap?: number;
|
|
20
|
+
/**
|
|
21
|
+
* Space between a bracket's end and its button, in pixels.
|
|
22
|
+
*
|
|
23
|
+
* @defaultValue 0
|
|
24
|
+
*/
|
|
25
|
+
bracketGap?: number;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* The outline gutter's layer: for each group in view, a bracket beside its details and a button on
|
|
29
|
+
* its summary that collapses or expands it; and beside each detail header a dot, as Excel draws.
|
|
30
|
+
*
|
|
31
|
+
* @remarks
|
|
32
|
+
* Lane `level - 1` holds the groups of that level, outermost nearest the sheet edge. Groups come from
|
|
33
|
+
* {@link IOutline.getGroups} limited to the pane's visible span, so the work is per group in view. A
|
|
34
|
+
* collapsed group draws only its button. The dots are the gutter's cells: a {@link CellTileDiv} in
|
|
35
|
+
* this layer renders one per header the tiling engine finds in view, and a header at level `n` gets
|
|
36
|
+
* its dot in lane `n`, the lane after its deepest bracket, so a dot never sits on a line.
|
|
37
|
+
* Re-renders on scroll (the pane context) and on `onOutlineChange`.
|
|
38
|
+
*/
|
|
39
|
+
export declare const SheetOutlineLayer: React.MemoExoticComponent<(props: SheetOutlineLayerProps) => React.JSX.Element>;
|
|
40
|
+
//# sourceMappingURL=SheetOutlineLayer.d.ts.map
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { ReactElement } from 'react';
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
import { LayerProps } from '@sheetxl/grid-react';
|
|
4
|
+
export interface SheetPivotCommandLayerProps extends LayerProps {
|
|
5
|
+
sheet: IWorksheet;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* **Command-only layer for the `pivot` scope**: no visuals; it joins the pane's z-chain to contribute
|
|
9
|
+
* the {@link contributePivotCommands pivot table operations} while the selection is in a pivot
|
|
10
|
+
* table, as {@link SheetTableCommandLayer} does for tables.
|
|
11
|
+
*/
|
|
12
|
+
export declare const SheetPivotCommandLayer: import('react').MemoExoticComponent<(props: SheetPivotCommandLayerProps) => ReactElement>;
|
|
13
|
+
//# sourceMappingURL=SheetPivotCommandLayer.d.ts.map
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { ReactElement } from 'react';
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
import { LayerProps } from '@sheetxl/grid-react';
|
|
4
|
+
export interface SheetSparklineCommandLayerProps extends LayerProps {
|
|
5
|
+
sheet: IWorksheet;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* **Command-only layer for the `sparkline` scope**: no visuals (the pictures are
|
|
9
|
+
* `SparklineLayer`'s); it joins the pane's z-chain to contribute
|
|
10
|
+
* {@link contributeSparklineCommands Excel's Sparkline tab} while the active cell has a sparkline,
|
|
11
|
+
* as `SheetTableCommandLayer` does for tables.
|
|
12
|
+
*/
|
|
13
|
+
export declare const SheetSparklineCommandLayer: import('react').MemoExoticComponent<(props: SheetSparklineCommandLayerProps) => ReactElement>;
|
|
14
|
+
//# sourceMappingURL=SheetSparklineCommandLayer.d.ts.map
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ReactElement } from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
3
|
import { LayerProps } from '@sheetxl/grid-react';
|
|
4
4
|
export interface SheetTableCommandLayerProps extends LayerProps {
|
|
5
|
-
sheet:
|
|
5
|
+
sheet: IWorksheet;
|
|
6
6
|
}
|
|
7
7
|
/**
|
|
8
8
|
* **Command-only layer for the `table` scope** — no visuals (the visual chrome lives in {@link TableLayer});
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
import { LayerProps } from '@sheetxl/grid-react';
|
|
4
|
+
export interface SparklineLayerProps extends LayerProps {
|
|
5
|
+
/** Class for the layer (devtools identification). */
|
|
6
|
+
className?: string;
|
|
7
|
+
/** Style for the tiles' host box. */
|
|
8
|
+
style?: React.CSSProperties;
|
|
9
|
+
/** The sheet whose sparklines are drawn. */
|
|
10
|
+
sheet: IWorksheet;
|
|
11
|
+
/**
|
|
12
|
+
* Whether the grid is dark: the pictures' colors are drawn as the cells draw theirs there.
|
|
13
|
+
*
|
|
14
|
+
* @defaultValue false
|
|
15
|
+
*/
|
|
16
|
+
darkMode?: boolean;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* The sheet's **sparklines**: each group's picture in each of its cells (DESIGN-SPARKLINES §3).
|
|
20
|
+
*
|
|
21
|
+
* @remarks
|
|
22
|
+
* A layer of its own, not a cell content renderer: a sparkline's cell is usually empty, and the
|
|
23
|
+
* cell layer visits only cells with content. It mounts above the cells, as Excel draws the picture
|
|
24
|
+
* over the cell's value, and takes no pointer events.
|
|
25
|
+
*
|
|
26
|
+
* The tiles hold one view per visible sparkline and are rebuilt only when the groups change (one
|
|
27
|
+
* added, removed, or moved). A value the picture reads changing is the view's own business: it
|
|
28
|
+
* listens to its group's `onLayoutChange` and asks for a new picture, so an edit repaints the
|
|
29
|
+
* pictures without rebuilding a tile.
|
|
30
|
+
*/
|
|
31
|
+
export declare const SparklineLayer: React.MemoExoticComponent<(props: SparklineLayerProps) => React.JSX.Element | null>;
|
|
32
|
+
//# sourceMappingURL=SparklineLayer.d.ts.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
3
|
import { LayerProps } from '@sheetxl/grid-react';
|
|
4
4
|
export interface SpillLayerProps extends LayerProps {
|
|
5
5
|
/** Style for the outline box. */
|
|
@@ -7,7 +7,7 @@ export interface SpillLayerProps extends LayerProps {
|
|
|
7
7
|
/**
|
|
8
8
|
* The sheet.
|
|
9
9
|
*/
|
|
10
|
-
sheet:
|
|
10
|
+
sheet: IWorksheet;
|
|
11
11
|
/**
|
|
12
12
|
* The animation time in milliseconds.
|
|
13
13
|
*
|
|
@@ -1,16 +1,17 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
3
|
import { LayerProps } from '@sheetxl/grid-react';
|
|
4
|
+
import { TableToolbarRenderProps } from './TableToolbar';
|
|
4
5
|
export interface TableLayerProps extends LayerProps {
|
|
5
6
|
/**
|
|
6
7
|
* The sheet.
|
|
7
8
|
*/
|
|
8
|
-
sheet:
|
|
9
|
+
sheet: IWorksheet;
|
|
9
10
|
/**
|
|
10
|
-
*
|
|
11
|
-
* button
|
|
11
|
+
* The toolbar that floats at a hovered table's top-right corner.
|
|
12
|
+
* @defaultValue a plain split button: edit the table · a menu of the table commands
|
|
12
13
|
*/
|
|
13
|
-
|
|
14
|
+
renderToolbar?: ((props: TableToolbarRenderProps) => React.ReactNode) | null;
|
|
14
15
|
}
|
|
15
16
|
/**
|
|
16
17
|
* Is the outline, resizer, and row selection.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IWorksheet, ITable } from '@sheetxl/sdk';
|
|
3
|
+
import { RangeToolbarRenderProps } from './RangeToolbar';
|
|
4
|
+
/** What the table toolbar is handed. */
|
|
5
|
+
export interface TableToolbarRenderProps extends RangeToolbarRenderProps {
|
|
6
|
+
/** The hovered table. A press anywhere on the toolbar makes it the current table first, so the table commands act on it. */
|
|
7
|
+
table: ITable;
|
|
8
|
+
}
|
|
9
|
+
/** What {@link TableLayer} hands its toolbar float. */
|
|
10
|
+
export interface TableToolbarFloatProps {
|
|
11
|
+
sheet: IWorksheet;
|
|
12
|
+
/** The table under the pointer, as the table layer's hover found it. */
|
|
13
|
+
hovered: ITable | null;
|
|
14
|
+
renderToolbar?: ((props: TableToolbarRenderProps) => React.ReactNode) | null;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* The **table toolbar**: hover a table and its commands float at its top-right corner, a quick action
|
|
18
|
+
* (edit the table) and a dropdown of the rest. A {@link RangeToolbarFloat} inside the table layer, fed
|
|
19
|
+
* the table the layer's own hover found. What it draws is the host's (`renderToolbar`); its commands
|
|
20
|
+
* resolve from the pane like any other.
|
|
21
|
+
*/
|
|
22
|
+
export declare const TableToolbarFloat: React.FC<TableToolbarFloatProps>;
|
|
23
|
+
//# sourceMappingURL=TableToolbar.d.ts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
2
|
import { CellCoords } from '@sheetxl/utils';
|
|
3
|
-
import {
|
|
3
|
+
import { IWorksheet, IDataValidation, IRange } from '@sheetxl/sdk';
|
|
4
4
|
import { IEditable, LayerProps } from '@sheetxl/grid-react';
|
|
5
5
|
/** What the probe hands the button: the validations to offer, and the cell they belong to. */
|
|
6
6
|
export interface ValidationDropdown {
|
|
@@ -22,7 +22,7 @@ export interface ValidationDropdownLayerProps extends Omit<LayerProps, 'children
|
|
|
22
22
|
/** Style for the floated button container. */
|
|
23
23
|
style?: React.CSSProperties;
|
|
24
24
|
/** The sheet whose selection is followed. */
|
|
25
|
-
sheet:
|
|
25
|
+
sheet: IWorksheet;
|
|
26
26
|
/**
|
|
27
27
|
* The editable a pick is entered through — the sheet's shared one, so a pick is a typed entry:
|
|
28
28
|
* coerced, formatted and checked as one. Without it the button opens nothing.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
3
|
import { LayerProps } from '@sheetxl/grid-react';
|
|
4
4
|
export interface ValidationIndicatorLayerProps extends LayerProps {
|
|
5
5
|
/** Class for the layer (devtools identification). */
|
|
@@ -7,7 +7,7 @@ export interface ValidationIndicatorLayerProps extends LayerProps {
|
|
|
7
7
|
/** Style for the indicators host box. */
|
|
8
8
|
style?: React.CSSProperties;
|
|
9
9
|
/** The sheet whose data validations are indicated. */
|
|
10
|
-
sheet:
|
|
10
|
+
sheet: IWorksheet;
|
|
11
11
|
/** Size (px, unzoomed) of the invalid-value corner mark. @defaultValue 7 */
|
|
12
12
|
markSize?: number;
|
|
13
13
|
}
|