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

Revert "Fix formula text being janky" #2627

Merged
merged 1 commit into from
Jan 26, 2025

Conversation

nguyentvan7
Copy link
Collaborator

@nguyentvan7 nguyentvan7 commented Jan 26, 2025

Reverts #2618

Summary by CodeRabbit

  • Style
    • Updated formula display rendering to use Material-UI's Typography component
    • Improved semantic structure of text rendering
    • Maintained existing conditional styling for strikethrough text

Copy link
Contributor

coderabbitai bot commented Jan 26, 2025

Walkthrough

The pull request modifies the getCalcDisplay.tsx file in the UI library, replacing a fragment with <span> elements with a Material-UI Typography component. The change updates the rendering approach for formula display, utilizing the Typography component and applying conditional styling through the sx prop. This refactoring enhances the semantic structure of the formula rendering mechanism.

Changes

File Change Summary
libs/gi/ui/src/util/getCalcDisplay.tsx - Added import for Typography from @mui/material
- Replaced fragment and <span> with Typography component
- Applied conditional strikethrough style using sx prop

Suggested Reviewers

  • frzyc

Possibly related PRs

Poem

🐰 A Typography Tale of Code Delight

Spans transform with Material's might,
Rendering formulas, clean and bright,
Components dance with stylish flair,
A rabbit's code beyond compare! 🎨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 27a9181 and d3112e8.

📒 Files selected for processing (1)
  • libs/gi/ui/src/util/getCalcDisplay.tsx (2 hunks)
🔇 Additional comments (2)
libs/gi/ui/src/util/getCalcDisplay.tsx (2)

16-16: LGTM!

The Typography import is correctly placed and necessary for the component usage below.


224-232: 🛠️ Refactor suggestion

Several improvements needed for performance, accessibility, and maintainability.

  1. Performance: Avoid wrapping each component in a span as it creates unnecessary DOM nodes.
  2. Accessibility: Specify a Typography variant for proper text hierarchy.
  3. Styling: Consider using a variant or class instead of inline styles.
  4. React: Using array index as key is an anti-pattern.

Consider this improved implementation:

 <Typography
+  variant="body1"
   sx={{
     textDecoration: info.strikethrough ? 'line-through' : undefined,
+    '& .formula-component:not(:last-child)': {
+      marginRight: 1,
+    },
   }}
 >
-  {components.map((x, i) => (
-    <span key={i}>{x}</span>
-  ))}
+  {components.map((component, index) => {
+    // Generate a more stable key based on component content if possible
+    const key = typeof component === 'string' ? component : `formula-${index}`;
+    return (
+      <span key={key} className="formula-component">
+        {component}
+      </span>
+    );
+  })}
 </Typography>

Let's verify if this revert is actually necessary by checking the "janky text" issue:


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
Contributor

github-actions bot commented Jan 26, 2025

[frontend] [Sun Jan 26 15:10:12 UTC 2025] - Deployed 08f3fc4 to https://genshin-optimizer-prs.github.io/pr/2627/frontend (Takes 3-5 minutes after this completes to be available)

[Sun Jan 26 17:36:34 UTC 2025] - Deleted deployment

@nguyentvan7 nguyentvan7 merged commit 72d89fb into master Jan 26, 2025
8 checks passed
@nguyentvan7 nguyentvan7 deleted the revert-2618-van/go/fixFormula branch January 26, 2025 17:36
nguyentvan7 added a commit that referenced this pull request Jan 27, 2025
nguyentvan7 added a commit that referenced this pull request Jan 27, 2025
* Add nonstacking to all relevant buffs

* fix

* dumdum proof

* Reapply "Add non-stacking buff back to NO4 in a smarter way (#2592)" (#2629)

This reverts commit e8a420a.

* Reapply "Fix formula text being janky (#2618)" (#2627)

This reverts commit 72d89fb.

---------

Co-authored-by: lantua <[email protected]>
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