mirror of https://github.com/resend/react-email.git synced 2026-09-14 14:18:02 +08:00

Files

T

History

resend-version-bump[bot] 71656573fa chore(root): version packages (#3657 )

Co-authored-by: resend-version-bump[bot] <277115511+resend-version-bump[bot]@users.noreply.github.com>

2026-07-15 17:41:59 -03:00

scripts

feat(editor): experimental editor (#3130 )

2026-03-27 16:02:53 -03:00

src

fix: zeroed composed body margins (#3653 )

2026-07-14 14:59:10 +01:00

CHANGELOG.md

chore(root): version packages (#3657 )

2026-07-15 17:41:59 -03:00

license.md

feat(editor): experimental editor (#3130 )

2026-03-27 16:02:53 -03:00

package.json

chore(root): version packages (#3657 )

2026-07-15 17:41:59 -03:00

postcss-import.d.ts

feat(editor): experimental editor (#3130 )

2026-03-27 16:02:53 -03:00

readme.md

fix: remaining references to @react-email/components (#3392 )

2026-04-17 17:32:37 -03:00

tsconfig.json

feat(editor): experimental editor (#3130 )

2026-03-27 16:02:53 -03:00

tsdown.config.ts

chore: update overrides, ensure mintlify-related ones are scoped (#3320 )

2026-04-16 13:15:11 -03:00

vitest.config.ts

fix(editor): reliability for focus scope handling (#3431 )

2026-04-28 10:47:34 -03:00

readme.md

@react-email/editor

A rich text editor for editing and building email templates, built on top of Tiptap and React Email.

Structure

packages/editor/src/
├── core/               # Editor core: hooks, serializer, event bus, types
├── extensions/         # Tiptap extensions for email elements (button, heading, columns, etc.)
├── plugins/            # ProseMirror plugins
├── ui/                 # UI components (bubble menus, slash command, inspector)
├── utils/              # Shared utilities
└── email-editor/       # Main editor component

Entry Points

The package exposes multiple entry points for granular imports:

@react-email/editor — Main editor component and top-level API
@react-email/editor/core — Serializer, types, and event bus
@react-email/editor/extensions — Tiptap extensions for all supported email elements
@react-email/editor/ui — UI components (bubble menus, slash command, inspector)
@react-email/editor/plugins — ProseMirror plugins
@react-email/editor/utils — Shared utilities

Installation

npm install @react-email/editor

Development

# Build the package
pnpm build

# Run type checking
pnpm typecheck

# Run all tests
pnpm test

# Run unit tests only
pnpm test:unit

# Run browser tests only
pnpm test:browser

# Watch mode for tests
pnpm test:watch

Documentation

For full usage guide and API reference, see the Editor documentation.

License

MIT