@sheetxl/react 0.8.0-beta.10 → 0.8.0-beta.12
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/B4mT3G7GHwgDYFGP.mjs +128 -0
- package/browser/esm/{BwRduT8FTrk5n72r.mjs → BDlpRkuBok0Uu4Hn.mjs} +1 -1
- package/browser/esm/BR-AiOwuQlYh5-tr.mjs +730 -0
- package/browser/esm/{BuvXl14hs-1CvjeA.mjs → BapujiblfiXDlu67.mjs} +1 -1
- package/browser/esm/{DyU9UInRnfkPYYlR.mjs → CSFORKZ8zrVL_Y0w.mjs} +1 -1
- package/browser/esm/CUekkfE6uwwsdQpc.mjs +36 -0
- package/browser/esm/C_LUq-BnguetvGZz.mjs +23561 -0
- package/browser/esm/{BZcQ-KYwS62Ut45c.mjs → Ck1LbcsdSfKNi6xq.mjs} +1 -1
- package/browser/esm/{CYoUd5KIl7W3AsxH.mjs → Cslk_qRdBSuJIi1O.mjs} +24 -23
- package/browser/esm/CtGhA0kS2MCfEsHN.mjs +262 -0
- package/browser/esm/D22NJmTiky4NL8tM.mjs +8 -0
- package/browser/esm/D2GydDzPuvIjdpok.mjs +42 -0
- package/browser/esm/DGG1auUKsjFbAazu.mjs +60 -0
- package/browser/esm/{Cfe0kofqVKGxLqO6.mjs → DN3lqq95KY0K6f1x.mjs} +1 -1
- package/browser/esm/{DjiBz4H74I6nPUY6.mjs → D_usN3pWuCJU2GN-.mjs} +2 -2
- package/browser/esm/{Sp6PJavGKpF8SJzA.mjs → DhYQRc8L2kALmFNz.mjs} +1 -1
- package/browser/esm/{Bow9CzRJrYxak2i5.mjs → DxEczXCHTerDemDP.mjs} +113 -108
- package/browser/esm/{Dd-ZybXAgoq9pgGv.mjs → LBQDhVhz7S7i6a8i.mjs} +1 -1
- package/browser/esm/{C6urN77szrYwODXF.mjs → ZoS0cpNEBcv6p-Z1.mjs} +1 -1
- package/browser/esm/{cYjYjqEsyd63x8t4.mjs → _6Sb6ElRcZftxMNh.mjs} +1 -1
- package/browser/esm/chart.mjs +33 -52
- package/browser/esm/control.mjs +2 -2
- package/browser/esm/group.mjs +3 -3
- package/browser/esm/index.mjs +8074 -5647
- package/browser/esm/note.mjs +73 -47
- package/browser/esm/picture.mjs +41 -41
- package/browser/esm/shape.mjs +2 -2
- package/browser/esm/slicer.mjs +5 -5
- package/licenses/dependencies.txt +313 -1
- package/node/esm/{Dxbm6ryIDCEi26RO.mjs → Apcuz4_QtBHt7G47.mjs} +1 -1
- package/node/esm/Bi2Jwc0zpweaNzKc.mjs +1697 -0
- package/node/esm/{Buw-VKYJy3y5dbaJ.mjs → C0KLMCRb3sbd5Q20.mjs} +23 -22
- package/node/esm/CH1DVfFhjdd_3pw1.mjs +128 -0
- package/node/esm/{BJ7ZZm63j5O6cvrB.mjs → CNOLkUDURBElaaIf.mjs} +1 -1
- package/node/esm/{DhSq680c5tgMFFbj.mjs → CalVk3o4-kX79s3v.mjs} +1 -1
- package/node/esm/{DYosMUJKp-3MSO4q.mjs → Cp1DuCae46eQKzWy.mjs} +1 -1
- package/node/esm/CzN6c6KyxVmNvayz.mjs +8 -0
- package/node/esm/DKqdv5JubgVaq-g9.mjs +35 -0
- package/node/esm/DWkPWuf5ZrLRMixG.mjs +328 -0
- package/node/esm/{BfRn5S5V4X8xIAEa.mjs → DXiNwr6ZnXBe7TlG.mjs} +1 -1
- package/node/esm/DayGI0Bt57FDNbVF.mjs +37 -0
- package/node/esm/{CM5BT7h-hMtST2bE.mjs → DyetXBW7vFLJWB22.mjs} +1 -1
- package/node/esm/{CFFlJxNwgyInjEnh.mjs → MWges5ywL3aEdChp.mjs} +1 -1
- package/node/esm/{DPN0n6MGYQ9vZ2KO.mjs → T5lfCrudsUnOTxEn.mjs} +1 -1
- package/node/esm/YB_qExw23Ci4nMYy.mjs +263 -0
- package/node/esm/{GkmuxU7OwRZtm2Rf.mjs → bRD1KCpSpAYTEs50.mjs} +1 -1
- package/node/esm/chart.mjs +32 -51
- package/node/esm/control.mjs +2 -2
- package/node/esm/group.mjs +3 -3
- package/node/esm/{C_ANM4feA1xV-pri.mjs → iL9jKJcnED6oi0B4.mjs} +1 -1
- package/node/esm/index.mjs +10998 -8556
- package/node/esm/note.mjs +86 -60
- package/node/esm/picture.mjs +41 -41
- package/node/esm/shape.mjs +285 -332
- package/node/esm/slicer.mjs +15 -15
- package/package.json +8 -6
- package/resources/contents.json +6 -0
- package/resources/locales/contents.json +14 -0
- package/resources/locales/de/chart.cmd.json +82 -0
- package/resources/locales/de/sheet.cmd.json +32 -0
- package/resources/locales/de/table.cmd.json +1 -1
- package/resources/locales/de/ui.msg.json +12 -0
- package/resources/locales/de/workbook.cmd.json +11 -0
- package/resources/locales/en/chart.cmd.json +82 -0
- package/resources/locales/en/sheet.cmd.json +32 -0
- package/resources/locales/en/table.cmd.json +1 -1
- package/resources/locales/en/ui.msg.json +14 -0
- package/resources/locales/en/workbook.cmd.json +11 -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 +76 -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} +9 -6
- package/types/src/cell/ColumnButton.d.ts +3 -3
- package/types/src/cell/OutlineButton.d.ts +4 -4
- package/types/src/cell/SheetHeaderRenderer.d.ts +1 -1
- package/types/src/cell/index.d.ts +8 -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 -0
- 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/_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 +12 -0
- package/types/src/chart/paint/toEChartsOption.d.ts +42 -0
- package/types/src/clipboard/ClipboardCommands.d.ts +3 -3
- package/types/src/clipboard/SheetClipboardLayer.d.ts +2 -2
- package/types/src/comment/CommentCardRequest.d.ts +9 -9
- package/types/src/comment/useSheetComments.d.ts +2 -2
- package/types/src/context/WorksheetContext.d.ts +18 -0
- package/types/src/context/index.d.ts +1 -1
- 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 -2
- package/types/src/editor/SheetCellEditorStartLayer.d.ts +22 -5
- 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 +49 -0
- package/types/src/editor/formulaAnchor.d.ts +12 -0
- package/types/src/editor/index.d.ts +1 -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/validationAlert.d.ts +3 -3
- package/types/src/frame/CommandContext.d.ts +7 -7
- package/types/src/index.d.ts +2 -0
- package/types/src/layer/BorderLayer.d.ts +2 -2
- package/types/src/layer/CellErrorLayer.d.ts +5 -4
- 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 +2 -2
- package/types/src/layer/CommentCardLayer.d.ts +2 -2
- package/types/src/layer/CommentsLayer.d.ts +2 -2
- package/types/src/layer/ConditionalBarLayer.d.ts +2 -2
- package/types/src/layer/ConditionalIconsLayer.d.ts +2 -2
- package/types/src/layer/ContextMenuLayer.d.ts +2 -2
- package/types/src/layer/GridFreezeLayer.d.ts +2 -2
- package/types/src/layer/HeaderSelectionLayer.d.ts +4 -4
- package/types/src/layer/HyperlinkLayer.d.ts +11 -8
- package/types/src/layer/MovableKindScope.d.ts +2 -2
- package/types/src/layer/ProtectionLayer.d.ts +4 -5
- package/types/src/layer/RangeAnnotationLayer.d.ts +2 -2
- package/types/src/layer/ResizeIndicator.d.ts +2 -2
- 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 +11 -13
- package/types/src/layer/SheetLayers.d.ts +115 -0
- package/types/src/layer/SheetMovableLayer.d.ts +4 -3
- package/types/src/layer/SheetOutlineLayer.d.ts +3 -3
- 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 +3 -3
- package/types/src/layer/TableToolbar.d.ts +4 -4
- 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 +21 -8
- package/types/src/layer/_tableColor.d.ts +2 -2
- package/types/src/layer/index.d.ts +3 -0
- package/types/src/layer/useFreezeDrag.d.ts +2 -2
- 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 +2 -2
- 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/DefaultMovable.d.ts +8 -0
- package/types/src/movable/MovableCommands.d.ts +2 -2
- package/types/src/movable/MovableControl.d.ts +3 -1
- package/types/src/movable/MovableFrame.d.ts +2 -1
- package/types/src/movable/MovableLayer.d.ts +6 -3
- package/types/src/movable/MovableRenderers.d.ts +3 -3
- package/types/src/movable/index.d.ts +1 -0
- package/types/src/picker/cellPickerOpen.d.ts +3 -3
- package/types/src/picker/useCellPicker.d.ts +2 -2
- 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 +2 -2
- package/types/src/sheet/ISheetHeaderElement.d.ts +3 -3
- package/types/src/sheet/{ISheetElement.d.ts → IWorksheetElement.d.ts} +64 -32
- package/types/src/sheet/OpaqueSheetElement.d.ts +21 -0
- package/types/src/sheet/SheetCommandProvider.d.ts +5 -2
- package/types/src/sheet/SheetCommands.d.ts +2 -2
- package/types/src/sheet/SheetKindIcon.d.ts +14 -0
- package/types/src/sheet/SheetOutlineElement.d.ts +6 -6
- package/types/src/sheet/SheetPanels.d.ts +11 -0
- package/types/src/sheet/SheetScrollbar.d.ts +3 -3
- 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 +2 -2
- package/types/src/sheet/circularReferences.d.ts +3 -3
- package/types/src/sheet/index.d.ts +5 -2
- package/types/src/sheet/useCycleHighlight.d.ts +2 -2
- 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 +6 -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 +17 -0
- package/types/src/taskPane/TaskPaneArea.d.ts +7 -0
- package/types/src/taskPane/index.d.ts +1 -0
- package/types/src/taskPane/useTaskPane.d.ts +6 -3
- package/types/src/theme/buildOOXMLThemeCSS.d.ts +2 -2
- package/types/src/theme/useGridColorScheme.d.ts +1 -1
- package/types/src/theme/useSystemColors.d.ts +2 -2
- package/types/src/workbook/DefaultRenderers.d.ts +5 -4
- package/types/src/workbook/IWorkbookElement.d.ts +76 -22
- package/types/src/workbook/WorkbookStrip.d.ts +5 -5
- package/browser/esm/BHjeSMaycUkS5dVL.mjs +0 -66
- package/browser/esm/CYMRbtPIr6SklGpp.mjs +0 -775
- package/browser/esm/CiRN-woJZWYOgTn4.mjs +0 -36
- package/browser/esm/J8cPagZBeXz86Lnd.mjs +0 -777
- package/node/esm/BpwE3HqTnrLLzE3C.mjs +0 -775
- package/node/esm/CV3bT3Hql74GcHoU.mjs +0 -37
- package/node/esm/D3YXHeOyFp00Xk3m.mjs +0 -323
- 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/sheet/SheetElement.d.ts +0 -15
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { ChartPaintKind } from './ChartPaintKind';
|
|
2
|
+
/**
|
|
3
|
+
* Registers the painters the package ships, through the same door a host's kind comes in by.
|
|
4
|
+
* Called by the translation before its first use.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* The built-ins name no ECharts modules of their own: `echarts.ts`, the lazy painter, brings the
|
|
8
|
+
* series types they use when it registers ECharts' pieces, so this module and the kinds stay free
|
|
9
|
+
* of ECharts and the package index stays light (DESIGN-CHART §7).
|
|
10
|
+
*/
|
|
11
|
+
export declare function registerBuiltInPaintKinds(register: (kind: ChartPaintKind) => () => void): void;
|
|
12
|
+
//# sourceMappingURL=_builtIns.d.ts.map
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import { EChartsCoreOption } from 'echarts/core';
|
|
2
|
+
import { ChartLayout } from '@sheetxl/sdk';
|
|
3
|
+
/**
|
|
4
|
+
* How the layout is translated.
|
|
5
|
+
*/
|
|
6
|
+
export interface TranslateOptions {
|
|
7
|
+
/**
|
|
8
|
+
* Whether the chart answers the pointer: tooltips. Off when rendering headless.
|
|
9
|
+
* @defaultValue true
|
|
10
|
+
*/
|
|
11
|
+
interactive?: boolean;
|
|
12
|
+
/**
|
|
13
|
+
* How the legend is drawn: by ECharts' `legend` component placed at the layout's rect, which
|
|
14
|
+
* flows the entries itself, or as `graphic` elements at exactly the layout's entry rects.
|
|
15
|
+
* @defaultValue 'graphic'
|
|
16
|
+
*/
|
|
17
|
+
legend?: 'native' | 'graphic';
|
|
18
|
+
/**
|
|
19
|
+
* Whether the chart is drawn as a dark grid draws its cells: each color through `IColor.toRGBA(true)`.
|
|
20
|
+
* @defaultValue false
|
|
21
|
+
*/
|
|
22
|
+
darkMode?: boolean;
|
|
23
|
+
/**
|
|
24
|
+
* What a chart area that states no fill is filled with, light: the background of where it is
|
|
25
|
+
* drawn. `'transparent'` leaves it to what is behind the chart.
|
|
26
|
+
* @defaultValue '#FFFFFF'
|
|
27
|
+
*/
|
|
28
|
+
background?: string;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Translates a {@link ChartLayout} to an ECharts option.
|
|
32
|
+
*
|
|
33
|
+
* @remarks
|
|
34
|
+
* A translation table and nothing else (DESIGN-CHART §2): the grid is the plot rect in px with
|
|
35
|
+
* `containLabel:false`; value axes get `min`, `max` and `interval` and a formatter that answers
|
|
36
|
+
* the layout's strings; bars get `barWidth` in px and `barGap` from the overlap; every DrawingML
|
|
37
|
+
* axis is an ECharts axis, a deleted one with `show:false`. Nothing is left for ECharts to decide.
|
|
38
|
+
*/
|
|
39
|
+
export declare function toEChartsOption(layout: ChartLayout, options?: TranslateOptions): EChartsCoreOption;
|
|
40
|
+
/** A concrete color for ECharts: it parses colors, so a CSS variable would not do. */
|
|
41
|
+
export declare const isConcreteColor: (color: string) => boolean;
|
|
42
|
+
//# sourceMappingURL=toEChartsOption.d.ts.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { EditModeHandler, ReferenceableClipboard, RemoveListener } from '@sheetxl/utils';
|
|
2
|
-
import { ICellRange,
|
|
2
|
+
import { ICellRange, IWorksheet } from '@sheetxl/sdk';
|
|
3
3
|
import { Command, IReactNotifier } from '@sheetxl/utils-react';
|
|
4
4
|
export interface SheetPasteOptions extends ReferenceableClipboard.PasteOptions, ICellRange.CopyOptions {
|
|
5
5
|
}
|
|
@@ -57,11 +57,11 @@ export interface ContributeClipboardCommandsOptions {
|
|
|
57
57
|
*
|
|
58
58
|
* **Standalone:** this module owns *everything* about its commands — definitions, behavior, enablement
|
|
59
59
|
* (protection-disable), and the marquee view — with **no dependency on SheetCommands** (it reads only the
|
|
60
|
-
* generic `
|
|
60
|
+
* generic `IWorksheet` model). It's the shape a third-party clipboard would take: sheet knows nothing about it.
|
|
61
61
|
*/
|
|
62
62
|
/** The single `data` bundle {@link contributeClipboardCommands} takes (the `DynamicCommandContributor` shape). */
|
|
63
63
|
export interface ClipboardCommandData extends ContributeClipboardCommandsOptions {
|
|
64
|
-
sheet:
|
|
64
|
+
sheet: IWorksheet;
|
|
65
65
|
}
|
|
66
66
|
export declare function contributeClipboardCommands(contribution: Command.CommandContribution, data: ClipboardCommandData): RemoveListener;
|
|
67
67
|
export {};
|
|
@@ -1,8 +1,8 @@
|
|
|
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 SheetClipboardLayerProps extends LayerProps {
|
|
5
|
-
sheet:
|
|
5
|
+
sheet: IWorksheet;
|
|
6
6
|
/** Class for the marquee visuals (devtools identification). */
|
|
7
7
|
className?: string;
|
|
8
8
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { CellCoords } from '@sheetxl/utils';
|
|
2
|
-
import { IComment,
|
|
2
|
+
import { IComment, IWorksheet } from '@sheetxl/sdk';
|
|
3
3
|
/**
|
|
4
4
|
* What a comments task pane is asked to open on — `activateTaskPane('comments', { args })`.
|
|
5
5
|
*/
|
|
@@ -18,7 +18,7 @@ export interface CommentsPaneArgs {
|
|
|
18
18
|
*/
|
|
19
19
|
export interface CommentCardRenderProps {
|
|
20
20
|
/** The sheet the card's cell is on. */
|
|
21
|
-
sheet:
|
|
21
|
+
sheet: IWorksheet;
|
|
22
22
|
/** The cell the card belongs to. */
|
|
23
23
|
coords: CellCoords;
|
|
24
24
|
/** The thread on the cell, or `null` for a draft: a comment that has not been posted. */
|
|
@@ -60,25 +60,25 @@ export interface RequestCommentCardOptions {
|
|
|
60
60
|
* request is {@link clearCommentCard | cleared}, which the layer drawing it does when the selection
|
|
61
61
|
* leaves the cell. A draft writes nothing until it is posted.
|
|
62
62
|
*/
|
|
63
|
-
export declare const requestCommentCard: (sheet:
|
|
63
|
+
export declare const requestCommentCard: (sheet: IWorksheet, coords: CellCoords, options?: RequestCommentCardOptions) => void;
|
|
64
64
|
/**
|
|
65
65
|
* Takes back a {@link requestCommentCard | request}; a draft that was not posted is dropped.
|
|
66
66
|
*/
|
|
67
|
-
export declare const clearCommentCard: (sheet:
|
|
67
|
+
export declare const clearCommentCard: (sheet: IWorksheet) => void;
|
|
68
68
|
/**
|
|
69
69
|
* The cell whose card is asked for on the sheet, or `null` for none.
|
|
70
70
|
*/
|
|
71
|
-
export declare const getCommentCardRequest: (sheet:
|
|
71
|
+
export declare const getCommentCardRequest: (sheet: IWorksheet) => CommentCardRequest | null;
|
|
72
72
|
/**
|
|
73
73
|
* Whether anything draws the sheet's comment cards. A command falls back to the comments task pane
|
|
74
74
|
* when nothing does.
|
|
75
75
|
*/
|
|
76
|
-
export declare const hasCommentCard: (sheet:
|
|
76
|
+
export declare const hasCommentCard: (sheet: IWorksheet) => boolean;
|
|
77
77
|
/**
|
|
78
78
|
* Listens for the sheet's card request changing. Whatever draws the cards listens; the returned
|
|
79
79
|
* function stops listening.
|
|
80
80
|
*/
|
|
81
|
-
export declare const addCommentCardListener: (sheet:
|
|
81
|
+
export declare const addCommentCardListener: (sheet: IWorksheet, listener: () => void) => (() => void);
|
|
82
82
|
/**
|
|
83
83
|
* The cell a draft is open on: a requested card whose cell has no comment yet. `null` for none.
|
|
84
84
|
*
|
|
@@ -86,9 +86,9 @@ export declare const addCommentCardListener: (sheet: ISheet, listener: () => voi
|
|
|
86
86
|
* For what marks the cell while its comment is being written. Following this does not count as
|
|
87
87
|
* drawing the cards, so {@link hasCommentCard} is unchanged by it.
|
|
88
88
|
*/
|
|
89
|
-
export declare const useCommentDraftCell: (sheet:
|
|
89
|
+
export declare const useCommentDraftCell: (sheet: IWorksheet) => CommentCardRequest | null;
|
|
90
90
|
/**
|
|
91
91
|
* {@link getCommentCardRequest}, kept current.
|
|
92
92
|
*/
|
|
93
|
-
export declare const useCommentCardRequest: (sheet:
|
|
93
|
+
export declare const useCommentCardRequest: (sheet: IWorksheet) => CommentCardRequest | null;
|
|
94
94
|
//# sourceMappingURL=CommentCardRequest.d.ts.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IComment,
|
|
1
|
+
import { IComment, IWorksheet } from '@sheetxl/sdk';
|
|
2
2
|
/**
|
|
3
3
|
* Options for {@link useSheetComments}.
|
|
4
4
|
*/
|
|
@@ -24,5 +24,5 @@ export interface UseSheetCommentsOptions {
|
|
|
24
24
|
* return <ul>{open.map((comment) => <li key={comment.getId()}>{comment.getContent()}</li>)}</ul>;
|
|
25
25
|
* ```
|
|
26
26
|
*/
|
|
27
|
-
export declare const useSheetComments: (sheet:
|
|
27
|
+
export declare const useSheetComments: (sheet: IWorksheet | null, options?: UseSheetCommentsOptions) => IComment[];
|
|
28
28
|
//# sourceMappingURL=useSheetComments.d.ts.map
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { default as React, ReactNode } from 'react';
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
export type WorksheetProviderProps = {
|
|
4
|
+
sheet: IWorksheet | null;
|
|
5
|
+
children: ReactNode;
|
|
6
|
+
};
|
|
7
|
+
/**
|
|
8
|
+
* Provides a sheet to descendants.
|
|
9
|
+
*
|
|
10
|
+
* Notes:
|
|
11
|
+
* - Prefer passing the sheet object as a stable reference from the host.
|
|
12
|
+
*/
|
|
13
|
+
export declare function WorksheetProvider(props: WorksheetProviderProps): React.JSX.Element;
|
|
14
|
+
/**
|
|
15
|
+
* Hook consumers call to access the current sheet.
|
|
16
|
+
*/
|
|
17
|
+
export declare function useWorksheet(): IWorksheet | null;
|
|
18
|
+
//# sourceMappingURL=WorksheetContext.d.ts.map
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
+
import { RenderSlotFn } from '@sheetxl/utils-react';
|
|
2
3
|
export interface EditableLabelAttributes {
|
|
3
4
|
startEdit(): void;
|
|
4
5
|
cancel(): void;
|
|
@@ -18,7 +19,8 @@ export interface EditableLabelProps extends Omit<React.HTMLAttributes<HTMLDivEle
|
|
|
18
19
|
onChange?: (value: string) => void;
|
|
19
20
|
onSubmit?: (value: string) => boolean | void;
|
|
20
21
|
onCancel?: () => void;
|
|
21
|
-
|
|
22
|
+
/** Render the input shown while editing. Spread the props on an `<input>`. */
|
|
23
|
+
renderInput?: RenderSlotFn<React.InputHTMLAttributes<HTMLInputElement>>;
|
|
22
24
|
/**
|
|
23
25
|
* Reference to the HTMLInputElement (or other) used for editing
|
|
24
26
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { RemoveListener } from '@sheetxl/utils';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
3
|
import { Command } from '@sheetxl/utils-react';
|
|
4
4
|
import { IEditable, EditorMode, EditorTextSelection } from '@sheetxl/grid-react';
|
|
5
5
|
/**
|
|
@@ -52,7 +52,7 @@ export declare function insertEditText(editable: IEditable<any, any, any>, text:
|
|
|
52
52
|
/** The single `data` bundle {@link contributeInsertCommands} takes (the `DynamicCommandContributor` shape). */
|
|
53
53
|
export interface InsertCommandData {
|
|
54
54
|
editable: IEditable<any, any, any>;
|
|
55
|
-
sheet:
|
|
55
|
+
sheet: IWorksheet;
|
|
56
56
|
/** `'startEdit'` begins an edit (the sheet's version when NOT editing); `'caret'` inserts at the focused editor's caret. */
|
|
57
57
|
flavor: InsertFlavor;
|
|
58
58
|
}
|
|
@@ -86,7 +86,7 @@ export declare function contributeWhileEditingCommands(contribution: Command.Com
|
|
|
86
86
|
/** The single `data` bundle {@link contributeEditorCommands} takes (the `DynamicCommandContributor` shape). */
|
|
87
87
|
export interface EditorCommandData {
|
|
88
88
|
editable: IEditable<any, any, any>;
|
|
89
|
-
sheet:
|
|
89
|
+
sheet: IWorksheet;
|
|
90
90
|
/**
|
|
91
91
|
* Contribute the edit-session commands only while an edit is **active** (a session exists). An idle editor
|
|
92
92
|
* owns no F4 / no caret overrides, so they cede to `redo` / the sheet's begin-edit flavor. The host passes
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
3
|
import { EditorAlignment, VirtualDivProps } from '@sheetxl/grid-react';
|
|
4
4
|
import { SheetEditable } from './SheetEditable';
|
|
5
5
|
/**
|
|
@@ -14,7 +14,7 @@ export interface SheetCellEditorLayerProps extends VirtualDivProps {
|
|
|
14
14
|
*/
|
|
15
15
|
zIndex?: number;
|
|
16
16
|
/** The sheet — its selection drives the input's leave-key nav, its active cell the edit-session commands. */
|
|
17
|
-
sheet:
|
|
17
|
+
sheet: IWorksheet;
|
|
18
18
|
/** The editable (UI model) — anchor + the single current edit. Shared with peers (the formula bar). */
|
|
19
19
|
editable: SheetEditable;
|
|
20
20
|
/**
|
|
@@ -1,18 +1,31 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
import { VirtualKeyboardHandler } from '@sheetxl/utils-react';
|
|
4
|
+
import { StartEditOptions } from '@sheetxl/grid-react';
|
|
3
5
|
import { SheetEditable } from './SheetEditable';
|
|
4
6
|
import { EditRejectedNotice } from './useEditRejectedNotice';
|
|
7
|
+
/**
|
|
8
|
+
* Start a ready-mode edit typed into the grid.
|
|
9
|
+
*
|
|
10
|
+
* @param keyboard The virtual keyboard the typing came through (a key typed into the
|
|
11
|
+
* {@link VirtualKeyboardLayer}'s input); omit for typing on the grid itself. In keyboard mode the
|
|
12
|
+
* edit opens in the keyboard's registered editor (a phone's formula bar) rather than the cell, by
|
|
13
|
+
* parking that editor on the new session before anything renders it.
|
|
14
|
+
* @returns Whether the edit started.
|
|
15
|
+
* @internal
|
|
16
|
+
*/
|
|
17
|
+
export declare const startTypedEdit: (editable: SheetEditable, coords: Parameters<SheetEditable["startEdit"]>[0], options: StartEditOptions<string>, keyboard?: VirtualKeyboardHandler) => boolean;
|
|
5
18
|
/**
|
|
6
19
|
* Props for {@link SheetCellEditorStartLayer}.
|
|
7
20
|
*/
|
|
8
21
|
export interface SheetCellEditorStartLayerProps {
|
|
9
22
|
/** The sheet — stamps the double-clicked cell's scope (sheet name) onto the coords it starts on. */
|
|
10
|
-
sheet:
|
|
23
|
+
sheet: IWorksheet;
|
|
11
24
|
/** The editable (UI model) — the same instance the {@link SheetCellEditorLayer} renders. */
|
|
12
25
|
editable: SheetEditable;
|
|
13
26
|
/**
|
|
14
27
|
* Notified when a start-edit attempt is rejected (`startEdit` returned `false` — a non-editable
|
|
15
|
-
* cell). The host that mounts one layer per pane (`
|
|
28
|
+
* cell). The host that mounts one layer per pane (`WorksheetElement`) passes a SHARED callback
|
|
16
29
|
* ({@link useEditRejectedNotice}) so all panes form one notice scope; it receives the rejected cell.
|
|
17
30
|
* @defaultValue this layer's own {@link useEditRejectedNotice}
|
|
18
31
|
*/
|
|
@@ -29,13 +42,17 @@ export interface SheetCellEditorStartLayerProps {
|
|
|
29
42
|
* sits at the **top** of the stack to paint over everything, but a Layer's handlers are its slot's
|
|
30
43
|
* tap — grid-wide ears that fire on every layer's turn, top first — so start handlers on the top
|
|
31
44
|
* layer intercepted keys and double-clicks aimed at a chart or note before that widget's own handlers
|
|
32
|
-
* ran. Starting an edit is the grid *floor's* behavior: `
|
|
45
|
+
* ran. Starting an edit is the grid *floor's* behavior: `WorksheetElement` mounts this as the first grid
|
|
33
46
|
* child, where it only hears what no widget above consumed.
|
|
34
47
|
*
|
|
35
48
|
* Keys are positionless, so the floor slot alone is not enough: a focused widget that does not consume
|
|
36
49
|
* a printable key (it must let keys through so its own commands can resolve) would still reach this
|
|
37
50
|
* tap. The key start therefore acts only when the key is aimed at the grid surface itself — the
|
|
38
|
-
* surface
|
|
51
|
+
* surface, or the pane's focus target standing in for it (the {@link VirtualKeyboardLayer}'s input),
|
|
52
|
+
* is the focused element. A double-click has a position; a widget that owns it consumes it.
|
|
53
|
+
*
|
|
54
|
+
* Text that reaches the focus target without a keydown that started an edit (a virtual keyboard can
|
|
55
|
+
* deliver it that way) starts one too, seeded with the text.
|
|
39
56
|
*/
|
|
40
57
|
export declare function SheetCellEditorStartLayer(props: SheetCellEditorStartLayerProps): React.ReactElement;
|
|
41
58
|
export declare namespace SheetCellEditorStartLayer {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { IWorksheet, IWorkbook, ICell } from '@sheetxl/sdk';
|
|
2
2
|
import { CreateEdit, IEditable, EditCommitArgs } from '@sheetxl/grid-react';
|
|
3
3
|
import { ReferenceModeHandler } from './useReferenceMode';
|
|
4
4
|
/** The editable shape for a spreadsheet: `clean` is a live cell getter, `dirty` is the working text. */
|
|
@@ -9,9 +9,9 @@ export type SheetEditable = IEditable<() => ICell, string, EditCommitArgs>;
|
|
|
9
9
|
* uses it to cover the cell while editing. The cell-aware input itself paints only the cell's *own*
|
|
10
10
|
* fill; this fallback is the container's job.
|
|
11
11
|
*/
|
|
12
|
-
export declare const resolveCellBackground: (cell: ICell, sheet:
|
|
12
|
+
export declare const resolveCellBackground: (cell: ICell, sheet: IWorksheet, darkMode?: boolean, bodyFill?: string) => string;
|
|
13
13
|
/**
|
|
14
|
-
* An `
|
|
14
|
+
* An `IWorksheet`-backed {@link CreateEdit} for the new {@link DefaultEditable} / {@link EditorLayer}.
|
|
15
15
|
*
|
|
16
16
|
* @remarks
|
|
17
17
|
* - **clean** is `() => ICell` — a *live* cell getter (not a captured value), so a cell-aware input
|
|
@@ -21,7 +21,7 @@ export declare const resolveCellBackground: (cell: ICell, sheet: ISheet, darkMod
|
|
|
21
21
|
* write leaves the selection as it is (a block typed into stays selected for Enter to move within),
|
|
22
22
|
* and an undo or a redo of it lands on the cell.
|
|
23
23
|
* - **`null`** ⇒ the cell is not editable (protected / read-only), via {@link ICell.isEditAllowed}.
|
|
24
|
-
* - **scope-aware**: `coords.scope` (a sheet name) picks the sheet to edit, via `workbook.
|
|
24
|
+
* - **scope-aware**: `coords.scope` (a sheet name) picks the sheet to edit, via `workbook.getWorksheet`,
|
|
25
25
|
* falling back to `sheet`. This is what makes a commit write back to the session's *origin* sheet even
|
|
26
26
|
* if a different sheet is currently displayed — `coords` here is the session's own (fixed) coords, not
|
|
27
27
|
* whatever the anchor currently reports.
|
|
@@ -33,7 +33,7 @@ export declare const resolveCellBackground: (cell: ICell, sheet: ISheet, darkMod
|
|
|
33
33
|
* out of `commit`, which rejects it; the editable fans the error out to
|
|
34
34
|
* `IEditable.subscribeCommitError`, where the host shows it.
|
|
35
35
|
*/
|
|
36
|
-
export declare const createSheetCreateEdit: (sheet:
|
|
36
|
+
export declare const createSheetCreateEdit: (sheet: IWorksheet, workbook?: IWorkbook | null) => CreateEdit<() => ICell, string, EditCommitArgs>;
|
|
37
37
|
/**
|
|
38
38
|
* Build the production {@link SheetEditable} for a sheet — the {@link DefaultEditable} wired with a
|
|
39
39
|
* workbook-aware active-cell anchor ({@link createEditableAnchor}) and SDK edit strategy
|
|
@@ -55,5 +55,5 @@ export interface CreateEditableOptions {
|
|
|
55
55
|
*/
|
|
56
56
|
referenceMode?: ReferenceModeHandler;
|
|
57
57
|
}
|
|
58
|
-
export declare const createEditable: (sheet:
|
|
58
|
+
export declare const createEditable: (sheet: IWorksheet, options?: CreateEditableOptions) => SheetEditable;
|
|
59
59
|
//# sourceMappingURL=SheetEditable.d.ts.map
|
|
@@ -34,7 +34,7 @@ export interface SheetReferenceHeaderLayerProps extends LayerProps {
|
|
|
34
34
|
* primary header selection fully in charge. The producer's gates — `scope` and `allowMulti` — are read
|
|
35
35
|
* here exactly as {@link SheetReferenceLayer} reads them for the body: the two surfaces drive one
|
|
36
36
|
* selection, so a gate honored by only one of them is no gate at all. It is a pointer surface
|
|
37
|
-
* only ({@link HeaderSelectionLayer} with `
|
|
37
|
+
* only ({@link HeaderSelectionLayer} with `hideAccent`) — the reference rectangles are drawn on
|
|
38
38
|
* the body grid by {@link SheetReferenceLayer}; `preserveFocus` keeps the formula editor focused across a
|
|
39
39
|
* header drag; `replaceActive` re-scopes/inserts the active reference instead of the primary's whole-
|
|
40
40
|
* selection replace.
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet, IWorksheetView } from '@sheetxl/sdk';
|
|
3
3
|
import { LayerProps } from '@sheetxl/grid-react';
|
|
4
4
|
import { SheetSelection } from '../selection';
|
|
5
5
|
/**
|
|
6
6
|
* Draws the current **reference selection** over the grid (Excel-style colored rectangles), highlighting
|
|
7
|
-
* the active reference. A pane layer (mounted per pane by `
|
|
7
|
+
* the active reference. A pane layer (mounted per pane by `WorksheetElement`), it reads the app-wide
|
|
8
8
|
* reference-mode bus ({@link useReferenceMode}) — not any edit session — so it renders whenever a
|
|
9
9
|
* reference selection is present, regardless of what produced it: a formula edit (via `SheetCellInput`)
|
|
10
10
|
* or, later, a selected chart showing its source data with no active input at all.
|
|
@@ -23,14 +23,14 @@ import { SheetSelection } from '../selection';
|
|
|
23
23
|
*/
|
|
24
24
|
export interface SheetReferenceLayerProps extends LayerProps {
|
|
25
25
|
/** The sheet this pane renders — ranges belonging to a different sheet are filtered out of this pane. */
|
|
26
|
-
sheet:
|
|
26
|
+
sheet: IWorksheet;
|
|
27
27
|
/**
|
|
28
28
|
* The sheet view — enables the **formula-view** fallback: while `isShowFormulas()` and no
|
|
29
29
|
* reference-mode state is on the bus, the selection anchor's formula (when it IS a formula)
|
|
30
30
|
* has its references outlined read-only (same palette as the anchor's colored formula text —
|
|
31
31
|
* see {@link useFormulaViewAnchor}). Omit for a host with no formula view.
|
|
32
32
|
*/
|
|
33
|
-
sheetView?:
|
|
33
|
+
sheetView?: IWorksheetView;
|
|
34
34
|
}
|
|
35
35
|
/**
|
|
36
36
|
* Wrap a selection so a range **committed through this pane** is stamped with this pane's sheet.
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { SheetEditable } from './SheetEditable';
|
|
3
|
+
/**
|
|
4
|
+
* Props for {@link VirtualKeyboardLayer}.
|
|
5
|
+
*/
|
|
6
|
+
export interface VirtualKeyboardLayerProps {
|
|
7
|
+
/**
|
|
8
|
+
* The sheet's editable: an edit in progress is what a rising keyboard is for, and its anchor is the
|
|
9
|
+
* active cell kept in view above the keyboard.
|
|
10
|
+
*/
|
|
11
|
+
editable: SheetEditable;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Keyboard mode for the sheet (see `useVirtualKeyboard`): while a virtual keyboard is up for typing
|
|
15
|
+
* into the sheet, focusing the sheet lands on an invisible input that holds the keyboard, so it stays
|
|
16
|
+
* up as the active cell moves.
|
|
17
|
+
*
|
|
18
|
+
* @remarks
|
|
19
|
+
* A virtual keyboard belongs to the focused text field, and the grid surface is not one. Each pane's
|
|
20
|
+
* layer hosts an input and registers it as the pane's focus target while in keyboard mode, asking for
|
|
21
|
+
* the keyboard's input mode. Keys typed there reach the {@link SheetCellEditorStartLayer} as keys
|
|
22
|
+
* aimed at the surface do; this layer starts no edits of its own.
|
|
23
|
+
*
|
|
24
|
+
* Per pane:
|
|
25
|
+
* - **A tap on the grid leaves keyboard mode**: the user has gone back to touching cells. With the
|
|
26
|
+
* store's `keepOnTap` it stays, as Excel keeps its keyboard: the tap does not move focus off the input.
|
|
27
|
+
* - **A focus that reaches the surface itself** in keyboard mode is passed on to the input.
|
|
28
|
+
* - **Leaving keyboard mode** with the input focused hands focus to the surface, lowering the keyboard.
|
|
29
|
+
*
|
|
30
|
+
* The primary pane's layer (the center pane, when there is one) also does the sheet's part, once:
|
|
31
|
+
* - **On and off with the keyboard.** A keyboard rising while the sheet is being edited (in the cell or
|
|
32
|
+
* a formula bar) enters keyboard mode; the keyboard going down (the system's back gesture, its own
|
|
33
|
+
* hide key) leaves it.
|
|
34
|
+
* - **Show.** Entering keyboard mode with focus outside any text field (a "show keyboard" button)
|
|
35
|
+
* focuses the pane, raising the keyboard.
|
|
36
|
+
* - **Done.** Taking a way out of the edit from chrome (the status bar's ✓ / ✕, see `exitEditMode`)
|
|
37
|
+
* leaves keyboard mode before the edit ends, so the focus returning to the grid lowers it.
|
|
38
|
+
* - **The active cell stays in view.** When the keyboard takes room from the grid, the active cell is
|
|
39
|
+
* scrolled back into view (unless the store's `disableScrollIntoView`).
|
|
40
|
+
*
|
|
41
|
+
* Mount it directly above the start layer, so a key typed into the input reaches the start layer's
|
|
42
|
+
* floor. It renders nothing where the keyboard store is not enabled (`isEnabled()`: a device with no
|
|
43
|
+
* virtual keyboard).
|
|
44
|
+
*/
|
|
45
|
+
export declare function VirtualKeyboardLayer(props: VirtualKeyboardLayerProps): React.ReactElement | null;
|
|
46
|
+
export declare namespace VirtualKeyboardLayer {
|
|
47
|
+
var displayName: string;
|
|
48
|
+
}
|
|
49
|
+
//# sourceMappingURL=VirtualKeyboardLayer.d.ts.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { IWorkbook, IWorksheet } from '@sheetxl/sdk';
|
|
2
|
+
/**
|
|
3
|
+
* The worksheet an editor parses formula text against: the selected worksheet, or, while a sheet of
|
|
4
|
+
* another kind is the active tab, the first worksheet. `null` for a workbook with no worksheet.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* Only the parse is anchored here. A field that has a home passes it as the coords (`scope`), and a
|
|
8
|
+
* reference that names its sheet names it; what is left is text with no sheet of its own, which a
|
|
9
|
+
* chart sheet cannot be home to.
|
|
10
|
+
*/
|
|
11
|
+
export declare const formulaAnchorSheet: (workbook: IWorkbook | null | undefined) => IWorksheet | null;
|
|
12
|
+
//# sourceMappingURL=formulaAnchor.d.ts.map
|
|
@@ -16,6 +16,7 @@ export * from './EditorCommands';
|
|
|
16
16
|
export * from './useEditRejectedNotice';
|
|
17
17
|
export * from './SheetCellEditorLayer';
|
|
18
18
|
export * from './SheetCellEditorStartLayer';
|
|
19
|
+
export * from './VirtualKeyboardLayer';
|
|
19
20
|
export * from './SheetReferenceLayer';
|
|
20
21
|
export * from './SheetReferenceHeaderLayer';
|
|
21
22
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { RangeCoords } from '@sheetxl/utils';
|
|
2
|
-
import { ICalculation, ICell, IRange,
|
|
2
|
+
import { ICalculation, ICell, IRange, IWorksheet } from '@sheetxl/sdk';
|
|
3
3
|
/**
|
|
4
4
|
* The text a range picked on the grid writes into a formula edited at `cell` — shared by the cell
|
|
5
5
|
* editor's two picker write-backs (re-scope and insert) so a pick writes the same text however it
|
|
@@ -42,7 +42,7 @@ export declare const namedReference: (cell: ICell, to: RangeCoords) => string |
|
|
|
42
42
|
*
|
|
43
43
|
* @param sheet Any sheet of the workbook — resolves `range.scope` (its own sheet when unscoped).
|
|
44
44
|
*/
|
|
45
|
-
export declare const isSpillExtent: (sheet:
|
|
45
|
+
export declare const isSpillExtent: (sheet: IWorksheet, range: RangeCoords) => boolean;
|
|
46
46
|
/**
|
|
47
47
|
* The spill reference (`D2#`) a picked range exactly is, or `null`.
|
|
48
48
|
*
|
|
@@ -72,5 +72,5 @@ export declare const spillReference: (cell: ICell, to: RangeCoords, flags?: IRan
|
|
|
72
72
|
* @param tokens The formula's tokens; the `#` anchor token carries its reference's `referenceIndex`.
|
|
73
73
|
* @param ranges Index-aligned with `referenceIndex`. Returned as-is when nothing widens.
|
|
74
74
|
*/
|
|
75
|
-
export declare const expandSpillAnchors: (sheet:
|
|
75
|
+
export declare const expandSpillAnchors: (sheet: IWorksheet, tokens: readonly ICalculation.FormulaToken[], ranges: (RangeCoords | null)[]) => (RangeCoords | null)[];
|
|
76
76
|
//# sourceMappingURL=pickedReference.d.ts.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { CellCoords } from '@sheetxl/utils';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
3
|
/**
|
|
4
4
|
* The callback a host invokes on each rejected edit attempt.
|
|
5
5
|
*
|
|
@@ -24,9 +24,9 @@ export type EditRejectedNotice = (coords?: CellCoords | null, retry?: () => void
|
|
|
24
24
|
*
|
|
25
25
|
* Any other non-editable reason stays silent.
|
|
26
26
|
*
|
|
27
|
-
* One instance should serve one visit scope — `
|
|
27
|
+
* One instance should serve one visit scope — `WorksheetElement` creates it and threads the callback to
|
|
28
28
|
* every consumer it hosts (its imperative `startEdit` and each pane's editor layer), so four frozen
|
|
29
29
|
* panes never warn four times.
|
|
30
30
|
*/
|
|
31
|
-
export declare const useEditRejectedNotice: (sheet:
|
|
31
|
+
export declare const useEditRejectedNotice: (sheet: IWorksheet) => EditRejectedNotice;
|
|
32
32
|
//# sourceMappingURL=useEditRejectedNotice.d.ts.map
|
|
@@ -17,7 +17,7 @@ import { FormulaArgument } from './functionArgs';
|
|
|
17
17
|
* localized name is what gets inserted, and that is correct: the editing compiler binds it back to
|
|
18
18
|
* canonical and storage stays canonical. Capped at {@link MAX_FUNCTION_RESULTS} *before* the merge.
|
|
19
19
|
* - **Names and tables** — one collection (a table is an `INamed` whose `getType()` is `'table'`).
|
|
20
|
-
* Pass the SHEET's (`
|
|
20
|
+
* Pass the SHEET's (`IWorksheet.getNames()`), which already holds exactly what a formula written there
|
|
21
21
|
* can refer to, shadowing resolved — the workbook's would offer other sheets' private names.
|
|
22
22
|
* Deliberately NOT localized: a defined name is the user's own text, spelled the same in every
|
|
23
23
|
* language. A name whose body is `LAMBDA(…)` is offered as `'lambda'`, completed like a function.
|
|
@@ -138,7 +138,7 @@ export interface UseFormulaHintsOptions {
|
|
|
138
138
|
* then holds functions only, exactly as before.
|
|
139
139
|
*
|
|
140
140
|
* @remarks
|
|
141
|
-
* Must be the SHEET's collection (`
|
|
141
|
+
* Must be the SHEET's collection (`IWorksheet.getNames()`), not the workbook's: that one holds exactly
|
|
142
142
|
* what a formula on that sheet can refer to, so no scoping is needed here. The workbook's would
|
|
143
143
|
* offer another sheet's private names, which complete to expressions that do not resolve.
|
|
144
144
|
*/
|
|
@@ -195,7 +195,7 @@ export interface FormulaHintsApi {
|
|
|
195
195
|
*/
|
|
196
196
|
getAnchorOffset(): number;
|
|
197
197
|
/**
|
|
198
|
-
* STABLE-identity panel renderer for `useFloatStack.
|
|
198
|
+
* STABLE-identity panel renderer for `useFloatStack.renderPopupPanel` — the autocomplete list when
|
|
199
199
|
* it has matches, else the signature preview. Returns `null` when there is nothing to show.
|
|
200
200
|
*/
|
|
201
201
|
renderPanel(): React.ReactNode;
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { CellCoords } from '@sheetxl/utils';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet, IDataValidation } from '@sheetxl/sdk';
|
|
3
3
|
/**
|
|
4
4
|
* The alert a typed entry raised: the rule it failed, and the cell it was typed into.
|
|
5
5
|
*/
|
|
6
6
|
export interface ValidationAlert {
|
|
7
7
|
/** The sheet the entry was typed on. */
|
|
8
|
-
sheet:
|
|
8
|
+
sheet: IWorksheet;
|
|
9
9
|
/** The cell the entry was typed into, as the edit session names it: with its sheet scope. */
|
|
10
10
|
coords: CellCoords;
|
|
11
11
|
/** The text that was typed. A Warning accepts the same text entered again. */
|
|
@@ -20,5 +20,5 @@ export declare const setValidationAlert: (alert: ValidationAlert | null) => void
|
|
|
20
20
|
/** The alert showing, on any sheet. */
|
|
21
21
|
export declare const getValidationAlert: () => ValidationAlert | null;
|
|
22
22
|
/** The alert showing on `sheet` (reactive). */
|
|
23
|
-
export declare const useValidationAlert: (sheet:
|
|
23
|
+
export declare const useValidationAlert: (sheet: IWorksheet) => ValidationAlert | null;
|
|
24
24
|
//# sourceMappingURL=validationAlert.d.ts.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IRange, ICell, ICellRanges, ICellRange, IColor, ITable, INamedCollection, IStyleCollection, ICellStyle, IBorders, ITheme, IThemeCollection, IFunction, IFunctionCollection, IWorkbook, ISlicer } from '@sheetxl/sdk';
|
|
1
|
+
import { IRange, ICell, ICellRanges, ICellRange, IColor, ITable, INamedCollection, IStyleCollection, ICellStyle, IBorders, ITheme, IThemeCollection, IFunction, IFunctionCollection, IWorkbook, ISlicer, IChart } from '@sheetxl/sdk';
|
|
2
2
|
/**
|
|
3
3
|
* For providing Adjustable Color Commands additional rendering capabilities.
|
|
4
4
|
*
|
|
@@ -51,13 +51,13 @@ export interface Slicer {
|
|
|
51
51
|
readonly slicer: () => ISlicer;
|
|
52
52
|
readonly styles: () => IStyleCollection;
|
|
53
53
|
}
|
|
54
|
-
/**
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
54
|
+
/** What a chart's galleries (its type, its elements) read: the active chart. */
|
|
55
|
+
export interface Chart {
|
|
56
|
+
readonly chart: () => IChart;
|
|
57
|
+
}
|
|
58
|
+
/** What the Insert Slicer gallery draws with: the workbook's styles. A pick inserts a slicer in that style. */
|
|
58
59
|
export interface SlicerStyles {
|
|
59
60
|
readonly styles: () => IStyleCollection;
|
|
60
|
-
readonly slicers?: () => readonly ISlicer[];
|
|
61
61
|
}
|
|
62
62
|
export interface Theme {
|
|
63
63
|
readonly theme: ITheme;
|
|
@@ -72,7 +72,7 @@ export interface NamedReference {
|
|
|
72
72
|
}
|
|
73
73
|
/**
|
|
74
74
|
* Used for the workbook-statistics dialog — the dialog profiles the live workbook itself
|
|
75
|
-
* (`IWorkbook.getStats` / `
|
|
75
|
+
* (`IWorkbook.getStats` / `IWorksheet.getStats`), so the context is just the model getter.
|
|
76
76
|
*/
|
|
77
77
|
export interface WorkbookStatistics {
|
|
78
78
|
getWorkbook: () => IWorkbook;
|
package/types/src/index.d.ts
CHANGED
|
@@ -18,7 +18,9 @@ export * from './editableLabel';
|
|
|
18
18
|
export * from './tabStrip';
|
|
19
19
|
export * from './icons';
|
|
20
20
|
export * from './layer/ConditionalIcons';
|
|
21
|
+
export { SheetLayers, useGridSurface, type SheetLayersProps, type SheetLayersFilter, type SheetSurface } from './layer/SheetLayers';
|
|
21
22
|
export * from './layer/RangeAnnotationLayer';
|
|
23
|
+
export * from './layer/CellInsertLayer';
|
|
22
24
|
export * from './layer/HyperlinkLayer';
|
|
23
25
|
export type { TableToolbarRenderProps } from './layer/TableToolbar';
|
|
24
26
|
export * from './picker';
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import { IRange,
|
|
1
|
+
import { IRange, IWorksheet, ICell } from '@sheetxl/sdk';
|
|
2
2
|
import { LayerProps, IGridPane } from '@sheetxl/grid-react';
|
|
3
3
|
export interface BorderLayerProps extends LayerProps {
|
|
4
4
|
/** Class for the borders host box (devtools identification). */
|
|
5
5
|
className?: string;
|
|
6
|
-
sheet:
|
|
6
|
+
sheet: IWorksheet;
|
|
7
7
|
getVisibleCells: (pane: IGridPane) => {
|
|
8
8
|
cell: ICell.Coords;
|
|
9
9
|
value?: ICell;
|