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

Update PortfolioSummary.tsx #938

Closed
wants to merge 2 commits into from
Closed

Conversation

GradleD
Copy link
Contributor

@GradleD GradleD commented Nov 7, 2024

  • Skeleton issue on PorfolioSummary

Summary by CodeRabbit

  • New Features

    • Introduced a loading state in the Portfolio Summary component to enhance user experience during data fetching.
    • Added a loading skeleton that displays while data is being retrieved.
  • Bug Fixes

    • Improved control flow to ensure main content only renders after loading completes.

Copy link

vercel bot commented Nov 7, 2024

@GradleD is attempting to deploy a commit to the LFG Labs Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Nov 7, 2024

Walkthrough

The changes in PortfolioSummary.tsx introduce a loading state to the component, utilizing the useEffect hook to simulate data fetching with a 2-second delay. A new Loading component is integrated to display a loading skeleton during this period. The component's return statement is modified to conditionally render the main content based on the loading state, while the ChartEntry component remains unchanged. Import statements are updated to include the new Loading component, and a state variable for loading management is added.

Changes

File Change Summary
components/dashboard/PortfolioSummary.tsx Added loading state management with useState, integrated Loading component, and simulated data fetching with useEffect.

Possibly related PRs

  • wallet-amount #925: The changes in profileCard.tsx involve the addition of a useEffect hook to fetch data asynchronously, similar to the loading state implementation in PortfolioSummary.tsx, indicating a related approach to managing loading states in components.

Suggested reviewers

  • Marchand-Nicolas

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

🧹 Outside diff range and nitpick comments (2)
components/dashboard/PortfolioSummary.tsx (2)

99-101: Consider making the loading skeleton height responsive

The fixed height of 300px might not be optimal for all screen sizes. Consider using relative units or min/max heights for better responsiveness.

- <Loading isLoading={loading} loadingType="skeleton" width="100%" height={300}>
+ <Loading isLoading={loading} loadingType="skeleton" width="100%" height="min(300px, 50vh)">

Line range hint 99-154: Improve component structure with early returns and error handling

The current nested conditional structure could be simplified, and error states should be handled in the UI.

Consider restructuring the component's return statement:

 return (
   <Loading isLoading={loading} loadingType="skeleton" width="100%" height={300}>
+    {error && (
+      <div className="text-red-500">
+        <Typography type={TEXT_TYPE.BODY_MIDDLE}>
+          {error.message}
+        </Typography>
+      </div>
+    )}
-    {data.length > 0 ? (
+    {!error && data.length === 0 && (
+      <Typography type={TEXT_TYPE.BODY_MIDDLE}>
+        No portfolio data available
+      </Typography>
+    )}
+    {!error && data.length > 0 && (
       <div className={styles.dashboard_portfolio_summary}>
         {/* ... existing content ... */}
       </div>
-    ) : null}
+    )}
   </Loading>
 );
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ad77f2c and 91c5d19.

📒 Files selected for processing (1)
  • components/dashboard/PortfolioSummary.tsx (5 hunks)
🔇 Additional comments (2)
components/dashboard/PortfolioSummary.tsx (2)

1-1: LGTM: Import statements are properly organized

The new imports for React hooks and the Loading component are correctly placed and follow good practices.

Also applies to: 13-13


Line range hint 1-157: Overall implementation successfully addresses the skeleton loading requirement

The changes effectively implement skeleton loading for the PortfolioSummary component, addressing the original PR objective. The implementation follows React best practices and provides a good user experience during loading states.

Copy link

vercel bot commented Nov 7, 2024

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

Name Status Preview Comments Updated (UTC)
starknet-quest ❌ Failed (Inspect) Nov 10, 2024 7:22am

Copy link
Contributor

@fricoben fricoben left a comment

Choose a reason for hiding this comment

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

Seems like you don't understand the issue at all.

Please refactor.

setLoading(false);
};
fetchData();
}, []);
Copy link
Contributor

Choose a reason for hiding this comment

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

What is this? Why are you simulating a loading? Are you to understand the issue ?

@@ -85,7 +96,10 @@ const PortfolioSummary: FunctionComponent<PortfolioSummaryProps> = ({ title, dat
const [showClaimModal, setShowClaimModal] = useState(false);
const [showSuccessModal, setShowSuccessModal] = useState(false);

return data.length > 0 ? (
return (
<Loading isLoading={loading} loadingType="skeleton" width="100%" height={300}>
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are you doing this ? We want to make a skeleton loading for this part not rendering it randomly
image

@@ -135,7 +149,9 @@ const PortfolioSummary: FunctionComponent<PortfolioSummaryProps> = ({ title, dat
</div>
</div>
</div>
) : null;
) : null}
</Loading>
Copy link
Contributor

Choose a reason for hiding this comment

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

?

@fricoben fricoben added the ❌ Change request Change requested from reviewer label Nov 7, 2024
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

🧹 Outside diff range and nitpick comments (1)
components/dashboard/PortfolioSummary.tsx (1)

Line range hint 99-154: Refine skeleton loading implementation

The current implementation wraps the entire component with skeleton loading, but based on the reviewer's screenshot, we should only apply skeleton loading to specific parts of the UI.

Consider this approach:

 return (
-  <Loading isLoading={loading} loadingType="skeleton" width="100%" height={300}>
   {data.length > 0 ? (
     <div className={styles.dashboard_portfolio_summary}>
       <div className="flex flex-col md:flex-row w-full justify-between items-center mb-4">
         {/* ... header content ... */}
       </div>
       <div className={styles.dashboard_portfolio_summary_info}>
         <div className="flex flex-col justify-between w-10/12 md:w-8/12 h-fit">
+          {!isDataLoaded ? (
+            <Loading loadingType="skeleton" width="100%" height={24} count={3} className="mb-2" />
+          ) : (
           {data.map((item, id) => (
             <ChartEntry key={id} {...item} />
           ))}
+          )}
         </div>
         <div className="w-full mb-4 md:w-3/12 md:mb-0">
+          {!isDataLoaded ? (
+            <Loading loadingType="skeleton" width="100%" height="100%" className="rounded-full" />
+          ) : (
           <Doughnut
             data={{
               labels: data.map(entry => entry.itemLabel),
               datasets: [{/* ... */}],
             }}
             options={chartOptions}
           />
+          )}
         </div>
       </div>
     </div>
   ) : null}
-  </Loading>
 );

This approach:

  1. Removes the wrapper Loading component
  2. Adds targeted skeleton loading for specific UI elements
  3. Shows skeleton UI only while actual data is loading
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 91c5d19 and 5d1be7f.

📒 Files selected for processing (1)
  • components/dashboard/PortfolioSummary.tsx (4 hunks)

components/dashboard/PortfolioSummary.tsx Show resolved Hide resolved
@fricoben
Copy link
Contributor

Hey @GradleD please update this or I'll assign to someone else

@GradleD GradleD closed this Nov 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
❌ Change request Change requested from reviewer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants