summaryrefslogtreecommitdiffstats
path: root/devtools/client/shared/test/browser_inplace-editor-01.js
blob: e6bc6043928556e9de04ac0b133ea32e2b2b4854 (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
/* 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 behavior.

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

  await testMultipleInitialization(doc);
  await testReturnCommit(doc);
  await testBlurCommit(doc);
  await testAdvanceCharCommit(doc);
  await testAdvanceCharsFunction(doc);
  await testEscapeCancel(doc);
  await testInputAriaLabel(doc);

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

function testMultipleInitialization(doc) {
  doc.body.innerHTML = "";
  const options = {};
  const span = (options.element = createSpan(doc));

  info("Creating multiple inplace-editor fields");
  editableField(options);
  editableField(options);

  info("Clicking on the inplace-editor field to turn to edit mode");
  span.click();

  is(span.style.display, "none", "The original <span> is hidden");
  is(doc.querySelectorAll("input").length, 1, "Only one <input>");
  is(
    doc.querySelectorAll("span").length,
    2,
    "Correct number of <span> elements"
  );
  is(
    doc.querySelectorAll("span.autosizer").length,
    1,
    "There is an autosizer element"
  );
}

function testReturnCommit(doc) {
  info("Testing that pressing return commits the new value");
  return new Promise(resolve => {
    createInplaceEditorAndClick(
      {
        initial: "explicit initial",
        start(editor) {
          is(
            editor.input.value,
            "explicit initial",
            "Explicit initial value should be used."
          );
          editor.input.value = "Test Value";
          EventUtils.sendKey("return");
        },
        done: onDone("Test Value", true, resolve),
      },
      doc
    );
  });
}

function testBlurCommit(doc) {
  info("Testing that bluring the field commits the new value");
  return new Promise(resolve => {
    createInplaceEditorAndClick(
      {
        start(editor) {
          is(editor.input.value, "Edit Me!", "textContent of the span used.");
          editor.input.value = "Test Value";
          editor.input.blur();
        },
        done: onDone("Test Value", true, resolve),
      },
      doc,
      "Edit Me!"
    );
  });
}

function testAdvanceCharCommit(doc) {
  info("Testing that configured advanceChars commit the new value");
  return new Promise(resolve => {
    createInplaceEditorAndClick(
      {
        advanceChars: ":",
        start() {
          EventUtils.sendString("Test:");
        },
        done: onDone("Test", true, resolve),
      },
      doc
    );
  });
}

function testAdvanceCharsFunction(doc) {
  info("Testing advanceChars as a function");
  return new Promise(resolve => {
    let firstTime = true;

    createInplaceEditorAndClick(
      {
        initial: "",
        advanceChars(charCode, text) {
          if (charCode !== KeyboardEvent.DOM_VK_COLON) {
            return false;
          }
          if (firstTime) {
            firstTime = false;
            return false;
          }

          // Just to make sure we check it somehow.
          return !!text.length;
        },
        start() {
          for (const ch of ":Test:") {
            EventUtils.sendChar(ch);
          }
        },
        done: onDone(":Test", true, resolve),
      },
      doc
    );
  });
}

function testEscapeCancel(doc) {
  info("Testing that escape cancels the new value");
  return new Promise(resolve => {
    createInplaceEditorAndClick(
      {
        initial: "initial text",
        start(editor) {
          editor.input.value = "Test Value";
          EventUtils.sendKey("escape");
        },
        done: onDone("initial text", false, resolve),
      },
      doc
    );
  });
}

function testInputAriaLabel(doc) {
  info("Testing that inputAriaLabel works as expected");
  doc.body.innerHTML = "";

  let element = createSpan(doc);
  editableField({
    element,
    inputAriaLabel: "TEST_ARIA_LABEL",
  });

  info("Clicking on the inplace-editor field to turn to edit mode");
  element.click();
  let input = doc.querySelector("input");
  is(
    input.getAttribute("aria-label"),
    "TEST_ARIA_LABEL",
    "Input has expected aria-label"
  );

  info("Testing that inputAriaLabelledBy works as expected");
  doc.body.innerHTML = "";
  element = createSpan(doc);
  editableField({
    element,
    inputAriaLabelledBy: "TEST_ARIA_LABELLED_BY",
  });

  info("Clicking on the inplace-editor field to turn to edit mode");
  element.click();
  input = doc.querySelector("input");
  is(
    input.getAttribute("aria-labelledby"),
    "TEST_ARIA_LABELLED_BY",
    "Input has expected aria-labelledby"
  );
}

function onDone(value, isCommit, resolve) {
  return function (actualValue, actualCommit) {
    info("Inplace-editor's done callback executed, checking its state");
    is(actualValue, value, "The value is correct");
    is(actualCommit, isCommit, "The commit boolean is correct");
    resolve();
  };
}