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
Configuration
This are some of the settings available
Config | Description | Type | Default |
---|---|---|---|
CKEDITOR_LICENSE_KEY | CKEditor License key | str | None |
CKEDITOR_EDITOR_TYPE | Editor package to be displayed | str | "classic" |
CKEDITOR_LOCAL_PATH | If custom package is present, this is the path in the static folder. | str | None |
CKEDITOR_LANGUAGE | The lengague of the editor. | str | None |
CKEDITOR_ENABLE_CSRF | Enable CSRF protection in SimpleUpload adapter | bool | None |
CKEDITOR_UPLOAD_ENDPOINT | SimpleUpload adapter endpoint. Must follow the CKEditor5 estipulations. Read more | str | None |
CKEDITOR_WATCHDOG | If watchdog plugin installed change this value to True to enable its rendering | bool | None |
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.31.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c229d61d7be70f01c714b8bbd31727d75e0fe9ef7acdde1cc0b0a87aa0a0a3e |
|
MD5 | 3ec7caa950ffeafa482f276e5aa453d9 |
|
BLAKE2b-256 | b85228f568a4825ed902ff0afb10393553de2fde92cc624818067095585f9c10 |
Hashes for flask_ckeditor_manager-0.1.31-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9136f12e42f7c1f5ebcfb88cf1f8161bd615a998243b615a329194c94a491f36 |
|
MD5 | 3d64b99900fce941b8cc943949d6d4e6 |
|
BLAKE2b-256 | 6ec178a6a63cd6c02c595dde14358bbcf8cd54085b26fe69e8480ad98d45f801 |