sdk  by templatical

Drag-and-drop email editor for modern web applications

Created 2 months ago
290 stars

Top 90.7% on SourcePulse

GitHubView on GitHub
Project Summary

Summary

Templatical offers an open-source, drag-and-drop email editor designed for seamless integration into any web application. It empowers developers to embed sophisticated email templating capabilities, providing portable JSON templates and MJML output for universal rendering. The editor is framework-agnostic, making it a versatile solution for modern web development stacks.

How It Works

The editor uses Vue.js and TipTap internally but integrates framework-agnostically via a simple init() function. Templates are stored as portable JSON, rendered to MJML for broad email client compatibility. Shadow DOM ensures style isolation, preventing CSS conflicts with the host application.

Quick Start & Requirements

Install via npm: npm install @templatical/editor @templatical/renderer. Integration requires a single init() call. No specific hardware or non-standard software prerequisites are detailed beyond a typical web development environment. Full guides and framework examples are available online.

Highlighted Details

  • Custom Blocks: Register custom block types with API-backed data sources.
  • Merge Tags: Pluggable syntax (Handlebars, Liquid, JS) with automatic label replacement.
  • Display Conditions: Show/hide blocks based on recipient attributes with live preview.
  • Theming: Comprehensive theming via design tokens (OKLch), custom fonts, and dark mode.
  • Template Portability: JSON templates are versionable and renderable anywhere.
  • MJML Output: Ensures compatibility across all major email clients.
  • Framework Agnostic: Integrates easily into React, Vue, Svelte, Angular, or vanilla JS.

Maintenance & Community

Maintained by a solo developer; sponsorship on GitHub is encouraged to support ongoing development. Community interaction occurs via GitHub Issues and Discussions.

Licensing & Compatibility

Editor packages use FSL-1.1-MIT (converts to MIT after 2 years), permitting commercial use, self-hosting, and modification, with a restriction against repackaging as a competing editor product. Renderer and other utility packages are MIT licensed.

Limitations & Caveats

Advanced Cloud features (AI, collaboration) are under development and not included in the open-source release. The FSL license's restriction on repackaging requires careful review for specific business models.

Health Check
Last Commit

13 hours ago

Responsiveness

Inactive

Pull Requests (30d)
106
Issues (30d)
14
Star History
291 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.