summaryrefslogtreecommitdiffstats
path: root/devtools/client/shared/test/browser_inplace-editor_stop_on_key.js
blob: 50ab5631ae9eabd7f310fa57941f945b33610bba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */
/* import-globals-from helper_inplace_editor.js */

"use strict";

loadHelperScript("helper_inplace_editor.js");

// Test the inplace-editor stopOnX options behavior

add_task(async function () {
  await addTab("data:text/html;charset=utf-8,inline editor stopOnX");
  const { host, doc } = await createHost();

  testStopOnReturn(doc);
  testStopOnTab(doc);
  testStopOnShiftTab(doc);

  host.destroy();
  gBrowser.removeCurrentTab();
});

function testStopOnReturn(doc) {
  const { span1El, span2El } = setupMarkupAndCreateInplaceEditors(doc);

  info(`Create an editable field with "stopOnReturn" set to true`);
  editableField({
    element: span1El,
    focusEditableFieldAfterApply: true,
    focusEditableFieldContainerSelector: "main",
    stopOnReturn: true,
  });
  editableField({
    element: span2El,
  });

  info("Activate inplace editor on first span");
  span1El.click();

  is(
    doc.activeElement.inplaceEditor.elt.id,
    "span-1",
    "Visible editable field is the one associated with first span"
  );
  assertFocusedElementInplaceEditorInput(doc);

  info("Press Return");
  EventUtils.synthesizeKey("VK_RETURN");

  is(
    doc.activeElement.id,
    "span-1",
    "Using Enter did not advance the editor to the next focusable element"
  );

  info("Activate inplace editor on first span again");
  span1El.click();

  is(
    doc.activeElement.inplaceEditor.elt.id,
    "span-1",
    "Visible editable field is the one associated with first span"
  );
  assertFocusedElementInplaceEditorInput(doc);

  const isMacOS = Services.appinfo.OS === "Darwin";
  info(`Press ${isMacOS ? "Cmd" : "Ctrl"} + Enter`);
  EventUtils.synthesizeKey("VK_RETURN", {
    [isMacOS ? "metaKey" : "ctrlKey"]: true,
  });

  is(
    doc.activeElement.inplaceEditor.elt.id,
    "span-2",
    `Using ${
      isMacOS ? "Cmd" : "Ctrl"
    } + Enter did advance the editor to the next focusable element`
  );
}

function testStopOnTab(doc) {
  const { span1El, span2El } = setupMarkupAndCreateInplaceEditors(doc);

  info(`Create editable fields with "stopOnTab" set to true`);
  const options = {
    focusEditableFieldAfterApply: true,
    focusEditableFieldContainerSelector: "main",
    stopOnTab: true,
  };
  editableField({
    element: span1El,
    ...options,
  });
  editableField({
    element: span2El,
    ...options,
  });

  info("Activate inplace editor on first span");
  span1El.click();

  is(
    doc.activeElement.inplaceEditor.elt.id,
    "span-1",
    "Visible editable field is the one associated with first span"
  );
  assertFocusedElementInplaceEditorInput(doc);

  info("Press Tab");
  EventUtils.synthesizeKey("VK_TAB");

  is(
    doc.activeElement.id,
    "span-1",
    "Using Tab did not advance the editor to the next focusable element"
  );

  info(
    "Activate inplace editor on second span to check that Shift+Tab does work"
  );
  span2El.click();

  is(
    doc.activeElement.inplaceEditor.elt.id,
    "span-2",
    "Visible editable field is the one associated with second span"
  );
  assertFocusedElementInplaceEditorInput(doc);

  info("Press Shift+Tab");
  EventUtils.synthesizeKey("VK_TAB", {
    shiftKey: true,
  });

  is(
    doc.activeElement.inplaceEditor.elt.id,
    "span-1",
    `Using Shift + Tab did move the editor to the previous focusable element`
  );
}

function testStopOnShiftTab(doc) {
  const { span1El, span2El } = setupMarkupAndCreateInplaceEditors(doc);
  info(`Create editable fields with "stopOnShiftTab" set to true`);
  const options = {
    focusEditableFieldAfterApply: true,
    focusEditableFieldContainerSelector: "main",
    stopOnShiftTab: true,
  };
  editableField({
    element: span1El,
    ...options,
  });
  editableField({
    element: span2El,
    ...options,
  });

  info("Activate inplace editor on second span");
  span2El.click();

  is(
    doc.activeElement.inplaceEditor.elt.id,
    "span-2",
    "Visible editable field is the one associated with second span"
  );
  assertFocusedElementInplaceEditorInput(doc);

  info("Press Shift+Tab");
  EventUtils.synthesizeKey("VK_TAB", { shiftKey: true });

  is(
    doc.activeElement.id,
    "span-2",
    "Using Shift+Tab did not move the editor to the previous focusable element"
  );

  info(
    "Activate inplace editor on first span to check that Tab is not impacted"
  );
  span1El.click();

  is(
    doc.activeElement.inplaceEditor.elt.id,
    "span-1",
    "Visible editable field is the one associated with first span"
  );
  assertFocusedElementInplaceEditorInput(doc);

  info("Press Tab");
  EventUtils.synthesizeKey("VK_TAB");

  is(
    doc.activeElement.inplaceEditor.elt.id,
    "span-2",
    `Using Tab did move the editor to the next focusable element`
  );
}

function setupMarkupAndCreateInplaceEditors(doc) {
  // For some reason <button> or <input> are not rendered, so let's use divs with
  // tabindex attribute to make them focusable.
  doc.body.innerHTML = `
      <main>
          <span id="span-1" tabindex=0>SPAN 1</span>
          <span id="span-2" tabindex=0>SPAN 2</span>
      <main>`;

  const span1El = doc.getElementById("span-1");
  const span2El = doc.getElementById("span-2");
  return { span1El, span2El };
}

function assertFocusedElementInplaceEditorInput(doc) {
  ok(
    doc.activeElement.matches("input.styleinspector-propertyeditor"),
    "inplace editor input is focused"
  );
}