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>
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.2.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 56bbe12a596b6ac4fa814a40f822064b4a3246a8cccd869e63d9bd88acdea667 |
|
| MD5 | e91886abffbfddcec0c33f08590219f2 |
|
| BLAKE2b-256 | b759b129f284bde0911dbc8a64fe72de4224009333bd27d5c05cd99e8550839d |
Hashes for flask_ckeditor_manager-0.1.2-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 621864131646d0b97a83b465ed5439ba0d708366f16118adfd1350f8e674a406 |
|
| MD5 | 06157b58d7d68479a18ffd00b2bb2c75 |
|
| BLAKE2b-256 | 50705d3dd76fdc58ff6cf1d4ef1bcf8bdcb13db0f2a0b188b2a59e75130c4d23 |
