Skip to content
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.

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

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

Closed
wants to merge 4 commits into from

Conversation

chirokas
Copy link
Contributor

@chirokas chirokas commented Nov 4, 2024

Closes #3913

📝 Description

See #3913 (comment)

⛳️ Current behavior (updates)

🚀 New behavior

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

  • New Features

    • Improved error handling for the select component, preventing default browser error messages.
    • Enhanced functionality of the hidden select component, including better management of required fields and selected values.
  • Bug Fixes

    • Fixed the onChange handler to properly update the selected keys in the state.
  • Tests

    • Added a new test suite to validate required field behavior in the select component.

@chirokas chirokas requested a review from jrgarciadev as a code owner November 4, 2024 15:21
Copy link

changeset-bot bot commented Nov 4, 2024

🦋 Changeset detected

Latest commit: 5bf7332

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@nextui-org/select Patch
@nextui-org/use-aria-multiselect Patch
@nextui-org/react Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Nov 4, 2024

@chirokas is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Nov 4, 2024

Walkthrough

This pull request introduces patches for the @nextui-org/select and @nextui-org/use-aria-multiselect packages to enhance error handling by preventing the default browser error UI from appearing. It modifies the useHiddenSelect function and the HiddenSelect component to improve the handling of the required attribute and the management of the value property for the hidden <select> element. Additionally, a new test suite is added to validate the behavior of the Select component when marked as required.

Changes

File Path Change Summary
.changeset/quick-buses-kick.md Added patches for the @nextui-org/select and @nextui-org/use-aria-multiselect packages to improve error handling.
packages/components/select/src/hidden-select.tsx Modified useHiddenSelect and HiddenSelect to better manage the required attribute and value property.
packages/components/select/__tests__/select.test.tsx Introduced a new test suite and test case to validate the required field behavior in the Select component.

Assessment against linked issues

Objective Addressed Explanation
Ensure consistent validation behavior between Input and Select components (#3913)

Possibly related PRs

Suggested labels

👀 Status: In Review, 📋 Scope : Docs

Suggested reviewers

  • wingkwong
  • jrgarciadev

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@wingkwong wingkwong added this to the v2.5.0 milestone Nov 4, 2024
@jrgarciadev jrgarciadev requested a review from wingkwong November 4, 2024 21:26
@jrgarciadev
Copy link
Member

@wingkwong please review

@wingkwong wingkwong self-assigned this Nov 5, 2024
Copy link

vercel bot commented Nov 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nextui-docs-v2 ❌ Failed (Inspect) Nov 10, 2024 3:42pm
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 10, 2024 3:42pm

Copy link
Member

@wingkwong wingkwong left a comment

Choose a reason for hiding this comment

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

supposedly submit should be blocked if validationBehavior is native. now with this PR change, it makes native validation same as aria, which means i can submit the form without a value while the field is required.

also please add tests.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7d6a1aa and b477f74.

📒 Files selected for processing (2)
  • packages/components/select/__tests__/select.test.tsx (1 hunks)
  • packages/components/select/src/hidden-select.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/components/select/src/hidden-select.tsx

packages/components/select/__tests__/select.test.tsx Outdated Show resolved Hide resolved
@chirokas chirokas marked this pull request as draft November 5, 2024 17:17
@chirokas chirokas marked this pull request as ready for review November 6, 2024 08:29
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
packages/hooks/use-aria-multiselect/src/use-multiselect-state.ts (1)

74-75: Document validation timing for maintainability.

Consider adding a comment explaining when validation is committed and why, as this is a crucial part of the component's behavior.

      }

+     // Commit validation after selection changes to ensure internal validation state is updated
      validationState.commitValidation();
    },
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b477f74 and 5bf7332.

📒 Files selected for processing (3)
  • .changeset/quick-buses-kick.md (1 hunks)
  • packages/components/select/__tests__/select.test.tsx (1 hunks)
  • packages/hooks/use-aria-multiselect/src/use-multiselect-state.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • .changeset/quick-buses-kick.md
  • packages/components/select/tests/select.test.tsx
🔇 Additional comments (1)
packages/hooks/use-aria-multiselect/src/use-multiselect-state.ts (1)

74-75: LGTM! Verify validation behavior in edge cases.

The addition of validationState.commitValidation() after selection changes aligns with the PR objective of preventing default browser error UI. This ensures validation state is managed internally.

Let's verify the validation behavior in related components:

✅ Verification successful

Let me gather more context about the validation behavior and its integration.


Validation behavior is correctly implemented and consistent

The implementation of validationState.commitValidation() in the multiselect component is appropriate and aligns with the codebase's validation patterns:

  • It uses the standard useFormValidationState hook with "native" validation behavior
  • The validation state is properly tied to the selected keys
  • The commit timing (after selection changes) matches the expected behavior
  • The validation state is correctly exposed through the component's API (isInvalid, validationErrors, validationDetails)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other validation commit calls to ensure consistent behavior
rg "commitValidation" --type ts

# Look for other validation state management
ast-grep --pattern 'useFormValidationState({$$$})'

Length of output: 896


Script:

#!/bin/bash
# Search for the useFormValidationState hook implementation
rg "useFormValidationState" -A 5 --type ts

# Look for other validation-related code in the multiselect component
rg "validation" packages/hooks/use-aria-multiselect --type ts

# Check for any validation-related tests
fd "test|spec" --type f --exec rg "validation" {} \;

Length of output: 5034

Copy link
Member

@wingkwong wingkwong left a comment

Choose a reason for hiding this comment

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

now aria behaviour becomes native one. please test both case.

@chirokas
Copy link
Contributor Author

@wingkwong Select doesn't support the validationBehavior prop.

const validationState = useFormValidationState({
...props,
// TODO: Future enhancement to support "aria" validation behavior.
validationBehavior: "native",
// @ts-ignore
value: listState.selectedKeys,
});

#3913 (comment)

@jrgarciadev jrgarciadev deleted the branch nextui-org:beta/release-next November 29, 2024 19:54
@chirokas
Copy link
Contributor Author

chirokas commented Dec 8, 2024

Opening a new one - #4281

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] - Add validationBehavior support for Select
3 participants