Skip to main content

Django form widget library for using CodeMirror on textarea

Project description

Version Status License Python versions

Django form widget library for using CodeMirror on Textarea.

Installation

pip install django-codemirror-widget

Usage

  1. 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.

  2. 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)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-codemirror-widget-0.4.1.tar.gz (5.4 kB) Copy SHA256 hash SHA256 Source None Sep 14, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page