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: asset list modal opens 1 click #116

Merged
merged 1 commit into from
Dec 4, 2024
Merged

fix: asset list modal opens 1 click #116

merged 1 commit into from
Dec 4, 2024

Conversation

chalabi2
Copy link
Collaborator

@chalabi2 chalabi2 commented Dec 4, 2024

finalizes #13

Summary by CodeRabbit

  • New Features

    • The DenomInfoModal is now always rendered in the TokenList component, enhancing visibility and interaction regardless of the selected denomination.
  • Bug Fixes

    • Improved the user experience by ensuring the modal is consistently displayed, allowing users to access information without dependency on the selection state.

Copy link

codecov bot commented Dec 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.00%. Comparing base (ce4786e) to head (21422b4).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #116      +/-   ##
==========================================
- Coverage   60.00%   60.00%   -0.01%     
==========================================
  Files         146      146              
  Lines       14485    14484       -1     
==========================================
- Hits         8692     8691       -1     
  Misses       5793     5793              

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

Copy link
Contributor

coderabbitai bot commented Dec 4, 2024

Walkthrough

The changes in this pull request involve modifying the rendering logic of the DenomInfoModal component within the TokenList component. The modal is now rendered unconditionally, regardless of the selectedDenom value, which ensures it is always present in the component's output. The logic for determining the denom prop remains unchanged, continuing to utilize the filteredBalances array to retrieve the necessary metadata.

Changes

File Path Change Summary
components/bank/components/tokenList.tsx Modified DenomInfoModal rendering to be unconditional, ensuring it always displays.

Possibly related PRs

  • fix: denom info modal #37: Involves significant restructuring of the DenomInfoModal component, related to the rendering logic modified in the main PR.
  • chalabi/modal fixes #87: Includes changes to the TokenList component regarding modal management, which relates to the unconditional rendering of the DenomInfoModal.

Suggested labels

render

Suggested reviewers

  • fmorency

Poem

🐇 In the meadow where tokens play,
The modal shines both night and day.
No more hiding, it’s here to stay,
Showing info in a bright array!
With every denom, come what may,
The rabbit hops, hip-hip-hooray! 🌼


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: 0

🧹 Outside diff range and nitpick comments (2)
components/bank/components/tokenList.tsx (2)

110-113: LGTM! The unconditional modal rendering fixes the issue.

While this change correctly ensures the modal element exists before click handlers try to access it, we could improve the implementation further.

Consider managing the modal's visibility through React state instead of direct DOM manipulation:

-  const [selectedDenom, setSelectedDenom] = useState<any>(null);
+  const [selectedDenom, setSelectedDenom] = useState<string | null>(null);
+  const [isModalOpen, setIsModalOpen] = useState(false);

   // In the click handlers, replace showModal() with state:
-  (document?.getElementById(`denom-info-modal`) as HTMLDialogElement)?.showModal();
+  setIsModalOpen(true);

   // Update modal component:
   <DenomInfoModal
     denom={filteredBalances.find(b => b.denom === selectedDenom)?.metadata ?? null}
-    modalId="denom-info-modal"
+    isOpen={isModalOpen}
+    onClose={() => setIsModalOpen(false)}
   />

This approach:

  1. Uses React state to control modal visibility
  2. Eliminates direct DOM manipulation
  3. Improves type safety with proper typing for selectedDenom

Line range hint 40-47: Consolidate duplicate modal trigger logic

The modal opening logic is duplicated between the row click and arrow button click handlers. This could lead to maintenance issues.

Consider extracting the shared logic into a reusable function:

+  const handleOpenModal = (denom: string, event?: React.MouseEvent) => {
+    event?.stopPropagation();
+    setSelectedDenom(denom);
+    setIsModalOpen(true);
+  };

   // In the row div:
-  onClick={() => {
-    setSelectedDenom(balance?.denom);
-    (document?.getElementById(`denom-info-modal`) as HTMLDialogElement)?.showModal();
-  }}
+  onClick={() => handleOpenModal(balance.denom)}

   // In the arrow button:
-  onClick={e => {
-    e.stopPropagation();
-    setSelectedDenom(balance?.denom);
-    (document?.getElementById(`denom-info-modal`) as HTMLDialogElement)?.showModal();
-  }}
+  onClick={e => handleOpenModal(balance.denom, e)}

This refactor:

  1. Eliminates code duplication
  2. Centralizes modal opening logic
  3. Makes the code more maintainable

Also applies to: 89-97

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ce4786e and 21422b4.

📒 Files selected for processing (1)
  • components/bank/components/tokenList.tsx (1 hunks)
🔇 Additional comments (1)
components/bank/components/tokenList.tsx (1)

110-113: Verify modal component interface and usage pattern

Let's verify the DenomInfoModal component interface and check for similar patterns across the codebase.

✅ Verification successful

Props interface matches the implementation

The DenomInfoModal component accepts exactly the props being passed:

  • denom: accepts MetadataSDKType | null type
  • modalId: accepts string type

The usage in tokenList.tsx is consistent with both the component's interface and the existing usage pattern in MyDenoms.tsx.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check DenomInfoModal implementation and usage
echo "Checking DenomInfoModal implementation:"
ast-grep --pattern 'export $_ function DenomInfoModal' -f components/factory/

echo "\nChecking for similar modal patterns:"
rg -l "getElementById.*showModal" --type tsx

Length of output: 508


Script:

#!/bin/bash
# Check DenomInfoModal implementation and usage with corrected commands
echo "Checking DenomInfoModal implementation:"
ast-grep --pattern 'export $_ function DenomInfoModal'

echo "\nChecking DenomInfoModal props usage:"
ast-grep --pattern 'interface DenomInfoModalProps'

echo "\nChecking for similar modal patterns:"
rg -l "getElementById.*showModal"

echo "\nChecking all DenomInfoModal usages:"
rg "DenomInfoModal"

Length of output: 1079


Script:

#!/bin/bash
# Let's check the DenomInfoModal implementation and its props interface
echo "Checking DenomInfoModal implementation in denomInfo.tsx:"
cat components/factory/modals/denomInfo.tsx

echo "\nChecking MyDenoms component implementation:"
cat components/factory/components/MyDenoms.tsx

Length of output: 22674

@fmorency fmorency merged commit 573c752 into main Dec 4, 2024
8 checks passed
@fmorency fmorency deleted the chalabi/modal_fix branch December 4, 2024 19:45
This was referenced Dec 4, 2024
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