Skip to content

fix(react-email): render block tokens in tight list items #3809

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.

Sign up for GitHub

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
Gyran wants to merge 1 commit into
base: canary
Choose a base branch
from
+49 −9
Open

fix(react-email): render block tokens in tight list items #3809

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/tight-list-blocks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"react-email": patch
---

render block tokens in tight list items
47 changes: 43 additions & 4 deletions packages/react-email/src/components/markdown/markdown.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,14 +202,12 @@ console.log(\`Hello, $\{name}!\`);
);
expect(actualOutput).toMatchInlineSnapshot(`
"<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><!--$--><div data-id="react-email-markdown"><ul>
<li><p>parent list item</p>
<ul>
<li>parent list item<ul>
<li>nested list item 1</li>
<li>nested list item 2</li>
</ul>
</li>
<li><p>another parent item</p>
<ol>
<li>another parent item<ol>
<li>nested ordered item 1</li>
<li>nested ordered item 2</li>
</ol>
Expand All @@ -218,6 +216,47 @@ console.log(\`Hello, $\{name}!\`);
</div><!--/$-->"
`);
});

it('renders a tight list followed by a heading and paragraph', async () => {
const actualOutput = await render(
<Markdown>{'- Hello\n ## Heading\n body\n'}</Markdown>,
);
expect(actualOutput).toMatchInlineSnapshot(`
"<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><!--$--><div data-id="react-email-markdown"><ul>
<li>Hello</li>
</ul>
<h2 style="font-weight:500;padding-top:20px;font-size:2rem">Heading</h2><p> body</p>
</div><!--/$-->"
`);
});

it('renders a heading that starts a tight list item', async () => {
const actualOutput = await render(
<Markdown>{'- ## Heading\n body\n'}</Markdown>,
);
expect(actualOutput).toMatchInlineSnapshot(`
"<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><!--$--><div data-id="react-email-markdown"><ul>
<li><h2 style="font-weight:500;padding-top:20px;font-size:2rem">Heading</h2></li>
</ul>
<p> body</p>
</div><!--/$-->"
`);
});

it('renders a tight list followed by a code block', async () => {
const actualOutput = await render(
<Markdown>{'- item\n ```\n code\n ```\n'}</Markdown>,
);
expect(actualOutput).toMatchInlineSnapshot(`
"<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><!--$--><div data-id="react-email-markdown"><ul>
<li>item</li>
</ul>
<pre style="color:#212529;font-size:87.5%;display:block;background: #f8f8f8;font-family:SFMono-Regular,Menlo,Monaco,Consolas,monospace;padding-top:10px;padding-right:10px;padding-left:10px;padding-bottom:1px;margin-bottom:20px;word-wrap:break-word"><code>code
</code></pre>
</div><!--/$-->"
`);
});

it('applies th styles to table header cells and td styles to body cells', async () => {
const actualOutput = await render(
<Markdown
Expand Down
6 changes: 1 addition & 5 deletions packages/react-email/src/components/markdown/markdown.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,11 +119,7 @@ export const Markdown = React.forwardRef<HTMLDivElement, MarkdownProps>(
};

renderer.listitem = ({ tokens, loose }) => {
const hasNestedList = tokens.some((token) => token.type === 'list');
const text =
loose || hasNestedList
? renderer.parser.parse(tokens)
: renderer.parser.parseInline(tokens);
const text = renderer.parser.parse(tokens, !!loose);

return `<li${
parseCssInJsToInlineCss(finalStyles.li) !== ''
Expand Down