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(textfield): inactive fields – improve UX globally #3292

Conversation

FussuChalice
Copy link
Contributor

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules

@rhahao
Copy link
Member

rhahao commented Dec 24, 2024

Copy link

vercel bot commented Dec 24, 2024

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

Name Status Preview Updated (UTC)
organized-app ✅ Ready (Inspect) Visit Preview Dec 24, 2024 4:00pm

Copy link
Contributor

coderabbitai bot commented Dec 24, 2024

Walkthrough

The pull request introduces modifications to two components: Autocomplete and TextField. In the Autocomplete component, the changes focus on restructuring prop handling, specifically replacing the ListboxComponent prop with a new slotProps structure and simplifying the renderInput function. The TextField component receives updates to its disabled state handling, including new state management for password input visibility, cursor styling, and color adjustments for disabled states.

Changes

File Change Summary
src/components/autocomplete/index.tsx - Replaced ListboxComponent prop with slotProps structure
- Updated renderInput to use label prop directly
- Simplified placeholder prop handling
src/components/textfield/index.tsx - Added showAccessCode state for password input visibility
- Modified input cursor style for disabled state
- Adjusted label and end adornment icon colors when disabled
- Added new style rule for fieldset in disabled state

Possibly related PRs

Suggested reviewers

  • rhahao

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link

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

🧹 Nitpick comments (2)
src/components/textfield/index.tsx (2)

129-133: Dynamic label color based on success/disabled states.

This helps highlight different states. If possible, confirm these color changes meet brand guidelines and pass a11y checks (e.g., for color-blind users).


156-158: Consistent icon styling whenever disabled.

Shifting to a lighter color for disabled icons improves clarity. For further consistency, consider a theming approach to unify color changes across components.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0b86072 and c84b352.

📒 Files selected for processing (2)
  • src/components/autocomplete/index.tsx (2 hunks)
  • src/components/textfield/index.tsx (4 hunks)
🔇 Additional comments (4)
src/components/autocomplete/index.tsx (1)

126-126: Explicitly assigning the label is clean and consistent.

Your removal of conditional placeholder logic ensures clarity. Confirm that there's no use case requiring a placeholder when label is omitted. Otherwise, this looks good.

src/components/textfield/index.tsx (3)

28-28: Enhanced feature: Toggle password visibility.

This stateful logic effectively manages password masking. Confirm that you have test coverage (e.g., unit or integration tests) for showAccessCode toggling.


82-82: Nice UX improvement to indicate non-interactivity.

Setting cursor: 'not-allowed' clarifies for users that the field is disabled. This is consistent with the PR objective to enhance disabled field UX.


123-126: Verify color contrast for disabled state.

The light border (var(--accent-200)) may be subtle on some monitors. Ensure it meets accessibility contrast guidelines.

Comment on lines +107 to +111
slotProps={{
listbox: {
component: CustomListBoxComponent,
},
}}
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Update required: Found another instance of deprecated ListboxComponent prop

The verification revealed that there's still one instance of the deprecated ListboxComponent prop in src/components/autocomplete_multiple/index.tsx. For consistency and future compatibility, this should also be updated to use the new slotProps approach.

  • src/components/autocomplete_multiple/index.tsx: Replace ListboxComponent={CustomListBoxComponent} with:
    slotProps={{
      listbox: {
        component: CustomListBoxComponent,
      },
    }}
🔗 Analysis chain

Good move to adopt the latest MUI slotProps approach.

Replacing the deprecated ListboxComponent prop with slotProps.listbox.component ensures future compatibility and a more flexible prop structure. Verify that no references to ListboxComponent remain in your codebase or documentation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for old references to ListboxComponent in the entire repo
rg 'ListboxComponent'

Length of output: 116

@rhahao rhahao merged commit c000673 into sws2apps:main Dec 25, 2024
11 checks passed
Copy link

cypress bot commented Dec 25, 2024

organized-app    Run #1865

Run Properties:  status check passed Passed #1865  •  git commit c000673371: fix(components): update styles for inactive fields
Project organized-app
Branch Review main
Run status status check passed Passed #1865
Run duration 00m 05s
Commit git commit c000673371: fix(components): update styles for inactive fields
Committer Max Makaluk
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 1
View all changes introduced in this branch ↗︎

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

Successfully merging this pull request may close these issues.

2 participants