django-codemirror-widget is Django form widget library for using CodeMirror on textarea
Project description
Django form widget library for using CodeMirror on Textarea
Install
sudo pip install django-codemirror-widget
or
sudo pip install git+git://github.com/lambdalisue/django-codemirror-widget.git#egg=django-code-mirror
How to Use
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
- 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)
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
Hashes for django-codemirror-widget-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd3092ad70a4b8746d70a251769946cdb0ca5f1bc710fc857cd0c98337c23280 |
|
MD5 | d5c8e419274882229011c2da1c8d063e |
|
BLAKE2b-256 | feb8d2c1566d850182ae7001d440b82c5bd994f97924c1e890b381cc9a9ab80f |