fix(input): ensure clear button is not focusable when disabled #3774

ryxxn · 2024-09-17T13:44:19Z

📝 Description

This PR fixes an issue where the clear button inside the Input component could still receive focus when the input is disabled (isDisabled). The button is now properly excluded from the tab order by setting tabIndex to -1 when the input is disabled.

⛳️ Current behavior (updates)

record.mov

Currently, the clear button in the Input component can still receive focus via the Tab key when the input is disabled. This behavior can cause accessibility issues and an inconsistent user experience.

🚀 New behavior

With this fix, the clear button will no longer be focusable when the input is disabled. The tabIndex for the clear button is set to -1 when isDisabled is true, preventing it from being part of the tab order.

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

📝 Additional Information

This fix enhances accessibility and user experience by ensuring that the clear button behaves correctly when the input is disabled.

Summary by CodeRabbit

New Features
- Enhanced accessibility for the clear button in the input component by preventing focus when the input is disabled.
- Updated the clear button from a <span> to a <button> element for improved semantic meaning and usability.
Bug Fixes
- Adjusted the tabIndex property for the clear button to ensure compliance with keyboard navigation standards.
Tests
- Added a new test case to verify the correct behavior of the clear button's tabIndex when the input is disabled.

…sabled

changeset-bot · 2024-09-17T13:44:24Z

🦋 Changeset detected

Latest commit: 081c0e4

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/input	Patch
@nextui-org/autocomplete	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

vercel · 2024-09-17T13:44:24Z

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

A member of the Team first needs to authorize it.

coderabbitai · 2024-09-17T13:44:30Z

Walkthrough

This update introduces a patch to the @nextui-org/input component, specifically modifying the behavior of the clear button when the input is disabled. The clear button will no longer receive focus in a disabled state, and its tabIndex is set to -1 under this condition. Additionally, the clear button's implementation is changed from a <span> to a <button> element to improve accessibility. New test cases have been added to verify these behaviors.

Changes

File	Change Summary
.changeset/two-waves-own.md	Introduced a patch for the clear button in the `@nextui-org/input` component to enhance accessibility.
packages/components/input/tests/input.test.tsx	Added a test case for the `Input` component to check `tabIndex` behavior when `isDisabled` is true.
packages/components/input/src/use-input.ts	Modified the button properties to reflect the disabled state based on the `isDisabled` property.
packages/components/input/src/input.tsx	Changed the clear button from a `<span>` to a `<button>` element for improved semantic meaning and accessibility.

Possibly related PRs

fix(input): added hover and focus to input when label placement is outside-left #2958: This PR enhances the hover and focus behavior of the input component, which is directly related to the changes made in the main PR regarding the input component's clear button behavior.
fix(autocomplete): ignore pointer events when the clear button is hidden #3000: This PR addresses the focus management of the clear button in the autocomplete component, which aligns with the main PR's focus on the clear button's behavior when the input is disabled.
fix(input): prevent clearable when input is readonly #3643: This PR ensures that the clear button is disabled when the input is read-only, which is relevant to the main PR's modifications to the clear button's functionality based on the input's state.
fix(autocomplete): highlight item in AutocompleteSection during keyboard navigation #3726: This PR improves keyboard navigation in the AutocompleteSection, which is related to the accessibility enhancements made in the main PR regarding the clear button's focus behavior.
fix(theme): update flat variant text colors to be accessible #3738: This PR updates text colors for accessibility in the theme, which complements the main PR's focus on improving accessibility for the input component.

Suggested reviewers

jrgarciadev
wingkwong

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2823aea and 081c0e4.

Files selected for processing (3)

packages/components/input/tests/input.test.tsx (6 hunks)
packages/components/input/src/input.tsx (1 hunks)
packages/components/input/src/use-input.ts (1 hunks)

Files skipped from review as they are similar to previous changes (2)

packages/components/input/tests/input.test.tsx
packages/components/input/src/use-input.ts

Additional comments not posted (1)

packages/components/input/src/input.tsx (1)

39-39: Excellent accessibility improvement!

Replacing <span> with <button> for the clear button is a great change that enhances the semantic meaning and accessibility of the component. This ensures the clear button is correctly recognized as an interactive element by assistive technologies, improving the user experience for users relying on such tools.

The change aligns perfectly with the PR objective of addressing the accessibility concerns related to the clear button.

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.

ryo-manba · 2024-09-18T01:23:35Z

packages/components/input/src/use-input.ts

@@ -511,7 +511,7 @@ export function useInput<T extends HTMLInputElement | HTMLTextAreaElement = HTML
      return {
        ...props,
        role: "button",
-        tabIndex: 0,
+        tabIndex: originalProps?.isDisabled ? -1 : 0,


It seems like you can use the button element and pass the disabled attribute, which would remove the need for setting tabindex and role: "button".

nextui/packages/components/input/src/input.tsx

Line 39 in bed4a59

return <span {...getClearButtonProps()}>{endContent || <CloseFilledIcon />}</span>;

Thank you for your comment!

I agree with using the button element.
Do you think it would be better to proceed with that change?

Yes, I think that would be better.

ryo-manba · 2024-09-18T01:23:54Z

packages/components/input/__tests__/input.test.tsx

@@ -37,6 +37,14 @@ describe("Input", () => {
    expect(container.querySelector("input")).toHaveAttribute("disabled");
  });

+  it("should set tabIndex to -1 when isDisabled is true", () => {


The test should verify that clicking the button does not clear the input.

The clear button is already non-functional when isDisabled is true.

That’s true, but if you’re adding tests, I would appreciate it if you could verify that the button is disabled.
I think specifying the tabindex will be resolved by marking it up as a button.

and update tests for clear button using button element

ryxxn · 2024-09-19T15:47:55Z

@ryo-manba
I have updated the code to replace the span element with a button element for the clear button.

This change removes the need to manually handle tabIndex and role, while improving accessibility.

ryxxn added 3 commits September 17, 2024 22:31

fix(input): ensure clear button is not focusable when disabled

b530806

test(input): add test to ensure clear button is not focusable when di…

99ce409

…sabled

chore: add changeset for clear button focus fix when input is disabled

2823aea

ryxxn requested a review from jrgarciadev as a code owner September 17, 2024 13:44

wingkwong added this to the v2.5.0 milestone Sep 17, 2024

ryo-manba requested changes Sep 18, 2024

View reviewed changes

ryo-manba added the 🚧 Status: Changes Requested label Sep 18, 2024

ryxxn requested a review from ryo-manba September 19, 2024 00:32

ryxxn added 2 commits September 20, 2024 00:37

fix(input): update clear button to use button element

4716c45

test(input): add focus test when disabled

081c0e4

and update tests for clear button using button element

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(input): ensure clear button is not focusable when disabled #3774

fix(input): ensure clear button is not focusable when disabled #3774

ryxxn commented Sep 17, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Sep 17, 2024 •

edited

Loading

vercel bot commented Sep 17, 2024

coderabbitai bot commented Sep 17, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

ryo-manba Sep 18, 2024

ryxxn Sep 18, 2024

ryo-manba Sep 19, 2024

ryo-manba Sep 18, 2024

ryxxn Sep 18, 2024

ryo-manba Sep 19, 2024

ryxxn commented Sep 19, 2024 •

edited

Loading

fix(input): ensure clear button is not focusable when disabled #3774

Are you sure you want to change the base?

fix(input): ensure clear button is not focusable when disabled #3774

Conversation

ryxxn commented Sep 17, 2024 • edited by coderabbitai bot Loading

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

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

📝 Additional Information

Summary by CodeRabbit

changeset-bot bot commented Sep 17, 2024 • edited Loading

🦋 Changeset detected

vercel bot commented Sep 17, 2024

coderabbitai bot commented Sep 17, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

ryo-manba Sep 18, 2024

Choose a reason for hiding this comment

ryxxn Sep 18, 2024

Choose a reason for hiding this comment

ryo-manba Sep 19, 2024

Choose a reason for hiding this comment

ryo-manba Sep 18, 2024

Choose a reason for hiding this comment

ryxxn Sep 18, 2024

Choose a reason for hiding this comment

ryo-manba Sep 19, 2024

Choose a reason for hiding this comment

ryxxn commented Sep 19, 2024 • edited Loading

ryxxn commented Sep 17, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Sep 17, 2024 •

edited

Loading

coderabbitai bot commented Sep 17, 2024 •

edited

Loading

ryxxn commented Sep 19, 2024 •

edited

Loading