mjml-core

Basic MJML to HTML Conversion

This feature allows you to convert MJML markup into responsive HTML. The code sample demonstrates how to use the `mjml2html` function to convert a simple MJML template into HTML.

const mjml2html = require('mjml');

const mjml = `
<mjml>
  <mj-body>
    <mj-section>
      <mj-column>
        <mj-text>Hello World</mj-text>
      </mj-column>
    </mj-section>
  </mj-body>
</mjml>`;

const { html, errors } = mjml2html(mjml);
console.log(html);

Custom Components

This feature allows you to create custom MJML components. The code sample demonstrates how to create and register a custom button component.

const { registerComponent, BodyComponent } = require('mjml-core');

class CustomButton extends BodyComponent {
  render() {
    return this.renderMJML(`
      <mj-button background-color="${this.getAttribute('background-color')}" href="${this.getAttribute('href')}">
        ${this.getContent()}
      </mj-button>
    `);
  }
}

registerComponent(CustomButton);

Validation

This feature provides validation for MJML templates. The code sample demonstrates how to use the `mjml2html` function with strict validation to catch any errors in the MJML markup.

const mjml2html = require('mjml');

const mjml = `
<mjml>
  <mj-body>
    <mj-section>
      <mj-column>
        <mj-text>Hello World</mj-text>
      </mj-column>
    </mj-section>
  </mj-body>
</mjml>`;

const { html, errors } = mjml2html(mjml, { validationLevel: 'strict' });

if (errors.length > 0) {
  console.error('Validation errors:', errors);
} else {
  console.log(html);
}