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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flask_ckeditor_manager-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53b2381e681b4ad94e09d63645e62acb5a4e7cb9e79934b47837e4f144fd323e |
|
MD5 | c66c22d384db49a476f4f254b39604dd |
|
BLAKE2b-256 | 4694da6609a4c6a4b526a5a9e2af53bcd698ada40c6b6c9695700d78dbd6f1f0 |
Hashes for flask_ckeditor_manager-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11aa8c4e296157843daa7b9b6933c261e04b6b7b4e83043db20537c848ddbfee |
|
MD5 | 5c22d97f9e18e84f99dbb2083666806b |
|
BLAKE2b-256 | 99be4d353601aeea94fbeccd3fd8a53f6eeefe38cfebd9c630f644381808262c |