Skip to content

Lightpanda: the headless browser designed for AI and automation

webapi: Add Form.reset, improve Output's form behavior

Karl Seguin59b0b4ed6588
diff --git a/src/browser/frame/user_input.zig b/src/browser/frame/user_input.zig
index 33e981fa3..eb3a1cb5b 100644
--- a/src/browser/frame/user_input.zig
+++ b/src/browser/frame/user_input.zig
@@ -1114,6 +1114,13 @@ pub fn handleClick(frame: *Frame, target: *Node, event_target: *Node) !void {
}
return frame.submitForm(element, input.getForm(frame), .{});
}
+ if (input._input_type == .reset) {
+ if (element.isDisabled()) {
+ return;
+ }
+ const form = input.getForm(frame) orelse return;
+ return form.reset(frame);
+ }
},
.button => {
const button = html_element.subtype(Element.Html.Button);
@@ -1123,6 +1130,13 @@ pub fn handleClick(frame: *Frame, target: *Node, event_target: *Node) !void {
}
return frame.submitForm(element, button.getForm(frame), .{});
}
+ if (std.mem.eql(u8, button.getType(), "reset")) {
+ if (element.isDisabled()) {
+ return;
+ }
+ const form = button.getForm(frame) orelse return;
+ return form.reset(frame);
+ }
},
.label => {
const label = html_element.subtype(Element.Html.Label);
diff --git a/src/browser/tests/element/html/form.html b/src/browser/tests/element/html/form.html
index 69e444bd8..5815a8638 100644
--- a/src/browser/tests/element/html/form.html
+++ b/src/browser/tests/element/html/form.html
@@ -781,3 +781,81 @@
testing.expectEqual('TypeError', caught)
}
</script>
+
+<form id="reset_form">
+ <input id="reset_text" value="a">
+ <input id="reset_checkbox" type="checkbox" checked>
+ <textarea id="reset_textarea">t</textarea>
+ <output id="reset_output">o</output>
+ <select id="reset_select"><option>1</option><option selected>2</option></select>
+ <input id="reset_input_button" type="reset">
+ <button id="reset_button" type="reset"></button>
+</form>
+
+<script id="reset">
+{
+ const form = $('#reset_form')
+ const text = $('#reset_text')
+ const checkbox = $('#reset_checkbox')
+ const textarea = $('#reset_textarea')
+ const select = $('#reset_select')
+ const output = $('#reset_output')
+ const dirty = () => {
+ text.value = 'b'
+ checkbox.checked = false
+ textarea.value = 'u'
+ select.selectedIndex = 0
+ output.value = 'p'
+ }
+ const expectReset = () => {
+ testing.expectEqual('a', text.value)
+ testing.expectTrue(checkbox.checked)
+ testing.expectEqual('t', textarea.value)
+ testing.expectEqual(1, select.selectedIndex)
+ testing.expectEqual('o', output.value)
+ // reset clears the default value override
+ testing.expectEqual('o', output.defaultValue)
+ output.defaultValue = 'o'
+ testing.expectEqual('o', output.textContent)
+ }
+
+ let events = 0
+ form.addEventListener('reset', (e) => {
+ events += 1
+ testing.expectTrue(e.isTrusted)
+ testing.expectTrue(e.cancelable)
+ })
+
+ dirty()
+ form.reset()
+ testing.expectEqual(1, events)
+ expectReset()
+
+ dirty()
+ $('#reset_input_button').click()
+ testing.expectEqual(2, events)
+ expectReset()
+
+ dirty()
+ $('#reset_button').click()
+ testing.expectEqual(3, events)
+ expectReset()
+
+ // a canceled reset event leaves the controls alone
+ const cancel = (e) => e.preventDefault()
+ form.addEventListener('reset', cancel)
+ text.value = 'b'
+ form.reset()
+ testing.expectEqual(4, events)
+ testing.expectEqual('b', text.value)
+ form.removeEventListener('reset', cancel)
+
+ // reset from within a reset listener is a no-op
+ let nested = 0
+ const reenter = () => { nested += 1; form.reset() }
+ form.addEventListener('reset', reenter)
+ form.reset()
+ testing.expectEqual(1, nested)
+ form.removeEventListener('reset', reenter)
+}
+</script>
diff --git a/src/browser/tests/element/html/output.html b/src/browser/tests/element/html/output.html
index 2b939eec5..352d574d7 100644
--- a/src/browser/tests/element/html/output.html
+++ b/src/browser/tests/element/html/output.html
@@ -7,3 +7,27 @@
testing.expectEqual('output', $('#out1').type);
testing.expectEqual('output', document.createElement('output').type);
</script>
+
+<script id="value">
+{
+ const out = document.createElement('output');
+ out.innerHTML = '<b>a</b>b';
+ testing.expectEqual('ab', out.value);
+ testing.expectEqual('ab', out.defaultValue);
+
+ // no override yet: defaultValue writes the content
+ out.defaultValue = 'c';
+ testing.expectEqual('c', out.textContent);
+ testing.expectEqual('c', out.defaultValue);
+
+ // value keeps the current content as the default value override
+ out.value = 'd';
+ testing.expectEqual('d', out.textContent);
+ testing.expectEqual('c', out.defaultValue);
+
+ // with an override, defaultValue only updates the override
+ out.defaultValue = 'e';
+ testing.expectEqual('d', out.value);
+ testing.expectEqual('e', out.defaultValue);
+}
+</script>
diff --git a/src/browser/webapi/collections/node_live.zig b/src/browser/webapi/collections/node_live.zig
index 865f22edd..28dfd9c36 100644
--- a/src/browser/webapi/collections/node_live.zig
+++ b/src/browser/webapi/collections/node_live.zig
@@ -78,7 +78,7 @@ const Filters = union(Mode) {
selected_options,
links,
anchors,
- form: struct { form: *Form, form_id: ?[]const u8, image_buttons: bool },
+ form: struct { form: *Form, form_id: ?[]const u8, image_buttons: bool, outputs: bool },
document_named: []const u8,
fn TypeOf(comptime mode: Mode) type {
@@ -370,7 +370,8 @@ pub fn NodeLive(comptime mode: Mode) type {
},
.form => {
const el = node.is(Element) orelse return false;
- if (!isFormControl(el)) {
+ const is_control = isFormControl(el) or (self._filter.outputs and el.getTag() == .output);
+ if (is_control == false) {
return false;
}
if (self._filter.image_buttons == false) {
diff --git a/src/browser/webapi/element/html/Form.zig b/src/browser/webapi/element/html/Form.zig
index 9a2dc4663..8bff08316 100644
--- a/src/browser/webapi/element/html/Form.zig
+++ b/src/browser/webapi/element/html/Form.zig
@@ -26,6 +26,7 @@ const Frame = @import("../../../Frame.zig");
const Node = @import("../../Node.zig");
const Element = @import("../../Element.zig");
const HtmlElement = @import("../Html.zig");
+const Event = @import("../../Event.zig");
const collections = @import("../../collections.zig");
const Custom = @import("Custom.zig");
@@ -33,6 +34,7 @@ pub const Input = @import("Input.zig");
pub const Button = @import("Button.zig");
pub const Select = @import("Select.zig");
pub const TextArea = @import("TextArea.zig");
+const Output = @import("Output.zig");
const NodeLive = collections.NodeLive;
const HTMLFormControlsCollection = collections.HTMLFormControlsCollection;
@@ -50,6 +52,8 @@ _firing_submission_events: bool = false,
// form. You can imagine an formdata = () => form.submit() endless loop.
_constructing_entry_list: bool = false,
+_locked_for_reset: bool = false,
+
fn asConstElement(self: *const Form) *const Element {
return Factory.protoOf(self).asElement();
}
@@ -104,6 +108,7 @@ pub fn getElements(self: *Form, frame: *Frame) !*HTMLFormControlsCollection {
const IteratorOpts = struct {
image_buttons: bool = true, // form.elements doesn't incude input type=image
+ outputs: bool = false, // only reset() wants <output>
};
pub fn iterator(self: *Form, opts: IteratorOpts, frame: *Frame) NodeLive(.form) {
@@ -113,7 +118,7 @@ pub fn iterator(self: *Form, opts: IteratorOpts, frame: *Frame) NodeLive(.form)
else
self.asNode(); // No ID: walk only form subtree (no external controls possible)
- return NodeLive(.form).init(root, .{ .form = self, .form_id = form_id, .image_buttons = opts.image_buttons }, frame);
+ return NodeLive(.form).init(root, .{ .form = self, .form_id = form_id, .image_buttons = opts.image_buttons, .outputs = opts.outputs }, frame);
}
fn getAction(self: *Form, frame: *Frame) ![]const u8 {
@@ -155,6 +160,40 @@ pub fn submit(self: *Form, frame: *Frame) !void {
return frame.submitForm(null, self, .{ .fire_event = false });
}
+pub fn reset(self: *Form, frame: *Frame) !void {
+ if (self._locked_for_reset) {
+ // don't let a listener keep resetting during a reset
+ return;
+ }
+ self._locked_for_reset = true;
+ defer self._locked_for_reset = false;
+
+ const event = try Event.initTrusted(comptime .wrap("reset"), .{ .bubbles = true, .cancelable = true }, frame.page);
+ if (try frame._event_manager.dispatchCancelable(self.asElement().asEventTarget(), event)) {
+ return;
+ }
+
+ // resetting an <output> replaces its children, which ends the tree walker
+ // what would be inside of it
+ var controls: std.ArrayList(*Element) = .empty;
+ var it = self.iterator(.{ .outputs = true }, frame);
+ while (it.next()) |element| {
+ try controls.append(frame.call_arena, element);
+ }
+
+ for (controls.items) |element| {
+ if (element.is(Input)) |input| {
+ try input.reset(frame);
+ } else if (element.is(Select)) |select| {
+ select.reset(frame);
+ } else if (element.is(TextArea)) |textarea| {
+ textarea.reset();
+ } else if (element.is(Output)) |output| {
+ try output.reset(frame);
+ }
+ }
+}
+
/// https://html.spec.whatwg.org/multipage/forms.html#dom-form-requestsubmit
/// Like submit(), but fires the submit event and validates the form.
pub fn requestSubmit(self: *Form, submitter: ?*Element, frame: *Frame) !void {
@@ -347,6 +386,7 @@ pub const JsApi = struct {
pub const length = bridge.accessor(Form.getLength, null, .{});
pub const submit = bridge.function(Form.submit, .{});
pub const requestSubmit = bridge.function(Form.requestSubmit, .{});
+ pub const reset = bridge.function(Form.reset, .{ .ce_reactions = true });
pub const checkValidity = bridge.function(Form.checkValidity, .{});
pub const reportValidity = bridge.function(Form.reportValidity, .{});
};
diff --git a/src/browser/webapi/element/html/Input.zig b/src/browser/webapi/element/html/Input.zig
index c537c8390..d524ae4d1 100644
--- a/src/browser/webapi/element/html/Input.zig
+++ b/src/browser/webapi/element/html/Input.zig
@@ -782,6 +782,20 @@ fn changeType(self: *Input, new_type: Type, frame: *Frame) !void {
}
}
+pub fn reset(self: *Input, frame: *Frame) !void {
+ self._value_dirty = false;
+ self._checked_dirty = false;
+ self._user_edited = false;
+ self._checked = self._default_checked;
+ if (self._input_type.valueMode() == .value) {
+ try self.syncValueFromAttribute(frame);
+ }
+ if (self._files != null) {
+ try self.replaceFiles(&.{}, frame);
+ }
+ frame.styleChanged();
+}
+
// The value of a non-dirty control in value mode is its sanitized value attribute
fn syncValueFromAttribute(self: *Input, frame: *Frame) !void {
const default_value = self._default_value orelse {
diff --git a/src/browser/webapi/element/html/Output.zig b/src/browser/webapi/element/html/Output.zig
index 24ad79b62..8c07593c4 100644
--- a/src/browser/webapi/element/html/Output.zig
+++ b/src/browser/webapi/element/html/Output.zig
@@ -32,8 +32,8 @@ const Output = @This();
pub const Proto = HtmlElement;
-_pad: bool = false,
_proto_canary: if (lp.IS_DEBUG) *HtmlElement else void = undefined,
+_default_value_override: ?[]const u8 = null,
pub fn asElement(self: *Output) *Element {
return Factory.protoOf(self).asElement();
@@ -42,6 +42,35 @@ pub fn asNode(self: *Output) *Node {
return self.asElement().asNode();
}
+fn getValue(self: *Output, frame: *Frame) ![]const u8 {
+ return self.asNode().getTextContentAlloc(frame.local_arena);
+}
+
+fn setValue(self: *Output, value: []const u8, frame: *Frame) !void {
+ if (self._default_value_override == null) {
+ const text = try self.asNode().getTextContentAlloc(frame.local_arena);
+ self._default_value_override = try frame.dupeString(text);
+ }
+ try self.asNode().setTextContent(value, frame);
+}
+
+fn getDefaultValue(self: *Output, frame: *Frame) ![]const u8 {
+ return self._default_value_override orelse self.getValue(frame);
+}
+
+fn setDefaultValue(self: *Output, value: []const u8, frame: *Frame) !void {
+ if (self._default_value_override == null) {
+ return self.asNode().setTextContent(value, frame);
+ }
+ self._default_value_override = try frame.dupeString(value);
+}
+
+pub fn reset(self: *Output, frame: *Frame) !void {
+ const default_value = try self.getDefaultValue(frame);
+ try self.asNode().setTextContent(default_value, frame);
+ self._default_value_override = null;
+}
+
fn getLabels(self: *Output, frame: *Frame) !js.Array {
return @import("Label.zig").getControlLabels(self.asElement(), frame);
}
@@ -72,6 +101,8 @@ pub const JsApi = struct {
pub const name = reflect.string("name");
pub const @"type" = bridge.property("output", .{ .template = false, .readonly = true });
+ pub const value = bridge.accessor(Output.getValue, Output.setValue, .{ .ce_reactions = true });
+ pub const defaultValue = bridge.accessor(Output.getDefaultValue, Output.setDefaultValue, .{ .ce_reactions = true });
pub const labels = bridge.accessor(Output.getLabels, null, .{});
pub const htmlFor = bridge.accessor(Output.getHtmlFor, Output.setHtmlFor, .{ .null_as_undefined = true, .ce_reactions = true });
};
diff --git a/src/browser/webapi/element/html/Select.zig b/src/browser/webapi/element/html/Select.zig
index 656320cd9..9e1117071 100644
--- a/src/browser/webapi/element/html/Select.zig
+++ b/src/browser/webapi/element/html/Select.zig
@@ -222,6 +222,24 @@ fn deselectOthers(self: *const Select, keep: *const Option) void {
}
}
+pub fn reset(self: *Select, frame: *Frame) void {
+ var last_selected: ?*Option = null;
+ var it = OptionIterator.init(self);
+ while (it.next()) |option| {
+ option._selected = option.asElement().hasAttributeInterned("selected");
+ if (option._selected) {
+ last_selected = option;
+ }
+ }
+ if (self.asElement().hasAttributeInterned("multiple") == false) {
+ if (last_selected) |keep| {
+ self.deselectOthers(keep);
+ }
+ }
+ self.resetToDefaultSelection();
+ frame.domChanged();
+}
+
// HTML's "ask for a reset". Every path that selects an option in a
// non-multiple select deselects the others, so this only has to handle a
// menu list left with nothing selected.
diff --git a/src/browser/webapi/element/html/TextArea.zig b/src/browser/webapi/element/html/TextArea.zig
index 428760804..ae25c9506 100644
--- a/src/browser/webapi/element/html/TextArea.zig
+++ b/src/browser/webapi/element/html/TextArea.zig
@@ -89,6 +89,11 @@ pub fn setValue(self: *TextArea, value: []const u8, frame: *Frame) !void {
}
}
+pub fn reset(self: *TextArea) void {
+ self._value = null;
+ self._user_edited = false;
+}
+
pub fn setUserValue(self: *TextArea, value: []const u8, frame: *Frame) !void {
try self.setValue(value, frame);
self._user_edited = true;