# @formio/vue 中文文档

规范地址：https://npmcn.com/package/%40formio/vue/

版本：6\.3\.6
npm 元数据更新时间：2026-11-13T16:48:33.906Z
中文译文更新时间：2026-11-15T09:10:01.796Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40formio/vue
原文对照：https://npmcn.com/package/%40formio/vue/?lang=original
项目主页：https://github.com/formio/vue-formio#readme
源码仓库：https://github.com/formio/vue-formio

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：85.6 kB，17 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：vue ^3\.4\.15，@formio/js ^5\.7\.1，@formio/core ^2\.9\.1
- 首次发布：2022-03-02T14:13:43.419Z
- 最新版本发布：2026-11-13T16:48:33.704Z
- 近 30 天下载量：5853（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：30（近 12 个月 23 个）

## 中文简介

一种用于形式.io的活化器.

## 安装

```sh
npm install @formio/vue
```

也可以使用：`pnpm add @formio/vue`、`yarn add @formio/vue`、`bun add @formio/vue`

## README

# @ formio/ veue

A 类 [Vue.js (英语)](https://vuejs.org/) 提供表格的组件 [表格.io](https://www.form.io/) 平台.

## 正式文件

最新文件、发布资料和指南一律参考本文中提供的官方表格:

**[https://help.form.io (英语)](https://help.form.io/dev/javascript-development/frameworks#vue)**

## 安装

### 无

`Vue Formio` 可以在服务器上使用,或者为客户端用 npm相容包装系统,例如 [浏览器](http://browserify.org/) 或者说 [网络软件包](http://webpack.github.io/)。 。 。 .

```
npm install @formio/vue --save
```

## 基本用途

Vue 模板文件内的 HTML :

```
<template>
  <div id="app">
    <formio src="" url="" form="" submission="" options="" v-on:submit=""></formio>
  </div>
</template>
```

Vue 模板文件内部的 Javascript.

```
<script>
  import { Form } from '@formio/vue';
  export default {
      name: 'app',
      components: { formio: Form },
  }
</script>
```

## 道具

### `src` 数字 : `string`

API 源代码的表单 [表单.io](https://www.form.io/) 或者您的自定义格式服务器 .

见 [创建窗体](https://help.form.io/launch#step-2-create-a-form) 为您的窗体设置 API 路径.

您也可以通过提交url作为 `src` 表格将随划界案所载数据一起制作.

### `url` 数字 : `string`

如果您直接通过表单并提交,一些组件如资源,文件和表单需要了解表单在服务器上的url. 用url选项传过来.

### `form` 数字 : `object`

代表窗体的物体。 使用此选项代替自定义表单 .

**说明:** `src` 如果使用, 将覆盖此属性 .

### `submission`数字 : `Object`

表示窗体默认数据的对象.

**说明:** `src` 如果输入提交 url , 将覆盖此选项.

### `options`数字 : `object`

带有流经的 formeio.js 选项的对象。 见 [窗体.io 选项](https://help.form.io/dev/form-development/form-renderer#form-renderer-options)。 。 。 .

## 活动

表格引发的所有事件均可通过v-on属性获取. 见 [表.io 事件](https://help.form.io/dev/form-development/form-renderer#form-events) 为所有可用的事件.

然后在表单上 `<formio src="myform" v-on:submit="doSomething" />`

## 窗体构建器

Vue 模板文件内的 HTML :

```
<template>
  <div id="app">
    <formbuilder v-bind:form="{display: 'form'}" v-bind:options="{}" v-on:change="(schema) => console.log(schema)"></formbuilder>
  </div>
</template>
```

Vue 模板文件内部的 Javascript.

```
<script>
  import { FormBuilder } from '@formio/vue';
  export default {
      name: 'app',
      components: { FormBuilder },
  }
</script>
```

## 窗体动作

访问表单实例

```
<template>
  <div id="app">
    <formio ref="formioForm"></formio>
  </div>
</template>
```

运行方法

```
this.$refs.formioForm.formio.submit()
```

所有方法都在这里 [https://help.form.io/developers/form-renderer#form-methods (中文(简体) )](https://help.form.io/developers/form-renderer#form-methods)

## 许可证

释放 [MIT 许可证](http://www.opensource.org/licenses/MIT)。 。 。 . 触摸

## 常见问题

### @formio/vue 是什么？

一种用于形式\.io的活化器\.

### 如何安装 @formio/vue？

在项目目录运行 npm install @formio/vue，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vue（^3\.4\.15）、@formio/js（^5\.7\.1）、@formio/core（^2\.9\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @formio/vue 支持 TypeScript 吗？

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

### @formio/vue 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @formio/vue 可以商用吗？

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

### @formio/vue 的下载量有多少？

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

### @formio/vue 还在维护吗？

最新版本 6\.3\.6 发布于 2026/11/14（2 天前）；至今共发布 30 个版本，其中过去 12 个月发布了 23 个；首次发布于 2022/03/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。