@flatfile/vuejs

中文文档
3.0.1发布于 2022/08/05MITCommonJS近 30 天下载 2679

Vue.js 平面文件适配器

中文使用文档
文档目录3 节
  1. 以 Flatfile (Vue.js) 开始
  2. 1个所需财产是:
  3. 出版

平面文件 Vue.js 组件 - @ flatfile/ vuejs

npm Minzipped Size NPM Downloads MIT License

注: 如果您从以前的版本( 0. x) 升级, v3+ 将带来一些更新并打破更改

打破变化:

注意最新版本 @flatfile/vuejs 3+ 使用新软件 @flatfile/sdk 在它下面完全改变与平面文件适配器相互作用的 API 表面 .

有关这些变化的更多信息请访问InfoFinland上的

现在只需要1个投入,即: :token (你必须从你的后端收到).

更多关于在此生成托肯语的内容


以 Flatfile (Vue.js) 开始

我们让你从Flatfile开始 用新的Flatfile组件 这是你需要知道的开始.

首先通过 npm 安装依赖性 :

npm install @flatfile/vuejs@3

这可以让你进入 <flatfile-button /> 以及和我们新的SDK相同的基本功能.

简单地将导入添加到您想要通过 Flatfile vuejs 适配器包含的组件中

import { FlatfileButton } from '@flatfile/vuejs';

export default {
  name: 'DemoComponent',
  components: {
    FlatfileButton,
  },
  // ...
}

现在在你的应用中 仅仅利用这个新的 <flatfile-button> 组件,但要确保通过所需的1个道具,(和/或任何您申请所需的可选道具).

1个所需财产是:

  • :token [你需要从后端得到]

读到这里 如何执行安全标志.

<flatfile-button :token="token">
  Upload to Flatfile!
</flatfile-button>

<script>
import { FlatfileButton } from '@flatfile/vuejs';

export default {
  name: 'App',
  components: {
    FlatfileButton,
  },
  data: () => ({
    token: 'Your_Token_You_Received_From_Your_Backend',    
  })
}
</script>

以下是一个将适配器可用的许多其他可选参数/方法传递过来的例子.

<flatfile-button 
  :token="token"
  :onInit="onInit"
  :onUpload="onUpload"
  :onLaunch="onLaunch"
  :onClose="onClose"
  :onComplete="onComplete"
  :onError="onError" 
  class="ff-button"
>
  Upload to Flatfile!
</flatfile-button>

<script>
import { FlatfileButton } from '@flatfile/vuejs';

export default {
  name: 'App',
  components: {
    FlatfileButton,
  },
  data: () => ({
    token: 'Your_Token_You_Received_From_Your_Backend',
  }),
  methods: {
    onInit: function (data) {
      console.log('onInit')
      console.log(data)
    },
    onUpload: function (data) {
      console.log('onUpload')
      console.log('data')
    },
    onLaunch: function (data) {
      console.log('onLaunch')
      console.log('data')
    },
    onClose: function (data) {
      console.log('onClose')
      console.log('data')
    },
    onComplete: function (data) {
      console.log('onComplete')
      console.log('data')
    },
    onError: function (error) {
      console.log('onError')
      console.log(error)
    },
  }
}
</script>

其他选项

也可以通过 mountUrl 财务报告和审定财务报表 apiUrl 页:1 <flatfile-button>。 。 。 .

<flatfile-button 
  :token="token"
  :mountUrl="mountUrl"
  :apiUrl="apiUrl"
>
  Upload to Flatfile!
</flatfile-button>

<script>
import { FlatfileButton } from '@flatfile/vuejs';

export default {
  name: 'App',
  components: {
    FlatfileButton,
  },
  data: () => ({
    token: 'Your_Token_You_Received_From_Your_Backend',
    mountUrl: 'mountUrl',
    apiUrl: '',
  }),
  // ... everything else
}
</script>

出版

更新更改日志(如果需要),更新软件包.json版本(semver),添加README所需的任何更新(如果需要),然后运行以下脚本:

npm run build:lib
npm publish

版本与发布记录

@flatfile/vuejs 共发布 14 个版本,首次发布于 2021/04/15;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.0.1latest2022/08/054 年前
3.0.02022/03/044 年前
0.3.62022/01/124 年前
0.3.52022/01/084 年前
0.3.42021/12/234 年前
0.3.32021/12/224 年前

关于 @flatfile/vuejs 的常见问题

@flatfile/vuejs 是什么?

Vue.js 平面文件适配器

如何安装 @flatfile/vuejs?

在项目目录运行 npm install @flatfile/vuejs,或使用 pnpm add / yarn add / bun add。

@flatfile/vuejs 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/flatfile__vuejs 是否存在。

@flatfile/vuejs 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@flatfile/vuejs 可以商用吗?

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

@flatfile/vuejs 的下载量有多少?

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

@flatfile/vuejs 还在维护吗?

最新版本 3.0.1 发布于 2022/08/05(4 年前);至今共发布 14 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/04/15。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。