@atlaskit/editor-plugin-table 7.16.11 → 7.16.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 (254) hide show
  1. package/.eslintrc.js +3 -3
  2. package/CHANGELOG.md +16 -0
  3. package/dist/cjs/commands/misc.js +3 -3
  4. package/dist/cjs/nodeviews/TableCell.js +10 -10
  5. package/dist/cjs/nodeviews/TableContainer.js +83 -27
  6. package/dist/cjs/nodeviews/TableResizer.js +40 -19
  7. package/dist/cjs/nodeviews/TableRow.js +23 -23
  8. package/dist/cjs/pm-plugins/table-resizing/plugin.js +3 -3
  9. package/dist/cjs/pm-plugins/table-resizing/utils/resize-state.js +4 -4
  10. package/dist/cjs/pm-plugins/table-resizing/utils/scale-table.js +3 -3
  11. package/dist/cjs/ui/FloatingContextualMenu/styles.js +1 -1
  12. package/dist/cjs/ui/FloatingDragMenu/styles.js +1 -1
  13. package/dist/cjs/ui/common-styles.js +13 -13
  14. package/dist/cjs/ui/ui-styles.js +25 -25
  15. package/dist/cjs/utils/guidelines.js +7 -4
  16. package/dist/cjs/utils/merged-cells.js +3 -3
  17. package/dist/cjs/utils/snapping.js +7 -8
  18. package/dist/es2019/commands/misc.js +3 -3
  19. package/dist/es2019/nodeviews/TableContainer.js +70 -9
  20. package/dist/es2019/nodeviews/TableResizer.js +42 -21
  21. package/dist/es2019/nodeviews/TableRow.js +21 -21
  22. package/dist/es2019/pm-plugins/table-resizing/plugin.js +3 -3
  23. package/dist/es2019/pm-plugins/table-resizing/utils/resize-state.js +4 -4
  24. package/dist/es2019/pm-plugins/table-resizing/utils/scale-table.js +3 -3
  25. package/dist/es2019/ui/FloatingContextualMenu/styles.js +47 -47
  26. package/dist/es2019/ui/FloatingDragMenu/styles.js +30 -30
  27. package/dist/es2019/ui/common-styles.js +802 -816
  28. package/dist/es2019/ui/ui-styles.js +665 -678
  29. package/dist/es2019/utils/guidelines.js +5 -2
  30. package/dist/es2019/utils/merged-cells.js +3 -3
  31. package/dist/es2019/utils/snapping.js +5 -6
  32. package/dist/esm/commands/misc.js +3 -3
  33. package/dist/esm/nodeviews/TableCell.js +10 -10
  34. package/dist/esm/nodeviews/TableContainer.js +85 -29
  35. package/dist/esm/nodeviews/TableResizer.js +42 -21
  36. package/dist/esm/nodeviews/TableRow.js +23 -23
  37. package/dist/esm/pm-plugins/table-resizing/plugin.js +3 -3
  38. package/dist/esm/pm-plugins/table-resizing/utils/resize-state.js +4 -4
  39. package/dist/esm/pm-plugins/table-resizing/utils/scale-table.js +3 -3
  40. package/dist/esm/ui/FloatingContextualMenu/styles.js +1 -1
  41. package/dist/esm/ui/FloatingDragMenu/styles.js +1 -1
  42. package/dist/esm/ui/common-styles.js +13 -13
  43. package/dist/esm/ui/ui-styles.js +25 -25
  44. package/dist/esm/utils/guidelines.js +6 -3
  45. package/dist/esm/utils/merged-cells.js +3 -3
  46. package/dist/esm/utils/snapping.js +6 -7
  47. package/dist/types/nodeviews/TableResizer.d.ts +2 -1
  48. package/dist/types/pm-plugins/decorations/utils/index.d.ts +1 -1
  49. package/dist/types/pm-plugins/drag-and-drop/utils/autoscrollers.d.ts +1 -1
  50. package/dist/types/pm-plugins/drag-and-drop/utils/getDragBehaviour.d.ts +1 -1
  51. package/dist/types/pm-plugins/table-resizing/utils/index.d.ts +1 -1
  52. package/dist/types/ui/ColumnResizeWidget/index.d.ts +1 -1
  53. package/dist/types/ui/FloatingAlignmentButtons/FloatingAlignmentButtons.d.ts +1 -1
  54. package/dist/types/ui/FloatingToolbarLabel/FloatingToolbarLabel.d.ts +1 -1
  55. package/dist/types/ui/TableFloatingColumnControls/ColumnDropTargets/ColumnDropTarget.d.ts +1 -1
  56. package/dist/types/ui/TableFloatingControls/CornerControls/index.d.ts +1 -1
  57. package/dist/types/ui/icons/DragHandleDisabledIcon.d.ts +1 -1
  58. package/dist/types/utils/guidelines.d.ts +2 -1
  59. package/dist/types/utils/snapping.d.ts +3 -2
  60. package/dist/types-ts4.5/nodeviews/TableResizer.d.ts +2 -1
  61. package/dist/types-ts4.5/pm-plugins/decorations/utils/index.d.ts +1 -1
  62. package/dist/types-ts4.5/pm-plugins/drag-and-drop/utils/autoscrollers.d.ts +1 -1
  63. package/dist/types-ts4.5/pm-plugins/drag-and-drop/utils/getDragBehaviour.d.ts +1 -1
  64. package/dist/types-ts4.5/pm-plugins/table-resizing/utils/index.d.ts +1 -1
  65. package/dist/types-ts4.5/ui/ColumnResizeWidget/index.d.ts +1 -1
  66. package/dist/types-ts4.5/ui/FloatingAlignmentButtons/FloatingAlignmentButtons.d.ts +1 -1
  67. package/dist/types-ts4.5/ui/FloatingToolbarLabel/FloatingToolbarLabel.d.ts +1 -1
  68. package/dist/types-ts4.5/ui/TableFloatingColumnControls/ColumnDropTargets/ColumnDropTarget.d.ts +1 -1
  69. package/dist/types-ts4.5/ui/TableFloatingControls/CornerControls/index.d.ts +1 -1
  70. package/dist/types-ts4.5/ui/icons/DragHandleDisabledIcon.d.ts +1 -1
  71. package/dist/types-ts4.5/utils/guidelines.d.ts +2 -1
  72. package/dist/types-ts4.5/utils/snapping.d.ts +3 -2
  73. package/docs/0-intro.tsx +9 -7
  74. package/package.json +3 -3
  75. package/report.api.md +67 -66
  76. package/src/commands/clear.ts +36 -44
  77. package/src/commands/collapse.ts +8 -8
  78. package/src/commands/column-resize.ts +412 -452
  79. package/src/commands/delete.ts +14 -14
  80. package/src/commands/display-mode.ts +10 -11
  81. package/src/commands/go-to-next-cell.ts +48 -54
  82. package/src/commands/hover.ts +210 -227
  83. package/src/commands/index.ts +35 -35
  84. package/src/commands/insert.ts +208 -235
  85. package/src/commands/misc.ts +655 -748
  86. package/src/commands/referentiality.ts +9 -9
  87. package/src/commands/selection.ts +433 -563
  88. package/src/commands/sort.ts +68 -86
  89. package/src/commands/split-cell.ts +14 -14
  90. package/src/commands/toggle.ts +69 -67
  91. package/src/commands-with-analytics.ts +570 -639
  92. package/src/create-plugin-config.ts +13 -13
  93. package/src/event-handlers.ts +513 -612
  94. package/src/handlers.ts +120 -133
  95. package/src/nodeviews/ExternalDropTargets.tsx +68 -73
  96. package/src/nodeviews/OverflowShadowsObserver.ts +148 -157
  97. package/src/nodeviews/TableCell.ts +47 -54
  98. package/src/nodeviews/TableComponent.tsx +1018 -1112
  99. package/src/nodeviews/TableComponentWithSharedState.tsx +91 -94
  100. package/src/nodeviews/TableContainer.tsx +384 -340
  101. package/src/nodeviews/TableNodeViewBase.ts +19 -24
  102. package/src/nodeviews/TableResizer.tsx +642 -653
  103. package/src/nodeviews/TableRow.ts +580 -629
  104. package/src/nodeviews/TableStickyScrollbar.ts +173 -190
  105. package/src/nodeviews/__mocks__/OverflowShadowsObserver.ts +8 -8
  106. package/src/nodeviews/__mocks__/OverridableMock.ts +14 -15
  107. package/src/nodeviews/table.tsx +345 -375
  108. package/src/nodeviews/types.ts +21 -24
  109. package/src/nodeviews/update-overflow-shadows.ts +8 -14
  110. package/src/plugin.tsx +578 -603
  111. package/src/pm-plugins/analytics/actions.ts +10 -12
  112. package/src/pm-plugins/analytics/commands.ts +31 -37
  113. package/src/pm-plugins/analytics/plugin-factory.ts +4 -2
  114. package/src/pm-plugins/analytics/plugin-key.ts +1 -3
  115. package/src/pm-plugins/analytics/plugin.ts +60 -70
  116. package/src/pm-plugins/analytics/reducer.ts +19 -19
  117. package/src/pm-plugins/analytics/types.ts +10 -10
  118. package/src/pm-plugins/analytics/utils/moved-event.ts +38 -38
  119. package/src/pm-plugins/decorations/plugin.ts +58 -77
  120. package/src/pm-plugins/decorations/utils/column-controls.ts +59 -71
  121. package/src/pm-plugins/decorations/utils/column-resizing.ts +50 -57
  122. package/src/pm-plugins/decorations/utils/compose-decorations.ts +6 -6
  123. package/src/pm-plugins/decorations/utils/index.ts +3 -6
  124. package/src/pm-plugins/decorations/utils/types.ts +7 -12
  125. package/src/pm-plugins/default-table-selection.ts +3 -3
  126. package/src/pm-plugins/drag-and-drop/actions.ts +25 -25
  127. package/src/pm-plugins/drag-and-drop/commands-with-analytics.ts +158 -190
  128. package/src/pm-plugins/drag-and-drop/commands.ts +154 -170
  129. package/src/pm-plugins/drag-and-drop/consts.ts +4 -5
  130. package/src/pm-plugins/drag-and-drop/plugin-factory.ts +23 -20
  131. package/src/pm-plugins/drag-and-drop/plugin-key.ts +1 -3
  132. package/src/pm-plugins/drag-and-drop/plugin.ts +329 -383
  133. package/src/pm-plugins/drag-and-drop/reducer.ts +30 -30
  134. package/src/pm-plugins/drag-and-drop/types.ts +8 -8
  135. package/src/pm-plugins/drag-and-drop/utils/autoscrollers.ts +38 -41
  136. package/src/pm-plugins/drag-and-drop/utils/getDragBehaviour.ts +3 -6
  137. package/src/pm-plugins/drag-and-drop/utils/monitor.ts +57 -70
  138. package/src/pm-plugins/keymap.ts +208 -220
  139. package/src/pm-plugins/main.ts +348 -400
  140. package/src/pm-plugins/plugin-factory.ts +32 -34
  141. package/src/pm-plugins/safari-delete-composition-text-issue-workaround.ts +83 -97
  142. package/src/pm-plugins/sticky-headers/commands.ts +2 -6
  143. package/src/pm-plugins/sticky-headers/plugin-key.ts +1 -3
  144. package/src/pm-plugins/sticky-headers/plugin-state.ts +41 -44
  145. package/src/pm-plugins/sticky-headers/plugin.ts +4 -4
  146. package/src/pm-plugins/sticky-headers/types.ts +8 -8
  147. package/src/pm-plugins/sticky-headers/util.ts +10 -10
  148. package/src/pm-plugins/table-analytics.ts +70 -72
  149. package/src/pm-plugins/table-local-id.ts +180 -184
  150. package/src/pm-plugins/table-resizing/commands.ts +72 -85
  151. package/src/pm-plugins/table-resizing/event-handlers.ts +298 -317
  152. package/src/pm-plugins/table-resizing/plugin-factory.ts +10 -10
  153. package/src/pm-plugins/table-resizing/plugin-key.ts +1 -3
  154. package/src/pm-plugins/table-resizing/plugin.ts +61 -68
  155. package/src/pm-plugins/table-resizing/reducer.ts +30 -33
  156. package/src/pm-plugins/table-resizing/utils/colgroup.ts +84 -84
  157. package/src/pm-plugins/table-resizing/utils/column-state.ts +78 -81
  158. package/src/pm-plugins/table-resizing/utils/content-width.ts +94 -114
  159. package/src/pm-plugins/table-resizing/utils/dom.ts +93 -110
  160. package/src/pm-plugins/table-resizing/utils/index.ts +29 -34
  161. package/src/pm-plugins/table-resizing/utils/misc.ts +94 -119
  162. package/src/pm-plugins/table-resizing/utils/resize-column.ts +93 -106
  163. package/src/pm-plugins/table-resizing/utils/resize-logic.ts +240 -257
  164. package/src/pm-plugins/table-resizing/utils/resize-state.ts +343 -372
  165. package/src/pm-plugins/table-resizing/utils/scale-table.ts +202 -207
  166. package/src/pm-plugins/table-resizing/utils/types.ts +17 -17
  167. package/src/pm-plugins/table-resizing/utils/unit-to-number.ts +1 -2
  168. package/src/pm-plugins/table-selection-keymap.ts +25 -51
  169. package/src/pm-plugins/table-width.ts +191 -204
  170. package/src/pm-plugins/view-mode-sort/index.ts +223 -227
  171. package/src/pm-plugins/view-mode-sort/plugin-key.ts +3 -2
  172. package/src/pm-plugins/view-mode-sort/types.ts +12 -12
  173. package/src/pm-plugins/view-mode-sort/utils.ts +108 -117
  174. package/src/reducer.ts +139 -155
  175. package/src/toolbar.tsx +815 -905
  176. package/src/transforms/column-width.ts +186 -213
  177. package/src/transforms/delete-columns.ts +208 -222
  178. package/src/transforms/delete-rows.ts +117 -121
  179. package/src/transforms/fix-tables.ts +190 -215
  180. package/src/transforms/merge.ts +263 -269
  181. package/src/transforms/replace-table.ts +27 -43
  182. package/src/transforms/split.ts +65 -75
  183. package/src/types.ts +421 -427
  184. package/src/ui/ColumnResizeWidget/index.tsx +40 -47
  185. package/src/ui/DragHandle/HandleIconComponent.tsx +9 -13
  186. package/src/ui/DragHandle/index.tsx +221 -250
  187. package/src/ui/DragPreview/index.tsx +35 -35
  188. package/src/ui/FloatingAlignmentButtons/FloatingAlignmentButtons.tsx +33 -41
  189. package/src/ui/FloatingContextualButton/FixedButton.tsx +154 -157
  190. package/src/ui/FloatingContextualButton/index.tsx +109 -115
  191. package/src/ui/FloatingContextualButton/styles.ts +43 -46
  192. package/src/ui/FloatingContextualMenu/ContextualMenu.tsx +634 -694
  193. package/src/ui/FloatingContextualMenu/index.tsx +83 -101
  194. package/src/ui/FloatingContextualMenu/styles.ts +57 -65
  195. package/src/ui/FloatingDeleteButton/DeleteButton.tsx +37 -37
  196. package/src/ui/FloatingDeleteButton/getPopUpOptions.ts +47 -57
  197. package/src/ui/FloatingDeleteButton/index.tsx +319 -350
  198. package/src/ui/FloatingDragMenu/DragMenu.tsx +555 -596
  199. package/src/ui/FloatingDragMenu/DropdownMenu.tsx +152 -162
  200. package/src/ui/FloatingDragMenu/index.tsx +88 -102
  201. package/src/ui/FloatingDragMenu/styles.ts +51 -54
  202. package/src/ui/FloatingInsertButton/InsertButton.tsx +204 -217
  203. package/src/ui/FloatingInsertButton/getPopupOptions.ts +100 -115
  204. package/src/ui/FloatingInsertButton/index.tsx +248 -292
  205. package/src/ui/FloatingToolbarLabel/FloatingToolbarLabel.tsx +24 -29
  206. package/src/ui/TableFloatingColumnControls/ColumnControls/index.tsx +308 -329
  207. package/src/ui/TableFloatingColumnControls/ColumnDropTargets/ColumnDropTarget.tsx +85 -94
  208. package/src/ui/TableFloatingColumnControls/ColumnDropTargets/index.tsx +46 -46
  209. package/src/ui/TableFloatingColumnControls/index.tsx +116 -136
  210. package/src/ui/TableFloatingControls/CornerControls/ClassicCornerControls.tsx +79 -91
  211. package/src/ui/TableFloatingControls/CornerControls/DragCornerControls.tsx +95 -102
  212. package/src/ui/TableFloatingControls/CornerControls/index.tsx +1 -4
  213. package/src/ui/TableFloatingControls/CornerControls/types.ts +8 -8
  214. package/src/ui/TableFloatingControls/FloatingControlsWithSelection.tsx +50 -50
  215. package/src/ui/TableFloatingControls/NumberColumn/index.tsx +111 -124
  216. package/src/ui/TableFloatingControls/RowControls/ClassicControls.tsx +86 -105
  217. package/src/ui/TableFloatingControls/RowControls/DragControls.tsx +305 -341
  218. package/src/ui/TableFloatingControls/RowDropTarget/index.tsx +72 -75
  219. package/src/ui/TableFloatingControls/index.tsx +191 -193
  220. package/src/ui/TableFullWidthLabel/index.tsx +20 -20
  221. package/src/ui/common-styles.ts +880 -912
  222. package/src/ui/consts.ts +29 -74
  223. package/src/ui/icons/AddColLeftIcon.tsx +33 -39
  224. package/src/ui/icons/AddColRightIcon.tsx +33 -39
  225. package/src/ui/icons/AddRowAboveIcon.tsx +16 -22
  226. package/src/ui/icons/AddRowBelowIcon.tsx +33 -39
  227. package/src/ui/icons/DisplayModeIcon.tsx +31 -31
  228. package/src/ui/icons/DragHandleDisabledIcon.tsx +19 -21
  229. package/src/ui/icons/DragHandleIcon.tsx +12 -12
  230. package/src/ui/icons/DragInMotionIcon.tsx +45 -52
  231. package/src/ui/icons/MergeCellsIcon.tsx +22 -28
  232. package/src/ui/icons/MinimisedHandle.tsx +9 -9
  233. package/src/ui/icons/SplitCellIcon.tsx +30 -36
  234. package/src/ui/ui-styles.ts +769 -798
  235. package/src/utils/alignment.ts +1 -1
  236. package/src/utils/analytics.ts +192 -208
  237. package/src/utils/collapse.ts +55 -64
  238. package/src/utils/column-controls.ts +237 -254
  239. package/src/utils/create.ts +30 -30
  240. package/src/utils/decoration.ts +482 -502
  241. package/src/utils/dom.ts +127 -134
  242. package/src/utils/drag-menu.ts +322 -373
  243. package/src/utils/get-allow-add-column-custom-step.ts +4 -5
  244. package/src/utils/guidelines.ts +16 -21
  245. package/src/utils/index.ts +68 -68
  246. package/src/utils/merged-cells.ts +245 -254
  247. package/src/utils/nodes.ts +91 -106
  248. package/src/utils/paste.ts +119 -135
  249. package/src/utils/row-controls.ts +199 -213
  250. package/src/utils/selection.ts +77 -87
  251. package/src/utils/snapping.ts +87 -100
  252. package/src/utils/table.ts +44 -44
  253. package/src/utils/transforms.ts +5 -5
  254. package/src/utils/update-plugin-state-decorations.ts +5 -9
@@ -21,197 +21,193 @@ import type { EditorState } from '@atlaskit/editor-prosemirror/state';
21
21
  import { PluginKey } from '@atlaskit/editor-prosemirror/state';
22
22
 
23
23
  interface TableLocalIdPluginState {
24
- // One time parse for initial load with existing tables without localIds
25
- parsedForLocalIds: boolean;
24
+ // One time parse for initial load with existing tables without localIds
25
+ parsedForLocalIds: boolean;
26
26
  }
27
27
 
28
28
  const pluginKey = new PluginKey<TableLocalIdPluginState>('tableLocalIdPlugin');
29
- const getPluginState = (
30
- state: EditorState,
31
- ): TableLocalIdPluginState | undefined | null =>
32
- state && pluginKey.getState(state);
29
+ const getPluginState = (state: EditorState): TableLocalIdPluginState | undefined | null =>
30
+ state && pluginKey.getState(state);
33
31
 
34
32
  /**
35
33
  * Ensures uniqueness of `localId`s on tables being created or edited
36
34
  */
37
35
  const createPlugin = (dispatch: Dispatch) =>
38
- new SafePlugin<TableLocalIdPluginState>({
39
- key: pluginKey,
40
- state: {
41
- init() {
42
- return {
43
- parsedForLocalIds: false,
44
- };
45
- },
46
- apply(tr, pluginState) {
47
- const meta = tr.getMeta(pluginKey);
48
- if (meta) {
49
- const keys = Object.keys(meta) as Array<
50
- keyof TableLocalIdPluginState
51
- >;
52
- const changed = keys.some((key) => {
53
- return pluginState[key] !== meta[key];
54
- });
55
-
56
- if (changed) {
57
- const newState = { ...pluginState, ...meta };
58
-
59
- dispatch(pluginKey, newState);
60
- return newState;
61
- }
62
- }
63
-
64
- return pluginState;
65
- },
66
- },
67
- view: () => {
68
- return {
69
- /**
70
- * Utilise the update cycle for _one_ scan through an initial doc
71
- * to ensure existing tables without IDs get them when this plugin is
72
- * enabled.
73
- *
74
- * This entire block can be skipped if we simply remove the `checkIsAddingTable`
75
- * check in appendTransaction, but that comes with 2 cons:
76
- *
77
- * 1. require a transaction before we actually add the local IDs
78
- * 2. ever slightly more unncessary checks
79
- *
80
- * Finally, this never happens in practice when utilising this in
81
- * confluence, as the collab/synchrony initialisation process will
82
- * trigger a transaction which adds tables, and thus this plugin will
83
- * add/dedupe the necessary IDs. But general usage of the editor
84
- * without collab should still solve for IDs.
85
- */
86
- update(editorView) {
87
- const { state } = editorView;
88
- const pluginState = getPluginState(state);
89
- if (!pluginState) {
90
- return;
91
- }
92
- const parsed = pluginState.parsedForLocalIds;
93
- if (parsed) {
94
- return;
95
- }
96
-
97
- const { table } = state.schema.nodes;
98
- rafSchedule(() => {
99
- const tr = editorView.state.tr;
100
- let tableIdWasAdded = false;
101
- editorView.state.doc.descendants((node, pos) => {
102
- const isTable = node.type === table;
103
- const localId = node.attrs.localId;
104
- if (isTable && !localId) {
105
- tableIdWasAdded = true;
106
- tr.setNodeMarkup(pos, undefined, {
107
- ...node.attrs,
108
- localId: uuid.generate(),
109
- });
110
- return false;
111
- }
112
- /**
113
- * Otherwise continue traversing, we can encounter tables nested in
114
- * expands/bodiedExtensions
115
- */
116
- return true;
117
- });
118
- if (tableIdWasAdded) {
119
- tr.setMeta('addToHistory', false);
120
- editorView.dispatch(tr);
121
- }
122
- })();
123
-
124
- editorView.dispatch(
125
- state.tr.setMeta(pluginKey, {
126
- parsedForLocalIds: true,
127
- }),
128
- );
129
- },
130
- };
131
- },
132
- appendTransaction: (transactions, _oldState, newState) => {
133
- let modified = false;
134
- const tr = newState.tr;
135
- const { table } = newState.schema.nodes;
136
-
137
- const addedTableNodes: Set<ProsemirrorNode> = new Set();
138
- const addedTableNodePos: Map<ProsemirrorNode, number> = new Map();
139
- const localIds: Set<string> = new Set();
140
-
141
- transactions.forEach((transaction) => {
142
- if (!transaction.docChanged) {
143
- return;
144
- }
145
-
146
- // Don't interfere with cut as it clashes with fixTables & we don't need
147
- // to handle any extra cut cases in this plugin
148
- const uiEvent = transaction.getMeta('uiEvent');
149
- if (uiEvent === 'cut') {
150
- return;
151
- }
152
-
153
- /** Get the tables we are adding and their position */
154
- for (const step of transaction.steps) {
155
- if (!stepHasSlice(step)) {
156
- continue;
157
- }
158
-
159
- step.slice.content.descendants((node) => {
160
- if (node.type === table) {
161
- addedTableNodes.add(node);
162
- }
163
-
164
- return true;
165
- });
166
- }
167
- });
168
-
169
- if (!addedTableNodes.size) {
170
- return;
171
- }
172
-
173
- // Get the existing localIds on the page
174
- newState.doc.descendants((node, pos) => {
175
- // Skip if this is position of added table
176
- if (addedTableNodes.has(node)) {
177
- addedTableNodePos.set(node, pos);
178
- return false;
179
- }
180
-
181
- if (node.type !== table) {
182
- return true;
183
- }
184
-
185
- localIds.add(node.attrs.localId);
186
-
187
- // can't have table within a table
188
- return false;
189
- });
190
-
191
- // If the added nodes have duplicate id, generate a new one
192
- for (const node of addedTableNodes) {
193
- if (!node.attrs.localId || localIds.has(node.attrs.localId)) {
194
- const pos = addedTableNodePos.get(node);
195
-
196
- if (pos === undefined) {
197
- continue;
198
- }
199
-
200
- tr.setNodeMarkup(pos, undefined, {
201
- ...node.attrs,
202
- localId: uuid.generate(),
203
- });
204
-
205
- modified = true;
206
- }
207
- }
208
-
209
- if (modified) {
210
- return tr;
211
- }
212
-
213
- return;
214
- },
215
- });
36
+ new SafePlugin<TableLocalIdPluginState>({
37
+ key: pluginKey,
38
+ state: {
39
+ init() {
40
+ return {
41
+ parsedForLocalIds: false,
42
+ };
43
+ },
44
+ apply(tr, pluginState) {
45
+ const meta = tr.getMeta(pluginKey);
46
+ if (meta) {
47
+ const keys = Object.keys(meta) as Array<keyof TableLocalIdPluginState>;
48
+ const changed = keys.some((key) => {
49
+ return pluginState[key] !== meta[key];
50
+ });
51
+
52
+ if (changed) {
53
+ const newState = { ...pluginState, ...meta };
54
+
55
+ dispatch(pluginKey, newState);
56
+ return newState;
57
+ }
58
+ }
59
+
60
+ return pluginState;
61
+ },
62
+ },
63
+ view: () => {
64
+ return {
65
+ /**
66
+ * Utilise the update cycle for _one_ scan through an initial doc
67
+ * to ensure existing tables without IDs get them when this plugin is
68
+ * enabled.
69
+ *
70
+ * This entire block can be skipped if we simply remove the `checkIsAddingTable`
71
+ * check in appendTransaction, but that comes with 2 cons:
72
+ *
73
+ * 1. require a transaction before we actually add the local IDs
74
+ * 2. ever slightly more unncessary checks
75
+ *
76
+ * Finally, this never happens in practice when utilising this in
77
+ * confluence, as the collab/synchrony initialisation process will
78
+ * trigger a transaction which adds tables, and thus this plugin will
79
+ * add/dedupe the necessary IDs. But general usage of the editor
80
+ * without collab should still solve for IDs.
81
+ */
82
+ update(editorView) {
83
+ const { state } = editorView;
84
+ const pluginState = getPluginState(state);
85
+ if (!pluginState) {
86
+ return;
87
+ }
88
+ const parsed = pluginState.parsedForLocalIds;
89
+ if (parsed) {
90
+ return;
91
+ }
92
+
93
+ const { table } = state.schema.nodes;
94
+ rafSchedule(() => {
95
+ const tr = editorView.state.tr;
96
+ let tableIdWasAdded = false;
97
+ editorView.state.doc.descendants((node, pos) => {
98
+ const isTable = node.type === table;
99
+ const localId = node.attrs.localId;
100
+ if (isTable && !localId) {
101
+ tableIdWasAdded = true;
102
+ tr.setNodeMarkup(pos, undefined, {
103
+ ...node.attrs,
104
+ localId: uuid.generate(),
105
+ });
106
+ return false;
107
+ }
108
+ /**
109
+ * Otherwise continue traversing, we can encounter tables nested in
110
+ * expands/bodiedExtensions
111
+ */
112
+ return true;
113
+ });
114
+ if (tableIdWasAdded) {
115
+ tr.setMeta('addToHistory', false);
116
+ editorView.dispatch(tr);
117
+ }
118
+ })();
119
+
120
+ editorView.dispatch(
121
+ state.tr.setMeta(pluginKey, {
122
+ parsedForLocalIds: true,
123
+ }),
124
+ );
125
+ },
126
+ };
127
+ },
128
+ appendTransaction: (transactions, _oldState, newState) => {
129
+ let modified = false;
130
+ const tr = newState.tr;
131
+ const { table } = newState.schema.nodes;
132
+
133
+ const addedTableNodes: Set<ProsemirrorNode> = new Set();
134
+ const addedTableNodePos: Map<ProsemirrorNode, number> = new Map();
135
+ const localIds: Set<string> = new Set();
136
+
137
+ transactions.forEach((transaction) => {
138
+ if (!transaction.docChanged) {
139
+ return;
140
+ }
141
+
142
+ // Don't interfere with cut as it clashes with fixTables & we don't need
143
+ // to handle any extra cut cases in this plugin
144
+ const uiEvent = transaction.getMeta('uiEvent');
145
+ if (uiEvent === 'cut') {
146
+ return;
147
+ }
148
+
149
+ /** Get the tables we are adding and their position */
150
+ for (const step of transaction.steps) {
151
+ if (!stepHasSlice(step)) {
152
+ continue;
153
+ }
154
+
155
+ step.slice.content.descendants((node) => {
156
+ if (node.type === table) {
157
+ addedTableNodes.add(node);
158
+ }
159
+
160
+ return true;
161
+ });
162
+ }
163
+ });
164
+
165
+ if (!addedTableNodes.size) {
166
+ return;
167
+ }
168
+
169
+ // Get the existing localIds on the page
170
+ newState.doc.descendants((node, pos) => {
171
+ // Skip if this is position of added table
172
+ if (addedTableNodes.has(node)) {
173
+ addedTableNodePos.set(node, pos);
174
+ return false;
175
+ }
176
+
177
+ if (node.type !== table) {
178
+ return true;
179
+ }
180
+
181
+ localIds.add(node.attrs.localId);
182
+
183
+ // can't have table within a table
184
+ return false;
185
+ });
186
+
187
+ // If the added nodes have duplicate id, generate a new one
188
+ for (const node of addedTableNodes) {
189
+ if (!node.attrs.localId || localIds.has(node.attrs.localId)) {
190
+ const pos = addedTableNodePos.get(node);
191
+
192
+ if (pos === undefined) {
193
+ continue;
194
+ }
195
+
196
+ tr.setNodeMarkup(pos, undefined, {
197
+ ...node.attrs,
198
+ localId: uuid.generate(),
199
+ });
200
+
201
+ modified = true;
202
+ }
203
+ }
204
+
205
+ if (modified) {
206
+ return tr;
207
+ }
208
+
209
+ return;
210
+ },
211
+ });
216
212
 
217
213
  export { createPlugin };
@@ -13,105 +13,92 @@ import type { ResizeState } from './utils';
13
13
  import { evenAllColumnsWidths, isClickNear } from './utils';
14
14
 
15
15
  export const evenColumns =
16
- ({
17
- resizeState,
18
- table,
19
- start,
20
- event,
21
- }: {
22
- resizeState: ResizeState;
23
- table: PMNode;
24
- start: number;
25
- event: MouseEvent;
26
- }): Command =>
27
- (state, dispatch) => {
28
- if (!isTableSelected(state.selection)) {
29
- return false;
30
- }
16
+ ({
17
+ resizeState,
18
+ table,
19
+ start,
20
+ event,
21
+ }: {
22
+ resizeState: ResizeState;
23
+ table: PMNode;
24
+ start: number;
25
+ event: MouseEvent;
26
+ }): Command =>
27
+ (state, dispatch) => {
28
+ if (!isTableSelected(state.selection)) {
29
+ return false;
30
+ }
31
31
 
32
- // double click detection logic
33
- // Note: ProseMirror's handleDoubleClick doesn't quite work with DOM mousedown event handler
34
- const { lastClick } = getPluginState(state);
35
- const now = Date.now();
36
- if (
37
- lastClick &&
38
- now - lastClick.time < 500 &&
39
- isClickNear(event, lastClick)
40
- ) {
41
- const newState = evenAllColumnsWidths(resizeState);
42
- setLastClick(null, (tr) =>
43
- updateColumnWidths(newState, table, start)(tr),
44
- )(state, dispatch);
32
+ // double click detection logic
33
+ // Note: ProseMirror's handleDoubleClick doesn't quite work with DOM mousedown event handler
34
+ const { lastClick } = getPluginState(state);
35
+ const now = Date.now();
36
+ if (lastClick && now - lastClick.time < 500 && isClickNear(event, lastClick)) {
37
+ const newState = evenAllColumnsWidths(resizeState);
38
+ setLastClick(null, (tr) => updateColumnWidths(newState, table, start)(tr))(state, dispatch);
45
39
 
46
- return true;
47
- }
40
+ return true;
41
+ }
48
42
 
49
- setLastClick({ x: event.clientX, y: event.clientY, time: now })(
50
- state,
51
- dispatch,
52
- );
43
+ setLastClick({ x: event.clientX, y: event.clientY, time: now })(state, dispatch);
53
44
 
54
- return false;
55
- };
45
+ return false;
46
+ };
56
47
 
57
48
  export const distributeColumnsWidths =
58
- (newResizeState: ResizeState, table: ContentNodeWithPos): Command =>
59
- (state, dispatch) => {
60
- if (dispatch) {
61
- const tr = updateColumnWidths(
62
- newResizeState,
63
- table.node,
64
- table.start,
65
- )(state.tr);
66
- tr.setMeta(META_KEYS.OVERFLOW_TRIGGER, {
67
- name: TABLE_OVERFLOW_CHANGE_TRIGGER.DISTRIBUTED_COLUMNS,
68
- });
69
- stopResizing(tr)(state, dispatch);
70
- }
49
+ (newResizeState: ResizeState, table: ContentNodeWithPos): Command =>
50
+ (state, dispatch) => {
51
+ if (dispatch) {
52
+ const tr = updateColumnWidths(newResizeState, table.node, table.start)(state.tr);
53
+ tr.setMeta(META_KEYS.OVERFLOW_TRIGGER, {
54
+ name: TABLE_OVERFLOW_CHANGE_TRIGGER.DISTRIBUTED_COLUMNS,
55
+ });
56
+ stopResizing(tr)(state, dispatch);
57
+ }
71
58
 
72
- return true;
73
- };
59
+ return true;
60
+ };
74
61
 
75
62
  export const setResizeHandlePos = (resizeHandlePos: number | null) =>
76
- createCommand({
77
- type: 'SET_RESIZE_HANDLE_POSITION',
78
- data: {
79
- resizeHandlePos,
80
- },
81
- });
63
+ createCommand({
64
+ type: 'SET_RESIZE_HANDLE_POSITION',
65
+ data: {
66
+ resizeHandlePos,
67
+ },
68
+ });
82
69
 
83
70
  export const stopResizing = (tr?: Transaction) =>
84
- createCommand(
85
- {
86
- type: 'STOP_RESIZING',
87
- },
88
- (originalTr) => (tr || originalTr).setMeta('scrollIntoView', false),
89
- );
71
+ createCommand(
72
+ {
73
+ type: 'STOP_RESIZING',
74
+ },
75
+ (originalTr) => (tr || originalTr).setMeta('scrollIntoView', false),
76
+ );
90
77
 
91
78
  export const setDragging = (
92
- dragging: { startX: number; startWidth: number } | null,
93
- tr?: Transaction,
79
+ dragging: { startX: number; startWidth: number } | null,
80
+ tr?: Transaction,
94
81
  ) =>
95
- createCommand(
96
- {
97
- type: 'SET_DRAGGING',
98
- data: {
99
- dragging,
100
- },
101
- },
102
- (originalTr) => tr || originalTr,
103
- );
82
+ createCommand(
83
+ {
84
+ type: 'SET_DRAGGING',
85
+ data: {
86
+ dragging,
87
+ },
88
+ },
89
+ (originalTr) => tr || originalTr,
90
+ );
104
91
 
105
92
  export const setLastClick = (
106
- lastClick: { x: number; y: number; time: number } | null,
107
- transform?: (tr: Transaction) => Transaction,
93
+ lastClick: { x: number; y: number; time: number } | null,
94
+ transform?: (tr: Transaction) => Transaction,
108
95
  ) =>
109
- createCommand(
110
- {
111
- type: 'SET_LAST_CLICK',
112
- data: {
113
- lastClick,
114
- },
115
- },
116
- transform,
117
- );
96
+ createCommand(
97
+ {
98
+ type: 'SET_LAST_CLICK',
99
+ data: {
100
+ lastClick,
101
+ },
102
+ },
103
+ transform,
104
+ );