readme.md

? styled-email-components

Extension of styled-components with essential features for building email components.

Important: due to dependencies on styled-components internals, latest compatible version of styled-components is 3.4.1. We'll re-evaluate design of this module after stable v4 release of styled-components. Thanks!

• Features
• Motivation
• Installation
• Getting Started
• API
  • styled.*
  • styled.vml.*
  • Other APIs
• License

Features

• Styles are injected inline
• Shorthand rules are expanded
• styled.* aliases are XHTML compliant
• Supports Outlook-specific elements
• Compatible with original APIs
• Provides TypeScript typings

Motivation

styled-components is a universal styling solution with great developer experience and low learning curve. Unfortunately, there's no native support for inline styling which is essential for building emails. This module adds all necessary features to build mail-first components.

Installation

Don't forget to install styled-components itself as a peer dependency.

yarn:

yarn add styled-email-components styled-components

npm:

npm install --save styled-email-components styled-components

Getting Started

Check original Gettings Started for more examples.

import React from 'react';
import { renderToStaticMarkup } from 'react-dom/server';
import styled from 'styled-email-components';

const Link = styled.a`
  font-family: sans-serif;
  background: blue;
  color: white;
`;

renderToStaticMarkup(<Link href="https://example.com">Hey</Link>),
// ? output
// <a href="https://example.com" style="font-family:sans-serif;background-color:blue;color:white;">Hey</a>

API

styled.*

This module sets list of XHTML 1.0 Transitional element aliases instead of original HTML5 set, which is a widely used doctype in mails.

styled.vml.*

In addition to XHTML elements, styled.vml.*, styled.wml.* and styled.office.* aliases are available. These are simple proxies and pass tag names as-is with v:, w: and o: prefixes respectevly.

Other APIs

Original APIs are mirrored without any modifications from styled-components. Make sure to check server-side rendering guide for rendering the final email.

License

MIT © Sergey Bekrin