@odoo/o-spreadsheet 14.0.1 → 15.0.0

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 (203) hide show
  1. package/dist/o_spreadsheet.cjs.js +31302 -0
  2. package/dist/o_spreadsheet.d.ts +6604 -0
  3. package/dist/o_spreadsheet.esm.js +31257 -0
  4. package/dist/o_spreadsheet.iife.js +31304 -0
  5. package/dist/o_spreadsheet.iife.min.js +3071 -0
  6. package/package.json +57 -15
  7. package/.eslintrc.json +0 -20
  8. package/.husky/post-checkout +0 -9
  9. package/.husky/pre-commit +0 -39
  10. package/.prettierignore +0 -1
  11. package/astToFormula.patch +0 -0
  12. package/demo/data.js +0 -255
  13. package/demo/index.html +0 -9
  14. package/demo/libs/Chart.bundle.js +0 -20755
  15. package/demo/main.js +0 -101
  16. package/doc/readme.md +0 -46
  17. package/rollup.config.js +0 -23
  18. package/src/base_plugin.ts +0 -102
  19. package/src/components/autofill.ts +0 -146
  20. package/src/components/bottom_bar.ts +0 -199
  21. package/src/components/color_picker.ts +0 -150
  22. package/src/components/composer/autocomplete_dropdown.ts +0 -135
  23. package/src/components/composer/composer.ts +0 -487
  24. package/src/components/composer/content_editable_helper.ts +0 -146
  25. package/src/components/figures/chart.ts +0 -70
  26. package/src/components/figures/container.ts +0 -268
  27. package/src/components/figures/text_figure.ts +0 -36
  28. package/src/components/grid.ts +0 -635
  29. package/src/components/helpers/dom_helpers.ts +0 -7
  30. package/src/components/helpers/drag_and_drop.ts +0 -17
  31. package/src/components/icons.ts +0 -36
  32. package/src/components/index.ts +0 -1
  33. package/src/components/menu.ts +0 -288
  34. package/src/components/overlay.ts +0 -457
  35. package/src/components/scrollbar.ts +0 -22
  36. package/src/components/selection_input.ts +0 -168
  37. package/src/components/side_panel/cell_is_rule_editor.ts +0 -169
  38. package/src/components/side_panel/chart_panel.ts +0 -104
  39. package/src/components/side_panel/color_scale_rule_editor.ts +0 -145
  40. package/src/components/side_panel/conditional_formatting.ts +0 -396
  41. package/src/components/side_panel/side_panel.ts +0 -127
  42. package/src/components/side_panel/translations_terms.ts +0 -45
  43. package/src/components/spreadsheet.ts +0 -198
  44. package/src/components/top_bar.ts +0 -535
  45. package/src/constants.ts +0 -26
  46. package/src/data.ts +0 -149
  47. package/src/fonts.ts +0 -41
  48. package/src/formulas/compiler.ts +0 -258
  49. package/src/formulas/composer_tokenizer.ts +0 -70
  50. package/src/formulas/index.ts +0 -15
  51. package/src/formulas/normalize.ts +0 -52
  52. package/src/formulas/parser.ts +0 -280
  53. package/src/formulas/range_tokenizer.ts +0 -97
  54. package/src/formulas/tokenizer.ts +0 -242
  55. package/src/functions/arguments.ts +0 -114
  56. package/src/functions/dates.ts +0 -302
  57. package/src/functions/helpers.ts +0 -592
  58. package/src/functions/index.ts +0 -52
  59. package/src/functions/module_database.ts +0 -282
  60. package/src/functions/module_date.ts +0 -743
  61. package/src/functions/module_info.ts +0 -69
  62. package/src/functions/module_logical.ts +0 -208
  63. package/src/functions/module_lookup.ts +0 -185
  64. package/src/functions/module_math.ts +0 -1252
  65. package/src/functions/module_operators.ts +0 -291
  66. package/src/functions/module_statistical.ts +0 -882
  67. package/src/functions/module_text.ts +0 -370
  68. package/src/helpers/color.ts +0 -30
  69. package/src/helpers/coordinates.ts +0 -71
  70. package/src/helpers/grid_manipulation.ts +0 -68
  71. package/src/helpers/index.ts +0 -7
  72. package/src/helpers/misc.ts +0 -76
  73. package/src/helpers/numbers.ts +0 -117
  74. package/src/helpers/uuid.ts +0 -19
  75. package/src/helpers/zones.ts +0 -263
  76. package/src/history.ts +0 -186
  77. package/src/index.ts +0 -84
  78. package/src/model.ts +0 -261
  79. package/src/plugins/autofill.ts +0 -412
  80. package/src/plugins/chart.ts +0 -404
  81. package/src/plugins/clipboard.ts +0 -461
  82. package/src/plugins/conditional_format.ts +0 -445
  83. package/src/plugins/core.ts +0 -1502
  84. package/src/plugins/edition.ts +0 -157
  85. package/src/plugins/evaluation.ts +0 -428
  86. package/src/plugins/figures.ts +0 -123
  87. package/src/plugins/formatting.ts +0 -630
  88. package/src/plugins/highlight.ts +0 -187
  89. package/src/plugins/index.ts +0 -32
  90. package/src/plugins/merge.ts +0 -524
  91. package/src/plugins/renderer.ts +0 -571
  92. package/src/plugins/selection.ts +0 -562
  93. package/src/plugins/selection_inputs.ts +0 -326
  94. package/src/registries/autofill_modifiers.ts +0 -76
  95. package/src/registries/autofill_rules.ts +0 -98
  96. package/src/registries/figure_registry.ts +0 -30
  97. package/src/registries/index.ts +0 -7
  98. package/src/registries/menu_items_registry.ts +0 -110
  99. package/src/registries/menus/cell_menu_registry.ts +0 -79
  100. package/src/registries/menus/col_menu_registry.ts +0 -63
  101. package/src/registries/menus/index.ts +0 -6
  102. package/src/registries/menus/menu_items_actions.ts +0 -425
  103. package/src/registries/menus/row_menu_registry.ts +0 -63
  104. package/src/registries/menus/sheet_menu_registry.ts +0 -75
  105. package/src/registries/menus/topbar_menu_registry.ts +0 -204
  106. package/src/registries/side_panel_registry.ts +0 -26
  107. package/src/registries/topbar_component_registry.ts +0 -12
  108. package/src/registry.ts +0 -51
  109. package/src/translation.ts +0 -44
  110. package/src/types/autofill.ts +0 -48
  111. package/src/types/chart.ts +0 -26
  112. package/src/types/commands.ts +0 -716
  113. package/src/types/conditional_formatting.ts +0 -124
  114. package/src/types/env.ts +0 -13
  115. package/src/types/functions.ts +0 -35
  116. package/src/types/getters.ts +0 -103
  117. package/src/types/index.ts +0 -20
  118. package/src/types/misc.ts +0 -143
  119. package/src/types/rendering.ts +0 -41
  120. package/src/types/workbook_data.ts +0 -62
  121. package/tests/__mocks__/uuid.ts +0 -7
  122. package/tests/canvas.mock.ts +0 -34
  123. package/tests/components/__mocks__/content_editable_helper.ts +0 -79
  124. package/tests/components/__mocks__/scrollbar.ts +0 -18
  125. package/tests/components/__snapshots__/autocomplete_dropdown_test.ts.snap +0 -29
  126. package/tests/components/__snapshots__/bottom_bar_test.ts.snap +0 -75
  127. package/tests/components/__snapshots__/context_menu_test.ts.snap +0 -88
  128. package/tests/components/__snapshots__/grid_test.ts.snap +0 -60
  129. package/tests/components/__snapshots__/spreadsheet_test.ts.snap +0 -455
  130. package/tests/components/__snapshots__/top_bar_test.ts.snap +0 -705
  131. package/tests/components/autocomplete_dropdown_test.ts +0 -315
  132. package/tests/components/autofill_test.ts +0 -167
  133. package/tests/components/bottom_bar_test.ts +0 -262
  134. package/tests/components/chart_side_panel_test.ts +0 -123
  135. package/tests/components/composer_test.ts +0 -400
  136. package/tests/components/context_menu_test.ts +0 -825
  137. package/tests/components/grid_manipulation_test.ts +0 -163
  138. package/tests/components/grid_test.ts +0 -581
  139. package/tests/components/overlay_test.ts +0 -541
  140. package/tests/components/selection_input_test.ts +0 -259
  141. package/tests/components/side_panel_test.ts +0 -148
  142. package/tests/components/spreadsheet_test.ts +0 -194
  143. package/tests/components/top_bar_test.ts +0 -427
  144. package/tests/data_test.ts +0 -175
  145. package/tests/dom_helper.ts +0 -42
  146. package/tests/formulas/__snapshots__/compiler_test.ts.snap +0 -302
  147. package/tests/formulas/compiler_test.ts +0 -266
  148. package/tests/formulas/composer_tokenizer_test.ts +0 -137
  149. package/tests/formulas/expressions_test.ts +0 -57
  150. package/tests/formulas/formulas_test.ts +0 -80
  151. package/tests/formulas/normalize_test.ts +0 -82
  152. package/tests/formulas/parser_test.ts +0 -224
  153. package/tests/formulas/range_tokenizer_test.ts +0 -187
  154. package/tests/formulas/tokenizer_test.ts +0 -164
  155. package/tests/functions/arguments_test.ts +0 -141
  156. package/tests/functions/dates_test.ts +0 -1081
  157. package/tests/functions/functions_test.ts +0 -53
  158. package/tests/functions/helper_test.ts +0 -98
  159. package/tests/functions/module_database_test.ts +0 -311
  160. package/tests/functions/module_date_test.ts +0 -941
  161. package/tests/functions/module_info_test.ts +0 -139
  162. package/tests/functions/module_logical_test.ts +0 -369
  163. package/tests/functions/module_lookup_test.ts +0 -541
  164. package/tests/functions/module_math_test.ts +0 -2482
  165. package/tests/functions/module_operators_test.ts +0 -955
  166. package/tests/functions/module_statistical_test.ts +0 -2014
  167. package/tests/functions/module_text_test.ts +0 -667
  168. package/tests/helpers/coordinates_test.ts +0 -25
  169. package/tests/helpers/misc_test.ts +0 -95
  170. package/tests/helpers/numbers_test.ts +0 -196
  171. package/tests/helpers/zones_test.ts +0 -97
  172. package/tests/helpers.ts +0 -384
  173. package/tests/menu_items_registry_test.ts +0 -540
  174. package/tests/model/plugins/__snapshots__/chart_test.ts.snap +0 -90
  175. package/tests/model/plugins/chart_test.ts +0 -562
  176. package/tests/model_test.ts +0 -82
  177. package/tests/plugins/__snapshots__/conditional_formatting_test.ts.snap +0 -131
  178. package/tests/plugins/__snapshots__/renderer_test.ts.snap +0 -371
  179. package/tests/plugins/autofill_test.ts +0 -457
  180. package/tests/plugins/borders_test.ts +0 -295
  181. package/tests/plugins/clipboard_test.ts +0 -1180
  182. package/tests/plugins/conditional_formatting_test.ts +0 -1253
  183. package/tests/plugins/core_test.ts +0 -614
  184. package/tests/plugins/edition_test.ts +0 -100
  185. package/tests/plugins/evaluation_async_test.ts +0 -332
  186. package/tests/plugins/evaluation_dates_test.ts +0 -79
  187. package/tests/plugins/evaluation_test.ts +0 -901
  188. package/tests/plugins/figures_test.ts +0 -327
  189. package/tests/plugins/formatting_test.ts +0 -391
  190. package/tests/plugins/grid_manipulation_test.ts +0 -1366
  191. package/tests/plugins/highlight_test.ts +0 -413
  192. package/tests/plugins/history_test.ts +0 -142
  193. package/tests/plugins/import_export_test.ts +0 -276
  194. package/tests/plugins/merges_test.ts +0 -490
  195. package/tests/plugins/navigation_test.ts +0 -181
  196. package/tests/plugins/plugins/evaluation_test.ts +0 -111
  197. package/tests/plugins/renderer_test.ts +0 -598
  198. package/tests/plugins/resizing_test.ts +0 -152
  199. package/tests/plugins/selection_input_test.ts +0 -409
  200. package/tests/plugins/selection_test.ts +0 -442
  201. package/tests/plugins/sheets_test.ts +0 -643
  202. package/tests/plugins/style_test.ts +0 -90
  203. package/tsconfig.json +0 -22
@@ -1,635 +0,0 @@
1
- import * as owl from "@odoo/owl";
2
- import {
3
- BACKGROUND_GRAY_COLOR,
4
- DEFAULT_CELL_HEIGHT,
5
- HEADER_HEIGHT,
6
- HEADER_WIDTH,
7
- SCROLLBAR_WIDTH,
8
- } from "../constants";
9
- import { isEqual, isInside, toCartesian, toXC } from "../helpers/index";
10
- import { Model } from "../model";
11
- import { cellMenuRegistry } from "../registries/menus/cell_menu_registry";
12
- import { colMenuRegistry } from "../registries/menus/col_menu_registry";
13
- import { rowMenuRegistry } from "../registries/menus/row_menu_registry";
14
- import { SpreadsheetEnv, Viewport } from "../types/index";
15
- import { Autofill } from "./autofill";
16
- import { Composer } from "./composer/composer";
17
- import { FiguresContainer } from "./figures/container";
18
- import { startDnd } from "./helpers/drag_and_drop";
19
- import { Menu, MenuState } from "./menu";
20
- import { Overlay } from "./overlay";
21
- import { ScrollBar } from "./scrollbar";
22
-
23
- /**
24
- * The Grid component is the main part of the spreadsheet UI. It is responsible
25
- * for displaying the actual grid, rendering it, managing events, ...
26
- *
27
- * The grid is rendered on a canvas. 3 sub components are (sometimes) displayed
28
- * on top of the canvas:
29
- * - a composer (to edit the cell content)
30
- * - a horizontal resizer (to resize columns)
31
- * - a vertical resizer (same, for rows)
32
- */
33
-
34
- const { Component, useState } = owl;
35
- const { xml, css } = owl.tags;
36
- const { useRef, onMounted, onWillUnmount } = owl.hooks;
37
- export type ContextMenuType = "ROW" | "COL" | "CELL";
38
-
39
- const registries = {
40
- ROW: rowMenuRegistry,
41
- COL: colMenuRegistry,
42
- CELL: cellMenuRegistry,
43
- };
44
-
45
- // copy and paste are specific events that should not be managed by the keydown event,
46
- // but they shouldn't be preventDefault and stopped (else copy and paste events will not trigger)
47
- // and also should not result in typing the character C or V in the composer
48
- const keyDownMappingIgnore: string[] = ["CTRL+C", "CTRL+V"];
49
-
50
- // -----------------------------------------------------------------------------
51
- // Error Tooltip Hook
52
- // -----------------------------------------------------------------------------
53
-
54
- interface ErrorTooltip {
55
- isOpen: boolean;
56
- text: string;
57
- style: string;
58
- }
59
- function useErrorTooltip(env: SpreadsheetEnv, getViewPort: () => Viewport): ErrorTooltip {
60
- const { browser, getters } = env;
61
- const { Date, setInterval, clearInterval } = browser;
62
- let x = 0;
63
- let y = 0;
64
- let lastMoved = 0;
65
- let tooltipCol: number, tooltipRow: number;
66
- const canvasRef = useRef("canvas");
67
- const tooltip = useState({ isOpen: false, text: "", style: "" });
68
- let interval;
69
- function updateMousePosition(e: MouseEvent) {
70
- x = e.offsetX;
71
- y = e.offsetY;
72
- lastMoved = Date.now();
73
- }
74
- function getPosition(): [number, number] {
75
- const viewport = getViewPort();
76
- const col = getters.getColIndex(x, viewport.left);
77
- const row = getters.getRowIndex(y, viewport.top);
78
- return [col, row];
79
- }
80
- function checkTiming() {
81
- if (tooltip.isOpen) {
82
- const [col, row] = getPosition();
83
- if (col !== tooltipCol || row !== tooltipRow) {
84
- tooltip.isOpen = false;
85
- }
86
- } else {
87
- const delta = Date.now() - lastMoved;
88
- if (400 < delta && delta < 600) {
89
- // mouse did not move for a short while
90
- const [col, row] = getPosition();
91
- if (col < 0 || row < 0) {
92
- return;
93
- }
94
- const mainXc = getters.getMainCell(toXC(col, row));
95
- const cell = getters.getCell(...toCartesian(mainXc));
96
- if (cell && cell.error) {
97
- tooltip.isOpen = true;
98
- tooltip.text = cell.error;
99
- tooltipCol = col;
100
- tooltipRow = row;
101
- const viewport = getViewPort();
102
- const [x, y, width, height] = env.getters.getRect(
103
- { left: col, top: row, right: col, bottom: row },
104
- viewport
105
- );
106
- const hAlign = x + width + 200 < viewport.width ? "left" : "right";
107
- const hOffset =
108
- hAlign === "left" ? x + width : viewport.width - x + (SCROLLBAR_WIDTH + 2);
109
- const vAlign = y + 120 < viewport.height ? "top" : "bottom";
110
- const vOffset =
111
- vAlign === "top" ? y : viewport.height - y - height + (SCROLLBAR_WIDTH + 2);
112
- tooltip.style = `${hAlign}:${hOffset}px;${vAlign}:${vOffset}px`;
113
- }
114
- }
115
- }
116
- }
117
-
118
- onMounted(() => {
119
- canvasRef.el!.addEventListener("mousemove", updateMousePosition);
120
- interval = setInterval(checkTiming, 200);
121
- });
122
-
123
- onWillUnmount(() => {
124
- canvasRef.el!.removeEventListener("mousemove", updateMousePosition);
125
- clearInterval(interval);
126
- });
127
-
128
- return tooltip;
129
- }
130
-
131
- function useTouchMove(handler: (deltaX: number, deltaY: number) => void, canMoveUp: () => boolean) {
132
- const canvasRef = useRef("canvas");
133
- let x = null as number | null;
134
- let y = null as number | null;
135
- function onTouchStart(ev: TouchEvent) {
136
- if (ev.touches.length !== 1) return;
137
- x = ev.touches[0].clientX;
138
- y = ev.touches[0].clientY;
139
- }
140
- function onTouchEnd() {
141
- x = null;
142
- y = null;
143
- }
144
- function onTouchMove(ev: TouchEvent) {
145
- if (ev.touches.length !== 1) return;
146
- // On mobile browsers, swiping down is often associated with "pull to refresh".
147
- // We only want this behavior if the grid is already at the top.
148
- // Otherwise we only want to move the canvas up, without triggering any refresh.
149
- if (canMoveUp()) {
150
- ev.preventDefault();
151
- ev.stopPropagation();
152
- }
153
- const currentX = ev.touches[0].clientX;
154
- const currentY = ev.touches[0].clientY;
155
- handler(x! - currentX, y! - currentY);
156
- x = currentX;
157
- y = currentY;
158
- }
159
- onMounted(() => {
160
- canvasRef.el!.addEventListener("touchstart", onTouchStart);
161
- canvasRef.el!.addEventListener("touchend", onTouchEnd);
162
- canvasRef.el!.addEventListener("touchmove", onTouchMove);
163
- });
164
-
165
- onWillUnmount(() => {
166
- canvasRef.el!.removeEventListener("touchstart", onTouchStart);
167
- canvasRef.el!.removeEventListener("touchend", onTouchEnd);
168
- canvasRef.el!.removeEventListener("touchmove", onTouchMove);
169
- });
170
- }
171
-
172
- // -----------------------------------------------------------------------------
173
- // TEMPLATE
174
- // -----------------------------------------------------------------------------
175
- const TEMPLATE = xml/* xml */ `
176
- <div class="o-grid" t-on-click="focus" t-on-keydown="onKeydown" t-on-wheel="onMouseWheel">
177
- <t t-if="getters.getEditionMode() !== 'inactive'">
178
- <Composer t-ref="composer" t-on-composer-unmounted="focus" viewport="snappedViewport"/>
179
- </t>
180
- <canvas t-ref="canvas"
181
- t-on-mousedown="onMouseDown"
182
- t-on-dblclick="onDoubleClick"
183
- tabindex="-1"
184
- t-on-contextmenu="onCanvasContextMenu"
185
- />
186
- <t t-if="errorTooltip.isOpen">
187
- <div class="o-error-tooltip" t-esc="errorTooltip.text" t-att-style="errorTooltip.style"/>
188
- </t>
189
- <t t-if="getters.getEditionMode() === 'inactive'">
190
- <Autofill position="getAutofillPosition()" viewport="snappedViewport"/>
191
- </t>
192
- <Overlay t-on-open-contextmenu="onOverlayContextMenu" viewport="snappedViewport"/>
193
- <Menu t-if="menuState.isOpen"
194
- menuItems="menuState.menuItems"
195
- position="menuState.position"
196
- t-on-close.stop="menuState.isOpen=false"/>
197
- <t t-set="gridSize" t-value="getters.getGridSize()"/>
198
- <FiguresContainer viewport="snappedViewport" model="props.model" t-on-figure-deleted="focus" />
199
- <div class="o-scrollbar vertical" t-on-scroll="onScroll" t-ref="vscrollbar">
200
- <div t-attf-style="width:1px;height:{{gridSize[1]}}px"/>
201
- </div>
202
- <div class="o-scrollbar horizontal" t-on-scroll="onScroll" t-ref="hscrollbar">
203
- <div t-attf-style="height:1px;width:{{gridSize[0]}}px"/>
204
- </div>
205
- </div>`;
206
-
207
- // -----------------------------------------------------------------------------
208
- // STYLE
209
- // -----------------------------------------------------------------------------
210
- const CSS = css/* scss */ `
211
- .o-grid {
212
- position: relative;
213
- overflow: hidden;
214
- background-color: ${BACKGROUND_GRAY_COLOR};
215
-
216
- > canvas {
217
- border-top: 1px solid #e2e3e3;
218
- border-bottom: 1px solid #e2e3e3;
219
-
220
- &:focus {
221
- outline: none;
222
- }
223
- }
224
- .o-error-tooltip {
225
- position: absolute;
226
- font-size: 13px;
227
- width: 180px;
228
- height: 80px;
229
- background-color: white;
230
- box-shadow: 0 1px 4px 3px rgba(60, 64, 67, 0.15);
231
- border-left: 3px solid red;
232
- padding: 10px;
233
- }
234
- .o-scrollbar {
235
- position: absolute;
236
- overflow: auto;
237
- z-index: 2;
238
- &.vertical {
239
- right: 0;
240
- top: ${HEADER_HEIGHT}px;
241
- bottom: ${SCROLLBAR_WIDTH}px;
242
- width: ${SCROLLBAR_WIDTH}px;
243
- overflow-x: hidden;
244
- }
245
- &.horizontal {
246
- bottom: 0;
247
- height: ${SCROLLBAR_WIDTH}px;
248
- right: ${SCROLLBAR_WIDTH + 1}px;
249
- left: ${HEADER_WIDTH}px;
250
- overflow-y: hidden;
251
- }
252
- }
253
- }
254
- `;
255
-
256
- // -----------------------------------------------------------------------------
257
- // JS
258
- // -----------------------------------------------------------------------------
259
- export class Grid extends Component<{ model: Model }, SpreadsheetEnv> {
260
- static template = TEMPLATE;
261
- static style = CSS;
262
- static components = { Composer, Overlay, Menu, Autofill, FiguresContainer };
263
-
264
- private menuState: MenuState = useState({
265
- isOpen: false,
266
- position: null,
267
- menuItems: [],
268
- });
269
-
270
- private composer = useRef("composer");
271
-
272
- private vScrollbarRef = useRef("vscrollbar");
273
- private hScrollbarRef = useRef("hscrollbar");
274
- private vScrollbar: ScrollBar;
275
- private hScrollbar: ScrollBar;
276
- private canvas = useRef("canvas");
277
- private getters = this.env.getters;
278
- private dispatch = this.env.dispatch;
279
- private currentPosition = this.getters.getPosition();
280
- private currentSheet = this.getters.getActiveSheet();
281
-
282
- private currentPositionInViewport = false;
283
- private clickedCol = 0;
284
- private clickedRow = 0;
285
- private viewport: Viewport = {
286
- width: 0,
287
- height: 0,
288
- offsetX: 0,
289
- offsetY: 0,
290
- left: 0,
291
- top: 0,
292
- right: 0,
293
- bottom: 0,
294
- };
295
- // this viewport represent the same area as the previous one, but 'snapped' to
296
- // the col/row structure, so, the offsets are correct for computations necessary
297
- // to align elements to the grid.
298
- private snappedViewport: Viewport = this.viewport;
299
- errorTooltip = useErrorTooltip(this.env, () => this.snappedViewport);
300
-
301
- // this map will handle most of the actions that should happen on key down. The arrow keys are managed in the key
302
- // down itself
303
- private keyDownMapping: { [key: string]: Function } = {
304
- ENTER: () => this.dispatch("START_EDITION"),
305
- TAB: () => this.dispatch("MOVE_POSITION", { deltaX: 1, deltaY: 0 }),
306
- "SHIFT+TAB": () => this.dispatch("MOVE_POSITION", { deltaX: -1, deltaY: 0 }),
307
- F2: () => this.dispatch("START_EDITION"),
308
- DELETE: () => {
309
- this.dispatch("DELETE_CONTENT", {
310
- sheet: this.getters.getActiveSheet(),
311
- target: this.getters.getSelectedZones(),
312
- });
313
- },
314
- "CTRL+A": () => this.dispatch("SELECT_ALL"),
315
- "CTRL+S": () => {
316
- this.trigger("save-requested");
317
- },
318
- "CTRL+Z": () => this.dispatch("UNDO"),
319
- "CTRL+Y": () => this.dispatch("REDO"),
320
- };
321
-
322
- constructor() {
323
- super(...arguments);
324
- this.vScrollbar = new ScrollBar(this.vScrollbarRef.el, "vertical");
325
- this.hScrollbar = new ScrollBar(this.hScrollbarRef.el, "horizontal");
326
- useTouchMove(this.moveCanvas.bind(this), () => this.vScrollbar.scroll > 0);
327
- }
328
-
329
- mounted() {
330
- this.vScrollbar.el = this.vScrollbarRef.el!;
331
- this.hScrollbar.el = this.hScrollbarRef.el!;
332
- this.focus();
333
- this.drawGrid();
334
- }
335
-
336
- async willUpdateProps() {
337
- const sheet = this.getters.getActiveSheet();
338
- if (this.currentSheet !== sheet) {
339
- // We need to reset the viewport as the sheet is changed
340
- this.currentPositionInViewport = true;
341
- this.viewport.offsetX = 0;
342
- this.viewport.offsetY = 0;
343
- this.hScrollbar.scroll = 0;
344
- this.vScrollbar.scroll = 0;
345
- this.viewport = this.getters.adjustViewportZone(this.viewport);
346
- this.viewport = this.getters.adjustViewportPosition(this.viewport);
347
- this.snappedViewport = this.getters.snapViewportToCell(this.viewport);
348
- }
349
- }
350
-
351
- patched() {
352
- this.drawGrid();
353
- }
354
- focus() {
355
- if (this.getters.getEditionMode() !== "selecting" && !this.getters.getSelectedFigureId()) {
356
- this.canvas.el!.focus();
357
- }
358
- }
359
-
360
- onScroll() {
361
- this.viewport.offsetX = this.hScrollbar.scroll;
362
- this.viewport.offsetY = this.vScrollbar.scroll;
363
- const viewport = this.getters.adjustViewportZone(this.viewport);
364
- if (!isEqual(viewport, this.viewport)) {
365
- this.viewport = viewport;
366
- this.render();
367
- }
368
- this.snappedViewport = this.getters.snapViewportToCell(this.viewport);
369
- }
370
-
371
- checkChanges(): boolean {
372
- const [col, row] = this.getters.getPosition();
373
- const [curCol, curRow] = this.currentPosition;
374
- const currentSheet = this.getters.getActiveSheet();
375
- const changed = currentSheet !== this.currentSheet || col !== curCol || row !== curRow;
376
- if (changed) {
377
- this.currentPosition = [col, row];
378
- }
379
- if (currentSheet !== this.currentSheet) {
380
- this.focus();
381
- this.currentSheet = currentSheet;
382
- }
383
- return changed;
384
- }
385
-
386
- getAutofillPosition() {
387
- const zone = this.getters.getSelectedZone();
388
- const sheet = this.getters.getActiveSheet();
389
- return {
390
- left:
391
- this.getters.getCol(sheet, zone.right).end -
392
- 4 +
393
- HEADER_WIDTH -
394
- this.snappedViewport.offsetX,
395
- top:
396
- this.getters.getRow(sheet, zone.bottom).end -
397
- 4 +
398
- HEADER_HEIGHT -
399
- this.snappedViewport.offsetY,
400
- };
401
- }
402
-
403
- drawGrid() {
404
- // update viewport dimensions
405
- // resize window
406
- this.viewport.width = this.el!.clientWidth - SCROLLBAR_WIDTH;
407
- this.viewport.height = this.el!.clientHeight - SCROLLBAR_WIDTH;
408
-
409
- // scrollbar scrolled
410
- this.viewport.offsetX = this.hScrollbar.scroll;
411
- this.viewport.offsetY = this.vScrollbar.scroll;
412
-
413
- // needed to reset the bottom and the right on the current viewport to the one of the new
414
- // active sheet or in any case, the number of cols & rows might have changed.
415
- this.viewport = this.getters.adjustViewportZone(this.viewport);
416
-
417
- // check for position changes
418
- if (this.checkChanges() && this.currentPositionInViewport) {
419
- this.currentPositionInViewport = false;
420
- this.viewport = this.getters.adjustViewportPosition(this.viewport);
421
- this.hScrollbar.scroll = this.viewport.offsetX;
422
- this.vScrollbar.scroll = this.viewport.offsetY;
423
- }
424
- this.snappedViewport = this.getters.snapViewportToCell(this.viewport);
425
-
426
- // drawing grid on canvas
427
- const canvas = this.canvas.el as HTMLCanvasElement;
428
- const dpr = window.devicePixelRatio || 1;
429
- const ctx = canvas.getContext("2d", { alpha: false })!;
430
- const thinLineWidth = 0.4 * dpr;
431
- const renderingContext = { ctx, viewport: this.viewport, dpr, thinLineWidth };
432
- const { width, height } = this.viewport;
433
- canvas.style.width = `${width}px`;
434
- canvas.style.height = `${height}px`;
435
- canvas.width = width * dpr;
436
- canvas.height = height * dpr;
437
- canvas.setAttribute("style", `width:${width}px;height:${height}px;`);
438
- ctx.translate(-0.5, -0.5);
439
- ctx.scale(dpr, dpr);
440
- this.props.model.drawGrid(renderingContext);
441
- }
442
-
443
- private moveCanvas(deltaX, deltaY) {
444
- this.vScrollbar.scroll = this.vScrollbar.scroll + deltaY;
445
- this.hScrollbar.scroll = this.hScrollbar.scroll + deltaX;
446
- }
447
-
448
- onMouseWheel(ev: WheelEvent) {
449
- function normalize(val: number): number {
450
- return val * (ev.deltaMode === 0 ? 1 : DEFAULT_CELL_HEIGHT);
451
- }
452
- this.moveCanvas(normalize(ev.deltaX), normalize(ev.deltaY));
453
- }
454
-
455
- // ---------------------------------------------------------------------------
456
- // Zone selection with mouse
457
- // ---------------------------------------------------------------------------
458
-
459
- getCartesianCoordinates(ev: MouseEvent): [number, number] {
460
- const rect = this.el!.getBoundingClientRect();
461
- const x = ev.pageX - rect.left;
462
- const y = ev.pageY - rect.top;
463
- const colIndex = this.getters.getColIndex(x, this.snappedViewport.left);
464
- const rowIndex = this.getters.getRowIndex(y, this.snappedViewport.top);
465
- return [colIndex, rowIndex];
466
- }
467
-
468
- onMouseDown(ev: MouseEvent) {
469
- if (ev.button > 0) {
470
- // not main button, probably a context menu
471
- return;
472
- }
473
- const [col, row] = this.getCartesianCoordinates(ev);
474
- if (col < 0 || row < 0) {
475
- return;
476
- }
477
- this.clickedCol = col;
478
- this.clickedRow = row;
479
-
480
- this.dispatch(ev.ctrlKey ? "START_SELECTION_EXPANSION" : "START_SELECTION");
481
- if (ev.shiftKey) {
482
- this.dispatch("ALTER_SELECTION", { cell: [col, row] });
483
- } else {
484
- this.dispatch("SELECT_CELL", { col, row });
485
- this.checkChanges();
486
- }
487
- let prevCol = col;
488
- let prevRow = row;
489
- const onMouseMove = (ev: MouseEvent) => {
490
- const [col, row] = this.getCartesianCoordinates(ev);
491
- if (col < 0 || row < 0) {
492
- return;
493
- }
494
- if (col !== prevCol || row !== prevRow) {
495
- prevCol = col;
496
- prevRow = row;
497
- this.dispatch("ALTER_SELECTION", { cell: [col, row] });
498
- }
499
- };
500
- const onMouseUp = (ev: MouseEvent) => {
501
- this.dispatch(ev.ctrlKey ? "PREPARE_SELECTION_EXPANSION" : "STOP_SELECTION");
502
- if (this.getters.getEditionMode() === "selecting") {
503
- if (this.composer.comp) {
504
- (this.composer.comp as Composer).addTextFromSelection();
505
- }
506
- }
507
- this.canvas.el!.removeEventListener("mousemove", onMouseMove);
508
- if (this.getters.isPaintingFormat()) {
509
- this.dispatch("PASTE", {
510
- target: this.getters.getSelectedZones(),
511
- });
512
- }
513
- };
514
-
515
- startDnd(onMouseMove, onMouseUp);
516
- }
517
-
518
- onDoubleClick(ev) {
519
- const [col, row] = this.getCartesianCoordinates(ev);
520
- if (this.clickedCol === col && this.clickedRow === row) {
521
- this.dispatch("START_EDITION");
522
- }
523
- }
524
- // ---------------------------------------------------------------------------
525
- // Keyboard interactions
526
- // ---------------------------------------------------------------------------
527
-
528
- processTabKey(ev: KeyboardEvent) {
529
- ev.preventDefault();
530
- const deltaX = ev.shiftKey ? -1 : 1;
531
- this.dispatch("MOVE_POSITION", { deltaX, deltaY: 0 });
532
- }
533
-
534
- processArrows(ev: KeyboardEvent) {
535
- ev.preventDefault();
536
- ev.stopPropagation();
537
- const deltaMap = {
538
- ArrowDown: [0, 1],
539
- ArrowLeft: [-1, 0],
540
- ArrowRight: [1, 0],
541
- ArrowUp: [0, -1],
542
- };
543
- this.currentPositionInViewport = true;
544
- const delta = deltaMap[ev.key];
545
- if (ev.shiftKey) {
546
- this.dispatch("ALTER_SELECTION", { delta });
547
- } else {
548
- this.dispatch("MOVE_POSITION", { deltaX: delta[0], deltaY: delta[1] });
549
- }
550
-
551
- if (this.getters.getEditionMode() === "selecting" && this.composer.comp) {
552
- (this.composer.comp as Composer).addTextFromSelection();
553
- } else if (this.getters.isPaintingFormat()) {
554
- this.dispatch("PASTE", {
555
- target: this.getters.getSelectedZones(),
556
- });
557
- }
558
- }
559
-
560
- onKeydown(ev: KeyboardEvent) {
561
- if (ev.key.startsWith("Arrow")) {
562
- this.processArrows(ev);
563
- return;
564
- }
565
-
566
- let keyDownString = "";
567
- if (ev.ctrlKey) keyDownString += "CTRL+";
568
- if (ev.metaKey) keyDownString += "CTRL+";
569
- if (ev.altKey) keyDownString += "ALT+";
570
- if (ev.shiftKey) keyDownString += "SHIFT+";
571
- keyDownString += ev.key.toUpperCase();
572
-
573
- let handler = this.keyDownMapping[keyDownString];
574
- if (handler) {
575
- ev.preventDefault();
576
- ev.stopPropagation();
577
- handler();
578
- return;
579
- }
580
- if (!keyDownMappingIgnore.includes(keyDownString)) {
581
- if (ev.key.length === 1 && !ev.ctrlKey && !ev.metaKey && !ev.altKey) {
582
- // if the user types a character on the grid, it means he wants to start composing the selected cell with that
583
- // character
584
- ev.preventDefault();
585
- ev.stopPropagation();
586
- this.dispatch("START_EDITION", { text: ev.key });
587
- }
588
- }
589
- }
590
-
591
- // ---------------------------------------------------------------------------
592
- // Context Menu
593
- // ---------------------------------------------------------------------------
594
-
595
- onCanvasContextMenu(ev: MouseEvent) {
596
- ev.preventDefault();
597
- const [col, row] = this.getCartesianCoordinates(ev);
598
- if (col < 0 || row < 0) {
599
- return;
600
- }
601
- const zones = this.getters.getSelectedZones();
602
- const lastZone = zones[zones.length - 1];
603
- let type: ContextMenuType = "CELL";
604
- if (!isInside(col, row, lastZone)) {
605
- this.dispatch("SELECT_CELL", { col, row });
606
- } else {
607
- if (this.getters.getActiveCols().has(col)) {
608
- type = "COL";
609
- } else if (this.getters.getActiveRows().has(row)) {
610
- type = "ROW";
611
- }
612
- }
613
- this.toggleContextMenu(type, ev.offsetX, ev.offsetY);
614
- }
615
-
616
- onOverlayContextMenu(ev: CustomEvent) {
617
- const type = ev.detail.type as ContextMenuType;
618
- const x = ev.detail.x;
619
- const y = ev.detail.y;
620
- this.toggleContextMenu(type, x, y);
621
- }
622
-
623
- toggleContextMenu(type: ContextMenuType, x: number, y: number) {
624
- this.menuState.isOpen = true;
625
- this.menuState.position = {
626
- x,
627
- y,
628
- width: this.el!.clientWidth,
629
- height: this.el!.clientHeight,
630
- };
631
- this.menuState.menuItems = registries[type]
632
- .getAll()
633
- .filter((item) => !item.isVisible || item.isVisible(this.env));
634
- }
635
- }
@@ -1,7 +0,0 @@
1
- /**
2
- * Return true if the event was triggered from
3
- * a child element.
4
- */
5
- export function isChildEvent(parent: HTMLElement, ev: Event): boolean {
6
- return !!ev.target && parent!.contains(ev.target as Node);
7
- }
@@ -1,17 +0,0 @@
1
- type EventFn = (ev: MouseEvent) => void;
2
-
3
- export function startDnd(onMouseMove: EventFn, onMouseUp: EventFn) {
4
- const _onMouseUp = (ev: MouseEvent) => {
5
- onMouseUp(ev);
6
- window.removeEventListener("mouseup", _onMouseUp);
7
- window.removeEventListener("dragstart", _onDragStart);
8
- window.removeEventListener("mousemove", onMouseMove);
9
- };
10
- function _onDragStart(ev: DragEvent) {
11
- ev.preventDefault();
12
- }
13
-
14
- window.addEventListener("mouseup", _onMouseUp);
15
- window.addEventListener("dragstart", _onDragStart);
16
- window.addEventListener("mousemove", onMouseMove);
17
- }