npm 包 inky-email-render-to-string 使用教程

阅读时长 7 分钟读完

前言:

在进行邮件开发时,我们经常需要使用 html 行内样式来渲染邮件,然而在实际开发中,我们会发现使用 html 行内样式来进行邮件开发相对来说比较繁琐和复杂,而且也很难保证渲染的效果一定是一致的。因此,本文介绍了使用 npm 包 inky-email-render-to-string 来实现邮件开发。

1. 什么是 inky-email-render-to-string

inky-email-render-to-string 是一个 npm 包,用于将 inky 模板编译成 HTML 字符串。它使用了 Foundation for Emails 标记语言 inky,为邮件开发提供了快速、简单和灵活的解决方案。

2. 如何安装

使用 npm 包管理器在本地安装该包:

3. 如何使用

首先,在项目中定义模板,模板使用 inky 语言编写。在模板中可以添加 html 标签,这些标签可以很好的适应不同的设备:

其次,在项目中调用该 npm 包:

其中,templateString 是指编写好的 inky 模板。 optionsObject 是一个对象,包含了 inky 的配置项。

例如:

在代码中使用变量:

最终,用户在收到邮件时,邮件将会带有渲染完成的 html 字符串。

4. 示例代码

下面是一个基本的 inky 模板:

-- -------------------- ---- -------
--------- -----
------
  ------
    ----- --------------- ---------------------------- -----------------
    ------- ---------
    -------
    ---- -
      ----------- --------
    -
    --------
  -------
  ------
    -----------
      ---- ---------------
        -------- -----------
          ---- --------------------------------- ----------- ------------ -------
        ----------
      ------

      -----
        -------- -----------
          ----------------
          ------- -- ---- -------
          ---------- -- --- ------------
        ----------
      ------

      ---- ---------------
        -------- -----------
          --------- --- ---- --------------
        ----------
      ------
    ------------
  -------
-------

在 Node.js 中使用 inky-email-render-to-string 进行模板渲染:

-- -------------------- ---- -------
----- ---- - ---------------------------------------

----- -------- - -
  -----------
    -----
      -------- -------------------- --- ---- ------------------
    ------
  ------------
--

----- ------- - -
  ------- -
    ----- ------------------------------
  --
--

----- ---- - -------------- ---------
------------------

上述代码编译出的 HTML:

-- -------------------- ---- -------
------ -------------- ---------------- ------------- -------------- - ----- ----------- ------------- ----------------------------

  ------ ----------- ----------------------- --------- ------------- ------ ----------- ------------- --------------------------- --------------------- -------------- ------- ------ ------------- -------- ------------ ---------- ------ ----------- ------------ ------- ------------- ----------------- -- ----------- ----- ------------ ---------------- ----- ------- - ----- ------- - ----- ---------- ------ ------ ------ -------------
      ---- -------------- ------------- ----- ------ ----- -------------- --------------- -- ----------- -------
      ------ -------------- ----------------------- --------- ------------- ------ --------------- ---- ------- ---------- ------ --------------------------- --------------- -- ------- --- -------------
      --------------------------
      --- ------------- -------- ------------ ---------- ------ ----------- ------------ ------- ---------- ----- -------------- ----- --------------- ----- ------------ ---- ----------- -- -------------- ----- --------------- -- ----------- -------------------------- ---- -------
      ------
    -----
  ---------------------

--------------------------

最终,我们可以在邮件开发中使用 inky-email-render-to-string 进行邮件的渲染,从而得到性能更好、更容易维护的代码。

5. 总结

inky-email-render-to-string 是一个非常实用的 npm 包,对于邮件开发来说,能够大大提高开发效率和渲染效果。本文介绍了其使用方法,并提供了基本示例。希望对于正在进行邮件开发的同学们有所帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005549281e8991b448d1d51

纠错
反馈