Skip to content

Lightpanda: the headless browser designed for AI and automation

input: fire change when typed text is committed by blur or Enter

Jay Hemnani9674bc9c3150
diff --git a/src/browser/actions.zig b/src/browser/actions.zig
index 7124f5f32..d130814ab 100644
--- a/src/browser/actions.zig
+++ b/src/browser/actions.zig
@@ -170,7 +170,7 @@ fn fillControl(ctl: anytype, text: []const u8, frame: *Frame) !void {
if (!edited) {
return error.ActionFailed;
}
- return dispatchTrusted(el, "change", frame);
+ return ctl.dispatchChangeIfEdited(frame);
}
ctl.setUserValue(text, frame) catch |err| {
diff --git a/src/browser/frame/user_input.zig b/src/browser/frame/user_input.zig
index eb3a1cb5b..0a0c23a19 100644
--- a/src/browser/frame/user_input.zig
+++ b/src/browser/frame/user_input.zig
@@ -1302,6 +1302,7 @@ pub fn typeChar(frame: *Frame, target: *Element, keypress: *KeyboardEvent, text:
if (target.is(Element.Html.Input)) |input| {
if (is_enter) {
+ try input.dispatchChangeIfEdited(frame);
return implicitFormSubmission(frame, input);
}
_ = try applyEdit(frame, input, .{ .insert = text });
@@ -1429,6 +1430,7 @@ pub fn applyEdit(frame: *Frame, ctl: anytype, edit: Edit) !bool {
return false;
}
+ try ctl.rememberValueBeforeEdit(frame);
if (text) |t| {
try ctl.innerInsert(t, data, input_type, frame);
} else {
diff --git a/src/browser/webapi/Element.zig b/src/browser/webapi/Element.zig
index 5f600218c..12b85d2ef 100644
--- a/src/browser/webapi/Element.zig
+++ b/src/browser/webapi/Element.zig
@@ -1386,6 +1386,12 @@ fn dispatchBlur(old: *Element, related: ?*EventTarget, frame: *Frame) !void {
const FocusEvent = @import("event/FocusEvent.zig");
const old_target = old.asEventTarget();
+ if (old.is(Html.Input)) |input| {
+ try input.dispatchChangeIfEdited(frame);
+ } else if (old.is(Html.TextArea)) |textarea| {
+ try textarea.dispatchChangeIfEdited(frame);
+ }
+
const blur_event = try FocusEvent.initTrusted(comptime .wrap("blur"), .{ .composed = true, .relatedTarget = related }, frame);
try frame._event_manager.dispatch(old_target, blur_event.asEvent());
diff --git a/src/browser/webapi/element/html/Input.zig b/src/browser/webapi/element/html/Input.zig
index d524ae4d1..851015925 100644
--- a/src/browser/webapi/element/html/Input.zig
+++ b/src/browser/webapi/element/html/Input.zig
@@ -111,6 +111,8 @@ _checked: bool = false,
_checked_dirty: bool = false,
// Only user edits count for tooLong/tooShort; script and attribute values don't.
_user_edited: bool = false,
+// The value before the user's first edit since the last change event.
+_value_before_edit: ?[]const u8 = null,
_input_type: Type = .text,
_indeterminate: bool = false,
_custom_validity: ?[]const u8 = null,
@@ -650,6 +652,8 @@ pub const tracksSelection = entry.tracksSelection;
pub const innerDelete = entry.innerDelete;
pub const moveCaret = entry.moveCaret;
pub const caretToEnd = entry.caretToEnd;
+pub const rememberValueBeforeEdit = entry.rememberValueBeforeEdit;
+pub const dispatchChangeIfEdited = entry.dispatchChangeIfEdited;
pub const CaretMove = entry.CaretMove;
pub const getSelectionDirection = entry.getSelectionDirection;
pub const setSelectionStart = entry.setSelectionStart;
diff --git a/src/browser/webapi/element/html/TextArea.zig b/src/browser/webapi/element/html/TextArea.zig
index ae25c9506..a8ad23487 100644
--- a/src/browser/webapi/element/html/TextArea.zig
+++ b/src/browser/webapi/element/html/TextArea.zig
@@ -43,6 +43,8 @@ _proto_canary: if (lp.IS_DEBUG) *HtmlElement else void = undefined,
_value: ?[]const u8 = null,
// Only user edits count for tooLong/tooShort; script and attribute values don't.
_user_edited: bool = false,
+// The value before the user's first edit since the last change event.
+_value_before_edit: ?[]const u8 = null,
_selection_start: u32 = 0,
_selection_end: u32 = 0,
@@ -140,6 +142,8 @@ pub const tracksSelection = entry.tracksSelection;
pub const innerDelete = entry.innerDelete;
pub const moveCaret = entry.moveCaret;
pub const caretToEnd = entry.caretToEnd;
+pub const rememberValueBeforeEdit = entry.rememberValueBeforeEdit;
+pub const dispatchChangeIfEdited = entry.dispatchChangeIfEdited;
pub const CaretMove = entry.CaretMove;
pub const getSelectionDirection = entry.getSelectionDirection;
pub const setSelectionStart = entry.setSelectionStart;
diff --git a/src/browser/webapi/element/text_entry.zig b/src/browser/webapi/element/text_entry.zig
index f83c627a6..edfe29669 100644
--- a/src/browser/webapi/element/text_entry.zig
+++ b/src/browser/webapi/element/text_entry.zig
@@ -154,6 +154,25 @@ pub fn TextEntry(comptime T: type) type {
try dispatchInputEvent(self, null, input_type, frame);
}
+ pub fn rememberValueBeforeEdit(self: *T, frame: *Frame) !void {
+ if (self._value_before_edit == null) {
+ self._value_before_edit = try frame.page_arena.dupe(u8, self.getValue());
+ }
+ }
+
+ // Commits the user's edits: fires change when they left the value
+ // different, as when the control loses focus or Enter submits it.
+ // https://html.spec.whatwg.org/multipage/input.html#common-input-element-events
+ pub fn dispatchChangeIfEdited(self: *T, frame: *Frame) !void {
+ const before = self._value_before_edit orelse return;
+ self._value_before_edit = null;
+ if (std.mem.eql(u8, before, self.getValue())) {
+ return;
+ }
+ const event = try Event.initTrusted(comptime .wrap("change"), .{ .bubbles = true }, frame.page);
+ try frame._event_manager.dispatch(self.asElement().asEventTarget(), event);
+ }
+
// Collapses the selection to the end of the value. Unlike
// setSelectionRange(), applies to email and number too.
pub fn caretToEnd(self: *T, frame: *Frame) !void {
diff --git a/src/server/Server.zig b/src/server/Server.zig
index 1b83edfa8..833d803f3 100644
--- a/src/server/Server.zig
+++ b/src/server/Server.zig
@@ -2344,7 +2344,7 @@ test "server: HTTP element input" {
try testing.expectEqual("{\"value\":true}", try elementCommand(&c, &session_id, opt_b, "/selected"));
const opt_a = try findElement(&c, &session_id, "css selector", "#opt_a");
try testing.expectEqual("{\"value\":false}", try elementCommand(&c, &session_id, opt_a, "/selected"));
- try testing.expectEqual("{\"value\":\"blur@area focus@pick click@opt_b input@pick change@pick\"}", try executeSync(&c, &session_id, take_events, "[]"));
+ try testing.expectEqual("{\"value\":\"change@area blur@area focus@pick click@opt_b input@pick change@pick\"}", try executeSync(&c, &session_id, take_events, "[]"));
}
// a click that navigates is answered once the new page has loaded
diff --git a/src/server/cdp/domains/input.zig b/src/server/cdp/domains/input.zig
index 2b3406258..ca77c74ee 100644
--- a/src/server/cdp/domains/input.zig
+++ b/src/server/cdp/domains/input.zig
@@ -2593,6 +2593,82 @@ test "cdp.input: dispatchKeyEvent Enter in a field submits through the default b
}
}
+// Typed text is committed with a change event when the field loses focus or
+// Enter submits it, and only when the value differs. Expectations match Chrome.
+test "cdp.input: typed text fires change on blur and Enter" {
+ var ctx = try testing.context();
+ defer ctx.deinit();
+
+ const bc = try ctx.loadBrowserContext(.{ .url = "mcp_actions.html" });
+ const frame = bc.mainFrame().?;
+
+ var ls: lp.js.Local.Scope = undefined;
+ frame.js.localScope(&ls);
+ defer ls.deinit();
+
+ _ = try ls.local.compileAndRun(
+ \\document.body.innerHTML = '<form id=f><input id=t><textarea id=ta></textarea></form><input id=o>';
+ \\window.events = [];
+ \\for (const id of ['t', 'ta']) {
+ \\ const el = document.getElementById(id);
+ \\ for (const type of ['change', 'blur']) {
+ \\ el.addEventListener(type, () => window.events.push(id + ':' + type + ':' + el.value));
+ \\ }
+ \\}
+ \\document.getElementById('f').addEventListener('submit', (e) => {
+ \\ e.preventDefault();
+ \\ window.events.push('submit');
+ \\});
+ \\window.arm = (id) => {
+ \\ const el = document.getElementById(id);
+ \\ el.focus();
+ \\ el.value = '';
+ \\ window.events = [];
+ \\};
+ , null);
+
+ var id: u32 = 1;
+
+ // typed, then Tab
+ _ = try ls.local.compileAndRun("arm('t')", null);
+ try ctx.processMessage(.{ .id = id, .method = "Input.insertText", .params = .{ .text = "ab" } });
+ id += 1;
+ try ctx.processMessage(.{ .id = id, .method = "Input.dispatchKeyEvent", .params = .{ .type = "keyDown", .key = "Tab", .code = "Tab" } });
+ id += 1;
+ try testing.expectEqualSlices(u8, "t:change:ab t:blur:ab", try (try ls.local.compileAndRun("window.events.join(' ')", null)).toStringSlice());
+
+ // typed into a textarea, then focus moves away
+ _ = try ls.local.compileAndRun("arm('ta')", null);
+ try ctx.processMessage(.{ .id = id, .method = "Input.insertText", .params = .{ .text = "x" } });
+ id += 1;
+ _ = try ls.local.compileAndRun("document.getElementById('o').focus()", null);
+ try testing.expectEqualSlices(u8, "ta:change:x ta:blur:x", try (try ls.local.compileAndRun("window.events.join(' ')", null)).toStringSlice());
+
+ // typed and deleted again: the value is unchanged
+ _ = try ls.local.compileAndRun("arm('t')", null);
+ try ctx.processMessage(.{ .id = id, .method = "Input.insertText", .params = .{ .text = "a" } });
+ id += 1;
+ try ctx.processMessage(.{ .id = id, .method = "Input.dispatchKeyEvent", .params = .{ .type = "rawKeyDown", .key = "Backspace", .code = "Backspace" } });
+ id += 1;
+ _ = try ls.local.compileAndRun("document.getElementById('t').blur()", null);
+ try testing.expectEqualSlices(u8, "t:blur:", try (try ls.local.compileAndRun("window.events.join(' ')", null)).toStringSlice());
+
+ // a value set by script is not a user edit
+ _ = try ls.local.compileAndRun("arm('t'); document.getElementById('t').value = 'js'; document.getElementById('t').blur()", null);
+ try testing.expectEqualSlices(u8, "t:blur:js", try (try ls.local.compileAndRun("window.events.join(' ')", null)).toStringSlice());
+
+ // Enter commits before the implicit submission, and blur has nothing left to commit
+ _ = try ls.local.compileAndRun("arm('t')", null);
+ try ctx.processMessage(.{ .id = id, .method = "Input.insertText", .params = .{ .text = "q" } });
+ id += 1;
+ try ctx.processMessage(.{ .id = id, .method = "Input.dispatchKeyEvent", .params = .{ .type = "keyDown", .key = "Enter", .code = "Enter" } });
+ id += 1;
+ try ctx.processMessage(.{ .id = id, .method = "Input.dispatchKeyEvent", .params = .{ .type = "char", .key = "Enter", .text = "\r" } });
+ id += 1;
+ _ = try ls.local.compileAndRun("document.getElementById('t').blur()", null);
+ try testing.expectEqualSlices(u8, "t:change:q submit t:blur:q", try (try ls.local.compileAndRun("window.events.join(' ')", null)).toStringSlice());
+}
+
// Enter on a checkbox or a radio clicks the form's default button like a text
// field does, but without a default button it never submits the form: only a
// text field can trigger the submission. Enter on a select never submits.