Django form widget library for using CodeMirror on Textarea.
Installation
pip install django-codemirror-widgetUsage
First, you need to specified CODEMIRROR_PATH on settings.py. CODEMIRROR_PATH is the URI of CodeMirror directory like CODEMIRROR_PATH = r"javascript/codemirror". If you don’t specify it, it defaults to 'codemirror'. CodeMirror should be put there.
Use codemirror.CodeMirrorTextarea widget for target Textarea like below:
from django import forms from codemirror import CodeMirrorTextarea codemirror_widget = CodeMirrorTextarea( mode="python", theme="cobalt", config={ 'fixedGutter': True }, ) document = forms.TextField(widget=codemirror_widget)
Settings
Use the followings in your settings.py.
CODEMIRROR_PATH
The URI of CodeMirror directory (your CodeMirror installation should live in {{ STATIC_URL }}/{{ CODEMIRROR_PATH }})
CODEMIRROR_MODE
The default mode which may be a string or configuration map (DEFAULT: 'javascript')
CODEMIRROR_THEME
The default theme applied (DEFAULT: 'default')
CODEMIRROR_CONFIG
Base mapping for the rest of the CodeMirror options (DEFAULT: { 'lineNumbers': True })
CODEMIRROR_JS_VAR_FORMAT
A format string interpolated with the form field name to name a global JS variable that will hold the CodeMirror editor object. For example with CODEMIRROR_JS_VAR_FORMAT = "%s_editor" and a field named ‘code’, the JS variable name would be ‘code_editor’. If CODEMIRROR_JS_VAR_FORMAT is None, no global variable is created (DEFAULT: None)
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file django-codemirror-widget-0.5.0.tar.gz.
File metadata
- Download URL: django-codemirror-widget-0.5.0.tar.gz
- Upload date:
- Size: 6.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/2.7.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a2f7facf299f3f51dff7227cc9850905b899e08485698d3f4fad110a7ad628be
|
|
| MD5 |
bc948b6ce21e4d7354147acc7865724a
|
|
| BLAKE2b-256 |
36c4cbb7865507104470fae886fb868a65e09a4345d30e60b47149e256f0f956
|
