Filestack Rails 插件使用教程

Filestack Rails 插件使用教程

1. 项目介绍

Filestack Rails 是一个官方的 Ruby on Rails 插件，旨在为 Web 或移动应用程序添加强大的文件上传和转换功能。该插件基于 Filestack 的文件选择器（File Picker），支持多文件上传、云存储集成、文件转换等功能。通过简单的配置和集成，开发者可以快速将这些功能添加到 Rails 应用中。

2. 项目快速启动

2.1 安装

首先，在 Rails 应用的 Gemfile 中添加以下行：

gem 'filestack-rails'

然后执行以下命令安装 gem：

bundle install

2.2 配置

在 config/application.rb 文件中设置 Filestack API 密钥和客户端名称：

config.filestack_rails.api_key = 'Your Filestack API Key'
config.filestack_rails.client_name = 'custom_client_name'

2.3 添加文件选择器

在应用的布局文件中添加 Filestack 文件选择器和初始化脚本：

<%= filestack_js_include_tag %>
<%= filestack_js_init_tag %>

请确保这些脚本在应用的自定义脚本之前添加。

2.4 使用文件选择器

在视图中添加一个文件上传按钮：

<%= filestack_picker_element 'Upload File', 'callbackForButton', id: 'someuniqueid', input_id: 'someuniqueinputid', pickerOptions: ['fromSources': 'facebook', 'maxFiles': 50] %>

3. 应用案例和最佳实践

3.1 文件上传表单

使用 filestack_field 助手方法创建一个文件上传表单：

<%= form_for @user do |f| %>
  <div>
    <%= f.filestack_field :filepicker_url, 'Upload Your Avatar', pickerOptions: ['fromSources': 'facebook'], id: 'unique-id', input_id: 'unique-input-id' %>
  </div>
  <%= f.submit %>
<% end %>

3.2 图像转换

使用 filestack_image 标签显示带有转换功能的图像：

<%= filestack_image @user.filepicker_url, transform: { resize: { width: 100, height: 100 } } %>

4. 典型生态项目

Filestack Rails 插件通常与其他 Filestack 生态项目一起使用，例如：

• Filestack API: 提供文件上传、存储和转换的核心服务。
• Filestack Ruby SDK: 为 Ruby 开发者提供与 Filestack API 交互的接口。
• Filestack JavaScript SDK: 提供前端文件选择器和图像处理功能。

通过这些项目的协同使用，开发者可以构建功能强大的文件管理和处理系统。