@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,71 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ICellRange, IRange } from '@sheetxl/sdk';
|
|
3
|
+
import { LayerProps } from '@sheetxl/grid-react';
|
|
4
|
+
/** Props for the button that inserts a row or column. */
|
|
5
|
+
export interface CellInsertButtonProps extends React.ButtonHTMLAttributes<HTMLElement> {
|
|
6
|
+
/** Rows or columns. */
|
|
7
|
+
axis: IRange.Axis;
|
|
8
|
+
/** The cells a press inserts. */
|
|
9
|
+
range: ICellRange;
|
|
10
|
+
/** The edge of the square the button fills, in pixels (zoom applied). */
|
|
11
|
+
size: number;
|
|
12
|
+
/** A localized description of what a press does. */
|
|
13
|
+
title: string;
|
|
14
|
+
/** Inserts the cells. */
|
|
15
|
+
onInsert: () => void;
|
|
16
|
+
}
|
|
17
|
+
export interface CellInsertLayerProps extends Omit<LayerProps, 'children'> {
|
|
18
|
+
/** Class for the layer. */
|
|
19
|
+
className?: string;
|
|
20
|
+
/**
|
|
21
|
+
* Whether the button inserts rows, from the row headers, or columns, from the column headers.
|
|
22
|
+
* A host that wants both declares one layer for each.
|
|
23
|
+
*
|
|
24
|
+
* @defaultValue 'row'
|
|
25
|
+
*/
|
|
26
|
+
axis?: IRange.Axis;
|
|
27
|
+
/**
|
|
28
|
+
* The cells to insert at the header border nearest the pointer, or `null` for no button. The
|
|
29
|
+
* preview line runs along the returned range. Called on every pointer move, so it should be cheap.
|
|
30
|
+
*
|
|
31
|
+
* @param range The entire row (column) just past the border: below it for rows, right of it for
|
|
32
|
+
* columns. A host usually narrows it, e.g. `range.getIntersect(table.getRange())`.
|
|
33
|
+
*
|
|
34
|
+
* Defaults to `range` when the sheet's protection allows inserting rows (columns).
|
|
35
|
+
*/
|
|
36
|
+
resolve?: (range: ICellRange) => ICellRange | null;
|
|
37
|
+
/** Called when the button is pressed. Defaults to `range.insert(axis)`. */
|
|
38
|
+
onInsert?: (range: ICellRange) => void;
|
|
39
|
+
/** Edge (px, unzoomed) of the button. @defaultValue 16 */
|
|
40
|
+
size?: number;
|
|
41
|
+
/**
|
|
42
|
+
* Renders the button, filling the square it is placed in. Defaults to {@link CellInsertButton}.
|
|
43
|
+
*/
|
|
44
|
+
renderButton?: (props: CellInsertButtonProps) => React.ReactNode;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* An **insert** button in the headers, on the border nearest the pointer, as Word shows one in the
|
|
48
|
+
* margin beside a table. Pressing it inserts cells at that border; while it shows, a line across the
|
|
49
|
+
* cells previews where.
|
|
50
|
+
*
|
|
51
|
+
* @remarks
|
|
52
|
+
* Declared on both the header strip and the cells, which a {@link SheetLayers} does:
|
|
53
|
+
*
|
|
54
|
+
* ```tsx
|
|
55
|
+
* <WorksheetElement sheet={sheet}>
|
|
56
|
+
* <SheetLayers surface={['rowHeaders', 'cells']}>
|
|
57
|
+
* <CellInsertLayer />
|
|
58
|
+
* </SheetLayers>
|
|
59
|
+
* </WorksheetElement>
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
62
|
+
* The button is offered from the headers only: hovering the cells shows nothing. Which cells an insert
|
|
63
|
+
* covers, and whether there is one at all, are the host's, through `resolve`. Left alone it inserts
|
|
64
|
+
* entire rows (columns) wherever the sheet's protection allows.
|
|
65
|
+
*/
|
|
66
|
+
export declare const CellInsertLayer: React.MemoExoticComponent<(props: CellInsertLayerProps) => React.JSX.Element | null>;
|
|
67
|
+
/**
|
|
68
|
+
* The chromeless insert button: a circled `+` in the primary color, filled while hovered.
|
|
69
|
+
*/
|
|
70
|
+
export declare const CellInsertButton: React.MemoExoticComponent<(props: CellInsertButtonProps) => React.JSX.Element>;
|
|
71
|
+
//# sourceMappingURL=CellInsertLayer.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 CircularIndicatorLayerProps extends LayerProps {
|
|
5
5
|
/** Class for the layer (devtools identification). */
|
|
@@ -7,7 +7,7 @@ export interface CircularIndicatorLayerProps extends LayerProps {
|
|
|
7
7
|
/** Style for the indicators host box. */
|
|
8
8
|
style?: React.CSSProperties;
|
|
9
9
|
/** The sheet whose circular references are marked. */
|
|
10
|
-
sheet:
|
|
10
|
+
sheet: IWorksheet;
|
|
11
11
|
/** Size (px, unzoomed) of the corner glyph. @defaultValue 9 */
|
|
12
12
|
markSize?: number;
|
|
13
13
|
/** Inset (px, unzoomed) of the glyph from the cell's top-left corner. @defaultValue 1 */
|
|
@@ -21,7 +21,7 @@ export interface CircularIndicatorLayerProps extends LayerProps {
|
|
|
21
21
|
* A {@link CellTileDiv} fed the sheet's `Feature.Circular` regions (engine-merged blocks: a
|
|
22
22
|
* 28K-cell block downstream of one cycle is one region, not 28K nodes), so a sheet with no cycles
|
|
23
23
|
* costs one lookup per frame. Members only get the glyph — a downstream cell is `0` for the same
|
|
24
|
-
* reason
|
|
24
|
+
* reason but the fix is never there, and a column of glyphs reads
|
|
25
25
|
* as a column of problems. The tooltip (`CellErrorLayer`) still answers for downstream cells.
|
|
26
26
|
*
|
|
27
27
|
* The glyph shows in every state; an unresolved cycle — iterative calculation off, or capped
|
|
@@ -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
|
import { CommentCardRenderProps } from '../comment/CommentCardRequest';
|
|
5
5
|
export interface CommentCardLayerProps extends Omit<LayerProps, 'children'> {
|
|
@@ -8,7 +8,7 @@ export interface CommentCardLayerProps extends Omit<LayerProps, 'children'> {
|
|
|
8
8
|
/** Style for the floated card container. */
|
|
9
9
|
style?: React.CSSProperties;
|
|
10
10
|
/** The sheet whose threads are shown. */
|
|
11
|
-
sheet:
|
|
11
|
+
sheet: IWorksheet;
|
|
12
12
|
/**
|
|
13
13
|
* Renders the card. The layer places it, keeps it open and keeps its keystrokes and presses from
|
|
14
14
|
* the grid; what it looks like is the renderer's.
|
|
@@ -17,7 +17,7 @@ export interface CommentCardLayerProps extends Omit<LayerProps, 'children'> {
|
|
|
17
17
|
/**
|
|
18
18
|
* The task pane that lists the sheet's threads. While it is the active pane the cards are shown
|
|
19
19
|
* there and this layer shows none.
|
|
20
|
-
* @defaultValue
|
|
20
|
+
* @defaultValue {@link TaskPaneKey.Comments}
|
|
21
21
|
*/
|
|
22
22
|
paneKey?: string;
|
|
23
23
|
/** Gap (px) between the cell's right edge and the card. @defaultValue 18 */
|
|
@@ -29,17 +29,15 @@ export interface CommentCardLayerProps extends Omit<LayerProps, 'children'> {
|
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
31
|
* The **comment card** beside a cell — a {@link RangeFloatLayer} showing the thread of the cell the
|
|
32
|
-
* pointer rests on, and the card a command
|
|
32
|
+
* pointer rests on, and the card a command asked for (`requestCommentCard`): a draft on a
|
|
33
33
|
* cell with no thread, or the thread a command went to. Selecting a cell shows nothing by itself,
|
|
34
34
|
* as in Excel.
|
|
35
35
|
*
|
|
36
36
|
* @remarks
|
|
37
37
|
* A note has a box of its own and is not shown here. The card of a requested cell stays until the
|
|
38
|
-
* selection leaves the cell or the card is dismissed
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* The float portals out of the pane, but React events still bubble through the React tree to the
|
|
42
|
-
* grid, so the layer stops the card's keystrokes, presses, clipboard and context-menu events there.
|
|
38
|
+
* selection leaves the cell or the card is dismissed. The card is a `'focus'` float: while it holds the
|
|
39
|
+
* caret it stays on its thread whatever the pointer does, Escape or a press outside it closes it (focus
|
|
40
|
+
* back to the grid), and none of its events reach the grid.
|
|
43
41
|
*/
|
|
44
42
|
export declare const CommentCardLayer: React.MemoExoticComponent<(props: CommentCardLayerProps) => React.JSX.Element>;
|
|
45
43
|
//# sourceMappingURL=CommentCardLayer.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 CommentsLayerProps extends LayerProps {
|
|
5
5
|
/** Class for the layer (devtools identification). */
|
|
@@ -7,7 +7,7 @@ export interface CommentsLayerProps extends LayerProps {
|
|
|
7
7
|
/** Style for the indicators host box. */
|
|
8
8
|
style?: React.CSSProperties;
|
|
9
9
|
/** The sheet whose comments are indicated. */
|
|
10
|
-
sheet:
|
|
10
|
+
sheet: IWorksheet;
|
|
11
11
|
/** Size (px, unzoomed) of the corner indicator. @defaultValue 7 */
|
|
12
12
|
markSize?: number;
|
|
13
13
|
/** Dwell (ms) on a note's cell before its box shows. @defaultValue 300 */
|
|
@@ -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 ConditionalBarLayerProps extends LayerProps {
|
|
5
5
|
/** Class for the layer (devtools identification). */
|
|
@@ -7,7 +7,7 @@ export interface ConditionalBarLayerProps extends LayerProps {
|
|
|
7
7
|
/** Style for the bars host box. */
|
|
8
8
|
style?: React.CSSProperties;
|
|
9
9
|
/** The sheet whose conditional data bars are drawn. */
|
|
10
|
-
sheet:
|
|
10
|
+
sheet: IWorksheet;
|
|
11
11
|
/**
|
|
12
12
|
* Margin (px, unzoomed) between the cell's edges and the bar, on ALL FOUR sides.
|
|
13
13
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ICellStyle, IConditionalFormat } from '@sheetxl/sdk';
|
|
2
2
|
/**
|
|
3
3
|
* One icon of a conditional-format icon set: which shape to draw and what to tint it.
|
|
4
4
|
*/
|
|
@@ -47,11 +47,11 @@ export type ConditionalIconTone = keyof typeof Tone;
|
|
|
47
47
|
* `set` is asked per cell rather than per rule because a rule may borrow each band's icon from a
|
|
48
48
|
* different set — see `IConditionalFormat.IconSetDecoration`.
|
|
49
49
|
*/
|
|
50
|
-
export declare const getConditionalIcon: (set:
|
|
50
|
+
export declare const getConditionalIcon: (set: ICellStyle.IconSet, index: number) => ConditionalIconSpec | null;
|
|
51
51
|
/**
|
|
52
52
|
* Returns every icon of a built-in set, band 0 first — for a picker previewing the set.
|
|
53
53
|
*/
|
|
54
|
-
export declare const getConditionalIconSet: (set:
|
|
54
|
+
export declare const getConditionalIconSet: (set: ICellStyle.IconSet) => readonly ConditionalIconSpec[];
|
|
55
55
|
/**
|
|
56
56
|
* The icon each band of a rule draws — the set's own, or the band's override — lowest band first.
|
|
57
57
|
*
|
|
@@ -78,7 +78,7 @@ export declare const describeConditionalIcon: (spec: ConditionalIconSpec) => {
|
|
|
78
78
|
*/
|
|
79
79
|
export interface ConditionalIconCatalogEntry {
|
|
80
80
|
/** The set the icon is borrowed from — what `IConditionalFormat.IconSet.icon` holds. */
|
|
81
|
-
set:
|
|
81
|
+
set: ICellStyle.IconSet;
|
|
82
82
|
/** The icon's index within that set. */
|
|
83
83
|
id: number;
|
|
84
84
|
spec: ConditionalIconSpec;
|
|
@@ -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 ConditionalIconsLayerProps extends LayerProps {
|
|
5
5
|
/** Class for the layer (devtools identification). */
|
|
@@ -7,7 +7,7 @@ export interface ConditionalIconsLayerProps extends LayerProps {
|
|
|
7
7
|
/** Style for the icons host box. */
|
|
8
8
|
style?: React.CSSProperties;
|
|
9
9
|
/** The sheet whose conditional icon sets are drawn. */
|
|
10
|
-
sheet:
|
|
10
|
+
sheet: IWorksheet;
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
13
13
|
* The sheet's **conditional icons** — the in-cell marks an `iconSet` rule draws.
|
|
@@ -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 { SheetLocation } from '../sheet';
|
|
5
5
|
export interface ContextMenuLayerProps extends LayerProps {
|
|
6
6
|
/** The sheet — the keyboard path anchors the menu to its selected cell (`getSelection().getCoords().cell`). */
|
|
7
|
-
sheet:
|
|
7
|
+
sheet: IWorksheet;
|
|
8
8
|
/**
|
|
9
9
|
* Returns the coordinates of the cell where the context menu was requested.
|
|
10
10
|
*/
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
export interface FreezeDragLinesProps {
|
|
3
|
+
/**
|
|
4
|
+
* Also draw the line at the grid's start while a grip is active (hovered, pressed or dragged) with
|
|
5
|
+
* nothing frozen on its axis — where the grid has no freeze line of its own to highlight. For the main
|
|
6
|
+
* grid; a header has the grip's bar there instead.
|
|
7
|
+
*/
|
|
8
|
+
showStart?: boolean;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* The lines of an in-progress freeze drag: solid at the boundary the drop would freeze at, dashed at the
|
|
12
|
+
* pointer while it is over the grid. Reads the drag from `useSurfaceState` (published by
|
|
13
|
+
* {@link useFreezeDrag}) and draws this pane's clipped slice, so it mounts in the headers and the main
|
|
14
|
+
* grid alike.
|
|
15
|
+
*/
|
|
16
|
+
export declare const FreezeDragLines: React.MemoExoticComponent<(props: FreezeDragLinesProps) => React.JSX.Element>;
|
|
17
|
+
//# sourceMappingURL=FreezeDragLines.d.ts.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
2
|
+
import { LayerProps } from '@sheetxl/grid-react';
|
|
3
|
+
export interface GridFreezeLayerProps extends Omit<LayerProps, 'children'> {
|
|
4
|
+
sheet: IWorksheet;
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* The main grid's freeze grips (one per frozen axis, on its freeze line) and its slice of the drag lines.
|
|
8
|
+
* The mirror of {@link HeaderFreezeLayer}; both share one drag.
|
|
9
|
+
*/
|
|
10
|
+
export declare const GridFreezeLayer: import('react').MemoExoticComponent<(props: GridFreezeLayerProps) => import("react").JSX.Element>;
|
|
11
|
+
//# sourceMappingURL=GridFreezeLayer.d.ts.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { ISheetHeader } from '@sheetxl/sdk';
|
|
2
|
+
import { LayerProps } from '@sheetxl/grid-react';
|
|
3
|
+
export interface HeaderFreezeLayerProps extends Omit<LayerProps, 'children'> {
|
|
4
|
+
sheetHeader: ISheetHeader;
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* The freeze grip in a header, and the header's slice of the drag lines. Dragging the grip moves the
|
|
8
|
+
* freeze to the nearest header boundary on screen; the main grid draws its slice of the lines from the
|
|
9
|
+
* same shared state.
|
|
10
|
+
*/
|
|
11
|
+
export declare const HeaderFreezeLayer: import('react').MemoExoticComponent<(props: HeaderFreezeLayerProps) => import("react").JSX.Element>;
|
|
12
|
+
//# sourceMappingURL=HeaderFreezeLayer.d.ts.map
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
2
|
import { ISheetHeader } from '@sheetxl/sdk';
|
|
3
|
-
|
|
3
|
+
import { LayerProps } from '@sheetxl/grid-react';
|
|
4
|
+
export interface HeaderResizerLayerProps extends Omit<LayerProps, 'children'> {
|
|
4
5
|
sheetHeader: ISheetHeader;
|
|
5
6
|
isColumn: boolean;
|
|
6
7
|
oppositeSize?: number;
|
|
@@ -49,11 +49,11 @@ export interface HeaderSelectionLayerProps extends LayerProps {
|
|
|
49
49
|
*/
|
|
50
50
|
scrollIntoView?: (coords: Partial<CellCoords>) => void;
|
|
51
51
|
/**
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
* @defaultValue
|
|
52
|
+
* Hide the selection accent (the header underline for selected rows/columns). For a picker overlay,
|
|
53
|
+
* whose reference rectangles are drawn by `RangesPickerLayer` — the accent would compete.
|
|
54
|
+
* @defaultValue false
|
|
55
55
|
*/
|
|
56
|
-
|
|
56
|
+
hideAccent?: boolean;
|
|
57
57
|
/**
|
|
58
58
|
* Keep the current focus on pointer-up instead of focusing the grid pane. On for a picker overlay used
|
|
59
59
|
* while editing a formula (focusing the pane would blur the editor). @defaultValue false
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { CellCoords } from '@sheetxl/utils';
|
|
3
|
+
import { IHyperlink, IWorksheet } from '@sheetxl/sdk';
|
|
4
|
+
import { StickyState, GridPlacement, HoverTipProps, LayerProps } from '@sheetxl/grid-react';
|
|
5
|
+
/** What a link preview service found for a page. Every field is optional; an empty one shows nothing. */
|
|
6
|
+
export interface LinkPreview {
|
|
7
|
+
/** The page's picture: its social card (`og:image`) or a screenshot. */
|
|
8
|
+
image?: string;
|
|
9
|
+
/**
|
|
10
|
+
* The width the picture was asked for. A screenshot service answers with a placeholder while it
|
|
11
|
+
* renders; a loaded picture of another width IS that placeholder, and the card asks again.
|
|
12
|
+
*/
|
|
13
|
+
imageWidth?: number;
|
|
14
|
+
title?: string;
|
|
15
|
+
description?: string;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Finds a {@link LinkPreview} for an address, or `null` for none. Synchronous when the preview is only
|
|
19
|
+
* a URL (a screenshot service), a promise when it has to be looked up (a social card).
|
|
20
|
+
*/
|
|
21
|
+
export type LinkPreviewLookup = (address: string) => LinkPreview | Promise<LinkPreview | null> | null;
|
|
22
|
+
/** What a hyperlink card is handed. The actions are bound to the hovered cell or picture. */
|
|
23
|
+
export interface HyperlinkCardRenderProps {
|
|
24
|
+
sheet: IWorksheet;
|
|
25
|
+
/** The hovered cell (the card anchors to its range, a merge included), or a linked picture's first. */
|
|
26
|
+
coords: CellCoords;
|
|
27
|
+
hyperlink: IHyperlink;
|
|
28
|
+
/** Follow the link. */
|
|
29
|
+
open: () => Promise<void>;
|
|
30
|
+
/** Copy the address to the clipboard. */
|
|
31
|
+
copy: () => Promise<void>;
|
|
32
|
+
/** Select the cell and open the hyperlink editor. */
|
|
33
|
+
edit: () => void;
|
|
34
|
+
/** Remove the link; the cell's text stays. */
|
|
35
|
+
remove: () => void;
|
|
36
|
+
/**
|
|
37
|
+
* `true` when the link cannot be changed, so {@link edit} and {@link remove} should show disabled:
|
|
38
|
+
* it is read-only ({@link IHyperlink.isReadOnly}) or the sheet's protection refuses the change.
|
|
39
|
+
*/
|
|
40
|
+
disabled: boolean;
|
|
41
|
+
/**
|
|
42
|
+
* The linked page's preview once the lookup resolved, or `null` — see
|
|
43
|
+
* {@link HyperlinkLayerProps.preview}. Draw its picture with {@link LinkPreviewImage}, which shows it
|
|
44
|
+
* only once it exists.
|
|
45
|
+
*/
|
|
46
|
+
preview: LinkPreview | null;
|
|
47
|
+
/** Spread onto the card root (keeps the card open while hovered; registers it with the tooltip group). */
|
|
48
|
+
tipProps: HoverTipProps;
|
|
49
|
+
state: StickyState;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Props for {@link HyperlinkLayer}.
|
|
53
|
+
*/
|
|
54
|
+
export interface HyperlinkLayerProps extends Omit<LayerProps, 'children'> {
|
|
55
|
+
sheet: IWorksheet;
|
|
56
|
+
/** The card. @defaultValue the plain card: address · copy · edit · remove */
|
|
57
|
+
renderCard?: ((props: HyperlinkCardRenderProps) => React.ReactNode) | null;
|
|
58
|
+
/**
|
|
59
|
+
* Looks up a preview of the linked page to show under the actions. Off by default: it is a request to
|
|
60
|
+
* a third party per hovered web link. {@link linkPreviewMicrolink} (the page's social card) and
|
|
61
|
+
* {@link linkPreviewMShots} (a screenshot) are two free ones; results are kept per address for the
|
|
62
|
+
* session.
|
|
63
|
+
*/
|
|
64
|
+
preview?: LinkPreviewLookup;
|
|
65
|
+
/** Where the card attaches. @defaultValue `{ side: 'b', align: 'start' }` */
|
|
66
|
+
placement?: GridPlacement;
|
|
67
|
+
/** Gap (px) between the cell and the card. @defaultValue 4 */
|
|
68
|
+
offset?: number;
|
|
69
|
+
className?: string;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* A page's **social card** through [microlink](https://microlink.io): the `og:image`, title and
|
|
73
|
+
* description the page declares — what a chat app unfurls. Free without a key, rate limited (25 requests
|
|
74
|
+
* a window, so hovering many distinct links in a burst runs dry until it resets); allows browser calls.
|
|
75
|
+
* Web addresses only.
|
|
76
|
+
*/
|
|
77
|
+
export declare const linkPreviewMicrolink: (address: string) => Promise<LinkPreview | null>;
|
|
78
|
+
/**
|
|
79
|
+
* A **screenshot** of the page through WordPress's free mShots service. No key, no quota stated. The
|
|
80
|
+
* address goes in the path as is (percent-encoding it is refused). While the shot is being taken the
|
|
81
|
+
* service redirects to a 400×300 placeholder, so `width` must not be 400 — {@link LinkPreviewImage}
|
|
82
|
+
* tells the placeholder from the shot by its width and asks again. Web addresses only.
|
|
83
|
+
*/
|
|
84
|
+
export declare const linkPreviewMShots: (address: string, width?: number) => LinkPreview | null;
|
|
85
|
+
/**
|
|
86
|
+
* The **hyperlink card** — hover a cell carrying a link and a card offers its address (click to follow),
|
|
87
|
+
* copy, edit and remove, as Excel Online does. A {@link RangeTooltipLayer} whose probe asks the cell for
|
|
88
|
+
* its hyperlink; the card is the tooltip group's one open tip, interactive, and closes on any press
|
|
89
|
+
* outside it. What the card looks like is the host's (`renderCard`); the plain default draws with the
|
|
90
|
+
* grid's tokens.
|
|
91
|
+
*
|
|
92
|
+
* @remarks
|
|
93
|
+
* Edit goes through the sheet's `updateHyperlink` command, which acts on the selection — so it selects
|
|
94
|
+
* the hovered cell first, as Excel Online does. Remove is the link's own `delete()`.
|
|
95
|
+
*/
|
|
96
|
+
export declare const HyperlinkLayer: React.MemoExoticComponent<(props: HyperlinkLayerProps) => React.JSX.Element>;
|
|
97
|
+
/**
|
|
98
|
+
* The preview picture, shown once it exists and has loaded — a missing card or a failed request draws
|
|
99
|
+
* nothing, so the card never shows a broken image. A picture that has to load slides open as it arrives;
|
|
100
|
+
* one the browser already has is simply there.
|
|
101
|
+
*
|
|
102
|
+
* A screenshot service answers while it is still rendering with a **placeholder picture** (mShots
|
|
103
|
+
* does). The caller says what width it asked for (`expectedWidth`); a loaded picture of another width
|
|
104
|
+
* is the placeholder, so it stays hidden and the request repeats every {@link PREVIEW_POLL_MS} until the
|
|
105
|
+
* shot arrives. The polling stops with the card.
|
|
106
|
+
*/
|
|
107
|
+
export declare const LinkPreviewImage: React.FC<{
|
|
108
|
+
src: string;
|
|
109
|
+
/** The width the service was asked for; a loaded picture of another width is its placeholder. */
|
|
110
|
+
expectedWidth?: number;
|
|
111
|
+
/** The width to draw at. @defaultValue the container's */
|
|
112
|
+
width?: number | string;
|
|
113
|
+
/** Style for the picture. A margin here takes no room until the picture shows. */
|
|
114
|
+
style?: React.CSSProperties;
|
|
115
|
+
}>;
|
|
116
|
+
//# sourceMappingURL=HyperlinkLayer.d.ts.map
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { ReactElement } from 'react';
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
export interface MovableKindScopeProps {
|
|
4
|
+
sheet: IWorksheet;
|
|
5
|
+
/** The movable layer's z. The kind's scope joins the pane's chain just above it. */
|
|
6
|
+
order: number;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* The scope and contextual tab of the active movable's kind. While a movable is the active selection,
|
|
10
|
+
* its kind's `commands` run in a scope named for the content type, stacked just above the `movable`
|
|
11
|
+
* scope so they out-resolve it, and its `toolbar` is shown in the main toolbar strip; a kind that
|
|
12
|
+
* brings no tab gets the default one ({@link createDefaultMovableToolbar}). Both follow the active
|
|
13
|
+
* movable and go when the selection clears; another movable of the same kind becoming active re-runs
|
|
14
|
+
* the commands with it. A kind whose module is still loading gets them when the load settles.
|
|
15
|
+
*/
|
|
16
|
+
export declare const MovableKindScope: import('react').MemoExoticComponent<(props: MovableKindScopeProps) => ReactElement | null>;
|
|
17
|
+
//# sourceMappingURL=MovableKindScope.d.ts.map
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
import { LayerProps } from '@sheetxl/grid-react';
|
|
4
|
+
import { PivotButtonConfigProps } from '../cell/PivotButton';
|
|
5
|
+
export interface PivotLayerProps extends LayerProps, PivotButtonConfigProps {
|
|
6
|
+
/** The sheet whose pivot tables' controls are rendered. */
|
|
7
|
+
sheet: IWorksheet;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* The sheet's pivot table controls: each field's dropdown and each item's expand/collapse box, drawn
|
|
11
|
+
* where Excel draws them - a dropdown pinned to its cell's right edge, a box after its label's
|
|
12
|
+
* indent and before its text.
|
|
13
|
+
*
|
|
14
|
+
* @remarks
|
|
15
|
+
* Sits above the selection, as the table column buttons do: a layer above the hit is offered a press
|
|
16
|
+
* first, so below the selection a press would move it before the button could stop it. The tables'
|
|
17
|
+
* empty boxes and outlines are {@link PivotFrameLayer}'s, below the selection. With no pivot table in
|
|
18
|
+
* the pane's view it renders nothing.
|
|
19
|
+
*
|
|
20
|
+
* A cell layer fed a pivot-aware source, as the table column buttons are: one walk of the
|
|
21
|
+
* sheet's pivot tables per pane, `[]` when none is in view, emitting only the cells that hold a
|
|
22
|
+
* control. Where the cells are is the table's (from its definition, with no calculation), so the
|
|
23
|
+
* layer draws for a table the moment it is placed.
|
|
24
|
+
*
|
|
25
|
+
* The box sits in the gutter {@link ICell.getInsets} already reserves on a label, so the text,
|
|
26
|
+
* wrapping, best-fit and the editor all start after it without this layer telling them to. A
|
|
27
|
+
* press changes the table's definition through {@link IPivotTable.IField} / {@link IPivotTable.IItem};
|
|
28
|
+
* the table announces the change and the layer redraws. Presses never reach the grid, so they do not
|
|
29
|
+
* move the selection.
|
|
30
|
+
*/
|
|
31
|
+
export declare const PivotLayer: React.MemoExoticComponent<(props: PivotLayerProps) => React.JSX.Element | null>;
|
|
32
|
+
export interface PivotFrameLayerProps extends LayerProps {
|
|
33
|
+
/** The sheet whose pivot tables are framed. */
|
|
34
|
+
sheet: IWorksheet;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* The frame of the sheet's pivot tables: the outline of the hovered table and of the active cell's,
|
|
38
|
+
* as a table's, and over a table with no fields yet its name, a hint and a picture of a pivot table,
|
|
39
|
+
* as Excel draws over its empty box. The hint says to pick fields once the active cell is in the
|
|
40
|
+
* table, and to click into it until then.
|
|
41
|
+
*
|
|
42
|
+
* @remarks
|
|
43
|
+
* Passive paint below the selection, so the selection draws over it. The table's controls are
|
|
44
|
+
* {@link PivotLayer}'s. With no pivot table in the pane's view it renders nothing.
|
|
45
|
+
*/
|
|
46
|
+
export declare const PivotFrameLayer: React.MemoExoticComponent<(props: PivotFrameLayerProps) => React.JSX.Element | null>;
|
|
47
|
+
//# sourceMappingURL=PivotLayer.d.ts.map
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IPivotTable, IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
import { LayerProps } from '@sheetxl/grid-react';
|
|
4
|
+
import { RangeToolbarRenderProps } from './RangeToolbar';
|
|
5
|
+
/** What the pivot table toolbar is handed. */
|
|
6
|
+
export interface PivotToolbarRenderProps extends RangeToolbarRenderProps {
|
|
7
|
+
/**
|
|
8
|
+
* The hovered pivot table. A press anywhere on the toolbar first puts the selection in it when it
|
|
9
|
+
* is elsewhere, so the PivotTable tab and its pane follow.
|
|
10
|
+
*/
|
|
11
|
+
pivot: IPivotTable;
|
|
12
|
+
}
|
|
13
|
+
/** Props for {@link PivotToolbarLayer}. */
|
|
14
|
+
export interface PivotToolbarLayerProps extends LayerProps {
|
|
15
|
+
sheet: IWorksheet;
|
|
16
|
+
/**
|
|
17
|
+
* The toolbar that floats at a hovered pivot table's top-right corner.
|
|
18
|
+
* @defaultValue a plain split button: edit the pivot table · a menu of its commands
|
|
19
|
+
*/
|
|
20
|
+
renderToolbar?: ((props: PivotToolbarRenderProps) => React.ReactNode) | null;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* The **pivot table toolbar**: hover a pivot table, its body or the page fields above it, and its
|
|
24
|
+
* commands float at its top-right corner, a quick action (edit it) and a dropdown of the rest, as the
|
|
25
|
+
* {@link TableToolbarFloat table toolbar} does for a table. The layer finds the hovered table itself;
|
|
26
|
+
* the float is a {@link RangeToolbarFloat}.
|
|
27
|
+
*/
|
|
28
|
+
export declare const PivotToolbarLayer: React.MemoExoticComponent<(props: PivotToolbarLayerProps) => React.ReactElement>;
|
|
29
|
+
//# sourceMappingURL=PivotToolbar.d.ts.map
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import { default as React } from 'react';
|
|
2
1
|
import { RangeCoordValue } from '@sheetxl/utils';
|
|
3
|
-
import { ICellRegion,
|
|
2
|
+
import { ICellRegion, IWorksheet, IWorksheetView } from '@sheetxl/sdk';
|
|
4
3
|
import { LayerProps } from '@sheetxl/grid-react';
|
|
5
4
|
/**
|
|
6
5
|
* The regions to punch out of the hatch, coalesced by appearance.
|
|
@@ -26,9 +25,9 @@ export interface ProtectionLayerProps extends LayerProps {
|
|
|
26
25
|
/** Class for the layer (devtools identification). */
|
|
27
26
|
className?: string;
|
|
28
27
|
/** The sheet whose locked area is hatched. */
|
|
29
|
-
sheet:
|
|
28
|
+
sheet: IWorksheet;
|
|
30
29
|
/** The view carrying `isShowLockedShading()` — the toggle this layer draws for. */
|
|
31
|
-
sheetView:
|
|
30
|
+
sheetView: IWorksheetView;
|
|
32
31
|
}
|
|
33
32
|
/**
|
|
34
33
|
* The **locked-cell hatch** — the sheet's protected area, with the unlocked ranges cut out of it.
|
|
@@ -48,5 +47,5 @@ export interface ProtectionLayerProps extends LayerProps {
|
|
|
48
47
|
*
|
|
49
48
|
* Passive paint (`pointerEvents: none`), below the selection.
|
|
50
49
|
*/
|
|
51
|
-
export declare const ProtectionLayer:
|
|
50
|
+
export declare const ProtectionLayer: import('react').MemoExoticComponent<(props: ProtectionLayerProps) => import("react").JSX.Element | null>;
|
|
52
51
|
//# sourceMappingURL=ProtectionLayer.d.ts.map
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IRange, IWorksheet, ICell } from '@sheetxl/sdk';
|
|
3
|
+
import { HoverTipProps, StickyState } from '@sheetxl/grid-react';
|
|
4
|
+
/**
|
|
5
|
+
* What a toolbar floated over a hovered range is handed, whatever the range holds. Each kind adds
|
|
6
|
+
* the object it floats over: {@link TableToolbarRenderProps}, {@link PivotToolbarRenderProps}.
|
|
7
|
+
*/
|
|
8
|
+
export interface RangeToolbarRenderProps {
|
|
9
|
+
sheet: IWorksheet;
|
|
10
|
+
/** Spread onto the toolbar root: it takes the pointer, and hovering it keeps the toolbar up. */
|
|
11
|
+
floatProps: HoverTipProps;
|
|
12
|
+
/**
|
|
13
|
+
* Keep the toolbar up while something it opened has the pointer, its dropdown. Call `true` when the
|
|
14
|
+
* dropdown opens and `false` when it closes.
|
|
15
|
+
*/
|
|
16
|
+
setHeld: (held: boolean) => void;
|
|
17
|
+
state: StickyState;
|
|
18
|
+
}
|
|
19
|
+
/** An object a toolbar floats over: a table, a pivot table. */
|
|
20
|
+
interface Hoverable {
|
|
21
|
+
isDeleted(): boolean;
|
|
22
|
+
getName(): string;
|
|
23
|
+
}
|
|
24
|
+
/** What {@link RangeToolbarFloat} takes of the kind of object it floats over. */
|
|
25
|
+
export interface RangeToolbarFloatProps<T extends Hoverable> {
|
|
26
|
+
/** The float's name, unique per kind. */
|
|
27
|
+
name: string;
|
|
28
|
+
sheet: IWorksheet;
|
|
29
|
+
/** The object under the pointer, or `null`. */
|
|
30
|
+
hovered: T | null;
|
|
31
|
+
/** The cells the toolbar floats beside. */
|
|
32
|
+
rangeOf: (object: T) => IRange.Coords;
|
|
33
|
+
/** Whether the active cell is in the object already, so a press on the toolbar selects nothing. */
|
|
34
|
+
contains: (object: T, cell: ICell.Coords) => boolean;
|
|
35
|
+
/** Puts the selection in the object. */
|
|
36
|
+
select: (object: T) => void;
|
|
37
|
+
/** Draws the toolbar for the object, with what every toolbar is handed. */
|
|
38
|
+
render: (object: T, props: RangeToolbarRenderProps) => React.ReactNode;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* A toolbar floated at a hovered object's top-right: a {@link VirtualRangeFloat} opened by hover but
|
|
42
|
+
* not a tooltip (it outlives a tip opening beside it and a press on its own buttons), `clamp`ed so it
|
|
43
|
+
* stays on screen while the object's top is scrolled away, and gone while a cell is edited.
|
|
44
|
+
*
|
|
45
|
+
* @remarks
|
|
46
|
+
* The commands act on the object under the active cell, so a press on the toolbar first puts the
|
|
47
|
+
* selection in the hovered object when it is elsewhere. While something it opened is up the toolbar
|
|
48
|
+
* is held (`setHeld`), as the pointer is there, not on the toolbar.
|
|
49
|
+
*/
|
|
50
|
+
export declare const RangeToolbarFloat: <T extends Hoverable>(props: RangeToolbarFloatProps<T>) => React.ReactElement;
|
|
51
|
+
/** Draws a toolbar slot: the host's renderer, the default when it gives none, nothing for `null`. */
|
|
52
|
+
export declare const renderToolbarSlot: <P>(render: ((props: P) => React.ReactNode) | null | undefined, fallback: (props: P) => React.ReactNode, props: P) => React.ReactNode;
|
|
53
|
+
/** What {@link RangeToolbarSplitButton} is handed. */
|
|
54
|
+
export interface RangeToolbarSplitButtonProps {
|
|
55
|
+
/** The object the commands take. */
|
|
56
|
+
target: Hoverable;
|
|
57
|
+
/** The quick action first, then the dropdown's commands, by key. */
|
|
58
|
+
commandKeys: readonly string[];
|
|
59
|
+
/** The quick action's color. */
|
|
60
|
+
color: string;
|
|
61
|
+
/** The quick action's icon. */
|
|
62
|
+
iconKey: string;
|
|
63
|
+
/** The dropdown's float name. */
|
|
64
|
+
menuName: string;
|
|
65
|
+
floatProps: HoverTipProps;
|
|
66
|
+
setHeld: (held: boolean) => void;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* The plain toolbar, with no UI kit: a quick action in the object's color and a dropdown listing it
|
|
70
|
+
* and the other commands. The dropdown opens in the float stack, so it closes under a context menu
|
|
71
|
+
* like any popup, and holds the toolbar up while open.
|
|
72
|
+
*/
|
|
73
|
+
export declare const RangeToolbarSplitButton: React.FC<RangeToolbarSplitButtonProps>;
|
|
74
|
+
export {};
|
|
75
|
+
//# sourceMappingURL=RangeToolbar.d.ts.map
|