Skip to content

fix(select): prevent default browser error UI from appearing #4281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
chirokas wants to merge 3 commits into from
Closed

fix(select): prevent default browser error UI from appearing #4281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
41bf6e1
fix(select): prevent default browser error UI from appearing
chirokas Nov 4, 2024
82f153b
chore: cleanup
chirokas Nov 6, 2024
f02168d
chore: save
chirokas Dec 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/quick-buses-kick.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@nextui-org/select": patch
"@nextui-org/use-aria-multiselect": patch
---

Prevent default browser error UI from appearing (#3913).
203 changes: 201 additions & 2 deletions packages/components/select/__tests__/select.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1179,6 +1179,181 @@ describe("validation", () => {
user = userEvent.setup();
});

describe("validationBehavior=native", () => {
it("supports isRequired", async () => {
const {getByTestId} = render(
<Form data-testid="form">
<Select
isRequired
data-testid="select"
label="Test"
name="select"
validationBehavior="native"
>
<SelectItem key="one">One</SelectItem>
<SelectItem key="two">Two</SelectItem>
<SelectItem key="three">Three</SelectItem>
</Select>
</Form>,
);

const select = getByTestId("select");
const input = document.querySelector<HTMLSelectElement>("[name=select]");
Comment on lines +1200 to +1201
Copy link
Copy Markdown
Contributor

@Peterl561 Peterl561 Dec 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Select is a <button> and input is a <select>, please consider renaming the variables in the these tests


expect(input).toHaveAttribute("required");
expect(input?.validity.valid).toBe(false);
Copy link
Copy Markdown
Contributor

@Peterl561 Peterl561 Dec 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be good to check validity.valueMissing too

expect(select).not.toHaveAttribute("aria-describedby");

act(() => {
(getByTestId("form") as HTMLFormElement).checkValidity();
});

expect(input?.validity.valid).toBe(false);
expect(select).toHaveAttribute("aria-describedby");
expect(document.getElementById(select.getAttribute("aria-describedby")!)).toHaveTextContent(
"Constraints not satisfied",
);

await user.click(select);
await user.click(document.querySelectorAll("[role='option']")[0]);
expect(input?.validity.valid).toBe(true);
expect(select).not.toHaveAttribute("aria-describedby");
});

it("supports validate function", async () => {
const {getByTestId} = render(
<form>
<Select
data-testid="select"
defaultSelectedKeys={["two"]}
label="Test"
name="select"
validate={(value) => (value.includes("two") ? "Invalid value" : null)}
validationBehavior="native"
>
<SelectItem key="one">One</SelectItem>
<SelectItem key="two">Two</SelectItem>
<SelectItem key="three">Three</SelectItem>
</Select>
<button data-testid="submit" type="submit">
Submit
</button>
</form>,
);

const select = getByTestId("select");
const input = document.querySelector<HTMLSelectElement>("[name=select]");

expect(input?.validity.valid).toBe(false);
expect(select).not.toHaveAttribute("aria-describedby");

await user.click(getByTestId("submit"));
expect(select).toHaveAttribute("aria-describedby");
Copy link
Copy Markdown
Contributor

@Peterl561 Peterl561 Dec 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should check for aria-invalid on input when a change is expected since input is the actual <select> element and select is just the trigger button

expect(document.getElementById(select.getAttribute("aria-describedby")!)).toHaveTextContent(
"Invalid value",
);

await user.click(select);
await user.click(document.querySelectorAll("[role='option']")[0]);
expect(select).not.toHaveAttribute("aria-describedby");
});

it("supports server validation", async () => {
function Test() {
const [serverErrors, setServerErrors] = React.useState({});
const onSubmit = (e) => {
e.preventDefault();
setServerErrors({
select: "Invalid value.",
});
};

return (
<Form validationErrors={serverErrors} onSubmit={onSubmit}>
<Select
isRequired
data-testid="select"
label="Test"
name="select"
validationBehavior="native"
>
<SelectItem key="one">One</SelectItem>
<SelectItem key="two">Two</SelectItem>
<SelectItem key="three">Three</SelectItem>
</Select>
<button data-testid="submit" type="submit">
Submit
</button>
</Form>
);
}

const {getByTestId} = render(<Test />);

const button = getByTestId("submit");
const select = getByTestId("select");
const input = document.querySelector<HTMLSelectElement>("[name=select]");

expect(select).not.toHaveAttribute("aria-describedby");

await user.click(button);
expect(select).toHaveAttribute("aria-describedby");
expect(document.getElementById(select.getAttribute("aria-describedby")!)).toHaveTextContent(
"Invalid value.",
);
expect(input?.validity.valid).toBe(false);

await user.click(select);
await user.click(document.querySelectorAll("[role='option']")[0]);
expect(select).not.toHaveAttribute("aria-describedby");
expect(input?.validity.valid).toBe(true);
});

it("clears validation on reset", async () => {
const {getByTestId} = render(
<Form data-testid="form">
<Select
isRequired
data-testid="select"
label="Test"
name="select"
validationBehavior="native"
>
<SelectItem key="one">One</SelectItem>
<SelectItem key="two">Two</SelectItem>
<SelectItem key="three">Three</SelectItem>
</Select>
<button data-testid="reset" type="reset">
Reset
</button>
</Form>,
);

const select = getByTestId("select");
const input = document.querySelector<HTMLSelectElement>("[name=select]");

expect(input).toHaveAttribute("required");
expect(input?.validity.valid).toBe(false);
expect(select).not.toHaveAttribute("aria-describedby");

act(() => {
(getByTestId("form") as HTMLFormElement).checkValidity();
});

expect(select).toHaveAttribute("aria-describedby");
expect(document.getElementById(select.getAttribute("aria-describedby")!)).toHaveTextContent(
"Constraints not satisfied",
);

await user.click(select);
await user.click(document.querySelectorAll("[role='option']")[0]);
expect(select).not.toHaveAttribute("aria-describedby");

await user.click(getByTestId("reset"));
expect(select).not.toHaveAttribute("aria-describedby");
Comment on lines +1350 to +1353
Copy link
Copy Markdown
Contributor

@Peterl561 Peterl561 Dec 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't actually tell us that the reset worked does it

});
});

describe("validationBehavior=aria", () => {
it("supports isRequired", async () => {
function FormRender() {
Expand Down Expand Up @@ -1223,7 +1398,7 @@ describe("validation", () => {
const {getByTestId} = render(<FormRender />);

const select = getByTestId("select");
const input = document.querySelector("input");
const input = document.querySelector<HTMLSelectElement>("[name=animal]");

expect(select).not.toHaveAttribute("aria-describedby");
const button = getByTestId("button");
Expand Down Expand Up @@ -1255,6 +1430,7 @@ describe("validation", () => {
data-testid="select"
defaultSelectedKeys={["penguin"]}
label="Favorite Animal"
name="animal"
validate={(v) => (v.includes("penguin") ? "Invalid value" : null)}
validationBehavior="aria"
>
Expand All @@ -1269,7 +1445,7 @@ describe("validation", () => {
);

const select = getByTestId("select");
const input = document.querySelector("input");
const input = document.querySelector<HTMLSelectElement>("[name=animal]");
const button = getByTestId("button");

expect(select).toHaveAttribute("aria-describedby");
Expand All @@ -1292,5 +1468,28 @@ describe("validation", () => {
expect(select).not.toHaveAttribute("aria-describedby");
expect(select).not.toHaveAttribute("aria-invalid");
});

it("supports server validation", async () => {
let {getByTestId} = render(
<Form validationErrors={{select: "Invalid value"}}>
<Select data-testid="select" label="Test" name="select" validationBehavior="aria">
<SelectItem key="one">One</SelectItem>
<SelectItem key="two">Two</SelectItem>
<SelectItem key="three">Three</SelectItem>
</Select>
</Form>,
);

const select = getByTestId("select");

expect(select).toHaveAttribute("aria-describedby");
expect(document.getElementById(select.getAttribute("aria-describedby")!)).toHaveTextContent(
"Invalid value",
);

await user.click(select);
await user.click(document.querySelectorAll("[role='option']")[0]);
expect(select).not.toHaveAttribute("aria-describedby");
});
});
});
5 changes: 1 addition & 4 deletions packages/components/select/src/hidden-select.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,19 +99,16 @@ export function useHiddenSelect<T>(
["data-a11y-ignore"]: "aria-hidden-focus",
},
inputProps: {
Copy link
Copy Markdown
Contributor

@Peterl561 Peterl561 Dec 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could probably delete the hidden input element, see adobe/react-spectrum#7200

...commonProps,
type: "text",
tabIndex: modality == null || state.isFocused || state.isOpen ? -1 : 0,
value: [...state.selectedKeys].join(",") ?? "",
style: {fontSize: 16},
onFocus: () => triggerRef.current?.focus(),
onChange: () => {}, // The onChange is handled by the `select` element
disabled: isDisabled,
},
selectProps: {
...commonProps,
name,
tabIndex: -1,
size: state.collection.size,
value:
selectionMode === "multiple"
? [...state.selectedKeys].map((k) => String(k))
Expand Down
3 changes: 2 additions & 1 deletion packages/hooks/use-aria-multiselect/src/use-multiselect-state.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ export function useMultiSelectState<T extends object>({
if (props.selectionMode === "single") {
triggerState.close();
}

validationState.commitValidation();
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Dec 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Potential reference error: validationState is used before it is defined

The call to validationState.commitValidation() inside onSelectionChange may cause a runtime error because validationState is declared after listState. Since validationState is not yet initialized when onSelectionChange is created, it will be undefined at the time of the function's execution.

To resolve this issue, consider initializing validationState before listState, or restructure the code so that validationState is accessible within onSelectionChange without causing a reference error.

},
});

Expand Down Expand Up @@ -124,7 +126,6 @@ export function useMultiSelectState<T extends object>({

setFocusStrategy(focusStrategy);
triggerState.toggle();
validationState.commitValidation();
},
isFocused,
setFocused,
Expand Down