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: Update ChartWidget fontFamily handling to respect system default #38784

Merged
merged 2 commits into from
Jan 21, 2025

Conversation

rahulbarwal
Copy link
Contributor

@rahulbarwal rahulbarwal commented Jan 21, 2025

Description

System font handling for chart widget

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags="@tag.Chart"

🔍 Cypress test results

Warning

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12884553057
Commit: 1978a03
Cypress dashboard.
Tags: @tag.Chart
Spec:
It seems like no tests ran 😔. We are not able to recognize it, please check workflow here.


Tue, 21 Jan 2025 10:06:24 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Enhanced chart widget font family configuration to support conditional font settings.
    • Added support for system default font settings.
  • Bug Fixes

    • Improved font rendering logic to ensure no fallback font is used when the system default is specified.

@rahulbarwal rahulbarwal self-assigned this Jan 21, 2025
Copy link
Contributor

coderabbitai bot commented Jan 21, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request modifies the ChartWidget component's font family rendering logic in the index.tsx file. The change introduces a new conditional approach to setting the font family, specifically handling the "System Default" case by setting the font to undefined when this value is selected. This adjustment provides more flexibility in font rendering for chart widgets.

Changes

File Change Summary
app/client/src/widgets/ChartWidget/widget/index.tsx Modified fontFamily property logic to handle "System Default" by setting to undefined instead of defaulting to "Nunito Sans"
app/client/src/widgets/ChartWidget/widget/index.test.ts Updated test case to reflect that no fallback font is used, changing expected value from "Nunito Sans" to undefined

Possibly related PRs

Suggested reviewers

  • jacquesikot

Poem

🎨 Fonts dancing free,
System default takes the lead,
Undefined and light,
Chart widget's typographic might!
Code poetry in flight 🖋️


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d7e8bb5 and 1978a03.

📒 Files selected for processing (1)
  • app/client/src/widgets/ChartWidget/widget/index.test.ts (2 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

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.

@github-actions github-actions bot added the Bug Something isn't working label Jan 21, 2025
@rahulbarwal rahulbarwal added Chart Widget ok-to-test Required label for CI labels Jan 21, 2025
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

🧹 Nitpick comments (1)
app/client/src/widgets/ChartWidget/widget/index.tsx (1)

260-264: Consider extracting "System Default" as a constant.

The implementation correctly handles system font fallback, but the magic string "System Default" should be moved to a constant for better maintainability.

+const SYSTEM_DEFAULT_FONT = "System Default";
+
 fontFamily={
-  this.props.fontFamily !== "System Default"
+  this.props.fontFamily !== SYSTEM_DEFAULT_FONT
     ? this.props.fontFamily
     : undefined
 }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8e9db85 and d7e8bb5.

📒 Files selected for processing (1)
  • app/client/src/widgets/ChartWidget/widget/index.tsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: perform-test / client-build / client-build
  • GitHub Check: perform-test / server-build / server-unit-tests
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-build / client-build
  • GitHub Check: client-check-cyclic-deps / check-cyclic-dependencies

@rahulbarwal rahulbarwal merged commit 16e121c into release Jan 21, 2025
43 checks passed
@rahulbarwal rahulbarwal deleted the rahulbarwal/chart-widget-system-font-fix branch January 21, 2025 10:04
@rahulbarwal rahulbarwal added the Widgets & Accelerators Pod Issues related to widgets & Accelerators label Jan 21, 2025
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Chart Widget ok-to-test Required label for CI Widgets & Accelerators Pod Issues related to widgets & Accelerators
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants