-
Notifications
You must be signed in to change notification settings - Fork 205
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
FEAT: Support Markdown Rendering #871
Conversation
…-markdown-rendering
…-markdown-rendering
… and their helper text
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some minor comments. everything else looks okay.,
frontend/src/components/helpers/custom-markdown/CustomMarkdown.jsx
Outdated
Show resolved
Hide resolved
frontend/src/components/rjsf-custom-widgets/checkbox-widget/CheckboxWidget.jsx
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tested the FE changes - haven't review the FE code though. Would suggest to get another approval for the same
frontend/src/components/pipelines-or-deployments/log-modal/LogsModal.jsx
Outdated
Show resolved
Hide resolved
…-markdown-rendering
…/unstract into feat/support-markdown-rendering
… security hotspot
…ress SonarQube issue" This reverts commit 5ed7ba9.
|
Quality Gate passedIssues Measures |
What
Introduced a
CustomMarkdown
component for selective markdown rendering, processing specific markdown syntax such as bold, newline, links, and codeblocks while displaying unsupported syntax as plain text. This component is used in three places: popup notification messages, logs component, and RJSF form's helper text.Why
To make messages more interactive and user-friendly. Previously, the displayed messages were less engaging and harder to read.
How
The
CustomMarkdown
component is designed to selectively parse and render supported markdown syntax while leaving unsupported syntax as-is. It uses a parsing logic that identifies markdown elements (like bold, link, andcode
) and converts them into appropriate React elements for rendering. This ensures consistent and user-friendly message formatting across all integrated components.Can this PR break any existing features. If yes, please list possible items. If no, please explain why. (PS: Admins do not merge the PR without this section filled)
Yes, the
CustomMarkdown
component is used in multiple places, which increases the chances of it potentially breaking existing features.Database Migrations
NA
Env Config
NA
Relevant Docs
NA
Related Issues or PRs
Zipstack/unstract-sdk#133
Dependencies Versions
NA
Notes on Testing
NA
Screenshots
CustomMarkdown component used inside the Notifications and Logs component:
CustomMarkdown component used inside the RjsfFormLayout component:
Checklist
I have read and understood the Contribution Guidelines.