Skip to content

Fix markdown in descriptions rendering #4597

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

heath-freenome
Copy link
Member

@heath-freenome heath-freenome commented May 3, 2025

Reimplements #4405 in v6

In the fields of type object and type boolean, markdown will be rendered in the description when enableMarkdownInDescription is set to true.

Issue reporting this bug: #3975
Previous PR to add the feature: #3665

The result:

mddesc.mov

Reasons for making this change

[Please describe them here]

If this is related to existing tickets, include links to them as well. Use the syntax fixes #[issue number] (ex: fixes #123).

If your PR is non-trivial and you'd like to schedule a synchronous review, please add it to the weekly meeting agenda: https://docs.google.com/document/d/12PjTvv21k6LIky6bNQVnsplMLLnmEuypTLQF8a-8Wss/edit

Checklist

  • I'm updating documentation
  • I'm adding or updating code
    • I've added and/or updated tests. I've run npx nx run-many --target=build --exclude=@rjsf/docs && npm run test:update to update snapshots, if needed.
    • I've updated docs if needed
    • I've updated the changelog with a description of the PR
  • I'm adding a new feature
    • I've updated the playground with an example use of the feature

@heath-freenome heath-freenome requested a review from nickgros May 3, 2025 02:39
Reimplements #4405 in v6

In the fields of type `object` and type `boolean`, markdown will be rendered in the description when `enableMarkdownInDescription` is set to `true`.

Issue reporting this bug: #3975
Previous PR to add the feature: #3665

The result:
<img width="1484" alt="Screenshot 2024-12-01 at 18 44 54" src="https://github.com/user-attachments/assets/46bcf958-2da3-4706-a855-825fd73e1b27">
</div>
);
}
return (
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is why the <p> turned to <div> in the snapshots.

@TheOneTheOnlyJJ
Copy link

This also fixes #4527, which I opened some time ago. This is great! Thank you very much!

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