Skip to main content

A simple interface to use CKEditor5 with Flask

Project description

Flask-CKEditor-Manager

Flask-CKEditor-Manager (from now on FCKM) provides a simple interface to use CKEDitor5 javascript library with Flask. Greatly inspired by Flask-CKEditor

🚧 This package is under heavy development..

Installation

Install the extension with pip:

pip install flask-ckeditor-manager

Install with poetry:

poetry add flask-ckeditor-manager

Usage

Once installed the FCKM is easy to use. Let's walk through setting up a basic application. Also please note that this is a very basic guide: we will be taking shortcuts here that you should never take in a real application.

To begin we'll set up a Flask app:

from flask import Flask

app = Flask(__name__)

Setting up extension

FCM works via a CKEditorManager object. To kick things off, we'll set up the ckeditor_manager by instantiating it and telling it about our Flask app:

from flask_ckeditor import CKEditorManager

ckeditor_manager = CKEditorManager()
ckeditor_manager.init_app(app)

Load resources

Once the extension is set up, this will make available the ckeditor object into the templates context so you could load the javascript package easily, like this.

<head>
  {{ ckeditor.load() }}
</head>

Rendering the editor

Once created you can pass the Chart object to render_template and use it likewise.

<!-- ckeditor.load() must be called before this line -->
<textarea id="editor"></textarea>
<div class="my-classes">{{ ckeditor.config('editor') }}</div>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flask_ckeditor_manager-0.1.1.tar.gz (3.9 kB view hashes)

Uploaded Source

Built Distribution

flask_ckeditor_manager-0.1.1-py3-none-any.whl (4.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page