Skip to content

fix: add break-word rule for text widgets#35046

Merged
KelvinOm merged 2 commits intoreleasefrom
fix/wds-text-widgets
Jul 22, 2024
Merged

fix: add break-word rule for text widgets#35046
KelvinOm merged 2 commits intoreleasefrom
fix/wds-text-widgets

Conversation

@KelvinOm
Copy link
Collaborator

@KelvinOm KelvinOm commented Jul 19, 2024

Description

Fix text wrapping into paragraph and heading widgets

Automation

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

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/10047055173
Commit: d0f7b27
Cypress dashboard.
Tags: @tag.Anvil
Spec:


Mon, 22 Jul 2024 19:49:10 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Introduced a new wordBreak property to the text component for improved control over text wrapping and overflow.
    • Enhanced the WDSParagraphWidget to utilize the new wordBreak property, improving text layout and readability.
  • Bug Fixes

    • Corrected a typo in documentation for the TextProps interface to enhance clarity.
  • Style

    • Modified CSS styles affecting text overflow behavior, enabling better customization and responsive design.

@KelvinOm KelvinOm marked this pull request as ready for review July 19, 2024 15:07
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 19, 2024

Walkthrough

The recent updates to the Text component significantly enhance its functionality by introducing a new wordBreak property. This addition allows developers to better manage text overflow and improve readability across various layouts, particularly in responsive designs. Moreover, adjustments to CSS styles and type documentation ensure a more cohesive and user-friendly experience.

Changes

Files Change Summary
app/client/packages/design-system/widgets/src/components/Text/src/Text.tsx Introduced wordBreak property to _Text, defaulting to "break-all" for improved text management.
app/client/packages/design-system/widgets/src/components/Text/src/styles.module.css Removed word-break: break-all;, affecting text overflow behavior within the component.
app/client/packages/design-system/widgets/src/components/Text/src/types.ts Corrected documentation for the style property and added an optional wordBreak property to manage CSS text breaking.
app/client/src/widgets/wds/WDSParagraphWidget/widget/index.tsx Enhanced WDSParagraphWidget by adding wordBreak="break-word" to Text, improving text rendering and layout.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant WDSParagraphWidget
    participant Text

    User->>WDSParagraphWidget: Request paragraph
    WDSParagraphWidget->>Text: Render text with wordBreak="break-word"
    Text-->>WDSParagraphWidget: Return formatted text
    WDSParagraphWidget-->>User: Display paragraph
Loading

Poem

In the realm where text does flow,
A new wordBreak steals the show.
With flexibility in every line,
Overflow issues now resign.
Components dance, layouts gleam,
Text embraces a flowing dream. 🌟✨


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 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

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

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.

@KelvinOm KelvinOm requested a review from jsartisan July 19, 2024 15:08
@github-actions github-actions bot added the Bug Something isn't working label Jul 19, 2024
@KelvinOm KelvinOm changed the title fix: add break-word rules for text widgets fix: add break-word rule for text widgets Jul 19, 2024
jsartisan
jsartisan previously approved these changes Jul 19, 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: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 404e6e6 and e7bcfda.

Files selected for processing (4)
  • app/client/packages/design-system/widgets/src/components/Text/src/Text.tsx (2 hunks)
  • app/client/packages/design-system/widgets/src/components/Text/src/styles.module.css (1 hunks)
  • app/client/packages/design-system/widgets/src/components/Text/src/types.ts (1 hunks)
  • app/client/src/widgets/wds/WDSParagraphWidget/widget/index.tsx (1 hunks)
Files skipped from review due to trivial changes (2)
  • app/client/packages/design-system/widgets/src/components/Text/src/styles.module.css
  • app/client/packages/design-system/widgets/src/components/Text/src/types.ts
Additional comments not posted (3)
app/client/packages/design-system/widgets/src/components/Text/src/Text.tsx (2)

25-25: Good job on adding the wordBreak property!

This addition enhances the flexibility of text handling within the component. Setting a default value of "break-all" ensures that text will wrap appropriately if no specific value is provided.


46-46: Well done on utilizing the wordBreak property in the inline style!

Incorporating the wordBreak property here ensures that the text wrapping behavior is applied as intended.

app/client/src/widgets/wds/WDSParagraphWidget/widget/index.tsx (1)

75-75: Nice addition of the wordBreak property!

Adding wordBreak="break-word" improves text rendering by allowing long words to break and wrap onto the next line, enhancing the overall layout and readability.

@KelvinOm KelvinOm added the ok-to-test Required label for CI label Jul 19, 2024
@KelvinOm KelvinOm force-pushed the fix/wds-text-widgets branch from e7bcfda to d0f7b27 Compare July 22, 2024 19:20
@KelvinOm KelvinOm added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Jul 22, 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: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e7bcfda and d0f7b27.

Files ignored due to path filters (2)
  • app/client/cypress/snapshots/AnvilHeadingWidgetSnapshot_spec.ts/anvilHeadingWidgetDeployIphone6.snap.png is excluded by !**/*.png
  • app/client/cypress/snapshots/AnvilParagraphWidgetSnapshot_spec.ts/anvilParagraphWidgetDeployIphone6.snap.png is excluded by !**/*.png
Files selected for processing (4)
  • app/client/packages/design-system/widgets/src/components/Text/src/Text.tsx (2 hunks)
  • app/client/packages/design-system/widgets/src/components/Text/src/styles.module.css (1 hunks)
  • app/client/packages/design-system/widgets/src/components/Text/src/types.ts (1 hunks)
  • app/client/src/widgets/wds/WDSParagraphWidget/widget/index.tsx (1 hunks)
Files skipped from review as they are similar to previous changes (4)
  • app/client/packages/design-system/widgets/src/components/Text/src/Text.tsx
  • app/client/packages/design-system/widgets/src/components/Text/src/styles.module.css
  • app/client/packages/design-system/widgets/src/components/Text/src/types.ts
  • app/client/src/widgets/wds/WDSParagraphWidget/widget/index.tsx

@KelvinOm KelvinOm merged commit 351acde into release Jul 22, 2024
@KelvinOm KelvinOm deleted the fix/wds-text-widgets branch July 22, 2024 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Bug Something isn't working ok-to-test Required label for CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants