跳转到主要内容

Django表单小部件库,用于在文本区域中使用CodeMirror

项目描述

Version Status License Python versions

Django 表单小部件库,用于在 CodeMirror 上使用 Textarea

安装

pip install django-codemirror-widget

用法

  1. 首先,您需要在 settings.py 中指定 CODEMIRROR_PATHCODEMIRROR_PATH 是CodeMirror目录的URI,例如 CODEMIRROR_PATH = r"javascript/codemirror"。如果您未指定,则默认为 'codemirror'。CodeMirror应该放在那里。

  2. 使用以下 codemirror.CodeMirrorTextarea 小部件针对以下 Textarea

    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.py 中使用以下内容。

CODEMIRROR_PATH

CodeMirror目录的URI(你的CodeMirror安装应位于 {{ STATIC_URL }}/{{ CODEMIRROR_PATH }}

CODEMIRROR_MODE

默认模式,可以是字符串或配置映射(默认: 'javascript'

CODEMIRROR_THEME

应用的默认主题(默认: 'default'

CODEMIRROR_CONFIG

CodeMirror其他选项的基本映射(默认: { 'lineNumbers': True }

CODEMIRROR_JS_VAR_FORMAT

一个格式化字符串,用于将表单字段名称插入以命名一个全局JS变量,该变量将保存CodeMirror编辑器对象。例如,如果 CODEMIRROR_JS_VAR_FORMAT = "%s_editor" 且字段名为“code”,则JS变量名将是“code_editor”。如果 CODEMIRROR_JS_VAR_FORMAT 为None,则不会创建全局变量(默认:None)

项目详情


下载文件

下载适用于您平台文件的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。

源分布

django-codemirror-widget-0.5.0.tar.gz (6.6 kB 查看哈希值)

上传时间

由以下组织支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面