@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
@@ -0,0 +1,26 @@
1
+ import { ICellRange, Scalar } from '@sheetxl/sdk';
2
+ import { CellRangeTarget, CellRangeHookOptions } from './useRangeSnapshot';
3
+ /**
4
+ * Binds a cell's value like `useState`: returns the value and a setter, and re-renders when the value
5
+ * changes, whether from the setter, the grid, or a recalculation.
6
+ *
7
+ * @template T The expected value type. This is not checked or converted: an empty cell is `null`, and a
8
+ * cell can hold any type.
9
+ * @param target The workbook or sheet to read from, or `null` while there is none.
10
+ * @param address The cell's address. A larger range binds its top-left cell.
11
+ * @param options Listener options, and an optional `onChange` that receives each change event.
12
+ * @returns The value, or `null` while `target` is `null`, and a setter that does nothing until there
13
+ * is a target.
14
+ *
15
+ * @remarks
16
+ * The setter writes the value as-is: text is never parsed, so `'=1+1'` is stored as text rather than as
17
+ * a formula. To write formulas or styles, use {@link useCell}.
18
+ *
19
+ * @example
20
+ * ```tsx
21
+ * const [customer, setCustomer] = useCellValue<string>(sheet, 'A4');
22
+ * return <input value={customer ?? ''} onChange={(e) => setCustomer(e.target.value)} />;
23
+ * ```
24
+ */
25
+ export declare const useCellValue: <T extends Scalar = Scalar>(target: CellRangeTarget | null | undefined, address: ICellRange.Address, options?: CellRangeHookOptions) => [T | null, (value: T | null) => void];
26
+ //# sourceMappingURL=useCellValue.d.ts.map
@@ -25,8 +25,8 @@ export interface ModelListenerOptions extends Omit<IListener.Options, 'once'> {
25
25
  /**
26
26
  * React hook for subscribing to model-level events (workbooks, sheets, etc.).
27
27
  *
28
- * @template SOURCE - The model type (e.g., IWorkbook, ISheet)
29
- * @template EVENTS - The listener interface type (e.g., ISheet.IListeners)
28
+ * @template SOURCE - The model type (e.g., IWorkbook, IWorksheet)
29
+ * @template EVENTS - The listener interface type (e.g., IWorksheet.IListeners)
30
30
  *
31
31
  * @param source - The model instance to listen to, or `null` to listen to nothing
32
32
  * @param listeners - Object containing listener callbacks for various events
@@ -45,8 +45,8 @@ export interface ModelListenerOptions extends Omit<IListener.Options, 'once'> {
45
45
  *
46
46
  * @example
47
47
  * ```tsx
48
- * function SheetComponent({ sheet }: { sheet: ISheet }) {
49
- * useModelListener<ISheet, ISheet.IListeners>(sheet, {
48
+ * function SheetComponent({ sheet }: { sheet: IWorksheet }) {
49
+ * useModelListener<IWorksheet, IWorksheet.IListeners>(sheet, {
50
50
  * onSave(source, json) {
51
51
  * console.log('Sheet saved:', json);
52
52
  * },
@@ -0,0 +1,35 @@
1
+ import { ICellRange, IWorkbook, IWorksheet } from '@sheetxl/sdk';
2
+ /**
3
+ * A workbook or a sheet: anything a range can be read from. A workbook address may be sheet-qualified
4
+ * (`'Invoice!A4'`); an unqualified one reads from the selected sheet.
5
+ */
6
+ export type CellRangeTarget = IWorkbook | IWorksheet;
7
+ /**
8
+ * Options shared by the cell-binding hooks.
9
+ */
10
+ export interface CellRangeHookOptions extends Omit<ICellRange.ListenerOptions, 'transactional'> {
11
+ /**
12
+ * Called with every change event the hook receives, before it re-renders.
13
+ *
14
+ * @remarks
15
+ * Uses the hook's own subscription. To receive events without re-rendering, use
16
+ * {@link useRangeListener} instead.
17
+ */
18
+ onChange?: ICellRange.Listener;
19
+ }
20
+ /**
21
+ * Resolves `address` against `target` and returns the range with a value read from it. Both are
22
+ * re-read only after the range reports a change, so they are stable between changes, as
23
+ * `useSyncExternalStore` requires.
24
+ *
25
+ * @param topLeft Narrow the range to its top-left cell.
26
+ *
27
+ * @remarks
28
+ * The range follows its cells: when rows or columns are inserted or deleted around it (or undone),
29
+ * the returned range is the one at the new address, so a write goes where the cells went.
30
+ */
31
+ export declare const useRangeSnapshot: <T>(target: CellRangeTarget | null | undefined, address: ICellRange.Address, topLeft: boolean, read: (range: ICellRange) => T, options?: CellRangeHookOptions) => {
32
+ range: ICellRange | null;
33
+ snapshot: T | null;
34
+ };
35
+ //# sourceMappingURL=useRangeSnapshot.d.ts.map
@@ -0,0 +1,26 @@
1
+ import { ITable } from '@sheetxl/sdk';
2
+ import { CellRangeTarget, CellRangeHookOptions } from './useRangeSnapshot';
3
+ /**
4
+ * Returns the table named `name` and re-renders when it changes: rows added or removed, its cells
5
+ * edited, or its settings changed.
6
+ *
7
+ * @param target The workbook or sheet to find the table in, or `null` while there is none. A workbook
8
+ * looks in each of its sheets.
9
+ * @param name The table's name.
10
+ * @param options Listener options for its cells, and an optional `onChange` that receives each change
11
+ * event in them.
12
+ * @returns The table, or `null` while `target` is `null` or has no table of that name.
13
+ *
14
+ * @remarks
15
+ * The returned table is the same object across renders; read from it during render, and change it
16
+ * through its own methods, such as {@link ITable.addRow} and {@link ITable.deleteRowsAt}.
17
+ *
18
+ * @example
19
+ * ```tsx
20
+ * const items = useTable(workbook, 'Items');
21
+ * const rows = items?.getDataRange().getValues() ?? [];
22
+ * return <button onClick={() => items?.addRow()}>Add</button>;
23
+ * ```
24
+ */
25
+ export declare const useTable: (target: CellRangeTarget | null | undefined, name: string, options?: CellRangeHookOptions) => ITable | null;
26
+ //# sourceMappingURL=useTable.d.ts.map
@@ -0,0 +1,8 @@
1
+ import { default as React } from 'react';
2
+ import { MovableElementProps } from './IMovableArea';
3
+ /**
4
+ * Renders a movable with the renderer for its kind of content, or a placeholder for a kind with
5
+ * none. The default `renderMovable` of a sheet element.
6
+ */
7
+ export declare const renderDefaultMovable: (props: MovableElementProps) => React.ReactElement;
8
+ //# sourceMappingURL=DefaultMovable.d.ts.map
@@ -1,5 +1,5 @@
1
1
  import { RemoveListener, EditModeHandler } from '@sheetxl/utils';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { Command, IReactNotifier } from '@sheetxl/utils-react';
4
4
  import { ActivateFrameOptions, ITaskPaneArea } from '../taskPane';
5
5
  /** Options for {@link contributeMovableCommands}. */
@@ -21,7 +21,7 @@ export interface ContributeMovableCommandsOptions {
21
21
  */
22
22
  /** The single `data` bundle {@link contributeMovableCommands} takes (the `DynamicCommandContributor` shape). */
23
23
  export interface MovableCommandData extends ContributeMovableCommandsOptions {
24
- sheet: ISheet | null;
24
+ sheet: IWorksheet | null;
25
25
  }
26
26
  export declare function contributeMovableCommands(contribution: Command.CommandContribution, data: MovableCommandData): RemoveListener;
27
27
  //# sourceMappingURL=MovableCommands.d.ts.map
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { IMovable, ISheet } from '@sheetxl/sdk';
2
+ import { IMovable, IWorksheet } from '@sheetxl/sdk';
3
3
  import { Command, IReactNotifier } from '@sheetxl/utils-react';
4
4
  import { ActivateFrameOptions, ITaskPaneArea } from '../taskPane';
5
5
  import { MovableElementProps } from './IMovableArea';
@@ -22,7 +22,7 @@ export type MovableRenderer = React.ComponentType<MovableRendererProps>;
22
22
  */
23
23
  export interface MovablePaneProps {
24
24
  movable: IMovable;
25
- sheet: ISheet;
25
+ sheet: IWorksheet;
26
26
  }
27
27
  /**
28
28
  * The `data` a kind's {@link MovableRendererModule.commands} contributor is handed while a movable of
@@ -30,7 +30,7 @@ export interface MovablePaneProps {
30
30
  * movable of the kind becomes the active one, so it never tracks the selection itself.
31
31
  */
32
32
  export interface MovableKindCommandData {
33
- sheet: ISheet;
33
+ sheet: IWorksheet;
34
34
  /** The active selected movable, always of this kind. */
35
35
  movable: IMovable;
36
36
  notifier?: IReactNotifier;
@@ -9,6 +9,7 @@ export * from './MovableEdit';
9
9
  export * from './EmptyFrame';
10
10
  export * from './TextBox';
11
11
  export * from './MovableRenderers';
12
+ export * from './DefaultMovable';
12
13
  export * from './MovableCommandGroups';
13
14
  export * from './ConnectionSites';
14
15
  //# sourceMappingURL=index.d.ts.map
@@ -1,6 +1,6 @@
1
- import { ISheet } from '@sheetxl/sdk';
1
+ import { IWorksheet } from '@sheetxl/sdk';
2
2
  /** Record that `sheet`'s picker opened, or (`null`) that the open one closed. */
3
- export declare const setCellPickerOpen: (sheet: ISheet | null) => void;
3
+ export declare const setCellPickerOpen: (sheet: IWorksheet | null) => void;
4
4
  /** Whether `sheet` has a cell picker open (reactive). */
5
- export declare const useCellPickerOpen: (sheet: ISheet) => boolean;
5
+ export declare const useCellPickerOpen: (sheet: IWorksheet) => boolean;
6
6
  //# sourceMappingURL=cellPickerOpen.d.ts.map
@@ -1,6 +1,6 @@
1
1
  import { default as React } from 'react';
2
2
  import { CellCoords, MaybePromise } from '@sheetxl/utils';
3
- import { ISheet } from '@sheetxl/sdk';
3
+ import { IWorksheet } from '@sheetxl/sdk';
4
4
  import { GridAnchor, IEditable } from '@sheetxl/grid-react';
5
5
  import { PickerItem } from './PickerPanel';
6
6
  /**
@@ -10,7 +10,7 @@ import { PickerItem } from './PickerPanel';
10
10
  */
11
11
  export interface CellPickerOptions {
12
12
  /** The sheet the cell is on: its `Normal` font, its current text, and the open flag. */
13
- sheet: ISheet;
13
+ sheet: IWorksheet;
14
14
  /**
15
15
  * The editable a default choice is entered through — the same path as typing the item's text, so
16
16
  * the value coerces and formats as a typed one does. Not needed when {@link onChoose} is given.
@@ -1,5 +1,5 @@
1
1
  import { default as React } from 'react';
2
- import { IRichText, IStyledFont } from '@sheetxl/sdk';
2
+ import { IRichText, IFontStyle } from '@sheetxl/sdk';
3
3
  /**
4
4
  * The contract of a rich text editor: text in, edited text out. A host may supply its own in place
5
5
  * of the default {@link RichTextEditor}.
@@ -26,7 +26,7 @@ export interface RichTextEditorProps extends Omit<React.HTMLAttributes<HTMLDivEl
26
26
  /**
27
27
  * The CSS for the font properties a run sets.
28
28
  */
29
- runStyle?: (font: IStyledFont.JSON) => React.CSSProperties | undefined;
29
+ runStyle?: (font: IFontStyle.JSON) => React.CSSProperties | undefined;
30
30
  ref?: React.Ref<HTMLDivElement>;
31
31
  }
32
32
  /**
@@ -1,12 +1,12 @@
1
1
  import { RemoveListener } from '@sheetxl/utils';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { Command } from '@sheetxl/utils-react';
4
4
  import { SelectionNavigation } from '@sheetxl/grid-react';
5
5
  /** The single `data` bundle {@link contributeSelectionCommands} takes (the `DynamicCommandContributor` shape). */
6
6
  export interface SelectionCommandData {
7
7
  /** `null` on the first render — the layer's `SelectionNavigation` is produced by its child via a ref. */
8
8
  navigation: SelectionNavigation | null;
9
- sheet?: ISheet;
9
+ sheet?: IWorksheet;
10
10
  }
11
11
  /**
12
12
  * Contribute the selection **behavior** onto `contribution` (a per-pane layer scope's contribution), as thin
@@ -1,11 +1,11 @@
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 { CommandContext } from '../frame';
5
5
  import { SheetLocation } from '../sheet';
6
6
  export interface SheetSelectionLayerProps extends LayerProps {
7
7
  /** The sheet whose `getSelection()` this layer drives. */
8
- sheet: ISheet;
8
+ sheet: IWorksheet;
9
9
  /** Whether this sheet/pane is the active one (gates move/fill interaction). */
10
10
  isActive?: boolean;
11
11
  /**
@@ -4,7 +4,7 @@ import { ISheetHeader } from '@sheetxl/sdk';
4
4
  import { Viewport, ThemeMode } from '@sheetxl/utils-react';
5
5
  import { IGridSurface } from '@sheetxl/grid-react';
6
6
  import { SheetCellRendererProps, ColumnButtonConfigProps } from '../cell';
7
- import { SheetLocation } from './ISheetElement';
7
+ import { SheetLocation } from './IWorksheetElement';
8
8
  /**
9
9
  * Props for the SheetHeaderElement component.
10
10
  */
@@ -1,5 +1,5 @@
1
- import { ISheet, ICell, IMovable } from '@sheetxl/sdk';
2
- import { ViewportMetrics, ScrollPaneProps, Viewport, ThemeMode } from '@sheetxl/utils-react';
1
+ import { IWorksheet, ICell, IMovable } from '@sheetxl/sdk';
2
+ import { ViewportMetrics, ScrollPaneProps, Viewport, ThemeMode, LoadingPanelProps, ErrorPanelProps } from '@sheetxl/utils-react';
3
3
  import { GridSurfaceProps, IGridSurface, IEditable, LayerNode } from '@sheetxl/grid-react';
4
4
  import { SheetCellRendererProps, ColumnButtonConfigProps, OutlineProps } from '../cell';
5
5
  import { MovableElementProps } from '../movable';
@@ -21,13 +21,46 @@ export interface SheetLocation {
21
21
  colIndex?: number;
22
22
  }
23
23
  /**
24
- * Props for the SheetElement component.
24
+ * Props for the WorksheetElement component.
25
25
  */
26
- export interface SheetElementProps extends React.HTMLAttributes<HTMLDivElement>, React.Attributes {
26
+ export interface WorksheetElementProps extends React.HTMLAttributes<HTMLDivElement>, React.Attributes {
27
27
  /**
28
- * The `ISheet` to render.
28
+ * The sheet to render, or a `Promise` for one. The element is empty until the sheet resolves and
29
+ * its text can be measured; a later input keeps the current sheet showing until it resolves.
29
30
  */
30
- sheet: ISheet;
31
+ sheet: IWorksheet | Promise<IWorksheet>;
32
+ /**
33
+ * Called with the sheet once {@link WorksheetElementProps.sheet} resolves, and again whenever a new
34
+ * input resolves to a different one. Until the first input resolves, or if an input fails, the
35
+ * sheet is `null`.
36
+ *
37
+ * @remarks
38
+ * Lets an app pass a `Promise` here and hold the live sheet in its own state, without awaiting or
39
+ * suspending.
40
+ *
41
+ * @example
42
+ * ```tsx
43
+ * const [pending] = useState(() => createInvoice());
44
+ * const [sheet, setSheet] = useState<IWorksheet | null>(null);
45
+ * const [total] = useCellValue<number>(sheet, 'D23');
46
+ * return <WorksheetElement sheet={pending} onSheetChange={setSheet} />;
47
+ * ```
48
+ */
49
+ onSheetChange?: (sheet: IWorksheet | null) => void;
50
+ /**
51
+ * Props passed to the loading panel.
52
+ */
53
+ propsSheetLoading?: Partial<LoadingPanelProps>;
54
+ /**
55
+ * Custom loading panel, shown while a `Promise` {@link WorksheetElementProps.sheet} resolves or the
56
+ * text engine loads. Defaults to a spinner.
57
+ */
58
+ renderSheetLoading?: (props: LoadingPanelProps) => React.ReactElement;
59
+ /**
60
+ * Custom error panel, shown when a `Promise` {@link WorksheetElementProps.sheet} fails to resolve.
61
+ * Defaults to a minimal message.
62
+ */
63
+ renderSheetError?: (props: ErrorPanelProps) => React.ReactElement;
31
64
  /**
32
65
  * The app (chrome / header) color scheme — selects the header/app surface mode.
33
66
  */
@@ -106,7 +139,7 @@ export interface SheetElementProps extends React.HTMLAttributes<HTMLDivElement>,
106
139
  /**
107
140
  * The app-created editor for the always-mounted cell editor. When provided, the grid edits through
108
141
  * this shared {@link IEditable}; pass the SAME instance to the formula bar for free two-way sync. A
109
- * stable reference. If omitted, a standalone SheetElement makes its own.
142
+ * stable reference. If omitted, a standalone WorksheetElement makes its own.
110
143
  */
111
144
  editable?: IEditable<() => ICell, string>;
112
145
  /**
@@ -193,12 +226,12 @@ export interface SheetElementProps extends React.HTMLAttributes<HTMLDivElement>,
193
226
  /**
194
227
  * Ref to the sheet element.
195
228
  */
196
- ref?: React.Ref<ISheetElement>;
229
+ ref?: React.Ref<IWorksheetElement>;
197
230
  }
198
231
  /**
199
232
  * Attributes and methods available on the sheet element beyond the HTMLDivElement.
200
233
  */
201
- export type ISheetAttributes = {
234
+ export type IWorksheetAttributes = {
202
235
  getGridSurface: () => IGridSurface;
203
236
  getRowHeaderElement: () => ISheetHeaderElement;
204
237
  getColumnHeaderElement: () => ISheetHeaderElement;
@@ -224,9 +257,9 @@ export type ISheetAttributes = {
224
257
  */
225
258
  focusMovable(movable?: IMovable): Promise<boolean>;
226
259
  /**
227
- * Returns the attached `ISheet`.
260
+ * Returns the attached `IWorksheet`.
228
261
  */
229
- getSheet: () => ISheet;
262
+ getWorksheet: () => IWorksheet;
230
263
  /**
231
264
  * For runtime introspection.
232
265
  */
@@ -235,6 +268,6 @@ export type ISheetAttributes = {
235
268
  /**
236
269
  * Type returned via ref property
237
270
  */
238
- export interface ISheetElement extends HTMLDivElement, ISheetAttributes {
271
+ export interface IWorksheetElement extends HTMLDivElement, IWorksheetAttributes {
239
272
  }
240
- //# sourceMappingURL=ISheetElement.d.ts.map
273
+ //# sourceMappingURL=IWorksheetElement.d.ts.map
@@ -0,0 +1,21 @@
1
+ import { default as React } from 'react';
2
+ import { IOpaqueSheet } from '@sheetxl/sdk';
3
+ export interface OpaqueSheetElementProps extends React.HTMLAttributes<HTMLDivElement> {
4
+ /**
5
+ * The sheet.
6
+ */
7
+ sheet: IOpaqueSheet;
8
+ /**
9
+ * Called once the pane has rendered, as a worksheet's grid calls it once it has.
10
+ */
11
+ onFirstRender?: () => void;
12
+ }
13
+ /**
14
+ * The pane shown for a chart sheet, a macro sheet or a dialog sheet while it is the active tab.
15
+ *
16
+ * @remarks
17
+ * Such a sheet is carried as read and saved unchanged; this names its kind and says so. A chart
18
+ * sheet's chart is drawn here once chart sheets have their chart.
19
+ */
20
+ export declare const OpaqueSheetElement: React.FC<OpaqueSheetElementProps>;
21
+ //# sourceMappingURL=OpaqueSheetElement.d.ts.map
@@ -1,5 +1,5 @@
1
1
  import { ReactNode } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { Command, IViewport } from '@sheetxl/utils-react';
4
4
  import { SheetEditable } from '../editor';
5
5
  import { SheetCommandData } from './SheetCommands';
@@ -16,7 +16,7 @@ export interface SheetCommandContributorData extends SheetCommandData {
16
16
  export declare const SheetCommandContributor: Command.CommandContributor<SheetCommandContributorData>;
17
17
  interface SheetCommandProviderProps {
18
18
  /** The active sheet the cell/format commands operate on. */
19
- sheet: ISheet | null;
19
+ sheet: IWorksheet | null;
20
20
  /** The shared cell editable — the **ready-mode** insert commands (`insertCurrent*`/`insertFunction*`) seed
21
21
  * an edit through it. `undefined` on a bare grid ⇒ those commands stay chrome-only (disabled). */
22
22
  editable?: SheetEditable | null;
@@ -1,5 +1,5 @@
1
1
  import { EditModeHandler, ReferenceableClipboard, RemoveListener, UndoManager } from '@sheetxl/utils';
2
- import { IBorders, IRange, IColor, ISheet } from '@sheetxl/sdk';
2
+ import { IBorders, IRange, IColor, IWorksheet } from '@sheetxl/sdk';
3
3
  import { Command, IReactNotifier, IViewport } from '@sheetxl/utils-react';
4
4
  import { ActivateFrameOptions, ITaskPaneArea } from '../taskPane';
5
5
  /** Minimal shape of the global clipboard handle the insert-copied-cells path reads. */
@@ -45,7 +45,7 @@ export interface ContributeSheetCommandsOptions {
45
45
  * together (the `DynamicCommandContributor` shape). `sheet` may be `null` on a bare grid (⇒ no behavior).
46
46
  */
47
47
  export interface SheetCommandData extends ContributeSheetCommandsOptions {
48
- sheet: ISheet | null;
48
+ sheet: IWorksheet | null;
49
49
  }
50
50
  /**
51
51
  * The arguments of the `freezePanesAt` command.
@@ -0,0 +1,14 @@
1
+ import { default as React } from 'react';
2
+ import { ISheet } from '@sheetxl/sdk';
3
+ export interface SheetKindIconProps extends React.HTMLAttributes<HTMLElement> {
4
+ /**
5
+ * The kind of sheet.
6
+ */
7
+ kind: ISheet.Kind;
8
+ }
9
+ /**
10
+ * The glyph that marks a sheet of a kind other than a worksheet: on its tab, in sheet lists, and on
11
+ * its pane. A worksheet has none, so it renders nothing.
12
+ */
13
+ export declare const SheetKindIcon: React.FC<SheetKindIconProps>;
14
+ //# sourceMappingURL=SheetKindIcon.d.ts.map
@@ -1,11 +1,11 @@
1
1
  import { default as React } from 'react';
2
2
  import { FixedEdge } from '@sheetxl/utils';
3
- import { IRange, ISheet } from '@sheetxl/sdk';
3
+ import { IRange, IWorksheet } from '@sheetxl/sdk';
4
4
  import { Viewport, ThemeMode } from '@sheetxl/utils-react';
5
5
  import { OutlineButtonProps, OutlineLevelButtonProps } from '../cell/OutlineButton';
6
6
  export interface SheetOutlineElementProps extends React.HTMLAttributes<HTMLElement> {
7
7
  /** The sheet whose outline is drawn. */
8
- sheet: ISheet;
8
+ sheet: IWorksheet;
9
9
  /** Rows (the gutter left of the row headers) or columns (above the column headers). */
10
10
  axis: IRange.Axis;
11
11
  /** The lanes across the gutter: one per level, plus one. */
@@ -31,7 +31,7 @@ export interface SheetOutlineElementProps extends React.HTMLAttributes<HTMLEleme
31
31
  * @remarks
32
32
  * Built like `SheetHeaderElement` — its own `GridSurface` over the header's offsets, following the
33
33
  * sheet's viewport along the axis, so it scrolls, zooms, hides and freezes with the headers. The
34
- * owner decides whether there is one (see `ISheetView.isShowOutlineSymbols` and `getLevelCount`) and sizes
34
+ * owner decides whether there is one (see `IWorksheetView.isShowOutlineSymbols` and `getLevelCount`) and sizes
35
35
  * it.
36
36
  *
37
37
  * It is app chrome, not header: it declares the `app` surface and paints no fill, so it shows what
@@ -40,7 +40,7 @@ export interface SheetOutlineElementProps extends React.HTMLAttributes<HTMLEleme
40
40
  export declare const SheetOutlineElement: React.MemoExoticComponent<(props: SheetOutlineElementProps) => React.JSX.Element>;
41
41
  export interface SheetOutlineLevelsProps extends React.HTMLAttributes<HTMLElement> {
42
42
  /** The sheet whose outline the buttons show levels of. */
43
- sheet: ISheet;
43
+ sheet: IWorksheet;
44
44
  /** Rows or columns. */
45
45
  axis: IRange.Axis;
46
46
  /** The number of buttons: one per level, plus one. */
@@ -0,0 +1,11 @@
1
+ import { default as React } from 'react';
2
+ import { ErrorPanelProps, LoadingPanelProps } from '@sheetxl/utils-react';
3
+ /**
4
+ * The default loading panel of a sheet or workbook element: a spinner, centered.
5
+ */
6
+ export declare const renderSheetLoading: (props: LoadingPanelProps) => React.ReactElement;
7
+ /**
8
+ * The default error panel of a sheet or workbook element: the error's message, centered.
9
+ */
10
+ export declare const renderSheetError: (props: ErrorPanelProps) => React.ReactElement;
11
+ //# sourceMappingURL=SheetPanels.d.ts.map
@@ -1,11 +1,11 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { ScrollbarOrientation, VirtualScrollbarProps, IScrollbarElement } from '@sheetxl/utils-react';
4
4
  export interface SheetScrollbarProps extends VirtualScrollbarProps {
5
5
  /**
6
- * The `ISheet` for the given scrollbar.
6
+ * The `IWorksheet` for the given scrollbar.
7
7
  */
8
- sheet: ISheet;
8
+ sheet: IWorksheet;
9
9
  /**
10
10
  * The direction of the scrollbar.
11
11
  */
@@ -1,8 +1,8 @@
1
1
  import { default as React } from 'react';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { ThemeMode } from '@sheetxl/utils-react';
4
4
  export interface TopLeftCornerProps extends React.HTMLProps<HTMLElement> {
5
- sheet: ISheet;
5
+ sheet: IWorksheet;
6
6
  /** The app (header) color scheme — headers follow the app surface; colors come from the header-surface
7
7
  * tokens. */
8
8
  colorScheme?: ThemeMode;
@@ -0,0 +1,12 @@
1
+ import { default as React } from 'react';
2
+ import { IWorksheetElement, WorksheetElementProps } from './IWorksheetElement';
3
+ /**
4
+ * UI representation for IWorksheet.
5
+ *
6
+ * @remarks
7
+ * It draws once the sheet has resolved and the text engine has loaded, so a sheet with no workbook
8
+ * needs no `whenReady()` first. Until then its box shows the loading panel, or the error panel if the
9
+ * sheet fails.
10
+ */
11
+ export declare const WorksheetElement: React.NamedExoticComponent<Omit<WorksheetElementProps, "ref"> & React.RefAttributes<IWorksheetElement>>;
12
+ //# sourceMappingURL=WorksheetElement.d.ts.map
@@ -1,4 +1,4 @@
1
- import { ISheetView, IRange } from '@sheetxl/sdk';
1
+ import { IWorksheetView, IRange } from '@sheetxl/sdk';
2
2
  /**
3
3
  * Move one axis's freeze to `index` (`0` unfreezes that axis), leaving the other axis as it is.
4
4
  *
@@ -6,5 +6,5 @@ import { ISheetView, IRange } from '@sheetxl/sdk';
6
6
  * position. Either way what is on screen stays put — provided the scrolling area starts exactly at the
7
7
  * current freeze, which is when the freeze grip allows a drag.
8
8
  */
9
- export declare const freezeAt: (view: ISheetView, axis: IRange.Axis, index: number) => void;
9
+ export declare const freezeAt: (view: IWorksheetView, axis: IRange.Axis, index: number) => void;
10
10
  //# sourceMappingURL=_freezeAt.d.ts.map
@@ -1,4 +1,4 @@
1
- import { IRange, ISheet } from '@sheetxl/sdk';
1
+ import { IRange, IWorksheet } from '@sheetxl/sdk';
2
2
  /**
3
3
  * The cell a sheet's status bar names for its UNRESOLVED circular references — Excel's
4
4
  * `Worksheet.CircularReference`, one cell — or `null` when the sheet has none.
@@ -17,7 +17,7 @@ import { IRange, ISheet } from '@sheetxl/sdk';
17
17
  * way, so an iterated cycle stays discoverable where it is; what goes quiet is the workbook-level
18
18
  * alarm, which is the same line `ICell.getErrors()` draws (§7.3).
19
19
  */
20
- export declare const findSheetCircularReference: (sheet: ISheet) => IRange.CellCoords | null;
20
+ export declare const findSheetCircularReference: (sheet: IWorksheet) => IRange.CellCoords | null;
21
21
  /**
22
22
  * A cell address the way a formula on `sheetName` would write it: bare on its own sheet
23
23
  * (`A1`), sheet-qualified elsewhere (`'Other Sheet'!A1`).
@@ -30,5 +30,5 @@ export declare const formatCellAddress: (coords: IRange.CellCoords, sheetName: s
30
30
  * The "go to" behind a circular tooltip's link and the status bar's readout. A `scope` this
31
31
  * workbook does not know (a cycle member in a named formula's body) selects nothing.
32
32
  */
33
- export declare const selectCell: (sheet: ISheet, target: IRange.CellCoords) => Promise<unknown> | null;
33
+ export declare const selectCell: (sheet: IWorksheet, target: IRange.CellCoords) => Promise<unknown> | null;
34
34
  //# sourceMappingURL=circularReferences.d.ts.map
@@ -1,5 +1,8 @@
1
- export type * from './ISheetElement';
2
- export * from './SheetElement';
1
+ export type * from './IWorksheetElement';
2
+ export * from './WorksheetElement';
3
+ export * from './OpaqueSheetElement';
4
+ export * from './SheetPanels';
5
+ export * from './SheetKindIcon';
3
6
  export * from './SheetScrollbar';
4
7
  export * from './SheetCommands';
5
8
  export * from './SheetCommandProvider';
@@ -1,4 +1,4 @@
1
- import { ICalculation, ISheet } from '@sheetxl/sdk';
1
+ import { ICalculation, IWorksheet } from '@sheetxl/sdk';
2
2
  /**
3
3
  * Outlines a reference cycle's MEMBERS on the grid for as long as the caller is mounted — the
4
4
  * highlight behind a circular tooltip.
@@ -17,5 +17,5 @@ import { ICalculation, ISheet } from '@sheetxl/sdk';
17
17
  * (the cleanup then finds someone else's state and leaves it alone, rather than clearing a live
18
18
  * edit's references out from under it). A cycle with no live members publishes nothing.
19
19
  */
20
- export declare const useCycleHighlight: (sheet: ISheet | null, cycle: ICalculation.ICircularReference | null | undefined) => void;
20
+ export declare const useCycleHighlight: (sheet: IWorksheet | null, cycle: ICalculation.ICircularReference | null | undefined) => void;
21
21
  //# sourceMappingURL=useCycleHighlight.d.ts.map
@@ -12,7 +12,7 @@ export interface SheetTabSurfaceProps extends React.HTMLAttributes<HTMLDivElemen
12
12
  }
13
13
  export interface SheetTabProps extends TabProps {
14
14
  /**
15
- * The sheet.
15
+ * The sheet, of any kind.
16
16
  */
17
17
  sheet: ISheet;
18
18
  /**
@@ -1,5 +1,5 @@
1
1
  import { RemoveListener, UndoManager } from '@sheetxl/utils';
2
- import { ISheet } from '@sheetxl/sdk';
2
+ import { IWorksheet } from '@sheetxl/sdk';
3
3
  import { Command, IReactNotifier } from '@sheetxl/utils-react';
4
4
  /** Options for {@link contributeTableCommands}. */
5
5
  export interface ContributeTableCommandsOptions {
@@ -10,7 +10,7 @@ export interface ContributeTableCommandsOptions {
10
10
  }
11
11
  /** The single `data` bundle {@link contributeTableCommands} takes (the `DynamicCommandContributor` shape). */
12
12
  export interface TableCommandData extends ContributeTableCommandsOptions {
13
- sheet: ISheet | null;
13
+ sheet: IWorksheet | null;
14
14
  }
15
15
  export declare function contributeTableCommands(contribution: Command.CommandContribution, data: TableCommandData): RemoveListener;
16
16
  //# sourceMappingURL=TableCommands.d.ts.map
@@ -112,6 +112,13 @@ export interface ITaskPaneArea {
112
112
  * @param key The task pane key.
113
113
  */
114
114
  activate: <A = any>(key: string, options?: ActivateFrameOptions<A>) => void;
115
+ /**
116
+ * Whether {@link activate} can show the task pane `key`: there is an area to show it in, and a
117
+ * pane registered under that key. A command that opens a pane is disabled when this is `false`.
118
+ *
119
+ * @param key The task pane key.
120
+ */
121
+ canActivate: (key: string) => boolean;
115
122
  /**
116
123
  * Return the key for the currently active task pane.
117
124
  */