@sheetxl/react 0.8.0-beta.10 → 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.
Files changed (233) hide show
  1. package/browser/esm/{CYoUd5KIl7W3AsxH.mjs → 1-LEUre9ZLG0OYYB.mjs} +24 -23
  2. package/browser/esm/94dxo1A-z8lgiiGw.mjs +128 -0
  3. package/browser/esm/{BwRduT8FTrk5n72r.mjs → B26QVfjer2oY2ewK.mjs} +1 -1
  4. package/browser/esm/B93LSmhnvkxNXTq-.mjs +42 -0
  5. package/browser/esm/{BZcQ-KYwS62Ut45c.mjs → BQYS2Yf-EAV_tBLr.mjs} +1 -1
  6. package/browser/esm/BegvsXeRs7e-9t8k.mjs +8 -0
  7. package/browser/esm/Bl2BFCQ00fotauKB.mjs +36 -0
  8. package/browser/esm/{Cfe0kofqVKGxLqO6.mjs → Bos4Rkp8UTF7QXUB.mjs} +1 -1
  9. package/browser/esm/{Dd-ZybXAgoq9pgGv.mjs → C1pc9F4Rt2C5FKUo.mjs} +1 -1
  10. package/browser/esm/{C6urN77szrYwODXF.mjs → CPnnESfZz2jjJd82.mjs} +1 -1
  11. package/browser/esm/CRi6DQ3UXmPEv-w_.mjs +729 -0
  12. package/browser/esm/{BuvXl14hs-1CvjeA.mjs → ClAtIfYbsUPA073B.mjs} +1 -1
  13. package/browser/esm/CzRIbc-Lk__VMLKM.mjs +60 -0
  14. package/browser/esm/{DyU9UInRnfkPYYlR.mjs → D2u6THGErqw64KQI.mjs} +1 -1
  15. package/browser/esm/{cYjYjqEsyd63x8t4.mjs → DMdsMPT0fWBbTkNn.mjs} +1 -1
  16. package/browser/esm/{Bow9CzRJrYxak2i5.mjs → DS66lAIM-9M-YoZQ.mjs} +5 -8
  17. package/browser/esm/DgL7Dy-Lqcr1TvW6.mjs +23528 -0
  18. package/browser/esm/{DjiBz4H74I6nPUY6.mjs → Dnh1kpz3v1JKtRD_.mjs} +2 -2
  19. package/browser/esm/{Sp6PJavGKpF8SJzA.mjs → cQ6xdPFkEcuDlNTN.mjs} +1 -1
  20. package/browser/esm/chart.mjs +32 -52
  21. package/browser/esm/control.mjs +2 -2
  22. package/browser/esm/group.mjs +3 -3
  23. package/browser/esm/index.mjs +6590 -4824
  24. package/browser/esm/note.mjs +73 -47
  25. package/browser/esm/picture.mjs +2 -2
  26. package/browser/esm/shape.mjs +2 -2
  27. package/browser/esm/slicer.mjs +5 -5
  28. package/browser/esm/ugfE7YeZALQURDKF.mjs +241 -0
  29. package/licenses/dependencies.txt +313 -1
  30. package/node/esm/6zApGj9DozhFy-bx.mjs +35 -0
  31. package/node/esm/{DPN0n6MGYQ9vZ2KO.mjs → BMVK5plvmBOAIlxP.mjs} +1 -1
  32. package/node/esm/{Dxbm6ryIDCEi26RO.mjs → BaRfst1euuhquupX.mjs} +1 -1
  33. package/node/esm/{BJ7ZZm63j5O6cvrB.mjs → Be9c1GwQkPo8Piuh.mjs} +1 -1
  34. package/node/esm/{DhSq680c5tgMFFbj.mjs → BiaDWnN3tT7neoRL.mjs} +1 -1
  35. package/node/esm/BlxXufqBBg1PtsXd.mjs +8 -0
  36. package/node/esm/{CM5BT7h-hMtST2bE.mjs → C_SNx7TlFEcwbYjx.mjs} +1 -1
  37. package/node/esm/DJPgbB1X22YmhbaR.mjs +242 -0
  38. package/node/esm/DTMTIrYIK1eZswsM.mjs +37 -0
  39. package/node/esm/{Buw-VKYJy3y5dbaJ.mjs → D_pCpfdQowV_4Aje.mjs} +23 -22
  40. package/node/esm/{DYosMUJKp-3MSO4q.mjs → DgGEHydEjD7nfsDB.mjs} +1 -1
  41. package/node/esm/{CFFlJxNwgyInjEnh.mjs → Dj5FM7_-YWhCtCCt.mjs} +1 -1
  42. package/node/esm/{GkmuxU7OwRZtm2Rf.mjs → DxQZmb-j4NLUO9Af.mjs} +1 -1
  43. package/node/esm/{BfRn5S5V4X8xIAEa.mjs → JiQGhLkoL8CJpVvA.mjs} +1 -1
  44. package/node/esm/b-XRVRI1fYQQMkTC.mjs +1664 -0
  45. package/node/esm/chart.mjs +32 -52
  46. package/node/esm/control.mjs +2 -2
  47. package/node/esm/{C_ANM4feA1xV-pri.mjs → gpD-9LDW92phhoma.mjs} +1 -1
  48. package/node/esm/group.mjs +3 -3
  49. package/node/esm/index.mjs +9005 -7225
  50. package/node/esm/note.mjs +86 -60
  51. package/node/esm/picture.mjs +2 -2
  52. package/node/esm/shape.mjs +292 -340
  53. package/node/esm/sigD1UFqvPlWUw_9.mjs +128 -0
  54. package/node/esm/slicer.mjs +15 -15
  55. package/node/esm/{D3YXHeOyFp00Xk3m.mjs → umljAT66yb3_rURh.mjs} +53 -56
  56. package/package.json +8 -6
  57. package/resources/contents.json +6 -0
  58. package/resources/locales/contents.json +14 -0
  59. package/resources/locales/de/chart.cmd.json +82 -0
  60. package/resources/locales/de/sheet.cmd.json +11 -0
  61. package/resources/locales/de/table.cmd.json +1 -1
  62. package/resources/locales/de/ui.msg.json +12 -0
  63. package/resources/locales/de/workbook.cmd.json +5 -0
  64. package/resources/locales/en/chart.cmd.json +82 -0
  65. package/resources/locales/en/sheet.cmd.json +11 -0
  66. package/resources/locales/en/table.cmd.json +1 -1
  67. package/resources/locales/en/ui.msg.json +12 -0
  68. package/resources/locales/en/workbook.cmd.json +5 -0
  69. package/types/src/autoFill/FillMenu.d.ts +2 -2
  70. package/types/src/autoFill/FillSeries.d.ts +2 -2
  71. package/types/src/border/StaticBorderRenderer.d.ts +18 -1
  72. package/types/src/border/useBorders.d.ts +74 -1
  73. package/types/src/cell/FormulaCellRenderer.d.ts +5 -2
  74. package/types/src/cell/useFormulaViewAnchor.d.ts +2 -2
  75. package/types/src/chart/ChartCommands.d.ts +15 -0
  76. package/types/src/chart/ChartEditor.d.ts +10 -2
  77. package/types/src/chart/ChartElement.d.ts +111 -0
  78. package/types/src/chart/ChartKind.d.ts +7 -0
  79. package/types/src/chart/PresetChartTypeDescriptors.d.ts +3 -1
  80. package/types/src/chart/index.d.ts +2 -0
  81. package/types/src/chart/paint/_fills.d.ts +24 -0
  82. package/types/src/chart/paint/_graphics.d.ts +46 -0
  83. package/types/src/chart/paint/echarts.d.ts +30 -0
  84. package/types/src/chart/paint/index.d.ts +12 -0
  85. package/types/src/chart/paint/kinds/ChartPaintKind.d.ts +132 -0
  86. package/types/src/chart/paint/kinds/_Area.d.ts +3 -0
  87. package/types/src/chart/paint/kinds/_Bar.d.ts +3 -0
  88. package/types/src/chart/paint/kinds/_BoxWhisker.d.ts +3 -0
  89. package/types/src/chart/paint/kinds/_Bubble.d.ts +3 -0
  90. package/types/src/chart/paint/kinds/_Funnel.d.ts +3 -0
  91. package/types/src/chart/paint/kinds/_Histogram.d.ts +3 -0
  92. package/types/src/chart/paint/kinds/_Line.d.ts +10 -0
  93. package/types/src/chart/paint/kinds/_OfPie.d.ts +3 -0
  94. package/types/src/chart/paint/kinds/_Pie.d.ts +21 -0
  95. package/types/src/chart/paint/kinds/_Placeholder.d.ts +7 -0
  96. package/types/src/chart/paint/kinds/_Radar.d.ts +3 -0
  97. package/types/src/chart/paint/kinds/_Scatter.d.ts +3 -0
  98. package/types/src/chart/paint/kinds/_Sunburst.d.ts +3 -0
  99. package/types/src/chart/paint/kinds/_Surface.d.ts +3 -0
  100. package/types/src/chart/paint/kinds/_Treemap.d.ts +3 -0
  101. package/types/src/chart/paint/kinds/_Waterfall.d.ts +3 -0
  102. package/types/src/chart/paint/kinds/_builtIns.d.ts +12 -0
  103. package/types/src/chart/paint/toEChartsOption.d.ts +31 -0
  104. package/types/src/clipboard/ClipboardCommands.d.ts +3 -3
  105. package/types/src/clipboard/SheetClipboardLayer.d.ts +2 -2
  106. package/types/src/comment/CommentCardRequest.d.ts +9 -9
  107. package/types/src/comment/useSheetComments.d.ts +2 -2
  108. package/types/src/context/WorksheetContext.d.ts +18 -0
  109. package/types/src/context/index.d.ts +1 -1
  110. package/types/src/editor/EditorCommands.d.ts +3 -3
  111. package/types/src/editor/SheetCellEditorLayer.d.ts +2 -2
  112. package/types/src/editor/SheetCellEditorStartLayer.d.ts +22 -5
  113. package/types/src/editor/SheetEditable.d.ts +6 -6
  114. package/types/src/editor/SheetReferenceLayer.d.ts +4 -4
  115. package/types/src/editor/VirtualKeyboardLayer.d.ts +49 -0
  116. package/types/src/editor/formulaAnchor.d.ts +12 -0
  117. package/types/src/editor/index.d.ts +1 -0
  118. package/types/src/editor/pickedReference.d.ts +3 -3
  119. package/types/src/editor/useEditRejectedNotice.d.ts +3 -3
  120. package/types/src/editor/useFormulaHints.d.ts +2 -2
  121. package/types/src/editor/validationAlert.d.ts +3 -3
  122. package/types/src/frame/CommandContext.d.ts +7 -7
  123. package/types/src/index.d.ts +2 -0
  124. package/types/src/layer/BorderLayer.d.ts +2 -2
  125. package/types/src/layer/CellErrorLayer.d.ts +2 -2
  126. package/types/src/layer/CellFillLayer.d.ts +2 -2
  127. package/types/src/layer/CellInsertLayer.d.ts +71 -0
  128. package/types/src/layer/CircularIndicatorLayer.d.ts +2 -2
  129. package/types/src/layer/CommentCardLayer.d.ts +2 -2
  130. package/types/src/layer/CommentsLayer.d.ts +2 -2
  131. package/types/src/layer/ConditionalBarLayer.d.ts +2 -2
  132. package/types/src/layer/ConditionalIconsLayer.d.ts +2 -2
  133. package/types/src/layer/ContextMenuLayer.d.ts +2 -2
  134. package/types/src/layer/GridFreezeLayer.d.ts +2 -2
  135. package/types/src/layer/HyperlinkLayer.d.ts +3 -3
  136. package/types/src/layer/MovableKindScope.d.ts +2 -2
  137. package/types/src/layer/ProtectionLayer.d.ts +3 -3
  138. package/types/src/layer/RangeAnnotationLayer.d.ts +2 -2
  139. package/types/src/layer/ResizeIndicator.d.ts +2 -2
  140. package/types/src/layer/SheetBackgroundLayer.d.ts +3 -3
  141. package/types/src/layer/SheetCellLayer.d.ts +4 -4
  142. package/types/src/layer/SheetColumnButtonLayer.d.ts +2 -2
  143. package/types/src/layer/SheetGridLineLayer.d.ts +11 -13
  144. package/types/src/layer/SheetLayers.d.ts +115 -0
  145. package/types/src/layer/SheetMovableLayer.d.ts +2 -2
  146. package/types/src/layer/SheetOutlineLayer.d.ts +2 -2
  147. package/types/src/layer/SheetTableCommandLayer.d.ts +2 -2
  148. package/types/src/layer/SpillLayer.d.ts +2 -2
  149. package/types/src/layer/TableLayer.d.ts +2 -2
  150. package/types/src/layer/TableToolbar.d.ts +3 -3
  151. package/types/src/layer/ValidationDropdownLayer.d.ts +2 -2
  152. package/types/src/layer/ValidationIndicatorLayer.d.ts +2 -2
  153. package/types/src/layer/ValidationPromptLayer.d.ts +5 -4
  154. package/types/src/layer/_tableColor.d.ts +2 -2
  155. package/types/src/layer/index.d.ts +2 -0
  156. package/types/src/layer/useFreezeDrag.d.ts +2 -2
  157. package/types/src/layer/useNormalBorderLines.d.ts +15 -0
  158. package/types/src/layer/useSheetFeatureRegions.d.ts +2 -2
  159. package/types/src/layer/useSheetVisibleCells.d.ts +2 -2
  160. package/types/src/layer/useSheetVisibleDecorations.d.ts +2 -2
  161. package/types/src/layer/useTableHeaderCells.d.ts +2 -2
  162. package/types/src/layer/useValidationPicker.d.ts +2 -2
  163. package/types/src/layer/useVisibleTables.d.ts +2 -2
  164. package/types/src/layer/validationMark.d.ts +3 -3
  165. package/types/src/listener/index.d.ts +5 -0
  166. package/types/src/listener/useCell.d.ts +29 -0
  167. package/types/src/listener/useCellRange.d.ts +23 -0
  168. package/types/src/listener/useCellValue.d.ts +26 -0
  169. package/types/src/listener/useModelListener.d.ts +4 -4
  170. package/types/src/listener/useRangeSnapshot.d.ts +35 -0
  171. package/types/src/listener/useTable.d.ts +26 -0
  172. package/types/src/movable/DefaultMovable.d.ts +8 -0
  173. package/types/src/movable/MovableCommands.d.ts +2 -2
  174. package/types/src/movable/MovableRenderers.d.ts +3 -3
  175. package/types/src/movable/index.d.ts +1 -0
  176. package/types/src/picker/cellPickerOpen.d.ts +3 -3
  177. package/types/src/picker/useCellPicker.d.ts +2 -2
  178. package/types/src/richText/RichTextEditor.d.ts +2 -2
  179. package/types/src/selection/SelectionCommands.d.ts +2 -2
  180. package/types/src/selection/SheetSelectionLayer.d.ts +2 -2
  181. package/types/src/sheet/ISheetHeaderElement.d.ts +1 -1
  182. package/types/src/sheet/{ISheetElement.d.ts → IWorksheetElement.d.ts} +46 -13
  183. package/types/src/sheet/OpaqueSheetElement.d.ts +21 -0
  184. package/types/src/sheet/SheetCommandProvider.d.ts +2 -2
  185. package/types/src/sheet/SheetCommands.d.ts +2 -2
  186. package/types/src/sheet/SheetKindIcon.d.ts +14 -0
  187. package/types/src/sheet/SheetOutlineElement.d.ts +4 -4
  188. package/types/src/sheet/SheetPanels.d.ts +11 -0
  189. package/types/src/sheet/SheetScrollbar.d.ts +3 -3
  190. package/types/src/sheet/TopLeftCorner.d.ts +2 -2
  191. package/types/src/sheet/WorksheetElement.d.ts +12 -0
  192. package/types/src/sheet/_freezeAt.d.ts +2 -2
  193. package/types/src/sheet/circularReferences.d.ts +3 -3
  194. package/types/src/sheet/index.d.ts +5 -2
  195. package/types/src/sheet/useCycleHighlight.d.ts +2 -2
  196. package/types/src/tabStrip/SheetTab.d.ts +1 -1
  197. package/types/src/table/TableCommands.d.ts +2 -2
  198. package/types/src/taskPane/TaskPaneArea.d.ts +7 -0
  199. package/types/src/theme/buildOOXMLThemeCSS.d.ts +2 -2
  200. package/types/src/theme/useGridColorScheme.d.ts +1 -1
  201. package/types/src/theme/useSystemColors.d.ts +2 -2
  202. package/types/src/workbook/DefaultRenderers.d.ts +3 -2
  203. package/types/src/workbook/IWorkbookElement.d.ts +27 -5
  204. package/browser/esm/BHjeSMaycUkS5dVL.mjs +0 -66
  205. package/browser/esm/CYMRbtPIr6SklGpp.mjs +0 -775
  206. package/browser/esm/CiRN-woJZWYOgTn4.mjs +0 -36
  207. package/browser/esm/J8cPagZBeXz86Lnd.mjs +0 -777
  208. package/node/esm/BpwE3HqTnrLLzE3C.mjs +0 -775
  209. package/node/esm/CV3bT3Hql74GcHoU.mjs +0 -37
  210. package/types/src/chart/templates/area-stacked-percent-template.json.d.ts +0 -10
  211. package/types/src/chart/templates/area-stacked-template.json.d.ts +0 -10
  212. package/types/src/chart/templates/area-template.json.d.ts +0 -9
  213. package/types/src/chart/templates/bar-stacked-percent-template.json.d.ts +0 -10
  214. package/types/src/chart/templates/bar-stacked-template.json.d.ts +0 -10
  215. package/types/src/chart/templates/bar-template.json.d.ts +0 -9
  216. package/types/src/chart/templates/column-stacked-percent-template.json.d.ts +0 -10
  217. package/types/src/chart/templates/column-stacked-template.json.d.ts +0 -10
  218. package/types/src/chart/templates/column-template.json.d.ts +0 -9
  219. package/types/src/chart/templates/line-markers-template.json.d.ts +0 -10
  220. package/types/src/chart/templates/line-stacked-markers-template.json.d.ts +0 -11
  221. package/types/src/chart/templates/line-stacked-percent-markers-template.json.d.ts +0 -11
  222. package/types/src/chart/templates/line-stacked-percent-template.json.d.ts +0 -10
  223. package/types/src/chart/templates/line-stacked-template.json.d.ts +0 -10
  224. package/types/src/chart/templates/line-template.json.d.ts +0 -9
  225. package/types/src/chart/templates/pie-doughnut-template.json.d.ts +0 -10
  226. package/types/src/chart/templates/pie-template.json.d.ts +0 -9
  227. package/types/src/chart/templates/scatter-lines-markers-smooth-template.json.d.ts +0 -10
  228. package/types/src/chart/templates/scatter-lines-markers-template.json.d.ts +0 -10
  229. package/types/src/chart/templates/scatter-lines-smooth-template.json.d.ts +0 -10
  230. package/types/src/chart/templates/scatter-lines-template.json.d.ts +0 -10
  231. package/types/src/chart/templates/scatter-markers-template.json.d.ts +0 -10
  232. package/types/src/context/SheetContext.d.ts +0 -18
  233. package/types/src/sheet/SheetElement.d.ts +0 -15
@@ -1,18 +1,31 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
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: ISheet;
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 (`SheetElement`) passes a SHARED callback
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: `SheetElement` mounts this as the first grid
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 is the focused element. A double-click has a position; a widget that owns it consumes it.
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 { ISheet, IWorkbook, ICell } from '@sheetxl/sdk';
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: ISheet, darkMode?: boolean, bodyFill?: string) => string;
12
+ export declare const resolveCellBackground: (cell: ICell, sheet: IWorksheet, darkMode?: boolean, bodyFill?: string) => string;
13
13
  /**
14
- * An `ISheet`-backed {@link CreateEdit} for the new {@link DefaultEditable} / {@link EditorLayer}.
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.getSheet`,
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: ISheet, workbook?: IWorkbook | null) => CreateEdit<() => ICell, string, EditCommitArgs>;
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: ISheet, options?: CreateEditableOptions) => SheetEditable;
58
+ export declare const createEditable: (sheet: IWorksheet, options?: CreateEditableOptions) => SheetEditable;
59
59
  //# sourceMappingURL=SheetEditable.d.ts.map
@@ -1,10 +1,10 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet, ISheetView } from '@sheetxl/sdk';
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 `SheetElement`), it reads the app-wide
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: ISheet;
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?: ISheetView;
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, ISheet } from '@sheetxl/sdk';
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: ISheet, range: RangeCoords) => boolean;
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: ISheet, tokens: readonly ICalculation.FormulaToken[], ranges: (RangeCoords | null)[]) => (RangeCoords | null)[];
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 { ISheet } from '@sheetxl/sdk';
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 — `SheetElement` creates it and threads the callback to
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: ISheet) => EditRejectedNotice;
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 (`ISheet.getNames()`), which already holds exactly what a formula written there
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 (`ISheet.getNames()`), not the workbook's: that one holds exactly
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
  */
@@ -1,11 +1,11 @@
1
1
  import { CellCoords } from '@sheetxl/utils';
2
- import { ISheet, IDataValidation } from '@sheetxl/sdk';
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: ISheet;
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: ISheet) => ValidationAlert | null;
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
- * What the Insert Slicer gallery draws with: the workbook's styles, and the slicers a picked style
56
- * restyles. With none, a pick inserts a slicer in that style.
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` / `ISheet.getStats`), so the context is just the model getter.
75
+ * (`IWorkbook.getStats` / `IWorksheet.getStats`), so the context is just the model getter.
76
76
  */
77
77
  export interface WorkbookStatistics {
78
78
  getWorkbook: () => IWorkbook;
@@ -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, ISheet, ICell } from '@sheetxl/sdk';
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: ISheet;
6
+ sheet: IWorksheet;
7
7
  getVisibleCells: (pane: IGridPane) => {
8
8
  cell: ICell.Coords;
9
9
  value?: ICell;
@@ -1,6 +1,6 @@
1
1
  import { default as React } from 'react';
2
2
  import { RangeCoords } from '@sheetxl/utils';
3
- import { ICalculation, IRange, ISheet } from '@sheetxl/sdk';
3
+ import { ICalculation, IRange, IWorksheet } from '@sheetxl/sdk';
4
4
  import { StickyState, GridPlacement, LayerProps } from '@sheetxl/grid-react';
5
5
  import { ValidationMark } from './validationMark';
6
6
  /** The kind of annotation a cell carries (drives the default tip styling). */
@@ -44,7 +44,7 @@ export interface CellErrorLayerProps extends Omit<LayerProps, 'children'> {
44
44
  /** Class forwarded to the inner layer's host box (devtools identification). */
45
45
  className?: string;
46
46
  /** The sheet whose cells are probed for `getErrors()` / `getCircularReference()` / `getWarnings()`. */
47
- sheet: ISheet;
47
+ sheet: IWorksheet;
48
48
  /** Which side of the cell the tip attaches to. @defaultValue `{ side: 'b', align: 'start' }`, as the input prompt's */
49
49
  placement?: GridPlacement;
50
50
  /** Gap (px) between the cell edge and the tip. @defaultValue 6 */
@@ -1,10 +1,10 @@
1
1
  import { default as React } from 'react';
2
- import { IRange, ISheet, ICell } from '@sheetxl/sdk';
2
+ import { IRange, IWorksheet, ICell } from '@sheetxl/sdk';
3
3
  import { IGridPane, LayerProps } from '@sheetxl/grid-react';
4
4
  export interface CellFillLayerProps extends LayerProps {
5
5
  /** Style for the fills host box. */
6
6
  style?: React.CSSProperties;
7
- sheet: ISheet;
7
+ sheet: IWorksheet;
8
8
  getVisibleCells: (pane: IGridPane) => {
9
9
  cell: ICell.Coords;
10
10
  value?: ICell;
@@ -0,0 +1,71 @@
1
+ import { default as React } from 'react';
2
+ import { ICellRange, IRange } from '@sheetxl/sdk';
3
+ import { LayerProps } from '@sheetxl/grid-react';
4
+ /** Props for the button that inserts a row or column. */
5
+ export interface CellInsertButtonProps extends React.ButtonHTMLAttributes<HTMLElement> {
6
+ /** Rows or columns. */
7
+ axis: IRange.Axis;
8
+ /** The cells a press inserts. */
9
+ range: ICellRange;
10
+ /** The edge of the square the button fills, in pixels (zoom applied). */
11
+ size: number;
12
+ /** A localized description of what a press does. */
13
+ title: string;
14
+ /** Inserts the cells. */
15
+ onInsert: () => void;
16
+ }
17
+ export interface CellInsertLayerProps extends Omit<LayerProps, 'children'> {
18
+ /** Class for the layer. */
19
+ className?: string;
20
+ /**
21
+ * Whether the button inserts rows, from the row headers, or columns, from the column headers.
22
+ * A host that wants both declares one layer for each.
23
+ *
24
+ * @defaultValue 'row'
25
+ */
26
+ axis?: IRange.Axis;
27
+ /**
28
+ * The cells to insert at the header border nearest the pointer, or `null` for no button. The
29
+ * preview line runs along the returned range. Called on every pointer move, so it should be cheap.
30
+ *
31
+ * @param range The entire row (column) just past the border: below it for rows, right of it for
32
+ * columns. A host usually narrows it, e.g. `range.getIntersect(table.getRange())`.
33
+ *
34
+ * Defaults to `range` when the sheet's protection allows inserting rows (columns).
35
+ */
36
+ resolve?: (range: ICellRange) => ICellRange | null;
37
+ /** Called when the button is pressed. Defaults to `range.insert(axis)`. */
38
+ onInsert?: (range: ICellRange) => void;
39
+ /** Edge (px, unzoomed) of the button. @defaultValue 16 */
40
+ size?: number;
41
+ /**
42
+ * Renders the button, filling the square it is placed in. Defaults to {@link CellInsertButton}.
43
+ */
44
+ renderButton?: (props: CellInsertButtonProps) => React.ReactNode;
45
+ }
46
+ /**
47
+ * An **insert** button in the headers, on the border nearest the pointer, as Word shows one in the
48
+ * margin beside a table. Pressing it inserts cells at that border; while it shows, a line across the
49
+ * cells previews where.
50
+ *
51
+ * @remarks
52
+ * Declared on both the header strip and the cells, which a {@link SheetLayers} does:
53
+ *
54
+ * ```tsx
55
+ * <WorksheetElement sheet={sheet}>
56
+ * <SheetLayers surface={['rowHeaders', 'cells']}>
57
+ * <CellInsertLayer />
58
+ * </SheetLayers>
59
+ * </WorksheetElement>
60
+ * ```
61
+ *
62
+ * The button is offered from the headers only: hovering the cells shows nothing. Which cells an insert
63
+ * covers, and whether there is one at all, are the host's, through `resolve`. Left alone it inserts
64
+ * entire rows (columns) wherever the sheet's protection allows.
65
+ */
66
+ export declare const CellInsertLayer: React.MemoExoticComponent<(props: CellInsertLayerProps) => React.JSX.Element | null>;
67
+ /**
68
+ * The chromeless insert button: a circled `+` in the primary color, filled while hovered.
69
+ */
70
+ export declare const CellInsertButton: React.MemoExoticComponent<(props: CellInsertButtonProps) => React.JSX.Element>;
71
+ //# sourceMappingURL=CellInsertLayer.d.ts.map
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  export interface CircularIndicatorLayerProps extends LayerProps {
5
5
  /** Class for the layer (devtools identification). */
@@ -7,7 +7,7 @@ export interface CircularIndicatorLayerProps extends LayerProps {
7
7
  /** Style for the indicators host box. */
8
8
  style?: React.CSSProperties;
9
9
  /** The sheet whose circular references are marked. */
10
- sheet: ISheet;
10
+ sheet: IWorksheet;
11
11
  /** Size (px, unzoomed) of the corner glyph. @defaultValue 9 */
12
12
  markSize?: number;
13
13
  /** Inset (px, unzoomed) of the glyph from the cell's top-left corner. @defaultValue 1 */
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  import { CommentCardRenderProps } from '../comment/CommentCardRequest';
5
5
  export interface CommentCardLayerProps extends Omit<LayerProps, 'children'> {
@@ -8,7 +8,7 @@ export interface CommentCardLayerProps extends Omit<LayerProps, 'children'> {
8
8
  /** Style for the floated card container. */
9
9
  style?: React.CSSProperties;
10
10
  /** The sheet whose threads are shown. */
11
- sheet: ISheet;
11
+ sheet: IWorksheet;
12
12
  /**
13
13
  * Renders the card. The layer places it, keeps it open and keeps its keystrokes and presses from
14
14
  * the grid; what it looks like is the renderer's.
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  export interface CommentsLayerProps extends LayerProps {
5
5
  /** Class for the layer (devtools identification). */
@@ -7,7 +7,7 @@ export interface CommentsLayerProps extends LayerProps {
7
7
  /** Style for the indicators host box. */
8
8
  style?: React.CSSProperties;
9
9
  /** The sheet whose comments are indicated. */
10
- sheet: ISheet;
10
+ sheet: IWorksheet;
11
11
  /** Size (px, unzoomed) of the corner indicator. @defaultValue 7 */
12
12
  markSize?: number;
13
13
  /** Dwell (ms) on a note's cell before its box shows. @defaultValue 300 */
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  export interface ConditionalBarLayerProps extends LayerProps {
5
5
  /** Class for the layer (devtools identification). */
@@ -7,7 +7,7 @@ export interface ConditionalBarLayerProps extends LayerProps {
7
7
  /** Style for the bars host box. */
8
8
  style?: React.CSSProperties;
9
9
  /** The sheet whose conditional data bars are drawn. */
10
- sheet: ISheet;
10
+ sheet: IWorksheet;
11
11
  /**
12
12
  * Margin (px, unzoomed) between the cell's edges and the bar, on ALL FOUR sides.
13
13
  *
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  export interface ConditionalIconsLayerProps extends LayerProps {
5
5
  /** Class for the layer (devtools identification). */
@@ -7,7 +7,7 @@ export interface ConditionalIconsLayerProps extends LayerProps {
7
7
  /** Style for the icons host box. */
8
8
  style?: React.CSSProperties;
9
9
  /** The sheet whose conditional icon sets are drawn. */
10
- sheet: ISheet;
10
+ sheet: IWorksheet;
11
11
  }
12
12
  /**
13
13
  * The sheet's **conditional icons** — the in-cell marks an `iconSet` rule draws.
@@ -1,10 +1,10 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { LayerProps } from '@sheetxl/grid-react';
4
4
  import { SheetLocation } from '../sheet';
5
5
  export interface ContextMenuLayerProps extends LayerProps {
6
6
  /** The sheet — the keyboard path anchors the menu to its selected cell (`getSelection().getCoords().cell`). */
7
- sheet: ISheet;
7
+ sheet: IWorksheet;
8
8
  /**
9
9
  * Returns the coordinates of the cell where the context menu was requested.
10
10
  */
@@ -1,7 +1,7 @@
1
- import { ISheet } from '@sheetxl/sdk';
1
+ import { IWorksheet } from '@sheetxl/sdk';
2
2
  import { LayerProps } from '@sheetxl/grid-react';
3
3
  export interface GridFreezeLayerProps extends Omit<LayerProps, 'children'> {
4
- sheet: ISheet;
4
+ sheet: IWorksheet;
5
5
  }
6
6
  /**
7
7
  * The main grid's freeze grips (one per frozen axis, on its freeze line) and its slice of the drag lines.
@@ -1,6 +1,6 @@
1
1
  import { default as React } from 'react';
2
2
  import { CellCoords } from '@sheetxl/utils';
3
- import { IHyperlink, ISheet } from '@sheetxl/sdk';
3
+ import { IHyperlink, IWorksheet } from '@sheetxl/sdk';
4
4
  import { StickyState, GridPlacement, HoverTipProps, LayerProps } from '@sheetxl/grid-react';
5
5
  /** What a link preview service found for a page. Every field is optional; an empty one shows nothing. */
6
6
  export interface LinkPreview {
@@ -21,7 +21,7 @@ export interface LinkPreview {
21
21
  export type LinkPreviewLookup = (address: string) => LinkPreview | Promise<LinkPreview | null> | null;
22
22
  /** What a hyperlink card is handed. The actions are bound to the hovered cell. */
23
23
  export interface HyperlinkCardRenderProps {
24
- sheet: ISheet;
24
+ sheet: IWorksheet;
25
25
  /** The hovered cell (the card anchors to its range, a merge included). */
26
26
  coords: CellCoords;
27
27
  hyperlink: IHyperlink;
@@ -47,7 +47,7 @@ export interface HyperlinkCardRenderProps {
47
47
  * Props for {@link HyperlinkLayer}.
48
48
  */
49
49
  export interface HyperlinkLayerProps extends Omit<LayerProps, 'children'> {
50
- sheet: ISheet;
50
+ sheet: IWorksheet;
51
51
  /** The card. @defaultValue the plain card: address · copy · edit · remove */
52
52
  renderCard?: (props: HyperlinkCardRenderProps) => React.ReactNode;
53
53
  /**
@@ -1,7 +1,7 @@
1
1
  import { ReactElement } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  export interface MovableKindScopeProps {
4
- sheet: ISheet;
4
+ sheet: IWorksheet;
5
5
  /** The movable layer's z. The kind's scope joins the pane's chain just above it. */
6
6
  order: number;
7
7
  }
@@ -1,6 +1,6 @@
1
1
  import { default as React } from 'react';
2
2
  import { RangeCoordValue } from '@sheetxl/utils';
3
- import { ICellRegion, ISheet, ISheetView } from '@sheetxl/sdk';
3
+ import { ICellRegion, IWorksheet, IWorksheetView } from '@sheetxl/sdk';
4
4
  import { LayerProps } from '@sheetxl/grid-react';
5
5
  /**
6
6
  * The regions to punch out of the hatch, coalesced by appearance.
@@ -26,9 +26,9 @@ export interface ProtectionLayerProps extends LayerProps {
26
26
  /** Class for the layer (devtools identification). */
27
27
  className?: string;
28
28
  /** The sheet whose locked area is hatched. */
29
- sheet: ISheet;
29
+ sheet: IWorksheet;
30
30
  /** The view carrying `isShowLockedShading()` — the toggle this layer draws for. */
31
- sheetView: ISheetView;
31
+ sheetView: IWorksheetView;
32
32
  }
33
33
  /**
34
34
  * The **locked-cell hatch** — the sheet's protected area, with the unlocked ranges cut out of it.
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet, IWorkbook } from '@sheetxl/sdk';
2
+ import { IWorksheet, IWorkbook } from '@sheetxl/sdk';
3
3
  import { LayerProps, StickyState } from '@sheetxl/grid-react';
4
4
  import { RangeAnnotation } from '../annotation';
5
5
  /** How an intent is drawn: its box, and the chip's frame. */
@@ -34,7 +34,7 @@ export interface RangeAnnotationChipProps {
34
34
  }
35
35
  export interface RangeAnnotationLayerProps extends Omit<LayerProps, 'children'> {
36
36
  /** The sheet whose annotations are drawn. @defaultValue the sheet in context (an injected layer needs none) */
37
- sheet?: ISheet;
37
+ sheet?: IWorksheet;
38
38
  /** Per-intent look. Merged over {@link DEFAULT_ANNOTATION_STYLES}. */
39
39
  styles?: Readonly<Record<string, RangeAnnotationStyle>>;
40
40
  /** Render the chip beside an annotation that is in view. Omit for the default. */