Auto save editor when in living mode

README.md

@@ -117,6 +117,11 @@ MARTOR_IMGUR_API_KEY   = 'your-api-key'
 MARTOR_MARKDOWNIFY_FUNCTION = 'martor.utils.markdownify' # default
 MARTOR_MARKDOWNIFY_URL = '/martor/markdownify/' # default
 
+# Delay in miliseconds to update editor preview when in living mode.
+MARTOR_MARKDOWNIFY_TIMEOUT = 0 # update the preview instantly
+# or:
+MARTOR_MARKDOWNIFY_TIMEOUT = 1000 # default
+
 # Markdown extensions (default)
 MARTOR_MARKDOWN_EXTENSIONS = [
     'markdown.extensions.extra',

martor/settings.py

@@ -60,6 +60,9 @@
     settings, "MARTOR_MARKDOWNIFY_URL", "/martor/markdownify/"
 )
 
+# Time to delay the markdownify ajax request, in millisecond.
+MARTOR_MARKDOWNIFY_TIMEOUT = getattr(settings, "MARTOR_MARKDOWNIFY_TIMEOUT", 1000)
+
 # Markdown extensions
 MARTOR_MARKDOWN_EXTENSIONS = getattr(
     settings,

martor/static/martor/js/martor.bootstrap.js

@@ -190,6 +190,15 @@
                 });
             };
 
+            let timeoutID;
+
+            var refreshPreviewTimeout = function () {
+                if (timeoutID) {
+                    clearTimeout(timeoutID);
+                }
+                timeoutID = setTimeout(refreshPreview, textareaId.data("save-timeout"));
+            }
+
             // Refresh the preview unconditionally on first load.
             window.onload = function () {
                 refreshPreview();
@@ -202,7 +211,7 @@
                     refreshPreview();
                 });
             } else {
-                editor.on('change', refreshPreview);
+                editor.on('change', refreshPreviewTimeout);
             }
 
             if (editorConfig.spellcheck == 'true') {

martor/static/martor/js/martor.semantic.js

@@ -179,6 +179,15 @@
                 });
             };
 
+            let timeoutID;
+
+            var refreshPreviewTimeout = function () {
+                if (timeoutID) {
+                    clearTimeout(timeoutID);
+                }
+                timeoutID = setTimeout(refreshPreview, textareaId.data("save-timeout"));
+            }
+
             // Refresh the preview unconditionally on first load.
             window.onload = function () {
                 refreshPreview();
@@ -191,7 +200,7 @@
                     refreshPreview();
                 });
             } else {
-                editor.on('change', refreshPreview);
+                editor.on('change', refreshPreviewTimeout);
             }
 
             var editorTabButton = $('.item[data-tab=editor-tab-' + field_name + ']');

martor/widgets.py

@@ -16,6 +16,7 @@
     MARTOR_ALTERNATIVE_JS_FILE_THEME,
     MARTOR_ALTERNATIVE_CSS_FILE_THEME,
     MARTOR_ALTERNATIVE_JQUERY_JS_FILE,
+    MARTOR_MARKDOWNIFY_TIMEOUT
 )
 
 
@@ -41,6 +42,8 @@ def render(self, name, value, attrs=None, renderer=None, **kwargs):
             attributes_to_pass["data-search-users-url"] = reverse("search_user_json")
         if MARTOR_SEARCH_USERS_URL:
             attributes_to_pass["data-base-emoji-url"] = MARTOR_MARKDOWN_BASE_EMOJI_URL
+        if MARTOR_MARKDOWNIFY_TIMEOUT:
+            attributes_to_pass["data-save-timeout"] = MARTOR_MARKDOWNIFY_TIMEOUT
 
         # Make sure that the martor value is in the class attr passed in
         if "class" in attrs: