Form widget¶

class djangocodemirror.widgets.CodeMirrorWidget(*args, **kwargs)[source]¶

Bases: Textarea

Widget to add a CodeMirror or DjangoCodeMirror instance on a textarea Take the same arguments than forms.Textarea and accepts one suplementary optionnal arguments :

Parameters:

config_name (string) – A Codemirror config name available in settings.CODEMIRROR_SETTINGS. Default is empty.
embed_config (bool) – If True will add Codemirror Javascript config just below the input. Default is False.

config_name¶

For given config name.

Type:: string

template_name¶

Template path for widget rendering.

Type:: string

init_manifest(name)[source]¶

Initialize a manifest instance

Parameters:: name (string) – Config name to register.
Returns:: A manifest instance where config (from config_name attribute) is registred.
Return type:: CodeMirrorManifest

get_codemirror_field_js()[source]¶

Return CodeMirror HTML template from CodeMirrorWidget.codemirror_field_js.

Returns:: HTML template string.
Return type:: string

codemirror_config()[source]¶

Shortcut to get Codemirror parameters.

Returns:: CodeMirror parameters.
Return type:: dict

codemirror_script(inputid)[source]¶

Build CodeMirror HTML script tag which contains CodeMirror init.

Parameters:: inputid (string) – Input id.
Returns:: HTML for field CodeMirror instance.
Return type:: string

render(name, value, attrs=None, renderer=None)[source]¶: Returns this Widget rendered as HTML, as a Unicode string.

property media¶

Adds necessary files (Js/CSS) to the widget’s medias.

Returns:: Media object with all assets from registered config.
Return type:: django.forms.Media

class djangocodemirror.widgets.CodeMirrorAdminWidget(*args, **kwargs)[source]¶

Bases: CodeMirrorWidget

CodeMirror widget suited for usage in models admins.

Act like CodeMirrorWidget but allways embed Codemirror Javascript config.

property media¶

Adds necessary files (Js/CSS) to the widget’s medias.

Returns:: Media object with all assets from registered config.
Return type:: django.forms.Media