💌 styled-email-components


Extension of styled-components (v5.x) with
essential features for building email components.

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

yarn:

``sh
yarn add styled-email-components
`

npm:

`sh
npm install --save styled-email-components
`

Getting Started

Check original
Getting Started
for more examples.

`js
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(Hey),
// 👇 output
// Hey
`

API

$3

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

$3

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 respectively.

$3

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