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

chore: bug: adjust WDS caption text style #31167

Merged
merged 2 commits into from Feb 16, 2024
Merged

chore: bug: adjust WDS caption text style #31167

merged 2 commits into from Feb 16, 2024

Conversation

jsartisan
Copy link
Contributor

@jsartisan jsartisan commented Feb 16, 2024

Fixes #30896

Summary by CodeRabbit

  • Refactor
    • Reordered typography variants for improved consistency in design.
  • New Features
    • Enhanced feature flag checks to directly return true for specific flags, improving feature toggling.
  • Style
    • Adjusted the order of style options in the widget property pane for better usability.

@github-actions github-actions bot added WDS team Anvil POD Issue related to Anvil project labels Feb 16, 2024
Copy link
Contributor

coderabbitai bot commented Feb 16, 2024

Walkthrough

The changes involve several updates across the application's codebase, focusing on typography adjustments, feature flag checks, and widget style configurations. The modifications include reordering typography variants for consistency, enhancing feature flag evaluation for specific flags, and adjusting widget style options to meet design requirements. These changes aim to improve the application's usability and align with design system standards.

Changes

File Path Change Summary
.../theming/src/token/src/types.ts Reordered TYPOGRAPHY_VARIANTS by moving "body" before "caption".
.../selectors/featureFlagsSelectors.ts Modified selectFeatureFlagCheck to return true for specific flags before value checks.
.../utils/hooks/useFeatureFlag.ts Added explicit checks for "ab_wds_enabled" and "release_anvil_enabled" flags.
.../wds/WDSParagraphWidget/config/.../styleConfig.ts Reordered style options in propertyPaneStyleConfig.

Assessment against linked issues

Objective Addressed Explanation
Adjust WDS caption text style (#30896)

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Feb 16, 2024
@jsartisan
Copy link
Contributor Author

jsartisan commented Feb 16, 2024

@vadim Note: In the PR, I have just reverted the order of caption and body. The reason is in the code, we don't specifically create sizes for body,caption,footnote etc. We just create some sizes and assign them by index.

return Object.keys(TYPOGRAPHY_VARIANTS).reduce((prev, current, index) => {
    return {
      ...prev,
      [current]: styles[index],
    };
  }, {} as Typography);

@ichik
Copy link
Contributor

ichik commented Feb 16, 2024

@jsartisan this seems to change the effective body size (and as a result all the widgets having text of that size), can we avoid that?

@jsartisan
Copy link
Contributor Author

Few solutions i can think of:

  1. Change default value of fontsize to "caption" instead of "body"
  2. Rename "caption" altogether maybe?

@vadim

@ichik
Copy link
Contributor

ichik commented Feb 16, 2024

@jsartisan

  1. Makes our semantic naming meaningless
  2. I don't understand how changing the name would change the value.

@KelvinOm
Copy link
Collaborator

@jsartisan this seems to change the effective body size (and as a result all the widgets having text of that size), can we avoid that?

@ichik You're right, but everything seems to be correct here. If we want to change the values, we can tweak the config and make the growth slower or something.

@KelvinOm KelvinOm merged commit ec85d4c into release Feb 16, 2024
18 of 19 checks passed
@KelvinOm KelvinOm deleted the fix/caption-size branch February 16, 2024 11:39
@jsartisan
Copy link
Contributor Author

jsartisan commented Feb 16, 2024

@vadim

I don't understand how changing the name would change the value.

I was just wondering why people are getting confused with caption is because of its name? maybe they expect "caption" to be smaller than "body". so i thought just changing the name would have cleared their confusion. just a random thought.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Anvil POD Issue related to Anvil project skip-changelog Adding this label to a PR prevents it from being listed in the changelog WDS team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug: adjust WDS caption text style
3 participants