@sheetxl/react 0.8.0-beta.1 → 0.8.0-beta.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/browser/esm/1-LEUre9ZLG0OYYB.mjs +197 -0
- package/browser/esm/94dxo1A-z8lgiiGw.mjs +128 -0
- package/browser/esm/B26QVfjer2oY2ewK.mjs +32 -0
- package/browser/esm/B93LSmhnvkxNXTq-.mjs +42 -0
- package/browser/esm/BQYS2Yf-EAV_tBLr.mjs +20 -0
- package/{node/esm/DAE_NG8D9uT50zUH.mjs → browser/esm/BegvsXeRs7e-9t8k.mjs} +3 -4
- package/browser/esm/Bl2BFCQ00fotauKB.mjs +36 -0
- package/browser/esm/Bos4Rkp8UTF7QXUB.mjs +31 -0
- package/browser/esm/C1pc9F4Rt2C5FKUo.mjs +45 -0
- package/browser/esm/CPnnESfZz2jjJd82.mjs +134 -0
- package/browser/esm/CRi6DQ3UXmPEv-w_.mjs +729 -0
- package/browser/esm/ClAtIfYbsUPA073B.mjs +2706 -0
- package/browser/esm/CzRIbc-Lk__VMLKM.mjs +60 -0
- package/browser/esm/D2u6THGErqw64KQI.mjs +63 -0
- package/browser/esm/DMdsMPT0fWBbTkNn.mjs +67 -0
- package/browser/esm/DS66lAIM-9M-YoZQ.mjs +315 -0
- package/browser/esm/DgL7Dy-Lqcr1TvW6.mjs +23528 -0
- package/browser/esm/Dnh1kpz3v1JKtRD_.mjs +79 -0
- package/browser/esm/cQ6xdPFkEcuDlNTN.mjs +75 -0
- package/browser/esm/chart.mjs +40 -0
- package/browser/esm/control.mjs +216 -0
- package/browser/esm/group.mjs +123 -0
- package/browser/esm/index.mjs +15460 -8762
- package/browser/esm/note.mjs +112 -0
- package/browser/esm/picture.mjs +86 -0
- package/browser/esm/shape.mjs +7 -0
- package/browser/esm/slicer.mjs +276 -0
- package/browser/esm/ugfE7YeZALQURDKF.mjs +241 -0
- package/licenses/dependencies.txt +319 -600
- package/node/esm/6zApGj9DozhFy-bx.mjs +35 -0
- package/node/esm/BMVK5plvmBOAIlxP.mjs +80 -0
- package/node/esm/BaRfst1euuhquupX.mjs +66 -0
- package/node/esm/Be9c1GwQkPo8Piuh.mjs +134 -0
- package/node/esm/BiaDWnN3tT7neoRL.mjs +68 -0
- package/node/esm/BlxXufqBBg1PtsXd.mjs +8 -0
- package/node/esm/C_SNx7TlFEcwbYjx.mjs +2706 -0
- package/node/esm/DJPgbB1X22YmhbaR.mjs +242 -0
- package/node/esm/DTMTIrYIK1eZswsM.mjs +37 -0
- package/node/esm/D_pCpfdQowV_4Aje.mjs +198 -0
- package/node/esm/DgGEHydEjD7nfsDB.mjs +76 -0
- package/node/esm/Dj5FM7_-YWhCtCCt.mjs +45 -0
- package/node/esm/DxQZmb-j4NLUO9Af.mjs +63 -0
- package/node/esm/JiQGhLkoL8CJpVvA.mjs +20 -0
- package/node/esm/b-XRVRI1fYQQMkTC.mjs +1664 -0
- package/node/esm/chart.mjs +40 -0
- package/node/esm/control.mjs +216 -0
- package/node/esm/gpD-9LDW92phhoma.mjs +32 -0
- package/node/esm/group.mjs +123 -0
- package/node/esm/index.mjs +15830 -8966
- package/node/esm/note.mjs +113 -0
- package/node/esm/picture.mjs +86 -0
- package/node/esm/shape.mjs +735 -0
- package/node/esm/sigD1UFqvPlWUw_9.mjs +128 -0
- package/node/esm/slicer.mjs +278 -0
- package/node/esm/umljAT66yb3_rURh.mjs +320 -0
- package/package.json +55 -14
- package/resources/contents.json +24 -0
- package/resources/locales/contents.json +56 -0
- package/resources/locales/de/chart.cmd.json +82 -0
- package/resources/locales/de/movable.cmd.json +154 -0
- package/resources/locales/de/picture.cmd.json +31 -0
- package/resources/locales/de/selection.cmd.json +8 -0
- package/resources/locales/de/shape.cmd.json +17 -0
- package/resources/locales/de/sheet.cmd.json +339 -21
- package/resources/locales/de/slicer.cmd.json +17 -0
- package/resources/locales/de/table.cmd.json +9 -1
- package/resources/locales/de/ui.msg.json +321 -3
- package/resources/locales/de/workbook.cmd.json +15 -6
- package/resources/locales/en/chart.cmd.json +82 -0
- package/resources/locales/en/movable.cmd.json +154 -0
- package/resources/locales/en/picture.cmd.json +31 -0
- package/resources/locales/en/selection.cmd.json +8 -0
- package/resources/locales/en/shape.cmd.json +17 -0
- package/resources/locales/en/sheet.cmd.json +353 -22
- package/resources/locales/en/slicer.cmd.json +17 -0
- package/resources/locales/en/table.cmd.json +9 -1
- package/resources/locales/en/ui.msg.json +321 -3
- package/resources/locales/en/workbook.cmd.json +16 -7
- 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/RangeAnnotations.d.ts +119 -0
- package/types/src/annotation/index.d.ts +2 -0
- package/types/src/autoFill/AutoFillPresets.d.ts +14 -0
- package/types/src/autoFill/FillMenu.d.ts +36 -0
- package/types/src/autoFill/FillSeries.d.ts +38 -0
- package/types/src/autoFill/index.d.ts +4 -0
- package/types/src/border/StaticBorderRenderer.d.ts +19 -2
- package/types/src/border/useBorders.d.ts +81 -8
- package/types/src/cell/CornerTriangle.d.ts +6 -0
- package/types/src/cell/FormulaCellRenderer.d.ts +6 -3
- package/types/src/cell/OutlineButton.d.ts +123 -0
- package/types/src/cell/SheetCellRenderer.d.ts +2 -2
- package/types/src/cell/SheetHeaderRenderer.d.ts +5 -0
- package/types/src/cell/StaticCellRenderer.d.ts +57 -0
- package/types/src/cell/index.d.ts +2 -0
- package/types/src/cell/useFormulaViewAnchor.d.ts +3 -3
- package/types/src/chart/ChartCommands.d.ts +15 -0
- package/types/src/chart/ChartEditor.d.ts +10 -2
- package/types/src/chart/ChartElement.d.ts +111 -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 +46 -0
- package/types/src/chart/paint/echarts.d.ts +30 -0
- package/types/src/chart/paint/index.d.ts +12 -0
- package/types/src/chart/paint/kinds/ChartPaintKind.d.ts +132 -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 +12 -0
- package/types/src/chart/paint/toEChartsOption.d.ts +31 -0
- package/types/src/checklist/ValueChecklist.d.ts +112 -0
- package/types/src/checklist/index.d.ts +2 -0
- 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 +94 -0
- package/types/src/comment/CommentUtils.d.ts +43 -0
- package/types/src/comment/NoteEditor.d.ts +20 -0
- package/types/src/comment/index.d.ts +5 -0
- package/types/src/comment/useCommentThread.d.ts +37 -0
- package/types/src/comment/useSheetComments.d.ts +28 -0
- package/types/src/{sheet → conditionalFormat}/ConditionalFormatPresets.d.ts +6 -6
- package/types/src/conditionalFormat/index.d.ts +1 -0
- 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/editor/EditorCommands.d.ts +3 -3
- package/types/src/editor/FunctionPreviewPanel.d.ts +15 -1
- package/types/src/editor/NamedItemLabel.d.ts +29 -0
- package/types/src/editor/NamedItemsPanel.d.ts +13 -2
- package/types/src/editor/SheetCellEditorLayer.d.ts +5 -9
- package/types/src/editor/SheetCellEditorStartLayer.d.ts +61 -0
- package/types/src/editor/SheetCellInput.d.ts +26 -2
- package/types/src/editor/SheetEditable.d.ts +14 -8
- package/types/src/editor/SheetReferenceLayer.d.ts +4 -4
- package/types/src/editor/VirtualKeyboardLayer.d.ts +49 -0
- package/types/src/editor/formulaAnchor.d.ts +12 -0
- package/types/src/editor/formulaCaret.d.ts +39 -10
- package/types/src/editor/formulaEval.d.ts +9 -5
- package/types/src/editor/formulaLint.d.ts +36 -0
- package/types/src/editor/formulaPresentation.d.ts +7 -0
- package/types/src/editor/formulaText.d.ts +17 -5
- package/types/src/editor/functionArgs.d.ts +20 -0
- package/types/src/editor/index.d.ts +5 -1
- package/types/src/editor/pickedReference.d.ts +76 -0
- package/types/src/editor/useEditRejectedNotice.d.ts +32 -0
- package/types/src/editor/useFormulaHints.d.ts +95 -5
- package/types/src/editor/useFormulaInput.d.ts +30 -4
- package/types/src/editor/useReferenceMode.d.ts +12 -0
- package/types/src/editor/validationAlert.d.ts +24 -0
- package/types/src/externalLink/ExternalLinksPaneArgs.d.ts +23 -0
- package/types/src/externalLink/index.d.ts +2 -0
- package/types/src/form/FormulaInput.d.ts +18 -2
- package/types/src/form/FormulaInputParts.d.ts +10 -1
- 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 +189 -7
- package/types/src/group/GroupEditor.d.ts +25 -0
- package/types/src/index.d.ts +14 -2
- package/types/src/io/WorkbookIO.d.ts +2 -0
- package/types/src/layer/BorderLayer.d.ts +2 -2
- package/types/src/layer/CellErrorLayer.d.ts +26 -9
- package/types/src/layer/CellFillLayer.d.ts +2 -2
- package/types/src/layer/CellInsertLayer.d.ts +71 -0
- package/types/src/layer/CircularIndicatorLayer.d.ts +2 -2
- package/types/src/layer/CommentCardLayer.d.ts +43 -0
- package/types/src/layer/CommentsLayer.d.ts +35 -0
- 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/HyperlinkLayer.d.ts +109 -0
- package/types/src/layer/MovableKindScope.d.ts +17 -0
- package/types/src/layer/ProtectionLayer.d.ts +52 -0
- package/types/src/layer/RangeAnnotationLayer.d.ts +71 -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 +4 -4
- package/types/src/layer/SheetColumnButtonLayer.d.ts +2 -2
- package/types/src/layer/SheetGridLineLayer.d.ts +11 -13
- package/types/src/layer/SheetHeaderCellLayer.d.ts +10 -1
- package/types/src/layer/SheetLayers.d.ts +115 -0
- package/types/src/layer/SheetMovableLayer.d.ts +2 -2
- package/types/src/layer/SheetOutlineLayer.d.ts +40 -0
- package/types/src/layer/SheetTableCommandLayer.d.ts +2 -2
- 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 +42 -0
- package/types/src/layer/ValidationDropdownLayer.d.ts +17 -7
- package/types/src/layer/ValidationIndicatorLayer.d.ts +11 -5
- package/types/src/layer/ValidationPromptLayer.d.ts +65 -0
- package/types/src/layer/_tableColor.d.ts +4 -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 +14 -1
- 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 +2 -2
- 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 +37 -37
- package/types/src/layer/useVisibleTables.d.ts +2 -2
- package/types/src/layer/validationMark.d.ts +63 -0
- 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 +8 -8
- 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 +56 -0
- package/types/src/movable/MovableAdornment.d.ts +26 -0
- package/types/src/movable/MovableCommandGroups.d.ts +40 -0
- package/types/src/movable/MovableCommands.d.ts +8 -3
- package/types/src/movable/MovableControl.d.ts +78 -0
- package/types/src/movable/MovableEdit.d.ts +22 -0
- package/types/src/movable/MovableFrame.d.ts +16 -13
- package/types/src/movable/MovableLayer.d.ts +25 -7
- 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/TextBox.d.ts +34 -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 +11 -0
- package/types/src/movable/pressTarget.d.ts +20 -0
- package/types/src/picker/PickerPanel.d.ts +52 -0
- package/types/src/picker/cellPickerOpen.d.ts +6 -0
- package/types/src/picker/index.d.ts +4 -0
- package/types/src/picker/useCellPicker.d.ts +95 -0
- package/types/src/picture/PictureCommands.d.ts +12 -0
- package/types/src/picture/PictureKind.d.ts +7 -0
- package/types/src/picture/index.d.ts +0 -1
- package/types/src/protection/ProtectionPaneArgs.d.ts +31 -0
- package/types/src/protection/index.d.ts +3 -0
- package/types/src/protection/unlockProtectedRanges.d.ts +23 -0
- package/types/src/richText/RichTextEditor.d.ts +41 -0
- package/types/src/richText/index.d.ts +2 -0
- package/types/src/selection/SelectionCommands.d.ts +2 -2
- package/types/src/selection/SheetSelectionLayer.d.ts +16 -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 +1 -1
- package/types/src/sheet/{ISheetElement.d.ts → IWorksheetElement.d.ts} +107 -77
- package/types/src/sheet/OpaqueSheetElement.d.ts +21 -0
- package/types/src/sheet/SheetCommandProvider.d.ts +11 -6
- package/types/src/sheet/SheetCommands.d.ts +22 -7
- 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/_useHeaderMetrics.d.ts +11 -0
- package/types/src/sheet/circularReferences.d.ts +12 -4
- package/types/src/sheet/index.d.ts +6 -3
- package/types/src/sheet/useCycleHighlight.d.ts +21 -0
- 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/tabStrip/SheetTab.d.ts +1 -1
- package/types/src/tabStrip/TabStrip.d.ts +7 -0
- package/types/src/table/TableCommands.d.ts +2 -2
- package/types/src/taskPane/ITaskPane.d.ts +12 -1
- package/types/src/taskPane/MovablePane.d.ts +17 -0
- package/types/src/taskPane/TaskPaneArea.d.ts +7 -0
- package/types/src/taskPane/index.d.ts +1 -0
- package/types/src/theme/ThemeState.d.ts +14 -1
- package/types/src/theme/buildOOXMLThemeCSS.d.ts +2 -2
- package/types/src/theme/useGridColorScheme.d.ts +2 -2
- package/types/src/theme/useSystemColors.d.ts +2 -2
- package/types/src/workbook/DefaultMovableRenderers.d.ts +20 -0
- package/types/src/workbook/DefaultRenderers.d.ts +3 -2
- package/types/src/workbook/IWorkbookElement.d.ts +51 -5
- package/types/src/workbook/WorkbookCommands.d.ts +2 -4
- package/types/src/workbook/WorkbookStrip.d.ts +9 -0
- package/types/src/workbook/_followOrigin.d.ts +9 -0
- package/types/src/workbook/useWorkbookFormat.d.ts +3 -3
- package/browser/cjs/Bo9Kx3L_XQkGPBJ5.cjs +0 -1
- package/browser/cjs/Pl04-kDEQSO8_qFU.cjs +0 -156
- package/browser/cjs/index.cjs +0 -35
- package/browser/esm/SJMJzBwlXTJ9QIO5.mjs +0 -6286
- 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/editor/useProtectedEditNotice.d.ts +0 -14
- package/types/src/layer/validationList.d.ts +0 -84
- package/types/src/list/SheetValueList.d.ts +0 -93
- package/types/src/list/index.d.ts +0 -2
- package/types/src/movable/MoveableBundle.d.ts +0 -4
- package/types/src/sheet/SheetElement.d.ts +0 -15
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import { IFill, IResource, IShape, IStyleCollection, ShapeStyleUtils } from '@sheetxl/sdk';
|
|
2
|
+
/** A color stop as the renderer draws it. */
|
|
3
|
+
export interface ResolvedGradientStop {
|
|
4
|
+
/** `0…1` along the gradient. */
|
|
5
|
+
offset: number;
|
|
6
|
+
/** CSS color. */
|
|
7
|
+
color: string;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* A gradient as the renderer draws it over the shape's frame: resolved colors at `0…1` offsets,
|
|
11
|
+
* and the line or the ellipse they run along, in terms of the frame.
|
|
12
|
+
*/
|
|
13
|
+
export type ResolvedGradient = {
|
|
14
|
+
kind: 'linear';
|
|
15
|
+
/**
|
|
16
|
+
* Degrees clockwise from left-to-right, DrawingML's measure (the model's is the CSS angle).
|
|
17
|
+
* With `scaled`, the direction is taken in a square and stretched to the frame, so 45° runs
|
|
18
|
+
* corner to corner (DrawingML `lin/@scaled`).
|
|
19
|
+
*/
|
|
20
|
+
angle: number;
|
|
21
|
+
scaled: boolean;
|
|
22
|
+
stops: ResolvedGradientStop[];
|
|
23
|
+
} | {
|
|
24
|
+
kind: 'radial';
|
|
25
|
+
/** The focus, as fractions of the frame's width and height. */
|
|
26
|
+
cx: number;
|
|
27
|
+
cy: number;
|
|
28
|
+
/** The radius to the farthest corner, as a fraction of the frame (an ellipse once stretched). */
|
|
29
|
+
r: number;
|
|
30
|
+
stops: ResolvedGradientStop[];
|
|
31
|
+
};
|
|
32
|
+
/**
|
|
33
|
+
* What a shape draws with, resolved to CSS: the colors a `<path>` can take and the line
|
|
34
|
+
* properties SVG strokes natively. A gradient is resolved to its stops and its line; a pattern is
|
|
35
|
+
* reduced to its foreground for now (SHAPES-PLAN, styling depth). Which fill and line apply is the
|
|
36
|
+
* model's call (`ShapeStyleUtils`); this turns its answer into what the renderer sets.
|
|
37
|
+
*/
|
|
38
|
+
export interface ResolvedShapeStyle {
|
|
39
|
+
/**
|
|
40
|
+
* CSS color, or `null` for no fill (also when the fill is an image, see `image`). For a gradient,
|
|
41
|
+
* its first stop: what draws where a gradient cannot (see `gradient`).
|
|
42
|
+
*/
|
|
43
|
+
fill: string | null;
|
|
44
|
+
/** A gradient fill, when the fill is one the renderer can draw as such. */
|
|
45
|
+
gradient?: ResolvedGradient;
|
|
46
|
+
/** An image fill: the resource to draw and how, when the shape holds the image. */
|
|
47
|
+
image?: {
|
|
48
|
+
resource: IResource;
|
|
49
|
+
fill: IFill.ImageJSON;
|
|
50
|
+
};
|
|
51
|
+
/** CSS color, or `null` for no line. For a gradient line, its first stop (see `strokeGradient`). */
|
|
52
|
+
stroke: string | null;
|
|
53
|
+
/** A gradient line, when the line's fill is one the renderer can draw as such. */
|
|
54
|
+
strokeGradient?: ResolvedGradient;
|
|
55
|
+
/** In shape-local px (points in the model). */
|
|
56
|
+
strokeWidth: number;
|
|
57
|
+
lineJoin: 'miter' | 'round' | 'bevel';
|
|
58
|
+
lineCap: 'butt' | 'round' | 'square';
|
|
59
|
+
miterLimit: number;
|
|
60
|
+
/**
|
|
61
|
+
* Alternating dash and space lengths in line widths, or `null` for a solid line. Caps are not
|
|
62
|
+
* accounted for; see {@link toDashArray}.
|
|
63
|
+
*/
|
|
64
|
+
dash: readonly number[] | null;
|
|
65
|
+
/** The text color the theme style gives, or `null` when nothing says. */
|
|
66
|
+
textColor: string | null;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* A dash as an SVG `stroke-dasharray` for a line `strokeWidth` wide, or `undefined` for solid.
|
|
70
|
+
* A round or square cap is drawn inside the dash, as Office draws it: each dash gives up a width
|
|
71
|
+
* to its caps and each space takes it, so a round-capped dot is a circle a width across.
|
|
72
|
+
*/
|
|
73
|
+
export declare const toDashArray: (dash: readonly number[] | null, strokeWidth: number, lineCap: ResolvedShapeStyle["lineCap"]) => string | undefined;
|
|
74
|
+
/** {@inheritDoc ShapeStyleUtils.inheritedGroupFill} */
|
|
75
|
+
export declare const inheritedGroupFill: typeof ShapeStyleUtils.inheritedGroupFill;
|
|
76
|
+
/**
|
|
77
|
+
* Resolves a shape's fill, line and text color to CSS: what it states itself over what its
|
|
78
|
+
* theme style gives, over Excel's defaults for a new shape. A member that takes its group's fill
|
|
79
|
+
* draws with `groupFill`.
|
|
80
|
+
*/
|
|
81
|
+
export declare const resolveShapeStyle: (json: IShape.JSON | null | undefined, styles: IStyleCollection | null, getResource?: (resourceId: number) => IResource | null, groupFill?: IFill.JSON | null) => ResolvedShapeStyle;
|
|
82
|
+
//# sourceMappingURL=shapeStyle.d.ts.map
|
|
@@ -4,7 +4,7 @@ import { ISheetHeader } from '@sheetxl/sdk';
|
|
|
4
4
|
import { Viewport, ThemeMode } from '@sheetxl/utils-react';
|
|
5
5
|
import { IGridSurface } from '@sheetxl/grid-react';
|
|
6
6
|
import { SheetCellRendererProps, ColumnButtonConfigProps } from '../cell';
|
|
7
|
-
import { SheetLocation } from './
|
|
7
|
+
import { SheetLocation } from './IWorksheetElement';
|
|
8
8
|
/**
|
|
9
9
|
* Props for the SheetHeaderElement component.
|
|
10
10
|
*/
|
|
@@ -1,54 +1,16 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import { ViewportMetrics, IShowToolTipProperties, ScrollPaneProps, Viewport, ThemeMode } from '@sheetxl/utils-react';
|
|
1
|
+
import { IWorksheet, ICell, IMovable } from '@sheetxl/sdk';
|
|
2
|
+
import { ViewportMetrics, ScrollPaneProps, Viewport, ThemeMode, LoadingPanelProps, ErrorPanelProps } from '@sheetxl/utils-react';
|
|
4
3
|
import { GridSurfaceProps, IGridSurface, IEditable, LayerNode } from '@sheetxl/grid-react';
|
|
5
|
-
import { SheetCellRendererProps, ColumnButtonConfigProps } from '../cell';
|
|
4
|
+
import { SheetCellRendererProps, ColumnButtonConfigProps, OutlineProps } from '../cell';
|
|
6
5
|
import { MovableElementProps } from '../movable';
|
|
6
|
+
import { CommentCardRenderProps } from '../comment';
|
|
7
|
+
import { HyperlinkCardRenderProps, HyperlinkLayerProps } from '../layer/HyperlinkLayer';
|
|
8
|
+
import { CellErrorTip } from '../layer/CellErrorLayer';
|
|
9
|
+
import { ValidationPrompt } from '../layer/ValidationPromptLayer';
|
|
10
|
+
import { ValidationAlert } from '../editor/validationAlert';
|
|
11
|
+
import { TableToolbarRenderProps } from '../layer/TableToolbar';
|
|
12
|
+
import { CommandContext } from '../frame';
|
|
7
13
|
import { ISheetHeaderElement, SheetHeaderProps } from './ISheetHeaderElement';
|
|
8
|
-
/**
|
|
9
|
-
* Describes how to begin an edit — the imperative "start editing" request the sheet element exposes
|
|
10
|
-
* ({@link ISheetElement.startEdit}), e.g. from a command or the formula bar. The element maps it onto
|
|
11
|
-
* the shared editable's start options.
|
|
12
|
-
*
|
|
13
|
-
* @remarks
|
|
14
|
-
* Lives here (the host that owns the request) — grid-react's editor API takes `StartEditOptions`
|
|
15
|
-
* directly and does not carry this shape.
|
|
16
|
-
*/
|
|
17
|
-
export interface StartEditEvent {
|
|
18
|
-
/**
|
|
19
|
-
* Edit text. If this is null or undefined then this will not replace the text.
|
|
20
|
-
*
|
|
21
|
-
* @defaultValue null
|
|
22
|
-
*
|
|
23
|
-
* @remarks
|
|
24
|
-
* * A '' will clear the text.
|
|
25
|
-
*/
|
|
26
|
-
text?: string;
|
|
27
|
-
/**
|
|
28
|
-
* Is editor starting in edit mode.
|
|
29
|
-
*
|
|
30
|
-
* @defaultValue false
|
|
31
|
-
*/
|
|
32
|
-
editMode?: boolean;
|
|
33
|
-
/**
|
|
34
|
-
* Allows the initial selection position to be overridden. By default it's at the end
|
|
35
|
-
*/
|
|
36
|
-
initialSelection?: {
|
|
37
|
-
start: number;
|
|
38
|
-
end: number;
|
|
39
|
-
direction?: "forward" | "backward" | "none";
|
|
40
|
-
};
|
|
41
|
-
/**
|
|
42
|
-
* Should the editor take focus when the edit starts.
|
|
43
|
-
*
|
|
44
|
-
* @defaultValue true
|
|
45
|
-
*/
|
|
46
|
-
autoFocus?: boolean;
|
|
47
|
-
/**
|
|
48
|
-
* The cell that should be edited
|
|
49
|
-
*/
|
|
50
|
-
cell?: CellCoords;
|
|
51
|
-
}
|
|
52
14
|
export interface SheetLocation {
|
|
53
15
|
clientX: number;
|
|
54
16
|
clientY: number;
|
|
@@ -59,13 +21,46 @@ export interface SheetLocation {
|
|
|
59
21
|
colIndex?: number;
|
|
60
22
|
}
|
|
61
23
|
/**
|
|
62
|
-
* Props for the
|
|
24
|
+
* Props for the WorksheetElement component.
|
|
63
25
|
*/
|
|
64
|
-
export interface
|
|
26
|
+
export interface WorksheetElementProps extends React.HTMLAttributes<HTMLDivElement>, React.Attributes {
|
|
27
|
+
/**
|
|
28
|
+
* The sheet to render, or a `Promise` for one. The element is empty until the sheet resolves and
|
|
29
|
+
* its text can be measured; a later input keeps the current sheet showing until it resolves.
|
|
30
|
+
*/
|
|
31
|
+
sheet: IWorksheet | Promise<IWorksheet>;
|
|
32
|
+
/**
|
|
33
|
+
* Called with the sheet once {@link WorksheetElementProps.sheet} resolves, and again whenever a new
|
|
34
|
+
* input resolves to a different one. Until the first input resolves, or if an input fails, the
|
|
35
|
+
* sheet is `null`.
|
|
36
|
+
*
|
|
37
|
+
* @remarks
|
|
38
|
+
* Lets an app pass a `Promise` here and hold the live sheet in its own state, without awaiting or
|
|
39
|
+
* suspending.
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* ```tsx
|
|
43
|
+
* const [pending] = useState(() => createInvoice());
|
|
44
|
+
* const [sheet, setSheet] = useState<IWorksheet | null>(null);
|
|
45
|
+
* const [total] = useCellValue<number>(sheet, 'D23');
|
|
46
|
+
* return <WorksheetElement sheet={pending} onSheetChange={setSheet} />;
|
|
47
|
+
* ```
|
|
48
|
+
*/
|
|
49
|
+
onSheetChange?: (sheet: IWorksheet | null) => void;
|
|
65
50
|
/**
|
|
66
|
-
*
|
|
51
|
+
* Props passed to the loading panel.
|
|
67
52
|
*/
|
|
68
|
-
|
|
53
|
+
propsSheetLoading?: Partial<LoadingPanelProps>;
|
|
54
|
+
/**
|
|
55
|
+
* Custom loading panel, shown while a `Promise` {@link WorksheetElementProps.sheet} resolves or the
|
|
56
|
+
* text engine loads. Defaults to a spinner.
|
|
57
|
+
*/
|
|
58
|
+
renderSheetLoading?: (props: LoadingPanelProps) => React.ReactElement;
|
|
59
|
+
/**
|
|
60
|
+
* Custom error panel, shown when a `Promise` {@link WorksheetElementProps.sheet} fails to resolve.
|
|
61
|
+
* Defaults to a minimal message.
|
|
62
|
+
*/
|
|
63
|
+
renderSheetError?: (props: ErrorPanelProps) => React.ReactElement;
|
|
69
64
|
/**
|
|
70
65
|
* The app (chrome / header) color scheme — selects the header/app surface mode.
|
|
71
66
|
*/
|
|
@@ -131,6 +126,12 @@ export interface SheetElementProps extends React.HTMLAttributes<HTMLDivElement>,
|
|
|
131
126
|
* Fire when a contentMenu is requested
|
|
132
127
|
*/
|
|
133
128
|
onSheetContextMenu?: (location: SheetLocation) => void;
|
|
129
|
+
/**
|
|
130
|
+
* Fired when a right-button drag of the fill handle is released — Excel's fill menu. Show a menu
|
|
131
|
+
* at `location` whose entries run `menu` (see {@link CommandContext.FillMenu}). Omit to leave the
|
|
132
|
+
* right-drag inert.
|
|
133
|
+
*/
|
|
134
|
+
onFillMenu?: (location: SheetLocation, menu: CommandContext.FillMenu) => void;
|
|
134
135
|
/**
|
|
135
136
|
* Called once when the sheet has been loaded but before it is rendered.
|
|
136
137
|
*/
|
|
@@ -138,7 +139,7 @@ export interface SheetElementProps extends React.HTMLAttributes<HTMLDivElement>,
|
|
|
138
139
|
/**
|
|
139
140
|
* The app-created editor for the always-mounted cell editor. When provided, the grid edits through
|
|
140
141
|
* this shared {@link IEditable}; pass the SAME instance to the formula bar for free two-way sync. A
|
|
141
|
-
* stable reference. If omitted, a standalone
|
|
142
|
+
* stable reference. If omitted, a standalone WorksheetElement makes its own.
|
|
142
143
|
*/
|
|
143
144
|
editable?: IEditable<() => ICell, string>;
|
|
144
145
|
/**
|
|
@@ -154,19 +155,52 @@ export interface SheetElementProps extends React.HTMLAttributes<HTMLDivElement>,
|
|
|
154
155
|
* @returns A React Element representing the IMovable.
|
|
155
156
|
*/
|
|
156
157
|
renderMovable?: (props: MovableElementProps) => React.ReactElement;
|
|
158
|
+
/**
|
|
159
|
+
* Renders the card of a threaded comment beside its cell: on hover, on selection, and as a draft
|
|
160
|
+
* when a command asks for one. Omit to show no card; the indicators are drawn either way.
|
|
161
|
+
*
|
|
162
|
+
* @param props - {@link CommentCardRenderProps}
|
|
163
|
+
*/
|
|
164
|
+
renderCommentCard?: (props: CommentCardRenderProps) => React.ReactNode;
|
|
165
|
+
/**
|
|
166
|
+
* Renders the card beside a hovered hyperlink cell: its address, copy, edit and remove. Omit for the
|
|
167
|
+
* plain default card.
|
|
168
|
+
*
|
|
169
|
+
* @param props - {@link HyperlinkCardRenderProps}
|
|
170
|
+
*/
|
|
171
|
+
renderHyperlinkCard?: (props: HyperlinkCardRenderProps) => React.ReactNode;
|
|
172
|
+
/** The hyperlink card's options — e.g. `preview` to show a picture of the linked page. */
|
|
173
|
+
propsHyperlink?: Omit<HyperlinkLayerProps, 'sheet' | 'renderCard'>;
|
|
174
|
+
/**
|
|
175
|
+
* Renders the tip beside a hovered cell that carries an error, a warning, a reference cycle or a
|
|
176
|
+
* failed validation. Omit for the plain default tip.
|
|
177
|
+
*
|
|
178
|
+
* @param tip - {@link CellErrorTip}
|
|
179
|
+
*/
|
|
180
|
+
renderCellErrorTip?: (tip: CellErrorTip) => React.ReactNode;
|
|
181
|
+
/**
|
|
182
|
+
* Renders the input prompt of a data validation under the selected cell. Spread `floatProps` on
|
|
183
|
+
* the returned element. Omit for the plain default box: the title in bold over the message.
|
|
184
|
+
*/
|
|
185
|
+
renderValidationPrompt?: (prompt: ValidationPrompt, floatProps: React.HTMLAttributes<HTMLElement>) => React.ReactNode;
|
|
186
|
+
/**
|
|
187
|
+
* Renders the alert a refused or questioned entry raises in the prompt's place. Spread `floatProps`
|
|
188
|
+
* on the returned element. Omit for the plain default card.
|
|
189
|
+
*/
|
|
190
|
+
renderValidationAlert?: (alert: ValidationAlert, floatProps: React.HTMLAttributes<HTMLElement>) => React.ReactNode;
|
|
191
|
+
/**
|
|
192
|
+
* Renders the toolbar that floats at a hovered table's top-right corner: a quick action and a
|
|
193
|
+
* dropdown of the table's commands. Omit for the plain default split button.
|
|
194
|
+
*
|
|
195
|
+
* @param props - {@link TableToolbarRenderProps}
|
|
196
|
+
*/
|
|
197
|
+
renderTableToolbar?: (props: TableToolbarRenderProps) => React.ReactNode;
|
|
157
198
|
/**
|
|
158
199
|
* Render element(s) directly onto the `GridSurface`, bottom → top — the same {@link LayerNode} the
|
|
159
200
|
* grid takes for its children (a node or an array of them). Each layer reads its pane from context
|
|
160
201
|
* ({@link useGridPane}); for a layer that must be built from the pane, call it in a small wrapper.
|
|
161
202
|
*/
|
|
162
203
|
layers?: LayerNode;
|
|
163
|
-
/**
|
|
164
|
-
* To show the tooltip
|
|
165
|
-
*
|
|
166
|
-
* @param props
|
|
167
|
-
*/
|
|
168
|
-
onShowTooltip?: (props: IShowToolTipProperties) => void;
|
|
169
|
-
onCloseTooltip?: () => void;
|
|
170
204
|
/**
|
|
171
205
|
* Customize the grid.
|
|
172
206
|
*
|
|
@@ -182,24 +216,25 @@ export interface SheetElementProps extends React.HTMLAttributes<HTMLDivElement>,
|
|
|
182
216
|
* This does not invalidate the rendering
|
|
183
217
|
*/
|
|
184
218
|
propsCellRender?: Partial<SheetCellRendererProps> & ColumnButtonConfigProps;
|
|
219
|
+
/**
|
|
220
|
+
* Props for the outline: the gutters that show row and column groups, and their level buttons.
|
|
221
|
+
*
|
|
222
|
+
* @remarks
|
|
223
|
+
* Omitted renderers fall back to plain, unstyled buttons.
|
|
224
|
+
*/
|
|
225
|
+
propsOutline?: OutlineProps;
|
|
185
226
|
/**
|
|
186
227
|
* Ref to the sheet element.
|
|
187
228
|
*/
|
|
188
|
-
ref?: React.Ref<
|
|
229
|
+
ref?: React.Ref<IWorksheetElement>;
|
|
189
230
|
}
|
|
190
231
|
/**
|
|
191
232
|
* Attributes and methods available on the sheet element beyond the HTMLDivElement.
|
|
192
233
|
*/
|
|
193
|
-
export type
|
|
234
|
+
export type IWorksheetAttributes = {
|
|
194
235
|
getGridSurface: () => IGridSurface;
|
|
195
236
|
getRowHeaderElement: () => ISheetHeaderElement;
|
|
196
237
|
getColumnHeaderElement: () => ISheetHeaderElement;
|
|
197
|
-
rowHeaderHeight: () => number;
|
|
198
|
-
colHeaderWidth: () => number;
|
|
199
|
-
startEdit(event?: StartEditEvent): void;
|
|
200
|
-
submitEdit(): void;
|
|
201
|
-
cancelEdit(): void;
|
|
202
|
-
isEditing: boolean;
|
|
203
238
|
contains(element: Node | null): boolean;
|
|
204
239
|
invalidate: (coords?: ICell.Coords | null) => void;
|
|
205
240
|
/**
|
|
@@ -222,14 +257,9 @@ export type ISheetAttributes = {
|
|
|
222
257
|
*/
|
|
223
258
|
focusMovable(movable?: IMovable): Promise<boolean>;
|
|
224
259
|
/**
|
|
225
|
-
* Returns the attached `
|
|
226
|
-
*/
|
|
227
|
-
getSheet: () => ISheet;
|
|
228
|
-
/**
|
|
229
|
-
* Wheel intercept (ctrl/⌘+wheel ⇒ zoom). Return `false` to consume the event. Exposed so an outer
|
|
230
|
-
* scroll wrapper can route wheel through the sheet's zoom handling.
|
|
260
|
+
* Returns the attached `IWorksheet`.
|
|
231
261
|
*/
|
|
232
|
-
|
|
262
|
+
getWorksheet: () => IWorksheet;
|
|
233
263
|
/**
|
|
234
264
|
* For runtime introspection.
|
|
235
265
|
*/
|
|
@@ -238,6 +268,6 @@ export type ISheetAttributes = {
|
|
|
238
268
|
/**
|
|
239
269
|
* Type returned via ref property
|
|
240
270
|
*/
|
|
241
|
-
export interface
|
|
271
|
+
export interface IWorksheetElement extends HTMLDivElement, IWorksheetAttributes {
|
|
242
272
|
}
|
|
243
|
-
//# sourceMappingURL=
|
|
273
|
+
//# sourceMappingURL=IWorksheetElement.d.ts.map
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IOpaqueSheet } from '@sheetxl/sdk';
|
|
3
|
+
export interface OpaqueSheetElementProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
4
|
+
/**
|
|
5
|
+
* The sheet.
|
|
6
|
+
*/
|
|
7
|
+
sheet: IOpaqueSheet;
|
|
8
|
+
/**
|
|
9
|
+
* Called once the pane has rendered, as a worksheet's grid calls it once it has.
|
|
10
|
+
*/
|
|
11
|
+
onFirstRender?: () => void;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* The pane shown for a chart sheet, a macro sheet or a dialog sheet while it is the active tab.
|
|
15
|
+
*
|
|
16
|
+
* @remarks
|
|
17
|
+
* Such a sheet is carried as read and saved unchanged; this names its kind and says so. A chart
|
|
18
|
+
* sheet's chart is drawn here once chart sheets have their chart.
|
|
19
|
+
*/
|
|
20
|
+
export declare const OpaqueSheetElement: React.FC<OpaqueSheetElementProps>;
|
|
21
|
+
//# sourceMappingURL=OpaqueSheetElement.d.ts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ReactNode } from 'react';
|
|
2
|
-
import {
|
|
3
|
-
import { Command } from '@sheetxl/utils-react';
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
import { Command, IViewport } from '@sheetxl/utils-react';
|
|
4
4
|
import { SheetEditable } from '../editor';
|
|
5
5
|
import { SheetCommandData } from './SheetCommands';
|
|
6
6
|
/** The `data` bundle for the sheet contributor — the sheet-command data plus the shared editable (for the
|
|
@@ -16,12 +16,12 @@ export interface SheetCommandContributorData extends SheetCommandData {
|
|
|
16
16
|
export declare const SheetCommandContributor: Command.CommandContributor<SheetCommandContributorData>;
|
|
17
17
|
interface SheetCommandProviderProps {
|
|
18
18
|
/** The active sheet the cell/format commands operate on. */
|
|
19
|
-
sheet:
|
|
19
|
+
sheet: IWorksheet | null;
|
|
20
20
|
/** The shared cell editable — the **ready-mode** insert commands (`insertCurrent*`/`insertFunction*`) seed
|
|
21
21
|
* an edit through it. `undefined` on a bare grid ⇒ those commands stay chrome-only (disabled). */
|
|
22
22
|
editable?: SheetEditable | null;
|
|
23
|
-
/** Hand the created `sheet` scope back to the parent (see {@link CommandScopeProvider.scopeRef})
|
|
24
|
-
*
|
|
23
|
+
/** Hand the created `sheet` scope back to the parent (see {@link CommandScopeProvider.scopeRef}), for a
|
|
24
|
+
* host that executes sheet commands directly without a provide/consume wrapper split. */
|
|
25
25
|
scopeRef?: {
|
|
26
26
|
current: Command.CommandScope | null;
|
|
27
27
|
};
|
|
@@ -38,6 +38,11 @@ interface SheetCommandProviderProps {
|
|
|
38
38
|
elementRef?: {
|
|
39
39
|
readonly current: Element | null;
|
|
40
40
|
};
|
|
41
|
+
/**
|
|
42
|
+
* The sheet's scroll controller. Zoom to Selection fits the selection into its client size (the
|
|
43
|
+
* model has no viewport size). Omitted ⇒ that command is a no-op.
|
|
44
|
+
*/
|
|
45
|
+
viewport?: IViewport;
|
|
41
46
|
children: ReactNode;
|
|
42
47
|
}
|
|
43
48
|
/**
|
|
@@ -52,6 +57,6 @@ interface SheetCommandProviderProps {
|
|
|
52
57
|
* Only the grid consumes the `sheet` scope, so it lives here (inside the workbook) rather than at studio
|
|
53
58
|
* level. Without an ambient command scope (a bare chromeless grid), this is a pass-through.
|
|
54
59
|
*/
|
|
55
|
-
export declare const SheetCommandProvider: ({ sheet, editable, scopeRef, elementRef, children }: SheetCommandProviderProps) => ReactNode;
|
|
60
|
+
export declare const SheetCommandProvider: ({ sheet, editable, scopeRef, elementRef, viewport, children }: SheetCommandProviderProps) => ReactNode;
|
|
56
61
|
export {};
|
|
57
62
|
//# sourceMappingURL=SheetCommandProvider.d.ts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { EditModeHandler, ReferenceableClipboard, RemoveListener, UndoManager } from '@sheetxl/utils';
|
|
2
|
-
import {
|
|
3
|
-
import { Command, IReactNotifier } from '@sheetxl/utils-react';
|
|
2
|
+
import { IBorders, IRange, IColor, IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
import { Command, IReactNotifier, IViewport } from '@sheetxl/utils-react';
|
|
4
4
|
import { ActivateFrameOptions, ITaskPaneArea } from '../taskPane';
|
|
5
5
|
/** Minimal shape of the global clipboard handle the insert-copied-cells path reads. */
|
|
6
6
|
interface GlobalClipboardLike {
|
|
@@ -31,19 +31,34 @@ export interface ContributeSheetCommandsOptions {
|
|
|
31
31
|
editModeHandler?: EditModeHandler;
|
|
32
32
|
/** Global clipboard — insert-cells reads a copied range reference to "insert copied cells". */
|
|
33
33
|
globalClipboard?: GlobalClipboardLike;
|
|
34
|
-
/** Persistent last-used values for the style pickers (color quick swatch + border) + memory. From the bridge's `
|
|
34
|
+
/** Persistent last-used values for the style pickers (color quick swatch + border) + memory. From the bridge's `usePersistentState`. */
|
|
35
35
|
pickerMemory?: PickerMemory;
|
|
36
|
+
/**
|
|
37
|
+
* The sheet's scroll controller — the cell area's client size, which Zoom to Selection fits the
|
|
38
|
+
* selection into. The model has no viewport size, so it cannot do this itself. Omitted ⇒ the command
|
|
39
|
+
* is a no-op (a bare grid).
|
|
40
|
+
*/
|
|
41
|
+
viewport?: IViewport;
|
|
36
42
|
}
|
|
37
43
|
/**
|
|
38
44
|
* The single `data` bundle {@link contributeSheetCommands} takes — the sheet **and** its services
|
|
39
45
|
* together (the `DynamicCommandContributor` shape). `sheet` may be `null` on a bare grid (⇒ no behavior).
|
|
40
46
|
*/
|
|
41
47
|
export interface SheetCommandData extends ContributeSheetCommandsOptions {
|
|
42
|
-
sheet:
|
|
48
|
+
sheet: IWorksheet | null;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* The arguments of the `freezePanesAt` command.
|
|
52
|
+
*/
|
|
53
|
+
export interface FreezePanesAtArgs {
|
|
54
|
+
/** The axis to move: `Column` moves the vertical freeze line, `Row` the horizontal one. */
|
|
55
|
+
axis: IRange.Axis;
|
|
56
|
+
/** The number of rows or columns to freeze. `0` unfreezes the axis; the other axis is left as it is. */
|
|
57
|
+
index: number;
|
|
43
58
|
}
|
|
44
59
|
/**
|
|
45
60
|
* Persistent "last used" values for the style pickers — the quick swatch (`quickColor`/`quickBorder`) and the
|
|
46
|
-
* `onColorSelect`/`onBorderSelect` memory. Owned by the bridge (`
|
|
61
|
+
* `onColorSelect`/`onBorderSelect` memory. Owned by the bridge (`usePersistentState`) and passed as **live
|
|
47
62
|
* getters** so the lazy `context` closures read the current value without re-contributing. Only fill/font
|
|
48
63
|
* color + border persist; the tab/gridline color pickers don't (their `onColorSelect` is a no-op).
|
|
49
64
|
*/
|
|
@@ -52,8 +67,8 @@ export interface PickerMemory {
|
|
|
52
67
|
setLastFillColor?: (color: IColor | null) => void;
|
|
53
68
|
getLastFontColor?: () => IColor | null;
|
|
54
69
|
setLastFontColor?: (color: IColor | null) => void;
|
|
55
|
-
getLastBorder?: () => Partial<
|
|
56
|
-
setLastBorder?: (border: Partial<
|
|
70
|
+
getLastBorder?: () => Partial<IBorders.Properties> | null;
|
|
71
|
+
setLastBorder?: (border: Partial<IBorders.Properties> | null) => void;
|
|
57
72
|
}
|
|
58
73
|
/**
|
|
59
74
|
* The per-sheet command **behavior** (paired with {@link registerSheetDefinitions}). A plain
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ISheet } from '@sheetxl/sdk';
|
|
3
|
+
export interface SheetKindIconProps extends React.HTMLAttributes<HTMLElement> {
|
|
4
|
+
/**
|
|
5
|
+
* The kind of sheet.
|
|
6
|
+
*/
|
|
7
|
+
kind: ISheet.Kind;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* The glyph that marks a sheet of a kind other than a worksheet: on its tab, in sheet lists, and on
|
|
11
|
+
* its pane. A worksheet has none, so it renders nothing.
|
|
12
|
+
*/
|
|
13
|
+
export declare const SheetKindIcon: React.FC<SheetKindIconProps>;
|
|
14
|
+
//# sourceMappingURL=SheetKindIcon.d.ts.map
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { FixedEdge } from '@sheetxl/utils';
|
|
3
|
+
import { IRange, IWorksheet } from '@sheetxl/sdk';
|
|
4
|
+
import { Viewport, ThemeMode } from '@sheetxl/utils-react';
|
|
5
|
+
import { OutlineButtonProps, OutlineLevelButtonProps } from '../cell/OutlineButton';
|
|
6
|
+
export interface SheetOutlineElementProps extends React.HTMLAttributes<HTMLElement> {
|
|
7
|
+
/** The sheet whose outline is drawn. */
|
|
8
|
+
sheet: IWorksheet;
|
|
9
|
+
/** Rows (the gutter left of the row headers) or columns (above the column headers). */
|
|
10
|
+
axis: IRange.Axis;
|
|
11
|
+
/** The lanes across the gutter: one per level, plus one. */
|
|
12
|
+
lanes: number;
|
|
13
|
+
/** The gutter's thickness across the axis, in pixels. */
|
|
14
|
+
thickness: number;
|
|
15
|
+
/** The headers frozen at the start of the axis. */
|
|
16
|
+
freezeStart?: number | FixedEdge;
|
|
17
|
+
/** The sheet's main viewport; the gutter follows it along the axis. */
|
|
18
|
+
viewport?: Viewport;
|
|
19
|
+
/** The app color scheme. */
|
|
20
|
+
colorScheme?: ThemeMode;
|
|
21
|
+
/** Renders a group's collapse / expand button. Defaults to `OutlineButton`. */
|
|
22
|
+
renderButton?: (props: OutlineButtonProps) => React.ReactNode;
|
|
23
|
+
/** The space around the buttons, in pixels: between neighbors, before the first and after the last. */
|
|
24
|
+
laneGap?: number;
|
|
25
|
+
/** Space between a bracket's end and its button, in pixels. */
|
|
26
|
+
bracketGap?: number;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* The outline gutter for one axis: the brackets and collapse buttons of the row or column groups.
|
|
30
|
+
*
|
|
31
|
+
* @remarks
|
|
32
|
+
* Built like `SheetHeaderElement` — its own `GridSurface` over the header's offsets, following the
|
|
33
|
+
* sheet's viewport along the axis, so it scrolls, zooms, hides and freezes with the headers. The
|
|
34
|
+
* owner decides whether there is one (see `IWorksheetView.isShowOutlineSymbols` and `getLevelCount`) and sizes
|
|
35
|
+
* it.
|
|
36
|
+
*
|
|
37
|
+
* It is app chrome, not header: it declares the `app` surface and paints no fill, so it shows what
|
|
38
|
+
* the sheet sits on, as the level buttons beside it do.
|
|
39
|
+
*/
|
|
40
|
+
export declare const SheetOutlineElement: React.MemoExoticComponent<(props: SheetOutlineElementProps) => React.JSX.Element>;
|
|
41
|
+
export interface SheetOutlineLevelsProps extends React.HTMLAttributes<HTMLElement> {
|
|
42
|
+
/** The sheet whose outline the buttons show levels of. */
|
|
43
|
+
sheet: IWorksheet;
|
|
44
|
+
/** Rows or columns. */
|
|
45
|
+
axis: IRange.Axis;
|
|
46
|
+
/** The number of buttons: one per level, plus one. */
|
|
47
|
+
lanes: number;
|
|
48
|
+
/** The size of one lane, in pixels. */
|
|
49
|
+
laneSize: number;
|
|
50
|
+
/**
|
|
51
|
+
* The space around the buttons, in pixels: between neighbors, before the first and after the last.
|
|
52
|
+
*
|
|
53
|
+
* @defaultValue 1
|
|
54
|
+
*/
|
|
55
|
+
laneGap?: number;
|
|
56
|
+
/** The app color scheme. */
|
|
57
|
+
colorScheme?: ThemeMode;
|
|
58
|
+
/** Renders a level button. Defaults to `OutlineLevelButton`. */
|
|
59
|
+
renderLevelButton?: (props: OutlineLevelButtonProps) => React.ReactNode;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* The level buttons `1`..`n` for one axis: button *k* shows the groups above level *k* and collapses
|
|
63
|
+
* the rest (`IOutline.setVisibleLevels`).
|
|
64
|
+
*
|
|
65
|
+
* @remarks
|
|
66
|
+
* Row buttons run across the row gutter (beside the column headers); column buttons run down the
|
|
67
|
+
* column gutter (beside the row headers), one per lane.
|
|
68
|
+
*/
|
|
69
|
+
export declare const SheetOutlineLevels: React.MemoExoticComponent<(props: SheetOutlineLevelsProps) => React.JSX.Element>;
|
|
70
|
+
//# sourceMappingURL=SheetOutlineElement.d.ts.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ErrorPanelProps, LoadingPanelProps } from '@sheetxl/utils-react';
|
|
3
|
+
/**
|
|
4
|
+
* The default loading panel of a sheet or workbook element: a spinner, centered.
|
|
5
|
+
*/
|
|
6
|
+
export declare const renderSheetLoading: (props: LoadingPanelProps) => React.ReactElement;
|
|
7
|
+
/**
|
|
8
|
+
* The default error panel of a sheet or workbook element: the error's message, centered.
|
|
9
|
+
*/
|
|
10
|
+
export declare const renderSheetError: (props: ErrorPanelProps) => React.ReactElement;
|
|
11
|
+
//# sourceMappingURL=SheetPanels.d.ts.map
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
3
|
-
import { ScrollbarOrientation, VirtualScrollbarProps, IScrollbarElement
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
import { ScrollbarOrientation, VirtualScrollbarProps, IScrollbarElement } from '@sheetxl/utils-react';
|
|
4
4
|
export interface SheetScrollbarProps extends VirtualScrollbarProps {
|
|
5
5
|
/**
|
|
6
|
-
* The `
|
|
6
|
+
* The `IWorksheet` for the given scrollbar.
|
|
7
7
|
*/
|
|
8
|
-
sheet:
|
|
8
|
+
sheet: IWorksheet;
|
|
9
9
|
/**
|
|
10
10
|
* The direction of the scrollbar.
|
|
11
11
|
*/
|
|
@@ -14,15 +14,6 @@ export interface SheetScrollbarProps extends VirtualScrollbarProps {
|
|
|
14
14
|
* @defaultValue false
|
|
15
15
|
*/
|
|
16
16
|
showCustomScrollButtons?: boolean;
|
|
17
|
-
/**
|
|
18
|
-
* To show the tooltip
|
|
19
|
-
* @param properties
|
|
20
|
-
*/
|
|
21
|
-
onShowTooltip?: (properties: IShowToolTipProperties) => void;
|
|
22
|
-
/**
|
|
23
|
-
* Called to close the tooltip. Required is onShowTip is provided
|
|
24
|
-
*/
|
|
25
|
-
onCloseTooltip?: () => void;
|
|
26
17
|
}
|
|
27
18
|
export declare const SheetScrollbar: React.NamedExoticComponent<Omit<SheetScrollbarProps, "ref"> & React.RefAttributes<IScrollbarElement>>;
|
|
28
19
|
//# sourceMappingURL=SheetScrollbar.d.ts.map
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
3
|
import { ThemeMode } from '@sheetxl/utils-react';
|
|
4
4
|
export interface TopLeftCornerProps extends React.HTMLProps<HTMLElement> {
|
|
5
|
-
sheet:
|
|
5
|
+
sheet: IWorksheet;
|
|
6
6
|
/** The app (header) color scheme — headers follow the app surface; colors come from the header-surface
|
|
7
7
|
* tokens. */
|
|
8
8
|
colorScheme?: ThemeMode;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IWorksheetElement, WorksheetElementProps } from './IWorksheetElement';
|
|
3
|
+
/**
|
|
4
|
+
* UI representation for IWorksheet.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* It draws once the sheet has resolved and the text engine has loaded, so a sheet with no workbook
|
|
8
|
+
* needs no `whenReady()` first. Until then its box shows the loading panel, or the error panel if the
|
|
9
|
+
* sheet fails.
|
|
10
|
+
*/
|
|
11
|
+
export declare const WorksheetElement: React.NamedExoticComponent<Omit<WorksheetElementProps, "ref"> & React.RefAttributes<IWorksheetElement>>;
|
|
12
|
+
//# sourceMappingURL=WorksheetElement.d.ts.map
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { IWorksheetView, IRange } from '@sheetxl/sdk';
|
|
2
|
+
/**
|
|
3
|
+
* Move one axis's freeze to `index` (`0` unfreezes that axis), leaving the other axis as it is.
|
|
4
|
+
*
|
|
5
|
+
* Each frozen area keeps the start it already has; an axis that becomes frozen starts at the scrolled
|
|
6
|
+
* position. Either way what is on screen stays put — provided the scrolling area starts exactly at the
|
|
7
|
+
* current freeze, which is when the freeze grip allows a drag.
|
|
8
|
+
*/
|
|
9
|
+
export declare const freezeAt: (view: IWorksheetView, axis: IRange.Axis, index: number) => void;
|
|
10
|
+
//# sourceMappingURL=_freezeAt.d.ts.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { ISheetHeader } from '@sheetxl/sdk';
|
|
2
|
+
/**
|
|
3
|
+
* The header's metrics as last announced: replaced on `onMetricsChange` (heard once the operation that
|
|
4
|
+
* changed them closes), not read fresh on every render. Everything that lays out from the returned
|
|
5
|
+
* metrics agrees, whatever re-renders in between.
|
|
6
|
+
*
|
|
7
|
+
* @returns The held metrics, and `refresh` to take the header's current metrics early — e.g. on each
|
|
8
|
+
* move of a resize drag, while its operation is still open.
|
|
9
|
+
*/
|
|
10
|
+
export declare const useHeaderMetrics: (header: ISheetHeader) => [ISheetHeader.IMetrics, () => void];
|
|
11
|
+
//# sourceMappingURL=_useHeaderMetrics.d.ts.map
|