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: ibc chain dropdown closes on selection #75

Merged
merged 1 commit into from
Nov 26, 2024
Merged

Conversation

chalabi2
Copy link
Collaborator

@chalabi2 chalabi2 commented Nov 26, 2024

fixes #14

Summary by CodeRabbit

  • New Features

    • Improved user experience with dropdown selection in the IbcSendForm component.
  • Bug Fixes

    • Removed unnecessary prop setIsIbcTransfer from the IbcSendForm, simplifying the component's interface.
  • Refactor

    • Eliminated unused useEffect import in IbcSendForm.
    • Enhanced dropdown interaction by managing focus after selection.

Copy link
Contributor

coderabbitai bot commented Nov 26, 2024

Walkthrough

The changes involve modifications to the SendBox and IbcSendForm components. The setIsIbcTransfer prop has been removed from both components, indicating a shift in state management for IBC transfers. The IbcSendForm component's dropdown selection logic has been improved to enhance user experience by closing the dropdown upon selection. Additionally, the import of useEffect has been removed from IbcSendForm, streamlining the component. Overall, the structure and core functionality of the components remain intact.

Changes

File Path Change Summary
components/bank/components/sendBox.tsx Removed setIsIbcTransfer prop from IbcSendForm invocation. Maintained structure and state management.
components/bank/forms/ibcSendForm.tsx Removed useEffect import and setIsIbcTransfer prop. Enhanced dropdown selection logic. Retained validation schema and core logic.

Assessment against linked issues

Objective Addressed Explanation
Close dropdown upon selection (Issue #14)

🐰 In the land of code where changes bloom,
The dropdown now closes, dispelling the gloom.
No more clicks needed, just select with glee,
A simpler SendBox, as happy as can be!
Hops of joy for the users, so bright and spry,
With each little change, we reach for the sky! 🌟


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.

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
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 UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 575a57b and e70c4fe.

📒 Files selected for processing (2)
  • components/bank/components/sendBox.tsx (0 hunks)
  • components/bank/forms/ibcSendForm.tsx (4 hunks)
💤 Files with no reviewable changes (1)
  • components/bank/components/sendBox.tsx
🧰 Additional context used
📓 Learnings (1)
components/bank/forms/ibcSendForm.tsx (1)
Learnt from: chalabi2
PR: liftedinit/manifest-app#9
File: components/bank/forms/ibcSendForm.tsx:149-152
Timestamp: 2024-11-12T13:03:18.927Z
Learning: In `components/bank/forms/ibcSendForm.tsx`, the `handleSend` function relies on the `useTx` hook for error handling, so additional error handling or user notifications within `handleSend` are unnecessary.
🔇 Additional comments (2)
components/bank/forms/ibcSendForm.tsx (2)

Line range hint 1-17: LGTM! Clean up of unused imports and props

The removal of the useEffect import and setIsIbcTransfer prop helps streamline the component by removing unused code.


171-171: LGTM! Form validation and submission logic is solid

The form validation and submission logic is well-implemented with proper error handling through the useTx hook, as confirmed by previous learnings.

Comment on lines +216 to +236
onClick={e => {
setSelectedChain(chain.id);
// Get the dropdown element and remove focus
const dropdown = (e.target as HTMLElement).closest('.dropdown');
if (dropdown) {
(dropdown as HTMLElement).removeAttribute('open');
(dropdown.querySelector('label') as HTMLElement)?.focus();
(dropdown.querySelector('label') as HTMLElement)?.blur();
}
}}
onKeyDown={e => {
if (e.key === 'Enter' || e.key === ' ') {
e.preventDefault();
setSelectedChain(chain.id);
// Get the dropdown element and remove focus
const dropdown = (e.target as HTMLElement).closest('.dropdown');
if (dropdown) {
(dropdown as HTMLElement).removeAttribute('open');
(dropdown.querySelector('label') as HTMLElement)?.focus();
(dropdown.querySelector('label') as HTMLElement)?.blur();
}
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Improve dropdown accessibility and code maintainability

While the changes fix the dropdown closure issue, there are some improvements we can make:

  1. Replace direct DOM manipulation with React refs
  2. Update ARIA attributes for better accessibility
  3. Extract duplicate logic to a shared function

Here's the suggested implementation:

+ const dropdownRef = useRef<HTMLDivElement>(null);
+ const labelRef = useRef<HTMLLabelElement>(null);
+
+ const handleChainSelection = (chain: IbcChain) => {
+   setSelectedChain(chain.id);
+   if (dropdownRef.current) {
+     dropdownRef.current.removeAttribute('open');
+     labelRef.current?.focus();
+     labelRef.current?.blur();
+   }
+ };

  <div 
+   ref={dropdownRef}
    className="dropdown dropdown-end w-full">
    <label
+     ref={labelRef}
      tabIndex={0}
      aria-label="chain-selector"
      role="combobox"
-     aria-expanded="false"
+     aria-expanded={dropdownRef.current?.hasAttribute('open') || false}
      aria-controls="chain-dropdown"
      aria-haspopup="listbox"
      className="btn btn-md btn-dropdown w-full">

    <a
-     onClick={e => {
-       setSelectedChain(chain.id);
-       const dropdown = (e.target as HTMLElement).closest('.dropdown');
-       if (dropdown) {
-         (dropdown as HTMLElement).removeAttribute('open');
-         (dropdown.querySelector('label') as HTMLElement)?.focus();
-         (dropdown.querySelector('label') as HTMLElement)?.blur();
-       }
-     }}
+     onClick={() => handleChainSelection(chain)}
      onKeyDown={e => {
        if (e.key === 'Enter' || e.key === ' ') {
          e.preventDefault();
-         setSelectedChain(chain.id);
-         const dropdown = (e.target as HTMLElement).closest('.dropdown');
-         if (dropdown) {
-           (dropdown as HTMLElement).removeAttribute('open');
-           (dropdown.querySelector('label') as HTMLElement)?.focus();
-           (dropdown.querySelector('label') as HTMLElement)?.blur();
-         }
+         handleChainSelection(chain);
        }
      }}

Committable suggestion skipped: line range outside the PR's diff.

@fmorency fmorency merged commit d85d4bd into main Nov 26, 2024
6 checks passed
@fmorency fmorency deleted the chalabi/dropdown_fix branch November 26, 2024 15:59
Copy link

codecov bot commented Nov 26, 2024

Codecov Report

Attention: Patch coverage is 58.82353% with 7 lines in your changes missing coverage. Please review.

Project coverage is 58.98%. Comparing base (575a57b) to head (e70c4fe).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
components/bank/forms/ibcSendForm.tsx 58.82% 7 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #75      +/-   ##
==========================================
- Coverage   59.00%   58.98%   -0.02%     
==========================================
  Files         145      145              
  Lines       14060    14072      +12     
==========================================
+ Hits         8296     8301       +5     
- Misses       5764     5771       +7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

Cross-chain chain selection rendering issue
2 participants