chore: fix markdown styles by jsartisan · Pull Request #36959 · appsmithorg/appsmith

jsartisan · 2024-10-18T05:20:08Z

Summary by CodeRabbit

New Features
- Updated Markdown rendering components to streamline available elements.
Bug Fixes
- Adjusted CSS styles for lists and anchor tags to improve layout and appearance.
Chores
- Removed unused components related to paragraphs and lists to enhance code maintainability.

coderabbitai · 2024-10-18T05:20:18Z

Walkthrough

The changes in this pull request involve the removal of several components related to rendering Markdown, specifically the p, ul, ol, and li components. Corresponding files for these components have been deleted, and CSS styles associated with them have been modified or removed. The exported components object now only includes a limited set of components, impacting the available elements for Markdown rendering.

Changes

File	Change Summary
`.../Markdown/src/components.tsx`	Removed `p`, `ul`, `ol`, and `li` components from the exported `components` object.
`.../Markdown/src/mdComponents/List.tsx`	Deleted file containing `ul`, `ol`, and `li` components.
`.../Markdown/src/mdComponents/Paragraph.tsx`	Deleted file containing the `p` component for rendering paragraphs.
`.../Markdown/src/styles.module.css`	Modified CSS: removed margin for `[data-component="p"]`, updated margins for `ul` and `ol`, added styles for `li`, and changed anchor tag display.

Possibly related PRs

chore: Update markdown component + create avatar component + refactor #36832: The changes in this PR involve updates to the Markdown component, which includes modifications to the components.tsx file where the p, ul, ol, and li components are relevant, aligning with the deletions made in the main PR.

Suggested labels

skip-changelog, ok-to-test

Suggested reviewers

KelvinOm
znamenskii-ilia

🎉 In the land of Markdown, changes took flight,
Components once present, now bid goodnight.
Paragraphs and lists, they've vanished away,
Leaving anchors and headings to brighten the day!
With styles adjusted, the layout's a charm,
A simpler structure, now free from alarm! 🌟

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.

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.

coderabbitai

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

app/client/packages/design-system/widgets/src/components/Markdown/src/styles.module.css (2)
80-80: LGTM. Consider using list-style-position.

The changes look good. The reduced margin and added list style improve the list appearance.

Consider adding list-style-position: inside; to ensure consistent indentation across browsers.

Also applies to: 82-82

92-93: LGTM. Consider adding hover styles.

The change to use display: inline-block; for anchor tags is good.

Consider adding hover styles to improve user interaction:
a {
  display: inline-block;
  text-decoration: none;
  color: var(--color-link);
}

a:hover {
  text-decoration: underline;
}

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5801f49 and eb53521.

📒 Files selected for processing (4)

app/client/packages/design-system/widgets/src/components/Markdown/src/components.tsx (0 hunks)
app/client/packages/design-system/widgets/src/components/Markdown/src/mdComponents/List.tsx (0 hunks)
app/client/packages/design-system/widgets/src/components/Markdown/src/mdComponents/Paragraph.tsx (0 hunks)
app/client/packages/design-system/widgets/src/components/Markdown/src/styles.module.css (1 hunks)

💤 Files with no reviewable changes (3)

app/client/packages/design-system/widgets/src/components/Markdown/src/components.tsx
app/client/packages/design-system/widgets/src/components/Markdown/src/mdComponents/List.tsx
app/client/packages/design-system/widgets/src/components/Markdown/src/mdComponents/Paragraph.tsx

🧰 Additional context used

🔇 Additional comments (1)

app/client/packages/design-system/widgets/src/components/Markdown/src/styles.module.css (1)

89-89: LGTM. Good use of list-style-type.

The addition of list-style-type: auto; is appropriate and consistent with the parent list styling.

jsartisan · 2024-10-18T05:21:58Z

...client/packages/design-system/widgets/src/components/Markdown/src/mdComponents/Paragraph.tsx

We are not using our Text component as the capsizing is causing issues with list item markers. Anyway, we used capsizing for single line use cases ( like text in button ). Having capsizing for everything is causing more harm than good.

jsartisan · 2024-10-18T05:22:19Z

app/client/packages/design-system/widgets/src/components/Markdown/src/mdComponents/List.tsx

i realized these wrappers are not needed anymore as I removed the text wrapper.

## Summary by CodeRabbit - **New Features** - Updated Markdown rendering components to streamline available elements. - **Bug Fixes** - Adjusted CSS styles for lists and anchor tags to improve layout and appearance. - **Chores** - Removed unused components related to paragraphs and lists to enhance code maintainability.

fix markdown styles

eb53521

github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Oct 18, 2024

coderabbitai bot reviewed Oct 18, 2024

View reviewed changes

jsartisan commented Oct 18, 2024

View reviewed changes

KelvinOm approved these changes Oct 18, 2024

View reviewed changes

KelvinOm merged commit 5e4b026 into release Oct 18, 2024

KelvinOm deleted the chore/chat-ui-fixes-3 branch October 18, 2024 07:19

This was referenced Oct 19, 2024

chore: fix blueprint operation inconsistency for zone #36980

Merged

chore: add new ADD_ACTION blueprint operation type #37078

Merged

This was referenced Oct 29, 2024

chore: chat widget polish fixes #37124

Merged

chore: update inline code styles #37136

Merged

chore: fix code style in markdown #37141

Merged

coderabbitai bot mentioned this pull request Apr 3, 2025

chore: update markdown styles #40061

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: fix markdown styles#36959

chore: fix markdown styles#36959
KelvinOm merged 1 commit intoreleasefrom
chore/chat-ui-fixes-3

jsartisan commented Oct 18, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Oct 18, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

jsartisan Oct 18, 2024

Uh oh!

jsartisan Oct 18, 2024 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

jsartisan commented Oct 18, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Oct 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

jsartisan Oct 18, 2024

Choose a reason for hiding this comment

Uh oh!

jsartisan Oct 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jsartisan commented Oct 18, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 18, 2024 •

edited

Loading

jsartisan Oct 18, 2024 •

edited

Loading