feat(AlertLayout): render markdown content #93
Conversation
ashmortar
force-pushed
the
f/lak-59/render-markdown-in-alerts
branch
from
424b8c9 to
1728aed
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## main #93 +/- ##
==========================================
+ Coverage 74.85% 75.04% +0.19%
==========================================
Files 38 38
Lines 505 509 +4
Branches 96 97 +1
==========================================
+ Hits 378 382 +4
Misses 90 90
Partials 37 37 ☔ View full report in Codecov by Sentry. |
ashmortar
force-pushed
the
f/lak-59/render-markdown-in-alerts
branch
from
1728aed to
b056797
Compare
There was a problem hiding this comment.
Would you be able to add a basic storybook story here so people know this is possible?
Also you will want to change your PR title to adhere to conventional commit syntax so it auto-releases a new version of the library.
ashmortar
force-pushed
the
f/lak-59/render-markdown-in-alerts
branch
from
b056797 to
db950ae
Compare
ashmortar
changed the title
ashmortar
force-pushed
the
f/lak-59/render-markdown-in-alerts
branch
from
db950ae to
4293c34
Compare
* use react-markdown in alerts to render markdown content as html * try changing module resolution and module settings to fix compat issue in react-markdown --------- Co-authored-by: Aaron Ross <[email protected]> Co-authored-by: Aaron Ross <[email protected]>
ashmortar
force-pushed
the
f/lak-59/render-markdown-in-alerts
branch
2 times, most recently
from
a98807c to
699d0ba
Compare
ashmortar
force-pushed
the
f/lak-59/render-markdown-in-alerts
branch
from
699d0ba to
22df851
Compare
|
|
||
| export function AlertLayout({ text, uischema }: LabelProps & RendererProps) { | ||
| const options = uischema.options as AlertLayoutOptions | ||
| const options = (uischema?.options ?? { style: {} }) as AlertLayoutOptions |
There was a problem hiding this comment.
it'd make this more runtime safe if you were to cast uischema instead:
const options = (uischema as LabelLayoutUISchema<unknown>).options
ie if AlertLayoutOptions gets a required property, the current cast would still steamroll it, allowing the code to later do something like
options.newRequiredProperty.OopsThisWillBeATypeError
| @@ -98,3 +98,46 @@ export const Success: Story = { | |||
| } satisfies UISchema<typeof schema>, | |||
| }, | |||
| } | |||
|
|
|||
| export const Mardown: Story = { | |||
| style={{ marginBottom: "24px" }} | ||
| type={options?.type} | ||
| message={text} | ||
| showIcon |
There was a problem hiding this comment.
This is a breaking change--you could add it to AlertLayoutOptions's pick of AlertProps if you want it to be configurable
| return ( | ||
| <Alert | ||
| style={{ marginBottom: "24px" }} | ||
| type={options?.type} | ||
| message={text} |
There was a problem hiding this comment.
what is the effect of using message vs description here? would this be a breaking change?
Why
Alerts are unable to render markdown style content like links, simple
code blocksor other elements that may be in use in our doc strings or would be helfpful for users (links to documentation).ptags withspanfor converted regular text