https://github.com/pavkout/react-mailkit

Create awesome and fully responsive emails without stress.
https://github.com/pavkout/react-mailkit

javascript kit mjml mjml-framework mjml-template mjml4 react typescript ui

Last synced: 7 days ago
JSON representation

Create awesome and fully responsive emails without stress.

• Host: GitHub
• URL: https://github.com/pavkout/react-mailkit
• Owner: pavkout
• License: mit
• Created: 2021-07-20T22:14:14.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-06T04:24:09.000Z (5 months ago)
• Last Synced: 2025-01-12T10:06:22.535Z (15 days ago)
• Topics: javascript, kit, mjml, mjml-framework, mjml-template, mjml4, react, typescript, ui
• Language: TypeScript
• Homepage: https://www.react-mailkit.io
• Size: 4.75 MB
• Stars: 65
• Watchers: 3
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  

  





  Welcome to react-mailkit 





  

    

  







  

  www.react-mailkit.io 

  

















---

Once upon a time, email creation wasn't an easy part using pure `html` and `css`.

`Now it is!` Create awesome and fully responsive emails without stress.

## Documentation

### You can see more docs and examples in our [Storybook](https://pavkout.github.io/react-mailkit).

## Getting Started

### What We Use

 ·  · 

## 📦 Install

```bash

yarn add react-mailkit

```

OR

```bash

npm install react-mailkit

```

## 👨‍💻 Tests

Over 350 🆙 unit tests

## ✍️ Example

```js

import {

  useEmail,

  EMail,

  EHead,

  ETitle,

  EPreview,

  EBody,

  ESection,

  EColumn,

  ECarousel,

  ECarouselImage

} from 'react-mailkit';

const { html, errors } = useEmail(

  

    

      Example

      Example

    

    

      

        

          

            

            

            

            

            

            

          

        

      

    

  

);

```

And this is the result (works in mobile too!)



## ✍️ Example project

You can find an example project

[here](https://github.com/pavkout/react-mailkit/tree/main/packages/react-mailkit-example)

## ⌨️ Try it live

You can try it [live](https://www.react-mailkit.io/#/try-it-live)

## TODO

- Add ability to convert the MJML format to react-mailkit via js and CLI. (Working)

- Add more custom components

## Reporting Bugs

Have a bug or a feature request? Please open a new

[bug report](https://github.com/pavkout/react-mailkit/issues).

Before opening a new issue, please search through any [existing issues](https://github.com/pavkout/react-mailkit/issues)

to avoid submitting duplicates.

## Contributing

All contributions are welcome! ❤️

## License Information

```

MIT License

Copyright (C) 2021

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.

```