Skip to content

Python 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 Python SDK comes with the possibility to load all the images inside a specified folder using the Image.list method.

Note: The path of the folder from where the images are being loaded is relative to the root of your application.

response = Image.list('/public/')

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 body of the request. The Image.delete method from the Python SDK is expecting the path of the image to remove from disk.

Image.delete(src)

Complete Example

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

    // Set the image delete URL.
    imageManagerDeleteURL: '/delete_image'
  })
</script>
# Django
from django.http import HttpResponse
import json
from froala_editor import Image

def load_images(request):
  try:
    response = Image.list('/public/')
  except Exception:
    response = {'error': str(sys.exc_info()[1])}
  return HttpResponse(json.dumps(response), content_type="application/json")

def delete_image(request):
  src = request.POST.get('src', '')
  try:
    Image.delete(src)
    return HttpResponse('ok', content_type="application/json")
  except:
    raise Exception('Could not delete image')
# Flask
from flask import request
import json
from froala_editor import Image

@app.route('/load_images')
def load_images():
  try:
    response = Image.list('/public/')
  except Exception:
    response = {'error': str(sys.exc_info()[1])}
  return json.dumps(response)

@app.route('/delete_image', methods=['POST'])
def delete_file():
  src = request.form.get('src')
  try:
    Image.delete(src)
    return json.dumps('ok')
  except:
    raise Exception('Could not delete file')
# Pyramid
from pyramid.response import Response
import json
from froala_editor import Image

def load_images(request):
  try:
    response = Image.list('/public/')
  except Exception:
    response = {'error': str(sys.exc_info()[1])}
  return Response(json.dumps(response))

def delete_image(request):
  src = request.POST.get('src')
  try:
    Image.delete(src)
    return Response(json.dumps('ok'))
  except:
    raise Exception('Could not delete image')