Xadmin 插件开发之富文本编辑器 ueditor

此文为前一篇文章的续写: Django 插件之 Xadmin

Ueditor 介绍

UEditor 是由百度 web 前端研发部开发所见即所得富文本 web 编辑器,具有轻量,可定制,注重用户体验等特点,开源基于 MIT 协议,允许自由使用和修改代码。

DjangoUeditor 安装

方法一:将 github 整个源码包下载回家,在命令行运行:

python setup.py install

方法二:使用 pip 工具在命令行运行(推荐):

pip install DjangoUeditor

settings.py 文件中注册此 app :

# settings.py
INSTALLED_APPS = [
    ...
    'DjangoUeditor',
]

urls .py 文件中配置:

# urls.py
urlpatterns = [
    ...
    url(r'^ueditor/',include('DjangoUeditor.urls' )), # 富文本相关URL
]

models.py 中配置:

# models.py
from DjangoUeditor.models import UEditorField
class Article(models.Model):
    content = UEditorField(verbose_name='内容详情',width=750, height=300, imagePath="images/ueditor/", filePath="images/ueditor/", default='') # imagePath和filePath 为文件上传路径
    ...

adminx.py 中为需要富文本的字段配置:

class ArticleAdmin(object):
    ...
    style_fields = {"content": "ueditor"}

到此,djangoueditor 配置完成。下面是将它作为 Xadmin 的插件步骤。

Xadmin 插件制作

找到 Xadmin 目录下的 plugins 文件夹,此文件下大多为 Xadmin 的插件,新建 ueditor.py 文件,代码及说明如下:

# ueditor.py   写法较为固定
import Xadmin
from Xadmin.views import BaseAdminPlugin
from DjangoUeditor.models import UEditorField
from DjangoUeditor.widgets import UEditorWidget
from django.conf import settings
from Xadmin.views import CreateAdminView
from Xadmin.views import UpdateAdminView
class XadminUEditorWidget(UEditorWidget):
    def __init__(self, **kwargs):
        self.ueditor_options = kwargs
        self.Media.js = None
        super(XadminUEditorWidget, self).__init__(kwargs)
        
class UeditorPlugin(BaseAdminPlugin):
    def get_field_style(self, attrs, db_field, style, **kwargs): # 判断传入的是否为 ueditor ,然后返回相关的富文本内容
        if style == 'ueditor':
            if isinstance(db_field, UEditorField):
                widget = db_field.formfield().widget
                param = {}
                param.update(widget.ueditor_settings)
                param.update(widget.attrs)
                return {'widget': XadminUEditorWidget(**param)}
        return attrs
    
    def block_extrahead(self, context, nodes):  # 在生成的页面中加入自定义的 js 文件
        js = '<script type="text/javascript" src="%s"></script>' % (settings.STATIC_URL + "ueditor/ueditor.config.js")
        js += '<script type="text/javascript" src="%s"></script>' % (settings.STATIC_URL + "ueditor/ueditor.all.min.js")
        nodes.append(js)
        
Xadmin.site.register_plugin(UeditorPlugin, UpdateAdminView)
Xadmin.site.register_plugin(UeditorPlugin, CreateAdminView)

然后在 plugins 文件下找到 __init__.py 文件,在代码中加入:

# __init__.py 
PLUGINS = (
    ...
    'ueditor'
)

这样,在 Xadmin 启动的时候,ueditor 会得到加载。

在后台页面中查看如下:

ueditor.png

tips:在 ueditor 不同版本中,上传图片时会出现上传失败现象,解决方案:

找到项目中的 site-packages ,再找到 DjangoUeditor 下的 views.py 文件:

# views.py 
@csrf_exempt   # 查看是否有此行代码,如没有,添加此行代码
def get_ueditor_controller(request):
    """获取ueditor的后端URL地址    """
    ...
    return reponseAction[action](request)

完成到这里,Xadmin 的插件就算制作完成。

参考资料:

django-ueditor 下载地址:https://github.com/zhangfisher/DjangoUeditor

ueditor 官网:http://ueditor.baidu.com/website/

Xadmin 官网:http://sshwsfc.github.io/Xadmin/

Xadmin 文档:http://Xadmin.readthedocs.io/en/docs-chinese/make_plugin.html

ueditor 官网:http://ueditor.baidu.com/website/

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343

推荐阅读更多精彩内容