@frigear-nu/forms

中文文档
0.5.0发布于 2026/11/13MITTypeScriptES Module构建来源已验证近 30 天下载 3147

Dynamic, database-stored forms (single page or stepped) with submissions, file uploads and email delivery for the frigear ecosystem.

原始使用文档

@frigear-nu/forms

Dynamic, database-stored forms for the frigear ecosystem. A form is a JSON definition (single page or stepped, with conditional fields), submissions are stored with a snapshot of the definition they were answered against, and delivery (email, webhooks, ...) hangs off the forms:submitted Nitro hook.

Captcha fields (Cloudflare Turnstile, reCAPTCHA, hCaptcha) need a site key (NUXT_PUBLIC_FORMS_CAPTCHA_<PROVIDER>_SITE_KEY) and a secret key (NUXT_FORMS_CAPTCHA_<PROVIDER>_SECRET_KEY) with <PROVIDER> one of TURNSTILE, RECAPTCHA, HCAPTCHA; NUXT_PUBLIC_FORMS_CAPTCHA_DEFAULT_PROVIDER picks the provider of a field that names none. A secret key can also be set per form in the admin builder: it is stored encrypted (AES-256-GCM, key from NUXT_FORMS_ENCRYPTION_KEY, else NUXT_ENCRYPTION_KEY, else the session password; changing the key makes stored secrets unreadable) and takes precedence over the environment one. Without any secret key submissions fail closed.

Embed a published form in Markdown (Nuxt Content / MDC) with the globally registered FormEmbed component (slug, title, locale, class; honors the form's access settings):

::form-embed{slug="contact"}
::

Full documentation: apps/docs/content/3.modules/3.features/2.forms/index.md.

export default defineNuxtConfig({
  modules: ['@frigear-nu/forms'],
  forms: {
    settings: { pages: { form: true, admin: true, adminForm: true, adminSubmissions: true, adminSubmission: true } },
  },
})
// nuxt.config.ts - who may manage forms: the `admin` role holds `forms:manage`, `forms:pii` and `forms:credentials`
// by default; give them to another role with `authorization.roles`, e.g. { formsmanager: ['forms:manage'] }
// (`forms:*` covers `forms:manage` and `forms:credentials`, never the sensitive `forms:pii`).

版本与发布记录

@frigear-nu/forms 共发布 25 个版本,首次发布于 2026/10/09;过去 12 个月发布了 25 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.5.0latest2026/11/133 天前
0.4.02026/11/123 天前
0.3.12026/11/123 天前
0.3.02026/11/123 天前
0.2.52026/11/0411 天前
0.2.42026/11/0411 天前

关于 @frigear-nu/forms 的常见问题

@frigear-nu/forms 是什么?

Dynamic, database-stored forms (single page or stepped) with submissions, file uploads and email delivery for the frigear ecosystem.

如何安装 @frigear-nu/forms?

在项目目录运行 npm install @frigear-nu/forms,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@nuxthub/core(^0.10.12)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@frigear-nu/forms 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@frigear-nu/forms 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@frigear-nu/forms 可以商用吗?

@frigear-nu/forms 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@frigear-nu/forms 的下载量有多少?

根据 npm 官方下载统计,@frigear-nu/forms 在 2026/10/16 – 2026/11/14 这 30 天内被下载 3,147 次,日均约 105 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@frigear-nu/forms 还在维护吗?

最新版本 0.5.0 发布于 2026/11/13(3 天前);至今共发布 25 个版本,其中过去 12 个月发布了 25 个;首次发布于 2026/10/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。