Fork of mjml-react for solid-js

mjml-solid ·

There is an awesome library mjml with github repo here https://github.com/mjmlio/mjml.

MJML is a markup language created by Mailjet. So in order to create emails on the fly we created a library with Solid components.

This library depends on Solid's renderToString method, which is only availble in NodeJS. It might be possible to run this library in the browser, but it's not supported.

Getting Started

npm install mjml-solid mjml solid-js

1. Wire up your render function

import { renderToMjml, renderToMjmlAsync } from "mjml-solid/utils/renderToMjml";
import mjml2html from "mjml";
import { MJMLParseResults } from "mjml-core";
import { JSX } from "solid-js";

// sync
export function renderSolidEmail(email: JSX.Element): MJMLParseResults {
  return mjml2html(renderToMjml(email));
}

// async
export async function renderSolidEmailAsync(email: JSX.Element): Promise<MJMLParseResults> {
  const  mjmlSrc = await renderToMjmlAsync(email);
  return mjml2html(mjmlSrc);
}

2. And afterwards write a code like a pro:

import {
  Mjml,
  MjmlHead,
  MjmlTitle,
  MjmlPreview,
  MjmlBody,
  MjmlSection,
  MjmlColumn,
  MjmlButton,
  MjmlImage,
} from "mjml-solid";

import { renderSolidEmail } from "./renderSolidEmail";

const { html, errors } = renderSolidEmail(
  <Mjml>
    <MjmlHead>
      <MjmlTitle>Last Minute Offer</MjmlTitle>
      <MjmlPreview>Last Minute Offer...</MjmlPreview>
    </MjmlHead>
    <MjmlBody width={500}>
      <MjmlSection fullWidth backgroundColor="#efefef">
        <MjmlColumn>
          <MjmlImage src="https://static.wixstatic.com/media/5cb24728abef45dabebe7edc1d97ddd2.jpg" />
        </MjmlColumn>
      </MjmlSection>
      <MjmlSection>
        <MjmlColumn>
          <MjmlButton
            padding="20px"
            backgroundColor="#346DB7"
            href="https://www.wix.com/"
          >
            I like it!
          </MjmlButton>
        </MjmlColumn>
      </MjmlSection>
    </MjmlBody>
  </Mjml>,
  { validationLevel: "soft" }
);

And as the result you will get a nice looking email HTML (works in mobile too!)

Options

mjml-solid sets the following MJML options when rendering to HTML:

{
  keepComments: false,
  beautify: false,
  minify: true,
  validationLevel: 'strict'
}

If you want to override these, you can pass an object to render as a second argument. See the MJML docs for the full list of options you can set.

Extensions

import {
  MjmlHtml,
  MjmlComment,
  MjmlConditionalComment
} from 'mjml-solid/extensions';

<MjmlComment comment="Built with ... at ..." />
// <!--Built with ... at ...-->

<MjmlConditionalComment comment="MSO conditionals" />
// <!--[if gte mso 9]>MSO conditionals<![endif]-->

<MjmlConditionalComment comment="MSO conditionals" condition="if IE" />
// <!--[if IE]>MSO conditionals<![endif]-->

<MjmlHtml html="<span>Hello World!</span>" />
// <span>Hello World!</span>

Utils

We do have also some utils for post processing the output HTML. Because not all mail clients do support named HTML entities, like '. So we need to replace them to hex.

import {
  namedEntityToHexCode,
  fixConditionalComment,
} from "mjml-solid/utils";

const html = "<div>&apos;</div>";
namedEntityToHexCode(html);
// <div>&#39;</div>

fixConditionalComment(
  "<!--[if mso]><div>Hello World</div><![endif]-->",
  "Hello",
  "if IE"
);
// <!--[if IE]><div>Hello World</div><![endif]-->

Limitations

Currently mjml and mjml-solid libraries are meant to be run inside a node.