{"id":8080707,"url":"https://github.com/zalify/easy-email-editor","last_synced_at":"2025-05-14T05:12:30.894Z","repository":{"id":39747798,"uuid":"351729275","full_name":"zalify/easy-email-editor","owner":"zalify","description":"Easy Email Editor is a feature-rich, top open-source SaaS email editor based on React and MJML.","archived":false,"fork":false,"pushed_at":"2025-04-29T12:35:36.000Z","size":13572,"stargazers_count":1887,"open_issues_count":28,"forks_count":370,"subscribers_count":24,"default_branch":"master","last_synced_at":"2025-05-03T19:03:18.667Z","etag":null,"topics":["email-builder","email-editor","email-template-editor","javascript","mjml-editor","react","react-email-editor"],"latest_commit_sha":null,"homepage":"https://email.maocanhua.cn/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zalify.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"License","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"custom":"https://www.buymeacoffee.com/easyemail"}},"created_at":"2021-03-26T09:33:29.000Z","updated_at":"2025-05-02T04:19:11.000Z","dependencies_parsed_at":"2025-04-14T02:57:33.708Z","dependency_job_id":"3319aa6b-c237-4378-a514-5170fbddb7c8","html_url":"https://github.com/zalify/easy-email-editor","commit_stats":null,"previous_names":["zalify/easy-email-editor","zalify/easy-email"],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalify%2Feasy-email-editor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalify%2Feasy-email-editor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalify%2Feasy-email-editor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalify%2Feasy-email-editor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zalify","download_url":"https://codeload.github.com/zalify/easy-email-editor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253306149,"owners_count":21887524,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["email-builder","email-editor","email-template-editor","javascript","mjml-editor","react","react-email-editor"],"created_at":"2024-04-17T03:01:45.902Z","updated_at":"2025-05-14T05:12:25.872Z","avatar_url":"https://github.com/zalify.png","language":"TypeScript","funding_links":["https://www.buymeacoffee.com/easyemail"],"categories":["react","TypeScript"],"sub_categories":[],"readme":"# Easy email\r\n\r\n\u003cbr\u003e\r\n\u003cp align=\"center\"\u003e\r\n  \u003ca aria-label=\"Easy email logo\" href=\"https://email.maocanhua.cn/?utm_source=github\"\u003e\r\n    \u003cimg src=\"./logo_text.svg\" width=\"300\"\u003e\r\n  \u003c/a\u003e\r\n\u003c/p\u003e\r\n\u003cbr\u003e\r\n\r\n\u003cp align=\"center\"\u003e\r\n\r\n  \u003cimg src=\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg\"\u003e\r\n  \u003ca aria-label=\"React version\" href=\"https://react.js\"\u003e\r\n    \u003cimg alt=\"\" src=\"https://img.shields.io/badge/React-18.2-yellow.svg\"\u003e\r\n  \u003c/a\u003e\r\n  \u003ca aria-label=\"MJML\" href=\"https://mjml.io/\"\u003e\r\n    \u003cimg src=\"https://img.shields.io/badge/MJML-awesome-rgb(120 33 117).svg\"\u003e\r\n  \u003c/a\u003e\r\n  \u003ca aria-label=\"Package size\" href=\"https://www.typescriptlang.org/\"\u003e\r\n    \u003cimg alt=\"Using TypeScript\" src=\"https://img.shields.io/badge/%3C/%3E-TypeScript-brightgreenred.svg\"\u003e\r\n  \u003c/a\u003e\r\n\u003c/p\u003e\r\n\r\n---\r\n\r\n## Pro Version Announcement\r\n\r\nWe are delighted to announce that we now have a more powerful and customizable commercial version available. If it is for internal use only, then the open-source version is sufficient. However, if your editor is a critical feature, I recommend using the commercial version.\r\n\u003ca href=\"https://www.easyemail.pro/?utm_source=github\" target=\"_blank\"\u003eCheck it out here \u003c/a\u003e.\r\n\r\n## Free email templates for MJML and HTML.\r\n\r\n\u003ca href=\"https://github.com/Easy-Email-Pro/email-templates\" target=\"_blank\"\u003eCheck it out here \u003c/a\u003e.\r\n\r\n## Introduction\r\n\r\nEasy email is developed based on the [MJML](https://mjml.io/) and has very good compatibility. At the same time, it can generate code through drag-and-drop editing.\r\n\r\n|                  Video Overview                  |\r\n| :----------------------------------------------: |\r\n| \u003cimg src=\"./StandardLayout.png\" alt=\"Overview\" \u003e |\r\n\r\n## Live Demo\r\n\r\nOpen source version: \u003ca href=\"https://email.maocanhua.cn/?utm_source=github\" target=\"_blank\" alt=\"https://email.maocanhua.cn/?utm_source=github\"\u003eemail.maocanhua.cn\u003c/a\u003e\r\n\r\nCommercial version: \u003ca href=\"https://demo.easyemail.pro/full?utm_source=github-live\" target=\"_blank\"\u003edemo.easyemail.pro\u003c/a\u003e.\r\n\r\n## Getting started\r\n\r\n```sh\r\n$ npm install --save easy-email-core easy-email-editor easy-email-extensions react-final-form\r\n```\r\n\r\n```js\r\nimport React from 'react';\r\nimport { BlockManager, BasicType, AdvancedType } from 'easy-email-core';\r\nimport { EmailEditor, EmailEditorProvider } from 'easy-email-editor';\r\nimport { ExtensionProps, StandardLayout } from 'easy-email-extensions';\r\n\r\nimport 'easy-email-editor/lib/style.css';\r\nimport 'easy-email-extensions/lib/style.css';\r\nimport '@arco-themes/react-easy-email-theme/css/arco.css';\r\n\r\nconst initialValues = {\r\n  subject: 'Welcome to Easy-email',\r\n  subTitle: 'Nice to meet you!',\r\n  content: BlockManager.getBlockByType(BasicType.PAGE)!.create({}),\r\n};\r\n\r\nexport default function App() {\r\n\r\n  return (\r\n    \u003cEmailEditorProvider\r\n      data={initialValues}\r\n      height={'calc(100vh - 72px)'}\r\n      autoComplete\r\n      dashed={false}\r\n    \u003e\r\n      {({ values }) =\u003e {\r\n        return (\r\n          \u003cStandardLayout\r\n            showSourceCode={true}\r\n          \u003e\r\n            \u003cEmailEditor /\u003e\r\n          \u003c/StandardLayout\u003e\r\n        );\r\n      }}\r\n    \u003c/EmailEditorProvider\u003e\r\n  );\r\n}\r\n\r\n\r\n```\r\n\r\n\u003c/br\u003e\r\n\r\n## Configuration\r\n\r\n| property      | Type                                                                                               | Description                                   |\r\n| ------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------- |\r\n| height        | string / number                                                                                    | Set the height of the container               |\r\n| data          | interface IEmailTemplate { content: IPage; subject: string; subTitle: string; }                    | Source data                                   |\r\n| children      | ( props: FormState\u003cT\u003e,helper: FormApi\u003cIEmailTemplate, Partial\u003cIEmailTemplate\u003e\u003e) =\u003e React.ReactNode | ReactNode                                     |\r\n| onSubmit      | Config\u003cIEmailTemplate, Partial\u003cIEmailTemplate\u003e\u003e['onSubmit'];                                       | Called when the commit is triggered manually  |\r\n| fontList      | { value: string; label: string; }[];                                                               | Default font list.                            |\r\n| onUploadImage | (data: Blob) =\u003e Promise\u003cstring\u003e;                                                                   | Triggered when an image is pasted or uploaded |\r\n\r\n\u003c/br\u003e\r\n\r\n## Development\r\n\r\n```sh\r\n$ git clone git@github.com:zalify/easy-email.git\r\n$ cd easy-email\r\n\r\n\r\n$ pnpm install\r\n$ pnpm run install-all\r\n$ pnpm run dev\r\n\r\n```\r\n\r\n`If you need some new features, we always welcome you to submit a PR.`\r\n\r\n## License\r\n\r\nThe MIT License\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzalify%2Feasy-email-editor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzalify%2Feasy-email-editor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzalify%2Feasy-email-editor/lists"}