@sheetxl/react 0.7.28-beta.4 → 0.8.0-beta.10

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 (245) hide show
  1. package/browser/esm/BHjeSMaycUkS5dVL.mjs +66 -0
  2. package/browser/esm/BZcQ-KYwS62Ut45c.mjs +20 -0
  3. package/browser/esm/Bow9CzRJrYxak2i5.mjs +318 -0
  4. package/browser/esm/BuvXl14hs-1CvjeA.mjs +2706 -0
  5. package/browser/esm/BwRduT8FTrk5n72r.mjs +32 -0
  6. package/browser/esm/C6urN77szrYwODXF.mjs +134 -0
  7. package/browser/esm/CYMRbtPIr6SklGpp.mjs +775 -0
  8. package/browser/esm/CYoUd5KIl7W3AsxH.mjs +196 -0
  9. package/browser/esm/Cfe0kofqVKGxLqO6.mjs +31 -0
  10. package/browser/esm/CiRN-woJZWYOgTn4.mjs +36 -0
  11. package/browser/esm/Dd-ZybXAgoq9pgGv.mjs +45 -0
  12. package/browser/esm/DjiBz4H74I6nPUY6.mjs +79 -0
  13. package/browser/esm/DyU9UInRnfkPYYlR.mjs +63 -0
  14. package/browser/esm/J8cPagZBeXz86Lnd.mjs +777 -0
  15. package/browser/esm/Sp6PJavGKpF8SJzA.mjs +75 -0
  16. package/browser/esm/cYjYjqEsyd63x8t4.mjs +67 -0
  17. package/browser/esm/chart.mjs +60 -0
  18. package/browser/esm/control.mjs +216 -0
  19. package/browser/esm/group.mjs +123 -0
  20. package/browser/esm/index.mjs +14122 -8944
  21. package/browser/esm/note.mjs +86 -0
  22. package/browser/esm/picture.mjs +86 -0
  23. package/{node/esm/Ban9guHVB-Vxa-tq.mjs → browser/esm/shape.mjs} +2 -4
  24. package/browser/esm/slicer.mjs +276 -0
  25. package/licenses/dependencies.txt +6 -599
  26. package/node/esm/BJ7ZZm63j5O6cvrB.mjs +134 -0
  27. package/node/esm/BfRn5S5V4X8xIAEa.mjs +20 -0
  28. package/node/esm/BpwE3HqTnrLLzE3C.mjs +775 -0
  29. package/node/esm/Buw-VKYJy3y5dbaJ.mjs +197 -0
  30. package/node/esm/CFFlJxNwgyInjEnh.mjs +45 -0
  31. package/node/esm/CM5BT7h-hMtST2bE.mjs +2706 -0
  32. package/node/esm/CV3bT3Hql74GcHoU.mjs +37 -0
  33. package/node/esm/C_ANM4feA1xV-pri.mjs +32 -0
  34. package/node/esm/D3YXHeOyFp00Xk3m.mjs +323 -0
  35. package/node/esm/DPN0n6MGYQ9vZ2KO.mjs +80 -0
  36. package/node/esm/DYosMUJKp-3MSO4q.mjs +76 -0
  37. package/node/esm/DhSq680c5tgMFFbj.mjs +68 -0
  38. package/node/esm/Dxbm6ryIDCEi26RO.mjs +66 -0
  39. package/node/esm/GkmuxU7OwRZtm2Rf.mjs +63 -0
  40. package/node/esm/chart.mjs +60 -0
  41. package/node/esm/control.mjs +216 -0
  42. package/node/esm/group.mjs +123 -0
  43. package/node/esm/index.mjs +16649 -11320
  44. package/node/esm/note.mjs +87 -0
  45. package/node/esm/picture.mjs +86 -0
  46. package/node/esm/shape.mjs +783 -0
  47. package/node/esm/slicer.mjs +278 -0
  48. package/package.json +53 -14
  49. package/resources/contents.json +18 -0
  50. package/resources/locales/contents.json +42 -0
  51. package/resources/locales/de/movable.cmd.json +154 -0
  52. package/resources/locales/de/picture.cmd.json +31 -0
  53. package/resources/locales/de/selection.cmd.json +8 -0
  54. package/resources/locales/de/shape.cmd.json +17 -0
  55. package/resources/locales/de/sheet.cmd.json +328 -21
  56. package/resources/locales/de/slicer.cmd.json +17 -0
  57. package/resources/locales/de/table.cmd.json +9 -1
  58. package/resources/locales/de/ui.msg.json +309 -3
  59. package/resources/locales/de/workbook.cmd.json +10 -6
  60. package/resources/locales/en/movable.cmd.json +154 -0
  61. package/resources/locales/en/picture.cmd.json +31 -0
  62. package/resources/locales/en/selection.cmd.json +8 -0
  63. package/resources/locales/en/shape.cmd.json +17 -0
  64. package/resources/locales/en/sheet.cmd.json +342 -22
  65. package/resources/locales/en/slicer.cmd.json +17 -0
  66. package/resources/locales/en/table.cmd.json +9 -1
  67. package/resources/locales/en/ui.msg.json +309 -3
  68. package/resources/locales/en/workbook.cmd.json +11 -7
  69. package/types/chart.d.ts +2 -0
  70. package/types/control.d.ts +2 -0
  71. package/types/group.d.ts +2 -0
  72. package/types/note.d.ts +2 -0
  73. package/types/picture.d.ts +2 -0
  74. package/types/shape.d.ts +2 -0
  75. package/types/slicer.d.ts +2 -0
  76. package/types/src/annotation/RangeAnnotations.d.ts +119 -0
  77. package/types/src/annotation/index.d.ts +2 -0
  78. package/types/src/autoFill/AutoFillPresets.d.ts +14 -0
  79. package/types/src/autoFill/FillMenu.d.ts +36 -0
  80. package/types/src/autoFill/FillSeries.d.ts +38 -0
  81. package/types/src/autoFill/index.d.ts +4 -0
  82. package/types/src/border/StaticBorderRenderer.d.ts +2 -2
  83. package/types/src/border/useBorders.d.ts +7 -7
  84. package/types/src/cell/CornerTriangle.d.ts +6 -0
  85. package/types/src/cell/FormulaCellRenderer.d.ts +1 -1
  86. package/types/src/cell/OutlineButton.d.ts +123 -0
  87. package/types/src/cell/SheetCellRenderer.d.ts +17 -2
  88. package/types/src/cell/SheetHeaderRenderer.d.ts +5 -0
  89. package/types/src/cell/StaticCellRenderer.d.ts +57 -0
  90. package/types/src/cell/index.d.ts +2 -0
  91. package/types/src/cell/useFormulaViewAnchor.d.ts +1 -1
  92. package/types/src/chart/index.d.ts +0 -1
  93. package/types/src/checklist/ValueChecklist.d.ts +112 -0
  94. package/types/src/checklist/index.d.ts +2 -0
  95. package/types/src/commands/ContextualToolbar.d.ts +19 -0
  96. package/types/src/commands/createTransactionalMiddleware.d.ts +4 -1
  97. package/types/src/commands/index.d.ts +1 -0
  98. package/types/src/comment/CommentCardRequest.d.ts +94 -0
  99. package/types/src/comment/CommentUtils.d.ts +43 -0
  100. package/types/src/comment/NoteEditor.d.ts +20 -0
  101. package/types/src/comment/index.d.ts +5 -0
  102. package/types/src/comment/useCommentThread.d.ts +37 -0
  103. package/types/src/comment/useSheetComments.d.ts +28 -0
  104. package/types/src/{sheet → conditionalFormat}/ConditionalFormatPresets.d.ts +6 -6
  105. package/types/src/conditionalFormat/index.d.ts +1 -0
  106. package/types/src/control/FormControlRenderers.d.ts +22 -0
  107. package/types/src/editor/FunctionPreviewPanel.d.ts +15 -1
  108. package/types/src/editor/NamedItemLabel.d.ts +29 -0
  109. package/types/src/editor/NamedItemsPanel.d.ts +13 -2
  110. package/types/src/editor/SheetCellEditorLayer.d.ts +3 -7
  111. package/types/src/editor/SheetCellEditorStartLayer.d.ts +44 -0
  112. package/types/src/editor/SheetCellInput.d.ts +26 -2
  113. package/types/src/editor/SheetEditable.d.ts +8 -2
  114. package/types/src/editor/formulaCaret.d.ts +39 -10
  115. package/types/src/editor/formulaEval.d.ts +9 -5
  116. package/types/src/editor/formulaLint.d.ts +36 -0
  117. package/types/src/editor/formulaPresentation.d.ts +7 -0
  118. package/types/src/editor/formulaText.d.ts +17 -5
  119. package/types/src/editor/functionArgs.d.ts +20 -0
  120. package/types/src/editor/index.d.ts +4 -1
  121. package/types/src/editor/pickedReference.d.ts +76 -0
  122. package/types/src/editor/useEditRejectedNotice.d.ts +32 -0
  123. package/types/src/editor/useFormulaHints.d.ts +93 -3
  124. package/types/src/editor/useFormulaInput.d.ts +30 -4
  125. package/types/src/editor/useReferenceMode.d.ts +12 -0
  126. package/types/src/editor/validationAlert.d.ts +24 -0
  127. package/types/src/externalLink/ExternalLinksPaneArgs.d.ts +23 -0
  128. package/types/src/externalLink/index.d.ts +2 -0
  129. package/types/src/form/FormulaInput.d.ts +18 -2
  130. package/types/src/form/FormulaInputParts.d.ts +10 -1
  131. package/types/src/form/useEditCommit.d.ts +23 -3
  132. package/types/src/form/useInputField.d.ts +2 -3
  133. package/types/src/frame/CommandContext.d.ts +188 -6
  134. package/types/src/group/GroupEditor.d.ts +25 -0
  135. package/types/src/index.d.ts +12 -1
  136. package/types/src/io/WorkbookIO.d.ts +2 -0
  137. package/types/src/layer/CellErrorLayer.d.ts +24 -7
  138. package/types/src/layer/CommentCardLayer.d.ts +43 -0
  139. package/types/src/layer/CommentsLayer.d.ts +35 -0
  140. package/types/src/layer/ConditionalIcons.d.ts +4 -4
  141. package/types/src/layer/FreezeDragLines.d.ts +17 -0
  142. package/types/src/layer/GridFreezeLayer.d.ts +11 -0
  143. package/types/src/layer/HeaderFreezeLayer.d.ts +12 -0
  144. package/types/src/layer/HeaderResizerLayer.d.ts +2 -1
  145. package/types/src/layer/HyperlinkLayer.d.ts +109 -0
  146. package/types/src/layer/MovableKindScope.d.ts +17 -0
  147. package/types/src/layer/ProtectionLayer.d.ts +52 -0
  148. package/types/src/layer/RangeAnnotationLayer.d.ts +71 -0
  149. package/types/src/layer/ResizeIndicator.d.ts +9 -8
  150. package/types/src/layer/ResizeTooltip.d.ts +13 -0
  151. package/types/src/layer/SheetHeaderCellLayer.d.ts +10 -1
  152. package/types/src/layer/SheetOutlineLayer.d.ts +40 -0
  153. package/types/src/layer/TableLayer.d.ts +5 -4
  154. package/types/src/layer/TableToolbar.d.ts +42 -0
  155. package/types/src/layer/ValidationDropdownLayer.d.ts +61 -0
  156. package/types/src/layer/ValidationIndicatorLayer.d.ts +14 -21
  157. package/types/src/layer/ValidationPromptLayer.d.ts +64 -0
  158. package/types/src/layer/_tableColor.d.ts +4 -0
  159. package/types/src/layer/cellTip.d.ts +13 -0
  160. package/types/src/layer/freezeDragState.d.ts +21 -0
  161. package/types/src/layer/index.d.ts +14 -0
  162. package/types/src/layer/resizeIndicatorState.d.ts +3 -1
  163. package/types/src/layer/useFreezeDrag.d.ts +22 -0
  164. package/types/src/layer/useValidationPicker.d.ts +54 -0
  165. package/types/src/layer/validationMark.d.ts +63 -0
  166. package/types/src/listener/useModelListener.d.ts +4 -4
  167. package/types/src/movable/ConnectionSites.d.ts +18 -0
  168. package/types/src/movable/IMovableArea.d.ts +56 -0
  169. package/types/src/movable/MovableAdornment.d.ts +26 -0
  170. package/types/src/movable/MovableCommandGroups.d.ts +40 -0
  171. package/types/src/movable/MovableCommands.d.ts +6 -1
  172. package/types/src/movable/MovableControl.d.ts +78 -0
  173. package/types/src/movable/MovableEdit.d.ts +22 -0
  174. package/types/src/movable/MovableFrame.d.ts +16 -13
  175. package/types/src/movable/MovableLayer.d.ts +25 -7
  176. package/types/src/movable/MovableRenderers.d.ts +210 -0
  177. package/types/src/movable/PlaceholderFrames.d.ts +11 -0
  178. package/types/src/movable/RotateHandle.d.ts +37 -0
  179. package/types/src/movable/TextBox.d.ts +34 -0
  180. package/types/src/movable/connect.d.ts +16 -0
  181. package/types/src/movable/framePlacement.d.ts +72 -0
  182. package/types/src/movable/geometry.d.ts +61 -0
  183. package/types/src/movable/index.d.ts +10 -0
  184. package/types/src/movable/pressTarget.d.ts +20 -0
  185. package/types/src/picker/PickerPanel.d.ts +52 -0
  186. package/types/src/picker/cellPickerOpen.d.ts +6 -0
  187. package/types/src/picker/index.d.ts +4 -0
  188. package/types/src/picker/useCellPicker.d.ts +95 -0
  189. package/types/src/picture/PictureCommands.d.ts +12 -0
  190. package/types/src/picture/PictureKind.d.ts +7 -0
  191. package/types/src/picture/index.d.ts +0 -1
  192. package/types/src/protection/ProtectionPaneArgs.d.ts +31 -0
  193. package/types/src/protection/index.d.ts +3 -0
  194. package/types/src/protection/unlockProtectedRanges.d.ts +23 -0
  195. package/types/src/richText/RichTextEditor.d.ts +41 -0
  196. package/types/src/richText/index.d.ts +2 -0
  197. package/types/src/selection/SheetSelectionLayer.d.ts +14 -10
  198. package/types/src/shape/ConnectorControl.d.ts +46 -0
  199. package/types/src/shape/ShapeCommands.d.ts +11 -0
  200. package/types/src/shape/ShapeControl.d.ts +8 -0
  201. package/types/src/shape/ShapeEditor.d.ts +15 -2
  202. package/types/src/shape/ShapeGallery.d.ts +31 -0
  203. package/types/src/shape/ShapeHandles.d.ts +28 -0
  204. package/types/src/shape/ShapeKind.d.ts +7 -0
  205. package/types/src/shape/ShapeSVG.d.ts +22 -0
  206. package/types/src/shape/ShapeText.d.ts +17 -0
  207. package/types/src/shape/icons/ShapeIcons.d.ts +16 -0
  208. package/types/src/shape/icons/_ShapeIconPack.d.ts +4 -0
  209. package/types/src/shape/index.d.ts +3 -1
  210. package/types/src/shape/shapeFrame.d.ts +50 -0
  211. package/types/src/shape/shapeStyle.d.ts +82 -0
  212. package/types/src/sheet/ISheetElement.d.ts +62 -65
  213. package/types/src/sheet/SheetCommandProvider.d.ts +9 -4
  214. package/types/src/sheet/SheetCommands.d.ts +21 -6
  215. package/types/src/sheet/SheetOutlineElement.d.ts +70 -0
  216. package/types/src/sheet/SheetScrollbar.d.ts +1 -10
  217. package/types/src/sheet/_freezeAt.d.ts +10 -0
  218. package/types/src/sheet/_useHeaderMetrics.d.ts +11 -0
  219. package/types/src/sheet/circularReferences.d.ts +9 -1
  220. package/types/src/sheet/index.d.ts +1 -1
  221. package/types/src/sheet/useCycleHighlight.d.ts +21 -0
  222. package/types/src/slicer/SlicerCommands.d.ts +10 -0
  223. package/types/src/slicer/SlicerEditor.d.ts +8 -2
  224. package/types/src/slicer/SlicerKind.d.ts +7 -0
  225. package/types/src/slicer/SlicerStylePreview.d.ts +18 -0
  226. package/types/src/slicer/index.d.ts +2 -1
  227. package/types/src/slicer/slicerStyles.d.ts +32 -0
  228. package/types/src/tabStrip/TabStrip.d.ts +7 -0
  229. package/types/src/taskPane/ITaskPane.d.ts +12 -1
  230. package/types/src/taskPane/MovablePane.d.ts +17 -0
  231. package/types/src/taskPane/index.d.ts +1 -0
  232. package/types/src/theme/ThemeState.d.ts +14 -1
  233. package/types/src/theme/useGridColorScheme.d.ts +1 -1
  234. package/types/src/workbook/DefaultMovableRenderers.d.ts +20 -0
  235. package/types/src/workbook/IWorkbookElement.d.ts +24 -0
  236. package/types/src/workbook/WorkbookCommands.d.ts +2 -4
  237. package/types/src/workbook/WorkbookStrip.d.ts +9 -0
  238. package/types/src/workbook/_followOrigin.d.ts +9 -0
  239. package/types/src/workbook/useWorkbookFormat.d.ts +3 -3
  240. package/browser/cjs/Bo9Kx3L_XQkGPBJ5.cjs +0 -1
  241. package/browser/cjs/Pl04-kDEQSO8_qFU.cjs +0 -156
  242. package/browser/cjs/index.cjs +0 -35
  243. package/browser/esm/BdJpSdwyWuh-Te5p.mjs +0 -6286
  244. package/types/src/editor/useProtectedEditNotice.d.ts +0 -14
  245. package/types/src/movable/MoveableBundle.d.ts +0 -4
@@ -0,0 +1,21 @@
1
+ import { IRange } from '@sheetxl/sdk';
2
+ import { FreezeDragPosition } from '@sheetxl/grid-react';
3
+ /**
4
+ * The transient state of an in-progress freeze drag, published by the producer
5
+ * (the freeze grips, through {@link useFreezeDrag}) and read by {@link FreezeDragLines} in both the
6
+ * header and the main grid.
7
+ *
8
+ * It rides `useSurfaceState` under {@link freezeDragKey}. `null` means no freeze drag is active for that
9
+ * axis.
10
+ */
11
+ export type FreezeDragState = FreezeDragPosition;
12
+ /**
13
+ * The `useSurfaceState` key for the freeze drag, namespaced by axis.
14
+ */
15
+ export declare const freezeDragKey: (axis: IRange.Axis) => string;
16
+ /**
17
+ * The `useSurfaceState` key for whether an axis's freeze grip is active (hovered or dragging) — the sheet
18
+ * highlights its freeze line while it is. A boolean; `false` when never written.
19
+ */
20
+ export declare const freezeActiveKey: (axis: IRange.Axis) => string;
21
+ //# sourceMappingURL=freezeDragState.d.ts.map
@@ -4,23 +4,37 @@ export * from './useSheetFeatureRegions';
4
4
  export * from './useSheetVisibleDecorations';
5
5
  export * from './CellFillLayer';
6
6
  export * from './CellErrorLayer';
7
+ export * from './HyperlinkLayer';
7
8
  export * from './BorderLayer';
8
9
  export * from './SheetCellLayer';
9
10
  export * from './SheetColumnButtonLayer';
10
11
  export * from './SheetGridLineLayer';
11
12
  export * from './SheetBackgroundLayer';
12
13
  export * from './SheetHeaderCellLayer';
14
+ export * from './SheetOutlineLayer';
13
15
  export * from './SheetMovableLayer';
14
16
  export * from './TableLayer';
17
+ export * from './TableToolbar';
15
18
  export * from './SheetTableCommandLayer';
16
19
  export * from './SpillLayer';
17
20
  export * from './ConditionalIcons';
18
21
  export * from './ConditionalBarLayer';
19
22
  export * from './ConditionalIconsLayer';
20
23
  export * from './ValidationIndicatorLayer';
24
+ export * from './ValidationDropdownLayer';
25
+ export * from './ValidationPromptLayer';
26
+ export * from './useValidationPicker';
21
27
  export * from './CircularIndicatorLayer';
28
+ export * from './CommentsLayer';
29
+ export * from './CommentCardLayer';
30
+ export * from './RangeAnnotationLayer';
31
+ export * from './ProtectionLayer';
22
32
  export * from './HeaderSelectionLayer';
23
33
  export * from './HeaderResizerLayer';
24
34
  export * from './ResizeIndicator';
35
+ export * from './HeaderFreezeLayer';
36
+ export * from './GridFreezeLayer';
37
+ export * from './FreezeDragLines';
38
+ export * from './freezeDragState';
25
39
  export * from './ContextMenuLayer';
26
40
  //# sourceMappingURL=index.d.ts.map
@@ -12,7 +12,9 @@ export interface ResizeIndicatorState {
12
12
  /** The index of the header (column or row) being resized. */
13
13
  index: number;
14
14
  /**
15
- * Live size (px) of the header during the gesture — `prevSize` at start, the dragged size while moving.
15
+ * Live size of the header during the gesture, in on-screen (zoomed) pixels — `prevSize` at start, the
16
+ * dragged size while moving. The model has not announced the new size yet, so the overlay draws the
17
+ * header's far edge from this rather than from the grid's metrics.
16
18
  * `0` ⇒ the header is (being) hidden (draw a single collapsed line, tooltip reads "Hidden").
17
19
  * `null` ⇒ draw the guide-lines only, with no size tooltip (e.g. a press-and-hold before any drag).
18
20
  */
@@ -0,0 +1,22 @@
1
+ import { ISheet, IRange } from '@sheetxl/sdk';
2
+ import { FreezeDragPosition } from '@sheetxl/grid-react';
3
+ export interface FreezeDrag {
4
+ disabled: boolean;
5
+ /** Whether a grip on this axis (header or body) is hovered or dragging. */
6
+ isActive: boolean;
7
+ onFreezeDragStart: (position: FreezeDragPosition) => void;
8
+ onFreezeDrag: (position: FreezeDragPosition) => void;
9
+ onFreezeDragEnd: (position: FreezeDragPosition) => void;
10
+ onFreezeDragCancel: () => void;
11
+ onActiveChange: (active: boolean) => void;
12
+ }
13
+ /**
14
+ * Wires a freeze grip on one axis to the sheet: publishes the drag for {@link FreezeDragLines}, commits the
15
+ * drop through `freezePanesAt`, and works out whether a drag is allowed right now.
16
+ *
17
+ * @remarks
18
+ * The drag is allowed only when the scrolling area starts exactly at the freeze — otherwise the frozen
19
+ * and scrolling areas are not contiguous and a drop could not land where it was let go.
20
+ */
21
+ export declare const useFreezeDrag: (sheet: ISheet, axis: IRange.Axis) => FreezeDrag;
22
+ //# sourceMappingURL=useFreezeDrag.d.ts.map
@@ -0,0 +1,54 @@
1
+ import { CellCoords } from '@sheetxl/utils';
2
+ import { ISheet, IDataValidation } from '@sheetxl/sdk';
3
+ import { GridAnchor, IEditable } from '@sheetxl/grid-react';
4
+ import { CellPicker } from '../picker';
5
+ /**
6
+ * What the list-validation picker needs: the rules covering the cell, and the generic picker's
7
+ * anchor and entry (see `CellPickerOptions`).
8
+ */
9
+ export interface ValidationPickerOptions {
10
+ /** The sheet the chosen value is written to. */
11
+ sheet: ISheet;
12
+ /**
13
+ * The editable the pick is entered through — the same path as typing the item's text, so the value
14
+ * coerces and formats as a typed one does. `null` offers nothing.
15
+ */
16
+ editable: IEditable<any, string, any> | null;
17
+ /**
18
+ * The list validations covering the cell, in priority order. The first one's items are offered;
19
+ * with several, only the items every rule lists, since every covering rule applies to the entry.
20
+ */
21
+ dataValidations: readonly IDataValidation[];
22
+ /** The cell that receives the chosen value. */
23
+ cell: CellCoords | null;
24
+ /** See `CellPickerOptions.anchor`. */
25
+ anchor: GridAnchor | null;
26
+ /** See `CellPickerOptions.minWidth`. */
27
+ minWidth?: number;
28
+ }
29
+ /**
30
+ * The items several list rules agree on: the first rule's, kept where every other rule lists an item
31
+ * with the same text.
32
+ *
33
+ * @remarks
34
+ * Every covering rule applies to an entry, so a pick outside the intersection is refused on entry;
35
+ * offering the union would offer values the other rule then rejects. Items are matched by their text
36
+ * because that is what a pick enters: a literal list's `2` and a reference list's cell holding 2 both
37
+ * read `2`, and entering it satisfies either.
38
+ */
39
+ export declare const intersectListItems: (lists: readonly (readonly IDataValidation.ListItem[])[]) => readonly IDataValidation.ListItem[];
40
+ /**
41
+ * The items the picker offers at `cell` under `rules` (list validations in priority order): the first
42
+ * rule's list, intersected with the others' ({@link intersectListItems}).
43
+ */
44
+ export declare const resolveListPickerItems: (rules: readonly IDataValidation[], cell: CellCoords) => Promise<readonly IDataValidation.ListItem[]>;
45
+ /**
46
+ * The **list-validation picker**: the generic cell picker (`useCellPicker`) over the covering list
47
+ * rules' items ({@link resolveListPickerItems}), a pick entered through the editable as typed text.
48
+ *
49
+ * @remarks
50
+ * No search field: a validation list is a short set of choices, and narrowing it belongs to the cell
51
+ * editor's typing (DESIGN-DV §3.7).
52
+ */
53
+ export declare const useValidationPicker: (options: ValidationPickerOptions) => CellPicker;
54
+ //# sourceMappingURL=useValidationPicker.d.ts.map
@@ -0,0 +1,63 @@
1
+ import { CellCoords, RangeCoords } from '@sheetxl/utils';
2
+ import { IDataValidation, ISheet } from '@sheetxl/sdk';
3
+ import { VisibleCell } from '@sheetxl/grid-react';
4
+ /**
5
+ * How a cell's value fails its data validations: `'failed'` when every failing rule raises no
6
+ * alert, otherwise the alert style of the rule that answers for it.
7
+ */
8
+ export type ValidationMarkState = 'failed' | IDataValidation.AlertStyle;
9
+ /**
10
+ * What a cell's invalid-value mark shows.
11
+ */
12
+ export interface ValidationMark {
13
+ /** See {@link ValidationMarkState}. */
14
+ state: ValidationMarkState;
15
+ /** The rule that answers for the cell: the one whose alert typing a value would raise. */
16
+ rule: IDataValidation;
17
+ /** How many other covering rules the value also fails. */
18
+ others: number;
19
+ }
20
+ /**
21
+ * The mark for the cell at `rowIndex`, `columnIndex`, or `null` when its value passes every rule.
22
+ *
23
+ * @param rules The data validations to consider, in priority order. A rule not covering the cell
24
+ * never fails it, so a range's rules can be passed for each of its cells.
25
+ *
26
+ * @remarks
27
+ * The first failing rule that raises an alert answers for the cell, the same rule an entry would be
28
+ * refused or warned by, so the mark previews what typing the value would do. A rule with its alert
29
+ * off still marks the cell, as `'failed'`, when no alerting rule fails it.
30
+ */
31
+ export declare const resolveValidationMark: (rules: readonly IDataValidation[], rowIndex: number, columnIndex: number) => ValidationMark | null;
32
+ /**
33
+ * The marks for the cells of `coords` (the window in view), each at the cell or the merge it anchors.
34
+ *
35
+ * @remarks
36
+ * Every rule reaching into the window applies, in priority order: a cell is marked when ANY rule
37
+ * covering it flags it. Rules are few, so this is a lookup per visited cell against each of them.
38
+ * Only cells holding a value are visited, unless a rule has Ignore blank off: an empty cell can fail
39
+ * that one, so the window's empty cells are visited too — bounded by the window, as painting is.
40
+ */
41
+ export declare const findVisibleValidationMarks: (sheet: ISheet, coords: RangeCoords) => VisibleCell[];
42
+ /**
43
+ * What the hover tip over a cell's invalid-value mark says.
44
+ */
45
+ export interface ValidationTip {
46
+ /** The cell, or the merge it anchors: the tip's anchor. */
47
+ range: RangeCoords;
48
+ /** The answering rule's alert title and message, or its condition when it raises none. */
49
+ message: string;
50
+ /** See {@link ValidationMark}. */
51
+ mark: ValidationMark;
52
+ }
53
+ /**
54
+ * The tip for the mark at `coords`, or `null` when there is none to explain: the marks are hidden
55
+ * (Show Invalid off), the value passes, or the cell is the active one and its input prompt is
56
+ * already saying what it wants.
57
+ */
58
+ export declare const findValidationTip: (sheet: ISheet, coords: CellCoords) => ValidationTip | null;
59
+ /** The color a mark is drawn in, per state: the theme's severity colors, neutral for no alert. */
60
+ export declare const VALIDATION_MARK_COLORS: Record<ValidationMarkState, string>;
61
+ /** The glyph for each state (the Base icon pack), the same the rule editor shows for a style. */
62
+ export declare const VALIDATION_MARK_ICONS: Record<ValidationMarkState, string>;
63
+ //# sourceMappingURL=validationMark.d.ts.map
@@ -28,7 +28,7 @@ export interface ModelListenerOptions extends Omit<IListener.Options, 'once'> {
28
28
  * @template SOURCE - The model type (e.g., IWorkbook, ISheet)
29
29
  * @template EVENTS - The listener interface type (e.g., ISheet.IListeners)
30
30
  *
31
- * @param source - The model instance to listen to
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
33
33
  * @param options - Optional configuration
34
34
  *
@@ -56,12 +56,12 @@ export interface ModelListenerOptions extends Omit<IListener.Options, 'once'> {
56
56
  * }
57
57
  * ```
58
58
  */
59
- export declare const useModelListener: <SOURCE, EVENTS>(source: IListener.ISource<SOURCE>, listeners: IListener.Callbacks<SOURCE, EVENTS>, options?: ModelListenerOptions) => void;
59
+ export declare const useModelListener: <SOURCE, EVENTS>(source: IListener.ISource<SOURCE> | null | undefined, listeners: IListener.Callbacks<SOURCE, EVENTS>, options?: ModelListenerOptions) => void;
60
60
  /**
61
61
  * Used for syncing with model state that causes a rerenders.
62
62
  *
63
- * @param source The source of the model
63
+ * @param source The source of the model, or `null` to listen to nothing.
64
64
  * @param eventNames The name of the event or events to listen for.
65
65
  */
66
- export declare function useModelSync<EVENTS>(source: IListener.ISource<any>, eventNames: keyof EVENTS | Array<keyof EVENTS>): void;
66
+ export declare function useModelSync<EVENTS>(source: IListener.ISource<any> | null | undefined, eventNames: keyof EVENTS | Array<keyof EVENTS>): void;
67
67
  //# sourceMappingURL=useModelListener.d.ts.map
@@ -0,0 +1,18 @@
1
+ import { default as React } from 'react';
2
+ import { IMovableCollection } from '@sheetxl/sdk';
3
+ export interface ConnectionSitesProps {
4
+ /** The sheet's movables, every one of which may offer sites. */
5
+ movables: IMovableCollection;
6
+ /** The layer's extent, in pane px. */
7
+ width: number;
8
+ height: number;
9
+ }
10
+ /**
11
+ * The connection sites a dragged connector end may glue to, drawn over every movable on the
12
+ * sheet while an end is held (`movable-connect` surface state); the site the end would take is
13
+ * filled. Which movables offer sites, and where, is the model's (`IMovable.getConnectionSites`):
14
+ * a picture or a chart its four edges, a shape its geometry's, a group none. Drawn by the layer,
15
+ * not by each content's editor, so a content kind needs nothing of its own to be glued to.
16
+ */
17
+ export declare const ConnectionSites: React.FC<ConnectionSitesProps>;
18
+ //# sourceMappingURL=ConnectionSites.d.ts.map
@@ -1,9 +1,36 @@
1
1
  import { IMovable } from '@sheetxl/sdk';
2
+ import { MovableGestureHost } from './MovableControl';
3
+ /**
4
+ * Props a movable renderer receives from its frame.
5
+ *
6
+ * @remarks
7
+ * Spread `style` onto the root element. It fills the frame, which owns the drawing's bounds (zoom
8
+ * included), AND carries its hit-testing: the frame itself is pointer-transparent, so
9
+ * `style.pointerEvents` (`'auto'` by default, `'none'` while the frame is hidden) is what makes the
10
+ * drawing clickable. A drawing that is not solid — a no-fill shape — overrides it with `'none'` on
11
+ * its root and sets `pointerEvents` back on its painted parts only (e.g. `visibleStroke` on an SVG
12
+ * path), so a click in its unfilled interior reaches the cell beneath, exactly as in Excel.
13
+ *
14
+ * The drawing never sizes itself. `zoom` is given only so that it can scale what it draws inside
15
+ * the frame (text, borders, padding), for example with the CSS `zoom` property; a drawing that
16
+ * stretches to its box, such as a picture, ignores it.
17
+ */
2
18
  export interface MovableElementProps extends React.HTMLAttributes<HTMLElement> {
3
19
  /**
4
20
  * The movable associated with this element.
5
21
  */
6
22
  movable?: IMovable;
23
+ /**
24
+ * The scale of the view the movable is drawn in, where `1` is unscaled.
25
+ * @defaultValue 1
26
+ */
27
+ zoom?: number;
28
+ /**
29
+ * How to mirror the drawing within the frame: the gesture's while one is in flight, else the
30
+ * movable's own. The frame does not mirror the drawing itself, since what a mirror means is the
31
+ * drawing's (a shape keeps its text readable); content that cannot be mirrored ignores it.
32
+ */
33
+ flip?: IMovable.Flip;
7
34
  /**
8
35
  * Called when the movable is hidden from view.
9
36
  *
@@ -18,6 +45,35 @@ export interface MovableElementProps extends React.HTMLAttributes<HTMLElement> {
18
45
  * Call when the movable is returned to the view.
19
46
  */
20
47
  onShow?: (show: (movable: IMovable) => void) => void;
48
+ /**
49
+ * Registers where a press starts a drag: the test answers `true` for a press that should move the
50
+ * movable. Without one, a press anywhere in the frame drags.
51
+ *
52
+ * @remarks
53
+ * A press outside the drag zone still selects the movable but is left to the content, so a text
54
+ * box can drag from its border and put the caret where its text is pressed.
55
+ */
56
+ onDragZone?: (isDragZone: (event: MouseEvent | TouchEvent) => boolean) => void;
57
+ /**
58
+ * A box above the selection chrome, placed and turned exactly as the frame is, for the content's
59
+ * own controls (a shape's adjustment handles). `null` when the movable has none.
60
+ *
61
+ * @remarks
62
+ * Render into it with a portal. It fills the frame's box and is pointer-transparent; controls opt
63
+ * back in. Drawn above the resize handles, so a control on the selection outline wins the press,
64
+ * as in Excel.
65
+ *
66
+ * While one of the content's controls is being dragged, give it the class `movable-gesture`: every
67
+ * control in the box, the layer's and the content's, hides until the class goes, as they do for a
68
+ * move or resize.
69
+ */
70
+ adornmentHost?: HTMLElement | null;
71
+ /**
72
+ * Runs a gesture of the content's own controls (a shape's adjustment handles) through the
73
+ * layer: previewed in every pane with what follows it, such as a connector glued to the shape,
74
+ * and committed as one step. Present while the movable's controls are drawn.
75
+ */
76
+ gesture?: MovableGestureHost;
21
77
  /**
22
78
  * If true then the component is disabled.
23
79
  * @defaultValue false
@@ -0,0 +1,26 @@
1
+ import { default as React } from 'react';
2
+ import { IMovable } from '@sheetxl/sdk';
3
+ import { MovablePreview } from './framePlacement';
4
+ /**
5
+ * Each adorned movable's adornment box, by movable, as the layer holds them. A container renderer
6
+ * reads it to hand each member its own box (`MovableElementProps.adornmentHost`), since a member
7
+ * has no frame of its own to be handed one through.
8
+ */
9
+ export declare const AdornmentHostsContext: React.Context<ReadonlyMap<IMovable, HTMLElement>>;
10
+ export interface MovableAdornmentProps {
11
+ movable: IMovable;
12
+ /** The gesture preview, as the frame is given it. */
13
+ preview?: MovablePreview | null;
14
+ /** Receives the box once mounted and `null` when it unmounts; the layer hands it to the content. */
15
+ onHost: (movable: IMovable, host: HTMLElement | null) => void;
16
+ /** The layer's own controls for the movable: its outline, resize and rotate handles. */
17
+ children?: React.ReactNode;
18
+ }
19
+ /**
20
+ * The box a selected movable's controls are drawn in: placed and turned as its frame is, from the
21
+ * same numbers. Its children stack in order, with no z-index of their own: the layer's controls
22
+ * come first and the content renders its own after them (see `MovableElementProps.adornmentHost`),
23
+ * so a content control paints over, and is hit before, a resize handle or outline it overlaps.
24
+ */
25
+ export declare const MovableAdornment: React.FC<MovableAdornmentProps>;
26
+ //# sourceMappingURL=MovableAdornment.d.ts.map
@@ -0,0 +1,40 @@
1
+ import { Command } from '@sheetxl/utils-react';
2
+ /** The key of a kind's ribbon tab: what a kind's own `toolbar` and the default tab are registered as. */
3
+ export declare const movableToolbarKey: (type: string) => string;
4
+ /**
5
+ * Adds a button to a kind's ribbon tab, whether the kind brings its own tab or has the default one:
6
+ * the contribution point for whatever adds to a kind it does not own, as a host adds its own widgets
7
+ * to a built-in kind.
8
+ *
9
+ * @param type The content type.
10
+ * @param entry The button: a command key to run (`defaultKey`), or a `render` of its own.
11
+ * @param placement Where in the tab. `{ order: -1, divider: 'after' }` puts it first, set apart.
12
+ * @returns A function that removes it.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * registerMovableToolbarEntry('shape', { key: 'shapeGlow', defaultKey: 'formatShapeGlow' }, { order: -1 });
17
+ * ```
18
+ */
19
+ export declare function registerMovableToolbarEntry(type: string, entry: Command.CommandButtonEntry & {
20
+ key: string;
21
+ }, placement?: Command.Placement): () => void;
22
+ /**
23
+ * The tab a kind of movable content gets when its module brings none: the drawing groups and the
24
+ * format pane, labeled with the kind's name (`IContent.getTypeDescription()`) unless the catalog
25
+ * has a label for `${type}Toolbar`. So a new kind with no commands of its own still gets a working
26
+ * tab.
27
+ *
28
+ * @param type The content type; the tab's key is `${type}Toolbar`.
29
+ * @param label The tab's label when the catalog has none.
30
+ */
31
+ export declare function createDefaultMovableToolbar(type: string, label: string): Command.CommandButtonEntry & {
32
+ key: string;
33
+ };
34
+ /**
35
+ * Registers the drawing button groups shared by every kind's ribbon tab and by a host's drawing
36
+ * right-click menu: z-order, align and distribute, flip, group, anchor sizing, and `arrangeOptions`,
37
+ * which gathers them for the end of a tab. Their chrome is in the `movable` catalog. Idempotent.
38
+ */
39
+ export declare function registerMovableCommandGroups(): void;
40
+ //# sourceMappingURL=MovableCommandGroups.d.ts.map
@@ -1,16 +1,21 @@
1
1
  import { RemoveListener, EditModeHandler } from '@sheetxl/utils';
2
2
  import { ISheet } from '@sheetxl/sdk';
3
3
  import { Command, IReactNotifier } from '@sheetxl/utils-react';
4
+ import { ActivateFrameOptions, ITaskPaneArea } from '../taskPane';
4
5
  /** Options for {@link contributeMovableCommands}. */
5
6
  export interface ContributeMovableCommandsOptions {
6
7
  /** Error reporting. */
7
8
  notifier?: IReactNotifier;
8
9
  /** Cleared after a drawing op. From `useEditMode()`. */
9
10
  editModeHandler?: EditModeHandler;
11
+ /** Opens a task pane; `formatMovable` opens the format pane with it. */
12
+ activateTaskPane?: (key: string, options?: ActivateFrameOptions) => void;
13
+ /** Read for whether the format pane is showing, the `formatMovable` state. */
14
+ taskPaneArea?: ITaskPaneArea;
10
15
  }
11
16
  /**
12
17
  * Contribute the movable **behavior** over `sheet`'s drawings. Each op runs `update` across the selected
13
- * movables inside one `doBatch`; the anchor/lock `state` re-contributes on selection change. Contribute on
18
+ * movables inside one `doBatch`; the anchor/lock/flip `state` follows the active movable. Contribute on
14
19
  * the **movable scope** (re-run per active sheet); tagged `noTransaction` since we own the `doBatch`, and
15
20
  * `noRepeat`. Returns a disposer.
16
21
  */
@@ -0,0 +1,78 @@
1
+ import { default as React } from 'react';
2
+ import { IMovable } from '@sheetxl/sdk';
3
+ import { ResizeDirection } from './geometry';
4
+ import { MovablePreview } from './framePlacement';
5
+ /** The resize cursor for a handle on a frame turned `rotation` degrees, so it follows the turn. */
6
+ export declare const resizeCursor: (direction: ResizeDirection, rotation: number) => string;
7
+ export interface MovableControlProps {
8
+ /** Compass names of the handles to draw (`nw`, `n`, … `se`). */
9
+ directions: readonly string[];
10
+ /** Degrees clockwise the frame is turned; only the cursors use it, the box turns itself. */
11
+ rotation: number;
12
+ /**
13
+ * Fade the control, as during a gesture. It stays mounted: the handle being dragged holds the
14
+ * pointer capture.
15
+ */
16
+ isDragging?: boolean;
17
+ /** A press on a handle. Return `false` to refuse the gesture. */
18
+ onResizeStart: () => boolean;
19
+ /**
20
+ * The pointer moved. `delta` is how far it is from the press, in screen pixels; `keepAspect` is
21
+ * whether Shift is held.
22
+ */
23
+ onResize: (direction: ResizeDirection, delta: readonly [number, number], keepAspect: boolean) => void;
24
+ /** The pointer was released. */
25
+ onResizeEnd: () => void;
26
+ /** The gesture was lost (`pointercancel`). */
27
+ onResizeCancel: () => void;
28
+ /**
29
+ * Draw the control as context: the frame of a group a selected member is inside, as Excel draws
30
+ * it (a dotted outline and hollow neutral handles). Its handles still resize that group.
31
+ */
32
+ context?: boolean;
33
+ /**
34
+ * A press on the move grip a frame too small for its handles shows in their place. Omit when the
35
+ * frame cannot be moved.
36
+ */
37
+ onMoveStart?: (e: PointerEvent) => void;
38
+ /** Drawn first in the control, so it hides with the handles and paints under them: the rotate handle. */
39
+ children?: React.ReactNode;
40
+ }
41
+ /**
42
+ * What the layer lets a content's own control do: run a gesture of its own through the layer's
43
+ * preview and commit loop, so it is drawn, cancelled and undone as a move or resize is.
44
+ */
45
+ export interface MovableGestureHost {
46
+ /**
47
+ * Starts a gesture on the control's movable: the layer snapshots it and readies one commit.
48
+ * `onCommit` runs on the movable inside that commit, after the previewed placement is written.
49
+ * Returns `false` when the layer refuses gestures.
50
+ */
51
+ start(description: string, onCommit?: (movable: IMovable) => void): boolean;
52
+ /** Draws the movable at a placement (absolute px) until the gesture ends. */
53
+ preview(preview: MovablePreview): void;
54
+ /** Commits what was previewed. */
55
+ finish(): void;
56
+ /** Drops the gesture with nothing written. */
57
+ cancel(): void;
58
+ }
59
+ /**
60
+ * Props of a control a content kind registers in place of the generic one (see
61
+ * `registerMovableRenderer`): the generic control's, and what a control of its own needs.
62
+ */
63
+ export interface ContentControlProps extends MovableControlProps {
64
+ movable: IMovable;
65
+ /** How the frame is mirrored: the gesture's while one is in flight, else the movable's. */
66
+ flip: IMovable.Flip;
67
+ gesture: MovableGestureHost;
68
+ }
69
+ /**
70
+ * A selected movable's outline and resize handles, drawn in its adornment box so they are placed
71
+ * and turned from the same numbers as the frame. Each handle captures the pointer for its gesture.
72
+ *
73
+ * @remarks
74
+ * A frame too small to show its handles apart (see the layer's stylesheet) hides them, still live,
75
+ * and draws a move grip below it, as Excel does.
76
+ */
77
+ export declare const MovableControl: React.FC<MovableControlProps>;
78
+ //# sourceMappingURL=MovableControl.d.ts.map
@@ -0,0 +1,22 @@
1
+ import { IMovable } from '@sheetxl/sdk';
2
+ /**
3
+ * Starts an edit of a movable's content, answering `true` if it took the caret.
4
+ */
5
+ export type MovableEditStarter = () => boolean;
6
+ /**
7
+ * Asks a movable's content to start editing: a text box puts the caret in its text.
8
+ *
9
+ * @remarks
10
+ * This is how a command reaches a content component it cannot see. A movable that is not drawn yet
11
+ * — a note that only shows while selected or pointed at — starts editing when its content mounts,
12
+ * as long as it is still selected then.
13
+ *
14
+ * @returns `true` if the edit started now, `false` if it waits for the content.
15
+ */
16
+ export declare const requestMovableEdit: (movable: IMovable) => boolean;
17
+ /**
18
+ * Registers how a movable's content starts an edit. Called by the content component; the returned
19
+ * function unregisters it.
20
+ */
21
+ export declare const registerMovableEdit: (movable: IMovable, starter: MovableEditStarter) => (() => void);
22
+ //# sourceMappingURL=MovableEdit.d.ts.map
@@ -1,7 +1,8 @@
1
1
  import { default as React } from 'react';
2
- import { Bounds } from '@sheetxl/utils';
3
2
  import { IMovable } from '@sheetxl/sdk';
4
3
  import { MovableElementProps } from './IMovableArea';
4
+ import { MovableGestureHost } from './MovableControl';
5
+ import { MovablePreview } from './framePlacement';
5
6
  export interface MovableFrameProps extends React.HTMLAttributes<HTMLElement> {
6
7
  /**
7
8
  * The underlying model for the chart.
@@ -18,24 +19,26 @@ export interface MovableFrameProps extends React.HTMLAttributes<HTMLElement> {
18
19
  onRefUnload: (ref: HTMLElement) => void;
19
20
  onHide: (hide: (movable: IMovable) => boolean | Promise<boolean> | void) => void;
20
21
  onShow: (show: (movable: IMovable) => void) => void;
22
+ /** {@inheritDoc MovableElementProps.adornmentHost} */
23
+ adornmentHost?: HTMLElement | null;
24
+ /** {@inheritDoc MovableElementProps.gesture} */
25
+ gesture?: MovableGestureHost;
21
26
  /**
22
- * Live drag/resize preview bounds (absolute), or null/undefined when idle. When set, the frame
23
- * renders HERE instead of at the model bounds (the model isn't touched until the gesture commits).
24
- * Surface-scoped in the parent, so it's set in every pane — that's what makes a dragged shape appear,
25
- * correctly clipped, on both sides of a freeze boundary.
27
+ * Live drag/resize/rotate preview, or null/undefined when idle. When set, the frame renders with it
28
+ * instead of the model (the model isn't touched until the gesture commits). Surface-scoped in the
29
+ * parent, so it's set in every pane — that's what makes a dragged shape appear, correctly clipped,
30
+ * on both sides of a freeze boundary.
26
31
  */
27
- overrideBounds?: Bounds | null;
28
- /**
29
- * Called after the frame repositions (scroll, keyboard nudge, drag preview, resize). The parent uses
30
- * it to re-sync the Moveable control box to the frame's new DOM rect — a nudge re-renders only this
31
- * frame, not the parent, so the parent can't detect the move on its own.
32
- */
33
- onReposition?: () => void;
32
+ preview?: MovablePreview | null;
34
33
  /**
35
34
  * Called when the final movable is unselected.
36
35
  */
37
36
  onUnFocus: () => void;
38
- dragStart(e: MouseEvent | TouchEvent, target?: EventTarget | null): void;
37
+ /**
38
+ * A press that may move the frame, after it selected. Not called for a press outside the
39
+ * content's drag zone or in an editable element.
40
+ */
41
+ dragStart(e: PointerEvent): void;
39
42
  disabled?: boolean;
40
43
  /**
41
44
  * Indicates if the frame is being dragged. Useful for styling.
@@ -1,5 +1,6 @@
1
1
  import { default as React } from 'react';
2
- import { IMovableCollection, IMovableSelection, IMovable, ITransaction } from '@sheetxl/sdk';
2
+ import { Bounds } from '@sheetxl/utils';
3
+ import { IMovableCollection, IMovableSelection, IMovable } from '@sheetxl/sdk';
3
4
  import { MovableElementProps } from './IMovableArea';
4
5
  export interface MovableLayerAttributes {
5
6
  /**
@@ -15,15 +16,29 @@ export interface MovableLayerAttributes {
15
16
  }
16
17
  export interface IMovableLayerElement extends HTMLDivElement, MovableLayerAttributes {
17
18
  }
19
+ /**
20
+ * The in-flight frame gesture passed to {@link MovableLayerProps.renderTip}: what the frame would be
21
+ * if released now.
22
+ */
23
+ export interface MovableGesture {
24
+ /** `move` keeps the size, `resize` changes it, `rotate` turns the frame. */
25
+ kind: 'move' | 'resize' | 'rotate';
26
+ /** The grabbed movable (the first selected one when several move together). */
27
+ movable: IMovable;
28
+ /** The unrotated frame, absolute. */
29
+ bounds: Bounds;
30
+ /** Degrees, clockwise. */
31
+ rotation: number;
32
+ }
18
33
  export interface MovableLayerProps extends React.HTMLAttributes<HTMLDivElement> {
19
34
  /**
20
35
  * The container to retrieve movable objects
21
36
  */
22
37
  movables: IMovableCollection;
23
38
  /**
24
- * The container view to retrieve selection information about the movables.
39
+ * The selection of the movables.
25
40
  */
26
- movablesView: IMovableSelection;
41
+ movableSelection: IMovableSelection;
27
42
  /**
28
43
  * Callback to render the movable.
29
44
  *
@@ -31,10 +46,6 @@ export interface MovableLayerProps extends React.HTMLAttributes<HTMLDivElement>
31
46
  * @returns A React Element representing the IMovable.
32
47
  */
33
48
  renderMovable: (props: MovableElementProps) => React.ReactElement;
34
- /**
35
- * If provided this will be used start and stop transactions on being/end move.
36
- */
37
- transactional: ITransaction.ITransactional;
38
49
  /**
39
50
  * Called when the final movable is unselected.
40
51
  */
@@ -68,10 +79,17 @@ export interface MovableLayerProps extends React.HTMLAttributes<HTMLDivElement>
68
79
  * Called after the first render of a movable.
69
80
  */
70
81
  onFirstRender?: () => void;
82
+ /**
83
+ * Render a readout while a frame is moved, resized or rotated — a {@link GestureTip} under the frame.
84
+ * Return an empty node for none.
85
+ */
86
+ renderTip?: (gesture: MovableGesture) => React.ReactNode;
71
87
  /**
72
88
  * Forwards the ref to the underlying element.
73
89
  */
74
90
  ref?: React.Ref<IMovableLayerElement>;
75
91
  }
92
+ /** The shadow under a selected movable's frame; content that shades itself draws the same along its outline. */
93
+ export declare const SELECTION_SHADOW = "1px 1px 2px 2px rgba(0,0,0,.15)";
76
94
  export declare const MovableLayer: React.NamedExoticComponent<Omit<MovableLayerProps, "ref"> & React.RefAttributes<IMovableLayerElement>>;
77
95
  //# sourceMappingURL=MovableLayer.d.ts.map