Editor.md自动保存插件的开发

Markdown编辑器Editor.md自动保存插件的开发。文章编辑器没有自动保存功能怎么行,万一不小心忘记保存不就辛苦白费了,然后就着手给自己的编辑器加了个自动保存功能,分享给有需要的朋友。
原文地址:代码汇个人博客 http://www.codehui.net/info/40.html

  • 此文章代码仅供参考。用于开发环境时可根据自己需要进行修改。

自动保存基于localStorage开发,请注意浏览器兼容。(IE7及以下不兼容)。各个浏览器对localStorage的存储大小支持都是不同的,chrome是5M ,IE10是1630K,其他的可以自行测试,基本保存一篇文章绰绰有余了。

1. 插件运行流程

插件使用方法:在编辑区输入内容后,会自动保存内容到客户端本地存储,页面关闭和断电对保存的内容不受影响。保存的内容没有过期时间,直到手动去除。

代码汇

2. 创建插件文件

plugins目录下创建 code-auto-save/code-auto-save.js文件。

3. 页面使用插件

为更方便使用缓存,我们在编辑器的工具栏添加一个自定义的按钮,就和ueditor类似,点击按钮读取缓存内容到编辑器。页面代码如下,都有注释的

<!DOCTYPE html>
<html lang="zh">
    <head>
        <meta charset="utf-8" />
        <title>editormd自动保存插件</title>
        <link rel="stylesheet" href="css/style.css" />
        <link rel="stylesheet" href="../css/editormd.css" />
    </head>
    <body>
        <div id="test-editormd">
            <textarea style="display:none;"></textarea>
        </div>
        <script src="js/jquery.min.js"></script>
        <script src="../editormd.js"></script>
        <script type="text/javascript">
            var testEditor = editormd("test-editormd", {
                path: '../lib/',
                // 工具栏添加一个自定义方法
                toolbarIcons: function() {
                    // 给工具栏full模式添加一个自定义方法
                    return editormd.toolbarModes.full.concat(["customIcon"]);
                },
                // 自定义方法的图标 指定一个FontAawsome的图标类
                toolbarIconsClass: {
                    customIcon: "fa-paste"
                },
                // 没有图标可以插入内容,字符串或HTML标签
                toolbarIconTexts: {
                    customIcon: "从草稿箱加载"
                },
                // 图标的title
                lang: {
                    toolbar: {
                        customIcon: "从草稿箱加载"
                    }
                },
                // 自定义工具栏按钮的事件处理
                toolbarHandlers: {
                    customIcon: function(){
                        // 读取缓存内容
                        testEditor.CodeAutoSaveGetCache();
                    }
                },
                // 自定义工具栏按钮的事件处理
                onload: function() {
                    // 引入插件 执行监听方法
                    editormd.loadPlugin("../plugins/code-auto-save/code-auto-save", function() {
                        // 初始化插件 实现监听
                        testEditor.CodeAutoSave();
                    });
                }
            });
            // 删除缓存
            testEditor.CodeAutoSaveDelCache();
            // 清空缓存的文档内容
            testEditor.CodeAutoSaveEmptyCacheContent();
            // 自定义设置缓存
            testEditor.CodeAutoSaveSetCache('缓存内容');
        </script>
    </body>

</html>

4. 插件的内容

防止缓存冲突,将页面url作为存储的key进去区分。监听编辑器change事件最好有一小段时间的缓冲,不然操作缓存太频繁造成性能问题。

/*!
 * editormd图片粘贴上传插件
 *
 * @file   code-auto-save.js
 * @author codehui
 * @date   2018-10-27
 * @link   https://www.codehui.net
 */

(function() {

    var factory = function (exports) {
        // 定义插件名称
        var pluginName   = "code-auto-save";  
        
        // 缓存key
        var cacheKey = 'editormd_cache';
        // 编辑器内容缓存key 替换url中的符号
        var cacheContentKey = ( location.protocol + location.host + location.pathname + location.search ).replace( /[.:?=\/-]/g, '_' );
        // 定义全局变量
        var cm;

        exports.fn.CodeAutoSave = function() {
            // 初始化系统变量
            var _this       = this;
            cm              = _this.cm;
            var settings    = _this.settings;
            var classPrefix = _this.classPrefix;
            var id          = _this.id;   // 编辑器id
            
            // 定时器
            var _saveFlag = null;    
            // 自动保存间隔时间, 单位ms
            var saveInterval = 500;   

            if(typeof(Storage)=="undefined"){
                console.log('对不起,您的浏览器不支持 web 存储。');
                return ;
            }
            
            // 设置编辑器为当前域名+编辑器id
            cacheContentKey = cacheContentKey + "_" + id;
            
            console.log('初始化插件成功');
            
            // 注册change事件
            cm.on('change', function(){
                
                //已经存在定时器关闭 重新开始 防止多次执行
                if(_saveFlag){
                    window.clearTimeout( _saveFlag );
                }
                //定时器的作用是加缓冲
                _saveFlag = window.setTimeout( function () {
                    // 执行设置缓存方法  cm.getValue() 是编辑器的源文档
                    _this.CodeAutoSaveSetCache(cm.getValue());
                }, saveInterval);
            })

        };
        // 设置缓存
        exports.fn.CodeAutoSaveSetCache = function(value) {
            value = value || cm.getValue();
            console.log('设置缓存');
            var cacheContent = {};
            cacheContent[cacheContentKey] = value;
            localStorage.setItem(cacheKey, JSON.stringify(cacheContent));
        }
        
        // 读取缓存
        exports.fn.CodeAutoSaveGetCache = function() {
            // 判断缓存key
            if(localStorage.hasOwnProperty(cacheKey)){
                var cacheData = JSON.parse(localStorage.getItem(cacheKey));
                if(cacheData[cacheContentKey]){
                    console.log('读取缓存 设置文档内容')
                    cm.setValue(cacheData[cacheContentKey]);
                }
            }else{
                console.log('缓存中没有数据')
            }
        }
        
        // 删除缓存
        exports.fn.CodeAutoSaveDelCache = function() {
            console.log('删除缓存')
            localStorage.removeItem(cacheKey);
        }
        
        // 清空缓存的文档内容
        exports.fn.CodeAutoSaveEmptyCacheContent = function() {
            console.log('清除缓存文档内容')
            _this.CodeAutoSaveSetCache('');
        }

    };
    
    // CommonJS/Node.js
    if (typeof require === "function" && typeof exports === "object" && typeof module === "object")
    { 
        module.exports = factory;
    }
    else if (typeof define === "function")  // AMD/CMD/Sea.js
    {
        if (define.amd) { // for Require.js

            define(["editormd"], function(editormd) {
                factory(editormd);
            });

        } else { // for Sea.js
            define(function(require) {
                var editormd = require("./../../editormd");
                factory(editormd);
            });
        }
    } 
    else
    {
        factory(window.editormd);
    }

})();

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

推荐阅读更多精彩内容

  • 第一部分 HTML&CSS整理答案 1. 什么是HTML5? 答:HTML5是最新的HTML标准。 注意:讲述HT...
    kismetajun阅读 27,486评论 1 45
  • 继续写API获取豆瓣电影前250的程序。 链接:https://api.douban.com/v2/movie/t...
    每日派森阅读 300评论 0 0
  • 昨天晚上和爱人朱玉琼、儿子陈志邦、冠珠团队的家人舒彩霞、高静、曹雅琳、高静、唐光辉、一起去观看了电影无问西东。这部...
    31c47a10aded阅读 228评论 0 3
  • “唯有对艺术家是应该告诉他死期的”。 天才画家祁答院在25岁的时候换上了痔疮。尽管饱受病魔的折磨,他却无心...
    流洋tututu阅读 767评论 0 0