@sheetxl/react 0.8.0-beta.11 → 0.8.0-beta.13

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 (141) hide show
  1. package/browser/esm/{B93LSmhnvkxNXTq-.mjs → -wQNyCnoJdQUTTfP.mjs} +1 -1
  2. package/browser/esm/{Bl2BFCQ00fotauKB.mjs → AL94cpxFjPurAMQG.mjs} +1 -1
  3. package/browser/esm/{BQYS2Yf-EAV_tBLr.mjs → B4K8rf7TAv0SBkbG.mjs} +1 -1
  4. package/browser/esm/{ClAtIfYbsUPA073B.mjs → BrwfFgqKdMG_-iar.mjs} +1 -1
  5. package/browser/esm/ByBGwdqhc_l75i5G.mjs +145 -0
  6. package/browser/esm/{DgL7Dy-Lqcr1TvW6.mjs → C1zqAqKQ6oa4FiTH.mjs} +4851 -4818
  7. package/browser/esm/C9lQPmVMIlUwXkKr.mjs +303 -0
  8. package/browser/esm/{Dnh1kpz3v1JKtRD_.mjs → CIrcPI7uOT93ydNn.mjs} +2 -2
  9. package/browser/esm/{DS66lAIM-9M-YoZQ.mjs → CZsNidKZjsn0lNnA.mjs} +112 -104
  10. package/browser/esm/{Bos4Rkp8UTF7QXUB.mjs → CcewpxckpDrXSiZ-.mjs} +1 -1
  11. package/browser/esm/{BegvsXeRs7e-9t8k.mjs → CdDvFP8Fqm8uU7Rw.mjs} +1 -1
  12. package/browser/esm/{D2u6THGErqw64KQI.mjs → CfewUx0gINn-wXt3.mjs} +1 -1
  13. package/browser/esm/{C1pc9F4Rt2C5FKUo.mjs → CfvYfq6ALVqkCsdg.mjs} +1 -1
  14. package/browser/esm/CulxiChz6lj3G9lw.mjs +341 -0
  15. package/browser/esm/D5Uy22WeT7vUS36Z.mjs +19 -0
  16. package/browser/esm/{1-LEUre9ZLG0OYYB.mjs → Dd8deQ2CDMdrhzF1.mjs} +6 -6
  17. package/browser/esm/Dit7p67J_fDF5RDj.mjs +262 -0
  18. package/browser/esm/{CPnnESfZz2jjJd82.mjs → DzWFl-_dCN-EOkio.mjs} +3 -3
  19. package/browser/esm/{94dxo1A-z8lgiiGw.mjs → MIDbAwdzknMaoTU5.mjs} +2 -2
  20. package/browser/esm/{B26QVfjer2oY2ewK.mjs → ao9zR4H88b7AmZEV.mjs} +1 -1
  21. package/browser/esm/chart.mjs +28 -27
  22. package/browser/esm/control.mjs +74 -73
  23. package/browser/esm/group.mjs +3 -3
  24. package/browser/esm/index.mjs +6195 -5307
  25. package/browser/esm/note.mjs +5 -5
  26. package/browser/esm/picture.mjs +2 -81
  27. package/browser/esm/sXn9faQLuh4P0TZ9.mjs +401 -0
  28. package/browser/esm/shape.mjs +2 -2
  29. package/browser/esm/slicer.mjs +112 -111
  30. package/browser/esm/{CzRIbc-Lk__VMLKM.mjs → u3A8I4A7GKIOLOOb.mjs} +3 -3
  31. package/browser/esm/{DMdsMPT0fWBbTkNn.mjs → x6A47UA3fzV361tO.mjs} +1 -1
  32. package/node/esm/{BiaDWnN3tT7neoRL.mjs → A_4Y7EtzCWp1AG3Y.mjs} +1 -1
  33. package/node/esm/BNwVylzKMErhrx4i.mjs +406 -0
  34. package/node/esm/BPBUSXc5TVnD15By.mjs +146 -0
  35. package/node/esm/{DxQZmb-j4NLUO9Af.mjs → BTT6UB5lGvPxcq3F.mjs} +1 -1
  36. package/node/esm/{JiQGhLkoL8CJpVvA.mjs → BYiAmyF-aOOuMkD1.mjs} +1 -1
  37. package/node/esm/BqS8o-CmPoCjHDHp.mjs +263 -0
  38. package/node/esm/{b-XRVRI1fYQQMkTC.mjs → CC_XgLOFPvqmFyZ_.mjs} +525 -492
  39. package/node/esm/{BaRfst1euuhquupX.mjs → CMGUrHMaBDeCezK5.mjs} +1 -1
  40. package/node/esm/{umljAT66yb3_rURh.mjs → CP07qkepi21zlB0n.mjs} +118 -110
  41. package/node/esm/{BlxXufqBBg1PtsXd.mjs → CQJJMfuXl6mbgHdT.mjs} +1 -1
  42. package/node/esm/{C_SNx7TlFEcwbYjx.mjs → CVDVFhM7OIpaOlyN.mjs} +1 -1
  43. package/node/esm/{gpD-9LDW92phhoma.mjs → CVMuO9bpR5YK0pPb.mjs} +1 -1
  44. package/node/esm/{BMVK5plvmBOAIlxP.mjs → CaZG4HD3SmHvD-Tu.mjs} +1 -1
  45. package/node/esm/{6zApGj9DozhFy-bx.mjs → CuRPfxQCj2jookWL.mjs} +1 -1
  46. package/node/esm/D8mYmUPUA6i8oFgR.mjs +19 -0
  47. package/node/esm/{Dj5FM7_-YWhCtCCt.mjs → DAUtyjkW5uSdnTli.mjs} +1 -1
  48. package/node/esm/{D_pCpfdQowV_4Aje.mjs → DfvJ0Dpn-AP2mGtz.mjs} +5 -5
  49. package/node/esm/{DTMTIrYIK1eZswsM.mjs → DipZYwHed-W6QMtQ.mjs} +1 -1
  50. package/node/esm/{Be9c1GwQkPo8Piuh.mjs → NvP_j9pSsDiJ_PyY.mjs} +3 -3
  51. package/node/esm/chart.mjs +26 -25
  52. package/node/esm/control.mjs +79 -78
  53. package/node/esm/{sigD1UFqvPlWUw_9.mjs → eecr5gnC2KqVhOzX.mjs} +2 -2
  54. package/node/esm/group.mjs +3 -3
  55. package/node/esm/index.mjs +6594 -5705
  56. package/node/esm/note.mjs +18 -18
  57. package/node/esm/picture.mjs +269 -50
  58. package/node/esm/shape.mjs +185 -578
  59. package/node/esm/slicer.mjs +51 -50
  60. package/package.json +7 -7
  61. package/resources/locales/de/picture.cmd.json +157 -0
  62. package/resources/locales/de/sheet.cmd.json +45 -2
  63. package/resources/locales/de/ui.msg.json +3 -0
  64. package/resources/locales/de/workbook.cmd.json +6 -0
  65. package/resources/locales/en/picture.cmd.json +157 -0
  66. package/resources/locales/en/sheet.cmd.json +45 -2
  67. package/resources/locales/en/ui.msg.json +5 -0
  68. package/resources/locales/en/workbook.cmd.json +6 -0
  69. package/types/src/border/useBorders.d.ts +2 -2
  70. package/types/src/cell/CellCheckboxRenderer.d.ts +20 -0
  71. package/types/src/cell/CellContent.d.ts +68 -0
  72. package/types/src/cell/CellControlContext.d.ts +37 -0
  73. package/types/src/cell/{FormulaCellRenderer.d.ts → CellFormulaRenderer.d.ts} +5 -5
  74. package/types/src/cell/CellImageRenderer.d.ts +11 -0
  75. package/types/src/cell/CellRenderers.d.ts +190 -0
  76. package/types/src/cell/{SheetCellRenderer.d.ts → CellTextRenderer.d.ts} +9 -6
  77. package/types/src/cell/ColumnButton.d.ts +3 -3
  78. package/types/src/cell/OutlineButton.d.ts +4 -4
  79. package/types/src/cell/SheetHeaderRenderer.d.ts +1 -1
  80. package/types/src/cell/index.d.ts +8 -2
  81. package/types/src/cell/useFormulaViewAnchor.d.ts +1 -1
  82. package/types/src/cell/useInsertableCellControls.d.ts +25 -0
  83. package/types/src/chart/ChartCommands.d.ts +1 -1
  84. package/types/src/chart/ChartEditor.d.ts +2 -0
  85. package/types/src/chart/ChartElement.d.ts +14 -3
  86. package/types/src/chart/paint/_graphics.d.ts +0 -8
  87. package/types/src/chart/paint/_mode.d.ts +6 -0
  88. package/types/src/chart/paint/echarts.d.ts +6 -3
  89. package/types/src/chart/paint/index.d.ts +1 -1
  90. package/types/src/chart/paint/kinds/ChartPaintKind.d.ts +9 -1
  91. package/types/src/chart/paint/kinds/_builtIns.d.ts +0 -9
  92. package/types/src/chart/paint/toEChartsOption.d.ts +12 -1
  93. package/types/src/editableLabel/EditableLabel.d.ts +3 -1
  94. package/types/src/editor/SheetReferenceHeaderLayer.d.ts +1 -1
  95. package/types/src/editor/useFormulaHints.d.ts +1 -1
  96. package/types/src/layer/CellErrorLayer.d.ts +3 -2
  97. package/types/src/layer/CellIndicatorLayer.d.ts +31 -0
  98. package/types/src/layer/CircularIndicatorLayer.d.ts +1 -1
  99. package/types/src/layer/HeaderSelectionLayer.d.ts +4 -4
  100. package/types/src/layer/HyperlinkLayer.d.ts +12 -5
  101. package/types/src/layer/ProtectionLayer.d.ts +1 -2
  102. package/types/src/layer/SheetCellLayer.d.ts +11 -4
  103. package/types/src/layer/SheetMovableLayer.d.ts +2 -1
  104. package/types/src/layer/SheetOutlineLayer.d.ts +1 -1
  105. package/types/src/layer/TableLayer.d.ts +1 -1
  106. package/types/src/layer/TableToolbar.d.ts +1 -1
  107. package/types/src/layer/ValidationPromptLayer.d.ts +16 -4
  108. package/types/src/layer/_visibleCellFeatures.d.ts +11 -0
  109. package/types/src/layer/index.d.ts +1 -0
  110. package/types/src/layer/useValidationPicker.d.ts +1 -1
  111. package/types/src/listener/useRangeListener.d.ts +13 -7
  112. package/types/src/movable/DefaultMovable.d.ts +1 -1
  113. package/types/src/movable/MovableControl.d.ts +3 -1
  114. package/types/src/movable/MovableFrame.d.ts +2 -1
  115. package/types/src/movable/MovableLayer.d.ts +6 -3
  116. package/types/src/movable/useFramePreview.d.ts +17 -0
  117. package/types/src/picture/PictureCommands.d.ts +8 -0
  118. package/types/src/picture/_pictureHyperlink.d.ts +13 -0
  119. package/types/src/picture/pictureCrop.d.ts +32 -0
  120. package/types/src/sheet/ISheetHeaderElement.d.ts +2 -2
  121. package/types/src/sheet/IWorksheetElement.d.ts +21 -22
  122. package/types/src/sheet/SheetCommandProvider.d.ts +3 -0
  123. package/types/src/sheet/SheetOutlineElement.d.ts +2 -2
  124. package/types/src/sheet/SheetPanels.d.ts +2 -2
  125. package/types/src/sheet/_hyperlinkEdit.d.ts +7 -0
  126. package/types/src/sheet/circularReferences.d.ts +1 -1
  127. package/types/src/tabStrip/Sortable.d.ts +5 -5
  128. package/types/src/tabStrip/TabStrip.d.ts +6 -6
  129. package/types/src/tabStrip/TabStripItem.d.ts +15 -13
  130. package/types/src/taskPane/CellControlPane.d.ts +17 -0
  131. package/types/src/taskPane/index.d.ts +1 -0
  132. package/types/src/taskPane/useTaskPane.d.ts +6 -3
  133. package/types/src/theme/buildDocThemeCSS.d.ts +4 -1
  134. package/types/src/workbook/DefaultRenderers.d.ts +4 -4
  135. package/types/src/workbook/IWorkbookElement.d.ts +52 -20
  136. package/types/src/workbook/WorkbookStrip.d.ts +5 -5
  137. package/browser/esm/CRi6DQ3UXmPEv-w_.mjs +0 -729
  138. package/browser/esm/cQ6xdPFkEcuDlNTN.mjs +0 -75
  139. package/browser/esm/ugfE7YeZALQURDKF.mjs +0 -241
  140. package/node/esm/DJPgbB1X22YmhbaR.mjs +0 -242
  141. package/node/esm/DgGEHydEjD7nfsDB.mjs +0 -76
@@ -1,9 +1,10 @@
1
1
  import { default as React } from 'react';
2
2
  import { UndoManager } from '@sheetxl/utils';
3
- import { IWorkbook, IWorkbookIO } from '@sheetxl/sdk';
4
- import { LoadingPanelProps, ErrorPanelProps, RenderFloatPanel, FloatPanelProps, ThemeMode, Command } from '@sheetxl/utils-react';
3
+ import { IWorkbook, IWorkbookIO, IMovable, ITable } from '@sheetxl/sdk';
4
+ import { LoadingPanelProps, ErrorPanelProps, RenderFloatPanel, FloatPanelProps, FloatReference, RenderSlotFn, ThemeMode, Command } from '@sheetxl/utils-react';
5
5
  import { WorksheetElementProps, IWorksheetElement, OpaqueSheetElementProps } from '../sheet';
6
6
  import { SheetEditable } from '../editor';
7
+ import { CommandContext } from '../frame';
7
8
  import { WorkbookStripProps } from './WorkbookStrip';
8
9
  /**
9
10
  * Workbook specific attributes beyond HTMLDivElement.
@@ -46,8 +47,39 @@ export interface IWorkbookElement extends HTMLDivElement, IWorkbookAttributes {
46
47
  export type WorkbookLoadEvent = {
47
48
  source: IWorkbookElement;
48
49
  };
50
+ /**
51
+ * What every workbook menu renderer is handed. Spread the rest on the menu's root.
52
+ */
53
+ export interface WorkbookMenuRenderProps extends React.HTMLAttributes<HTMLDivElement> {
54
+ /** The menu's float. Close it when an entry runs. */
55
+ floatReference: FloatReference;
56
+ disabled?: boolean;
57
+ }
58
+ /** What {@link WorkbookElementProps.renderContextMenu} is handed. */
59
+ export interface ContextMenuRenderProps extends WorkbookMenuRenderProps {
60
+ workbook: IWorkbook;
61
+ }
62
+ /** What {@link WorkbookElementProps.renderColumnMenu} is handed. */
63
+ export interface ColumnMenuRenderProps extends WorkbookMenuRenderProps {
64
+ /** The table column whose button was pressed. */
65
+ column: ITable.IColumn;
66
+ }
67
+ /** What {@link WorkbookElementProps.renderMovableMenu} is handed. */
68
+ export interface MovableMenuRenderProps extends WorkbookMenuRenderProps {
69
+ movable: IMovable;
70
+ }
71
+ /** What {@link WorkbookElementProps.renderFillMenu} is handed. */
72
+ export interface FillMenuRenderProps extends WorkbookMenuRenderProps {
73
+ workbook: IWorkbook;
74
+ /** What the right-drag offers and runs. */
75
+ menu: CommandContext.FillMenu;
76
+ }
49
77
  /**
50
78
  * Properties and methods available on the workbook element.
79
+ *
80
+ * @remarks
81
+ * Every `render*` slot is mounted as its own component, so a renderer may call hooks. Omit a slot (or
82
+ * pass `undefined`) for its default; pass `null` to render nothing.
51
83
  */
52
84
  export interface WorkbookElementProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'autoFocus'>, React.Attributes {
53
85
  /**
@@ -134,30 +166,30 @@ export interface WorkbookElementProps extends Omit<React.HTMLAttributes<HTMLDivE
134
166
  */
135
167
  propsTabs?: Partial<WorkbookStripProps>;
136
168
  /**
137
- * Render custom tabs.
169
+ * Render the sheet tabs.
138
170
  */
139
- renderTabs?: (props: WorkbookStripProps) => React.ReactElement;
171
+ renderTabs?: RenderSlotFn<WorkbookStripProps> | null;
140
172
  /**
141
- * Props for the context menu.
173
+ * Props handed to every menu renderer.
142
174
  */
143
- propsContextMenu?: any;
175
+ propsContextMenu?: Partial<WorkbookMenuRenderProps>;
144
176
  /**
145
- * Render custom context menu. (chrome - no default)
177
+ * Render the grid's context menu. The default renders none, and the browser's menu shows.
146
178
  */
147
- renderContextMenu?: (props: any) => React.ReactElement;
179
+ renderContextMenu?: RenderSlotFn<ContextMenuRenderProps> | null;
148
180
  /**
149
- * Render custom filter/column menu. (chrome - no default)
181
+ * Render the filter menu of a table column's button. The default renders none.
150
182
  */
151
- renderColumnMenu?: (props: any) => React.ReactElement;
183
+ renderColumnMenu?: RenderSlotFn<ColumnMenuRenderProps> | null;
152
184
  /**
153
- * Render custom movable menu. (chrome - no default)
185
+ * Render the context menu of a chart, shape or other movable. The default renders none.
154
186
  */
155
- renderMovableMenu?: (props: any) => React.ReactElement;
187
+ renderMovableMenu?: RenderSlotFn<MovableMenuRenderProps> | null;
156
188
  /**
157
- * Render the fill menu a right-drag of the fill handle ends in. (chrome - no default; without it
158
- * the right-drag is inert)
189
+ * Render the menu a right-drag of the fill handle ends in. The default renders none, and the
190
+ * right-drag is inert.
159
191
  */
160
- renderFillMenu?: (props: any) => React.ReactElement;
192
+ renderFillMenu?: RenderSlotFn<FillMenuRenderProps> | null;
161
193
  /**
162
194
  * Allow for customizations on the floating surface used for the workbook's popups.
163
195
  */
@@ -174,12 +206,12 @@ export interface WorkbookElementProps extends Omit<React.HTMLAttributes<HTMLDivE
174
206
  /**
175
207
  * Assign a custom loading panel.
176
208
  */
177
- renderWorkbookLoading?: (props: LoadingPanelProps) => React.ReactElement;
209
+ renderWorkbookLoading?: RenderSlotFn<LoadingPanelProps> | null;
178
210
  /**
179
211
  * Custom error panel, shown when a `Promise` / {@link IWorkbookIO.ReadOptions} {@link WorkbookElementProps.workbook}
180
212
  * fails to resolve. Defaults to a minimal message. (Studio supplies a themed panel.)
181
213
  */
182
- renderWorkbookError?: (props: ErrorPanelProps) => React.ReactElement;
214
+ renderWorkbookError?: RenderSlotFn<ErrorPanelProps> | null;
183
215
  /**
184
216
  * The app-created editor for the new always-mounted cell editor. Pass the SAME stable
185
217
  * {@link IEditable} instance here and to the formula bar for free two-way sync; this forwards it to
@@ -191,13 +223,13 @@ export interface WorkbookElementProps extends Omit<React.HTMLAttributes<HTMLDivE
191
223
  */
192
224
  propsSheet?: Partial<WorksheetElementProps>;
193
225
  /**
194
- * Render custom IWorksheetElement.
226
+ * Render the active worksheet. Pass `props.ref` on to the {@link IWorksheetElement}.
195
227
  */
196
- renderWorksheet?: (props: WorksheetElementProps) => React.ReactElement;
228
+ renderWorksheet?: RenderSlotFn<WorksheetElementProps>;
197
229
  /**
198
230
  * Render the pane of a chart sheet, a macro sheet or a dialog sheet while it is the active tab.
199
231
  */
200
- renderOpaqueSheet?: (props: OpaqueSheetElementProps) => React.ReactElement;
232
+ renderOpaqueSheet?: RenderSlotFn<OpaqueSheetElementProps>;
201
233
  /**
202
234
  * Allows users to Wrap stage children in Top level Context.
203
235
  */
@@ -1,6 +1,6 @@
1
1
  import { default as React } from 'react';
2
2
  import { IWorkbook } from '@sheetxl/sdk';
3
- import { ScrollButtonProps } from '@sheetxl/utils-react';
3
+ import { ScrollButtonProps, RenderSlotFn } from '@sheetxl/utils-react';
4
4
  import { SheetTabProps } from '../tabStrip';
5
5
  /**
6
6
  * A table tab strip that operates on an {@link IWorkbook}.
@@ -53,7 +53,7 @@ export interface WorkbookStripProps extends React.HTMLAttributes<HTMLDivElement>
53
53
  * the whole strip. The `sheet`, `inverted` and (when {@link onTabContextMenu} is set)
54
54
  * `onContextMenu` are provided; anything else is the underlying {@link TabStrip} tab props.
55
55
  */
56
- renderSheetTab?: (props: SheetTabProps) => React.ReactElement;
56
+ renderSheetTab?: RenderSlotFn<SheetTabProps>;
57
57
  /**
58
58
  * Called on a sheet tab's context-menu (right-click) event, after that tab has been selected.
59
59
  * The strip itself renders no menu — a host provides one (e.g. the MUI strip's `SheetTabMenu`).
@@ -65,9 +65,9 @@ export interface WorkbookStripProps extends React.HTMLAttributes<HTMLDivElement>
65
65
  * currently rendered by `TabStrip`; start/end are accepted for parity. Pass `null` to suppress
66
66
  * a button (as the strip does for all three in {@link condensed} layout).
67
67
  */
68
- renderScrollButtonStart?: ((props: ScrollButtonProps) => React.ReactElement) | null;
69
- renderScrollButtonEnd?: ((props: ScrollButtonProps) => React.ReactElement) | null;
70
- renderScrollButtonEdge?: ((props: ScrollButtonProps) => React.ReactElement) | null;
68
+ renderScrollButtonStart?: RenderSlotFn<ScrollButtonProps> | null;
69
+ renderScrollButtonEnd?: RenderSlotFn<ScrollButtonProps> | null;
70
+ renderScrollButtonEdge?: RenderSlotFn<ScrollButtonProps> | null;
71
71
  }
72
72
  /**
73
73
  * Imperative handle for {@link WorkbookStrip}: the root element plus tab-editing methods