flask-ckeditor's Introduction

Flask-CKEditor

a flask module for CKEditor integration

Flask-CKEditor Demo

demo => http://115.28.152.113:520/appDemo/

code => https://github.com/neo1218/flask-ckeditor-demo

### Install

$ pip install flaskckeditor

Situation 1: Basic Usage

Step1: Clone the CKEditor I Have Configured and Put it Under Static Folder

Step2: Writing Forms(In Flask-WTF Case)

from flask_wtf import Form
from wtforms import TextAreaField, SubmitField, StringField

class CKEditorForm(Form):
    title =  StringField()
    ckdemo = TextAreaField()
    submit = SubmitField('submit')

Step3: Replace the Form to CKEditor

<script src="/static/ckeditor/ckeditor.js" type="text/javascript"></script>

<form method="POST">
    {{ form.hidden_tag() }}
    {{ form.title }}
    {{ form.ckdemo(class='ckeditor') }}
    {{ form.submit }}
</form>

Situation 2: Open (file/img)Upload Interface

Step1: Upload Class Inheritance

from flask_wtf import Form
from wtforms import TextAreaField, SubmitField, StringField
from flaskckeditor import CKEditor

class CKEditorForm(Form, CKEditor):
    title =  StringField()
    ckdemo = TextAreaField()
    submit = SubmitField('submit')

Step2: Write Upload View Function

from "forms_module" import CKEditorForm

@app.route("/ckupload/")
def ckupload():
    form = CKEditorForm()
    res = form.upload(endpoint=app)
    return res

Situation 3: Use Blueprint

You need to pay attention to the following points:
1.Blueprint static_folder property should be the absolute path leading to the static folder

blue = Blueprint(
    'blue',
    __name__,
    static_folder = '/abspath/to/static/'
)

2.Endpoint parameter of upload function should be the blueprint name

from "forms_module" import CKEditorForm

@blue.route("/ckupload/")
def ckupload():
    form = CKEditorForm()
    res = form.upload(endpoint=blue)
    return res