Email Widgets
A collection of email widgets for use with MJML
Basic Usage
Install Widgets
yarn add hapi-maily-widgets
Usage
;;; const emailComponent = ;const staticEmail = ; console; // Static HTML email
Available Components
Preview available widgets in react storybook, each story item
needs to be served through renderMJML
in order to convert
mjml into valid HTML markup.
Theming
You are able to customize the look of the mail components by passing a
theme property to the renderMJML
method.
The structure of the theme should be as follows
const theme = colors: primary: '#E91E63' // you can use additional colors // below, so long as it is // string: 'HEX' headerImage: src: 'url to hosted image' alt: 'alt text describing image'
Then you can simply call the renderMJML method with your components.
;;; const theme = colors: primary: '#03A9F4' secondary: '#009688' paul: '#8BC34A' ; const buttonComponent = <Button url="http://google.com" buttonType="paul" > Hi Im Paul! </Button> const emailComponent = ;const staticEmail = ; console; // Static Themed HTML email
Contributing
Available Commands
yarn start
Generates the email widgets in storybook mode. Open http://localhost:9009 to view it in the browser.
yarn lint
Runs the linting command, should be done before pull requests are made. This application follows the airbnb linting styleguide with minor changes.