Skip to content

Ruby Image Manager

How it works

  1. You specify the image load options when the javascript editor is initialized on client side.
  2. When the Image Manger modal is displayed, the javascript editor makes a request to the server to load the images.
  3. Once the request hits the server, it returns the list with the images to display in the rich text editor.
  4. The javascript editor processes the response of the server and renders the images in its interface.

Jump to Complete Example

Initialize the javascript editor

To get started, the javascript editor needs to have the imageManagerLoadURL and imageManagerDeleteURL options so that it can interact with your server to load or delete the images listed inside the Image Manager tool. Additionally, you can set other options related to the interaction between your server and the rich text editor: imageManagerLoadMethod, imageManagerLoadParams, imageManagerPreloader, imageManagerDeleteParams.

<script>
  new FroalaEditor('.selector', {
    // Set the image upload URL.
    imageManagerLoadURL: '/load_images',

    // Set the image delete URL.
    imageManagerDeleteURL: '/delete_image'
  })
</script>

Receive the load request

The server implementation is responsible for receiving the request and handling it appropriately. The WYSIWYG editor's Ruby SDK comes with the possibility to load all the images inside a specified folder using the FroalaEditorSDK::Image.load_images method.

Note: The path of the folder from where the images are being loaded is relative to the Rails.root global variable.

FroalaEditorSDK::Image.load_images("public/uploads/images/")

Receive the delete request

Your server should listen for any delete request and process it accordingly. Using the code from the Editor Initialization step, makes the image path available in the params[:src] variable. The FroalaEditorSDK::Image.delete() method from the Ruby SDK is expecting the path of the image to remove from disk.

FroalaEditorSDK::Image.delete(params[:src], "public/uploads/images/")

Complete Example

<script>
  new FroalaEditor('.selector', {
    // Set the image upload URL.
    imageManagerLoadURL: '/load_images',

    // Set the image delete URL.
    imageManagerDeleteURL: '/delete_image'
  })
</script>
class UploadController < ActionController::Base

  ...

  def load_images
    render :json => FroalaEditorSDK::Image.load_images("public/uploads/images/")
  end

  ...

end
class UploadController < ActionController::Base

  ...

  def delete_image
    render :json => FroalaEditorSDK::Image.delete(params[:src], "public/uploads/images/")
  end

  ...

end

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