# @bigbinary/neeto-message-templates-frontend 中文文档 规范地址：https://npmcn.com/package/%40bigbinary/neeto-message-templates-frontend/ 版本：2\.1\.2 npm 元数据更新时间：2026-11-01T00:31:16.878Z 中文译文更新时间：2026-11-08T02:21:43.067Z 软件包许可：UNLICENSED 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40bigbinary/neeto-message-templates-frontend 原文对照：https://npmcn.com/package/%40bigbinary/neeto-message-templates-frontend/?lang=original 项目主页：https://github.com/bigbinary/neeto-message-templates-nano ## 关键信息（来自 npm 元数据） - 包体积（解压后）：1.5 MB，140 个文件 - 模块格式：ESM + CJS - TypeScript 类型：包内自带 - Node.js 要求：\>=22\.13 - 运行依赖：2 个 - peer 依赖：qs 6\.16\.2，url 0\.11\.4，yup 0\.32\.11，antd 5\.22\.1，util ^0\.12\.5，axios 1\.20\.0，ramda 0\.29\.0，react 18\.3\.1，buffer ^6\.0\.3，formik 2\.4\.6，i18next 22\.5\.1，zustand 4\.4\.2，dompurify 3\.4\.17，js-logger 1\.6\.1，react-dom 18\.3\.1，classnames 2\.5\.1，stream-http 3\.2\.0，tailwindcss ^4\.1\.17，react-helmet ^6\.1\.0，os-browserify 0\.3\.0，react-i18next 12\.3\.1，vm-browserify 1\.1\.2，@babel/runtime 7\.29\.7，react-toastify 8\.0\.2，tty-browserify 0\.0\.1，path-browserify ^1\.0\.1，https-browserify 1\.0\.0，mixpanel-browser ^2\.45\.0，react-router-dom 5\.3\.3，crypto-browserify 3\.12\.1，source-map-loader 4\.0\.1，stream-browserify ^3\.0\.0，@bigbinary/neetoui 8\.8\.3，@honeybadger-io/js 6\.10\.1，@monaco-editor/react ^4\.7\.0，@bigbinary/neeto-cist 1\.0\.17，@honeybadger-io/react 6\.1\.25，@tanstack/react-query 5\.59\.20，@bigbinary/neeto-atoms 1\.1\.2，@bigbinary/neeto-icons 1\.20\.89，@bigbinary/neeto-molecules 5\.9\.13，@tailwindcss/container-queries ^0\.1\.1，@tanstack/react-query-devtools 5\.59\.20，@bigbinary/neeto-editor-frontend 2\.4\.0，@bigbinary/neeto-commons-frontend 4\.14\.8，@bigbinary/neeto-filters-frontend 4\.6\.3，@babel/plugin-syntax-dynamic-import ^7\.8\.3 - 首次发布：2023-05-31T14:36:20.939Z - 最新版本发布：2026-11-01T00:31:16.730Z - 近 30 天下载量：5234（2026-10-08 至 2026-11-06，npm 官方下载统计） - 已发布版本数：104（近 12 个月 31 个） ## 中文简介 管理横跨neto产品的信息模板. ## 安装 ```sh npm install @bigbinary/neeto-message-templates-frontend ``` 也可以使用：`pnpm add @bigbinary/neeto-message-templates-frontend`、`yarn add @bigbinary/neeto-message-templates-frontend`、`bun add @bigbinary/neeto-message-templates-frontend` ## README # 需要电讯-腾讯-nano 这个 `neeto-message-templates-nano` 管理横跨 neto 的信件模板 产品。 目前,它支持创建短消息,电子邮件和Whatsapp 模板。 纳米出口 页:1 `@bigbinary/neeto-message-templates-frontend` 国家防范机制一揽子计划 财务报告和审定财务报表 `neeto-message-templates-engine` 铁路发展引擎. # 目录 1. [用主机应用程序开发](https://npmcn.com/package/%40bigbinary/neeto-message-templates-frontend/#readme-development-with-host-application) - [发动机](https://npmcn.com/package/%40bigbinary/neeto-message-templates-frontend/#readme-engine) - [安装](https://npmcn.com/package/%40bigbinary/neeto-message-templates-frontend/#readme-installation) - [使用量](https://npmcn.com/package/%40bigbinary/neeto-message-templates-frontend/#readme-usage) - [前端软件包](https://npmcn.com/package/%40bigbinary/neeto-message-templates-frontend/#readme-frontend-package) - [安装](https://npmcn.com/package/%40bigbinary/neeto-message-templates-frontend/#readme-installation-1) - [构成部分](https://npmcn.com/package/%40bigbinary/neeto-message-templates-frontend/#readme-components) 2. [出版指令](https://npmcn.com/package/%40bigbinary/neeto-message-templates-frontend/#readme-instructions-for-publishing) # 用主机应用程序开发 ## 发动机 该引擎用于管理横跨neto产品的信息模板. ### 安装 1. 将此行添加到您的应用程序的 Gemfile 中 : ```ruby source "NEETO_GEM_SERVER_URL" do # ..existing gems gem 'neeto-message-templates-engine' end ``` 2. 然后执行: ```zsh bundle install ``` 3. 将此行添加到您的应用程序 `config/routes.rb` 文件 : ```ruby mount NeetoMessageTemplatesEngine::Engine, at: "/neeto_message_templates" ``` 4. 运行以下命令以复制从引擎到主机的迁移 应用程序 : ```zsh bundle exec rails neeto_message_templates_engine:install:migrations ``` 5. 添加迁移到数据库 : ```zsh bundle exec rails db:migrate ``` 6. 创建文件 `neeto-message-templates.rb` 下级 `config/initializers` 改为 提供 `owner_class` 资料 ```ruby NeetoFormEngine.owner_class = "Organization" ``` 7. 添加权限 `neeto_message_templates_engine.manage_message_templates` 给您的 `permissions.yml` 文档. 8. 在主机应用程序中配置所有者模式 . ```ruby has_many :message_templates, as: :owner, class_name: "NeetoMessageTemplatesEngine::MessageTemplate", dependent: :destroy ``` ### 使用量 您可以在此了解更多关于用法: 1. [模型](https://npmcn.com/docs/engine/models.md) ## 前端软件包 ### 安装 1. 安装最新的 `neeto-message-templates-nano` 使用下列软件包 命令 : ```zsh yarn add @bigbinary/neeto-message-templates-frontend ``` ### 发展指示 检查 [前端软件包开发指南](https://neeto-engineering.neetokb.com/p/a-d34cb4b0) 用于开发前端软件包的分步指令. ### 构成部分 #### `MessageTemplates` (单位:千美元)[源代码](https://github.com/bigbinary/neeto-message-templates-nano/blob/80a73223e8facf21a0135675d4dc837645d0f2b0/app/javascript/src/components/MessageTemplates/index.jsx)(中文(简体) ) 此组件用于管理您网络应用程序中的消息模板 。 这个 为查看、添加和编辑模板提供方便用户的界面, 以及过滤和搜索能力. ##### 道具 - `shouldIncludeTestTemplate`: 显示测试消息的布尔 应包含模板选项. - `handleSubmitTestTemplate`: 主机应用程序中负责的函数 提交值以发送电子邮件和短消息的测试模板. - `isTestMessageLoading`: 显示测试模板是否处理的布尔 提交处于装入状态. - `type`: 代表信件类型, 包含 `email`, (中文(简体) ), `sms`,或 `whatsapp`。 。 。 . ##### 可选道具 - `templateVariables`: (可选) 以添加动态变量来形成正体字段. - `ownerId`: (可选) 提供 `ID` 如果不是拥有者 组织模式. 如果拥有者是一个组织,这个道具可以留给它 不详. - `breadcrumbs`: 指定用于导航的面包屑的一系列物体. - `isTestingTemplateDisabled`: 显示测试模板的布尔 按钮应启用与否. - `manageTemplatesPaneCustomFields`: 在管理器中添加自定义组件 模板窗格 . - `customFieldsBelowBody`: 在管理模板中添加自定义字段组件 将它置于身体之下. - `customFieldsInitialValues`: 为自定义字段提供初始值. - `customFieldsValidationSchema`: 为定制提供验证计划 字段. - `onMutationSuccess`: 成功时触发的回调功能 的变异函数(创建、更新和删除). - `paneSize`:确定窗格的大小。 默认为 `"large"`. 接受 值为 `"small"`, (中文(简体) ), `"large"`,或 `"extraLarge"`。 。 。 . - `helpPopoverProps`: 为组件添加帮助 popover 。 参考 [帮助Popover 组件 doc](https://neeto-molecules.neeto.com/?path=/docs/helppopover--docs)。 。 。 . 注: `href` 从 `helpLinkProps` 用于显示帮助文件 链接在 `NoData` 组件。 标题将用作帮助弹出 如果没有提供标题. - `allowAddingImagesToEmailTemplate`: 一个布尔表示图像可以是 添加到邮件模板信件正文中 . ##### 使用量 ```jsx import React from "react"; import { MessageTemplates } from "@bigbinary/neeto-message-templates-frontend"; const App = () => { const queryClient = useQueryClient(); const breadcrumbs = [ { link: "/settings", text: "Settings", }, ]; const handleSubmit = () => { //api call }; const TEMPLATE_VARIABLES = [ { key: "name", label: "Name", }, ]; const customFieldsBelowBody = () => ( This will render below body ); const manageTemplatesPaneCustomFields = () => ( Twilio integration is required for sending SMS. Please connect your Twilio account. ); return ( queryClient.invalidateQueries({ queryKey: ["rules"], }) } /> ); }; ``` #### `SendMessagePane` (单位:千美元)[源代码](https://github.com/bigbinary/neeto-message-templates-nano/blob/80a73223e8facf21a0135675d4dc837645d0f2b0/app/javascript/src/components/SendMessagePane/index.jsx)(中文(简体) ) 此组件提供了一个窗格, 用户可以选择模板并添加内容 来撰写和发送消息. ##### 道具 - `isOpen`: 一个布尔决定边窗帘是否打开. - `onClose`: 关闭时执行的函数. - `handleSubmit`:主机应用程序内用于发送短消息和电子邮件的功能. - `type`: 代表信件类型, 包含 `email`, (中文(简体) ), `sms`,或 `whatsapp`。 。 。 . - `paneSize`:确定窗格的大小。 默认为 `"large"`. 接受 值为 `"small"`, (中文(简体) ), `"large"`,或 `"extraLarge"`。 。 。 . ##### 可选道具 - `customFields`:将自定义字段组件添加到窗格中. - `customFieldsBelowBody`: 将自定义字段组件添加到窗格并制作 它的下方的躯体在 `EmailAndSms`。 。 。 . - `customFieldsInitialValues`: 为自定义字段提供初始值. - `customFieldsValidationSchema`: 为定制提供验证计划 字段. - `templateVariables`: 要添加动态变量以形成体域. - `ownerId`:提供 `ID` 如果不是组织,则由所有者承担 型号。 如果所有者是一个组织,则此道具可以留作未加说明. - `isSaveAsTemplateEnabled` - 允许用户保存当前内容 消息作为新模板. - `canManageTemplates` - 当这被设定为虚假, `save as template` 选项 将不会显示给用户 . - `helpPopoverProps`: 要显示的道具 `HelpPopover` 输入字段旁边 `EmailAndSms`。 。 。 . - `allowAddingImagesToEmail`: 显示是否可以添加图像的布尔 到邮件信件正文. ##### 使用量 ```jsx import React, { useState } from "react"; import { SendMessagePane } from "@bigbinary/neeto-message-templates-frontend"; import { EMAIL_SUBJECT_HELP_DOC_URL, SMS_TEMPLATE_HELP_DOC_URL } const App = () => { const [isPaneOpen, setIsPaneOpen] = useState(false); const handleSubmit = () => { //api call }; const customFields = () => (
); const customFieldsBelowBody = () => (
); const customFieldsInitialValues = { to: "", from: "", cc: "", bcc: "", replyTo: "", }; const customFieldsSchema = yup.object().shape({ to: yup.string().trim().required("To address is required").email("invalid"), from: yup .string() .trim() .required("From address is required") .email("invalid"), cc: yup.string().trim().email("Invalid email"), bcc: yup.string().trim().email("Invalid email"), replyTo: yup.string().trim().email("Invalid email"), }); const helpPopoverProps = { email: { subject: { helpIconProps: { popoverProps: { title: "subject", helpLinkProps: { href: EMAIL_SUBJECT_HELP_DOC_URL, label: t("View help article"), }, }, }, }, }, sms: { template: { helpIconProps: { popoverProps: { title: "SMS Templates", helpLinkProps: { href: SMS_TEMPLATE_HELP_DOC_URL, label: t("View help article"), }, }, }, }, }, }; return ( setIsPaneOpen(false)} customFields={customFields()} customFieldsBelowBody={customFieldsBelowBody()} customFieldsInitialValues={customFieldsInitialValues} customFieldsValidationSchema={customFieldsSchema} helpPopoverProps={helpPopoverProps} /> ); }; ``` #### ApiTemplates (英语:[源代码](https://github.com/bigbinary/neeto-message-templates-nano/blob/main/app/javascript/src/components/Api/ApiTemplates/index.jsx)(中文(简体) ) 此组件用于管理应用程序中的 API 模板 。 这个 提供添加、删除和编辑 API 模板的界面,同时提供 过滤和搜索能力. ##### 道具 - `ownerId`:提供 `ID` aPI 模板所属所有者 改为:. ##### 可选道具 - `breadcrumbs`: 指定用于导航的面包屑的一系列物体. - `onMutationSuccess`: 成功时触发的回调功能 的变异函数(创建、更新和删除). - `initialPayload`:指定主体作为对象的初始值. - `templateVariables`:将动态变量添加到体域. - `paneSize`:确定窗格的大小。 默认为 `"large"`. 接受 值为 `"small"`, (中文(简体) ), `"large"`,或 `"extraLarge"`。 。 。 . - `helpPopoverProps` - 给各行各业增加帮助弹出器. - **页眉**: 在下面定义弹出道具 `apiTemplates`说明: `href` 从 `helpLinkProps` 将用来在 `NoData` 组件。 如果没有标题, 标题将用作帮助弹出标题 提供. - **自定义信头**: 在下面定义弹出道具 `customHeaders`。 。 。 . - **体质**: 在下面定义弹出道具 `body`。 。 。 . 以更详之. 详情请参见: [帮助Popover 组件文档](https://neeto-molecules.neeto.com/?path=/docs/helppopover--docs)。 。 。 . ##### 使用量 ```js import React from "react"; import { ApiTemplates } from "neetomessagetemplates"; const App = () => { const queryClient = useQueryClient(); const breadcrumbs = [{ link: "/settings", text: "Settings" }]; const ownerId = "ownerId"; const HELP_POPOVER_PROPS = { apiTemplates: { title: "Title for the popover displayed in header", description: "Description for the popover displayed in header.", helpLinkProps: { href: SEND_TO_API_HELP_DOC_URL }, }, customHeaders: { title: "Title for custom headers popover", description: "Description for custom headers popover.", helpLinkProps: { href: CUSTOM_HEADERS_HELP_DOC_URL }, }, body: { title: "Title for API payload popover", description: "Description for API payload popover.", helpLinkProps: { href: API_PAYLOAD_HELP_DOC_URL }, }, }; TEMPLATE_VARIABLES = [ { label: t("form.allAnswers"), key: "all-answers" }, { label: t("common.formName"), key: "form-name" }, ]; return ( queryClient.invalidateQueries({ queryKey: ["rules"] }) } /> ); }; ``` #### 发送 ApiPane ([源代码](https://github.com/bigbinary/neeto-message-templates-nano/blob/main/app/javascript/src/components/Api/SendToApiPane/index.jsx)(中文(简体) ) 此组件提供了一个窗格,用户可以选择 API 模板并修改 如果需要,则将其发送到指定的HTTP(S)端点. ##### 道具 - `ownerId`: 一个布尔决定边窗帘是否打开. - `onClose`: 关闭窗格时会执行此函数. - `onSubmit`: 此函数将在提交窗体时执行. - `isSubmitting`: 布尔以了解表单提交状态 - `canManageTemplates` - 当这被设定为虚假, `save as template` 选项 将不会显示给用户 . - `templateVariables`:将动态变量添加到体域. - `paneSize`:确定窗格的大小。 默认为 `"large"`. 接受 值为 `"small"`, (中文(简体) ), `"large"`,或 `"extraLarge"`。 。 。 . - `helpPopoverProps` - 加入帮助弹出器 在窗帘的各个部分. - **字段标题**: 在下面定义弹出道具 `sendToApi`。 。 。 . - **自定义信头**: 在下面定义弹出道具 `customHeaders`。 。 。 . - **体质**: 在下面定义弹出道具 `body`。 。 。 . 以更详之. 详情请参见: [帮助Popover 组件文档](https://neeto-molecules.neeto.com/?path=/docs/helppopover--docs)。 。 。 . ##### 使用量 ```js import React, { useState } from "react"; import { SendToApiPane } from "@bigbinary/neeto-message-templates-frontend"; const App = () => { const [isSubmitting, setIsSubmitting] = useState(false); const [isSendToApiPaneOpen, setIsSendToApiPaneOpen] = useState(false); const ownerId = "ownerId"; const HELP_POPOVER_PROPS = { sendToApi: { title: "Title for send to API popover", description: "Description for send to API popover.", helpLinkProps: { href: SEND_TO_API_HELP_DOC_URL }, }, customHeaders: { title: "Title for custom headers popover", description: "Description for custom headers popover.", helpLinkProps: { href: CUSTOM_HEADERS_HELP_DOC_URL }, }, body: { title: "Title for API payload popover", description: "Description for API payload popover.", helpLinkProps: { href: API_PAYLOAD_HELP_DOC_URL }, }, }; TEMPLATE_VARIABLES = [ { label: t("form.allAnswers"), key: "all-answers" }, { label: t("common.formName"), key: "form-name" }, ]; const handleSubmit = () => { setIsSubmitting(true); // API call setIsSubmitting(false); }; return ( setIsSendToApiPaneOpen(false)} onSubmit={handleSubmit} helpPopoverProps={HELP_POPOVER_PROPS} templateVariables={TEMPLATE_VARIABLES} /> ); }; ``` # 出版指令 咨询 [构建和释放软件包](https://neeto-engineering.neetokb.com/articles/building-and-releasing-packages) 关于如何出版的详细指南. ## 常见问题 ### @bigbinary/neeto-message-templates-frontend 是什么？ 管理横跨neto产品的信息模板\. ### 如何安装 @bigbinary/neeto-message-templates-frontend？ 在项目目录运行 npm install @bigbinary/neeto-message-templates-frontend，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：qs（6\.16\.2）、url（0\.11\.4）、yup（0\.32\.11）、antd（5\.22\.1）、util（^0\.12\.5）、axios（1\.20\.0）、ramda（0\.29\.0）、react（18\.3\.1）、buffer（^6\.0\.3）、formik（2\.4\.6）、i18next（22\.5\.1）、zustand（4\.4\.2）、dompurify（3\.4\.17）、js-logger（1\.6\.1）、react-dom（18\.3\.1）、classnames（2\.5\.1）、stream-http（3\.2\.0）、tailwindcss（^4\.1\.17）、react-helmet（^6\.1\.0）、os-browserify（0\.3\.0）、react-i18next（12\.3\.1）、vm-browserify（1\.1\.2）、@babel/runtime（7\.29\.7）、react-toastify（8\.0\.2）、tty-browserify（0\.0\.1）、path-browserify（^1\.0\.1）、https-browserify（1\.0\.0）、mixpanel-browser（^2\.45\.0）、react-router-dom（5\.3\.3）、crypto-browserify（3\.12\.1）、source-map-loader（4\.0\.1）、stream-browserify（^3\.0\.0）、@bigbinary/neetoui（8\.8\.3）、@honeybadger-io/js（6\.10\.1）、@monaco-editor/react（^4\.7\.0）、@bigbinary/neeto-cist（1\.0\.17）、@honeybadger-io/react（6\.1\.25）、@tanstack/react-query（5\.59\.20）、@bigbinary/neeto-atoms（1\.1\.2）、@bigbinary/neeto-icons（1\.20\.89）、@bigbinary/neeto-molecules（5\.9\.13）、@tailwindcss/container-queries（^0\.1\.1）、@tanstack/react-query-devtools（5\.59\.20）、@bigbinary/neeto-editor-frontend（2\.4\.0）、@bigbinary/neeto-commons-frontend（4\.14\.8）、@bigbinary/neeto-filters-frontend（4\.6\.3）、@babel/plugin-syntax-dynamic-import（^7\.8\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。 ### @bigbinary/neeto-message-templates-frontend 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @bigbinary/neeto-message-templates-frontend 支持 ESM 还是 CommonJS？ 同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。 ### @bigbinary/neeto-message-templates-frontend 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=22\.13。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @bigbinary/neeto-message-templates-frontend 可以商用吗？ @bigbinary/neeto-message-templates-frontend 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。 ### @bigbinary/neeto-message-templates-frontend 的下载量有多少？ 根据 npm 官方下载统计，@bigbinary/neeto-message-templates-frontend 在 2026/10/08 – 2026/11/06 这 30 天内被下载 5,234 次，日均约 174 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @bigbinary/neeto-message-templates-frontend 还在维护吗？ 最新版本 2\.1\.2 发布于 2026/11/01（7 天前）；至今共发布 104 个版本，其中过去 12 个月发布了 31 个；首次发布于 2023/05/31。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。