Skip to content

Commit 31b056d

Browse files
committed
feat: updated react-email component and readme
1 parent 69a0119 commit 31b056d

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,11 @@ npm install md-to-react-email
6565
import {parseMarkdownToReactEmailJSX} from "md-to-react-email"
6666

6767
const markdown = `# Hello World`
68-
const parsedReactMail = parseMarkdownToReactEmail(markdown)
68+
const parsedReactMail = parseMarkdownToReactEmailJSX({markdown})
69+
const parsedReactMailWithDataAttributes = parseMarkdownToReactEmailJSX({markdown, withDataAttr: true})
6970

70-
console.log(parsedReactMail) // `<Heading as="h1" style="...valid inline CSS..."></Heading>`
71+
console.log(parsedReactMail) // `<h1 style="...valid inline CSS...">Hello, World!</h1>`
72+
console.log(parsedReactMailWithDataAttributes) // `<h1 data-id="react-email-heading" style="...valid inline CSS...">Hello, World!</h1>`
7173

7274
```
7375

@@ -98,6 +100,8 @@ The following components are available for customization:
98100
- Image
99101
- Line-breaks (br)
100102
- Horizontal-rule (hr)
103+
- Table: table, thead, tbody, th, td, tr
104+
- Strikethrough
101105

102106
## Supported Email Clients
103107

src/components/reactEmailMarkdown.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,19 @@ interface ReactEmailMarkdownProps {
77
markdown: string;
88
markdownCustomStyles?: StylesType;
99
markdownContainerStyles?: React.CSSProperties;
10+
showDataAttributes?: boolean;
1011
}
1112

1213
export const ReactEmailMarkdown: React.FC<ReactEmailMarkdownProps> = ({
1314
markdown,
1415
markdownCustomStyles,
1516
markdownContainerStyles,
17+
showDataAttributes = true,
1618
}) => {
1719
const parsedMarkdown = parseMarkdownToReactEmailJSX({
1820
markdown,
1921
customStyles: markdownCustomStyles,
20-
withDataAttr: true,
22+
withDataAttr: showDataAttributes,
2123
});
2224

2325
return (

0 commit comments

Comments
 (0)