Days
Hours
Minutes
Seconds
x

Froala Editor v4.2.0 is Here LEARN MORE

Skip to content

Ruby File Server Upload

How it works

  1. Specify upload options when initializing the editor.
  2. On file insertion, the editor automatically makes an AJAX request to the server.
  3. Once the request reaches the server, it stores the file and sends back to the client the link to the uploaded file.

Jump to Complete Example

Initialize the editor

First, set the fileUploadURL option and specify the URL destination for the uploaded files.

Next, set any additional options to configure upload methods and allowed file types: fileUploadParam, fileUploadParams, fileUploadMethod, fileMaxSize, fileAllowedTypes.

<script>
  new FroalaEditor('.selector', {
    // Set the file upload URL.
    fileUploadURL: '/upload_file'
  })
</script>

Receive the uploaded file and store it

The server implementation is responsible for receiving the request and handling it appropriately. In Ruby, the uploaded file is available in the params global variable. The Ruby editor SDK detects the uploaded file automatically but you have to specify the path where to store it.

Note: The path of the file is relative to the Rails.root global variable.

FroalaEditorSDK::File.upload(params)

To store the uploaded file, the server needs write rights on the uploads folder. Additionally, check uploaded files are publicly accessible in the browser.

Return the path to the uploaded file

If the save action is successful, the SDK generates a FileResponse object with the absolute path to the uploaded file, and the server returns the path to the client side.

render :json => FroalaEditorSDK::File.upload(params)

Complete Example

<script>
  new FroalaEditor('.selector', {
    // Set the file upload URL.
    fileUploadURL: '/upload_file'
  })
</script>
class UploadController < ActionController::Base

  ...

  def upload_file
    render :json => FroalaEditorSDK::File.upload(params)
  end

  ...

end

Do you think we can improve this article? Let us know.

Ready to dive in? Explore our plans