scrivito_editors 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c08476ab0a102e46e91e58ad43e617a3ee6ff3b2
-  data.tar.gz: f07ebb84641bd5244c695d25010c3fda9ce99501
+  metadata.gz: 18977d126e4b35ad587ce7fb5037209c057d903b
+  data.tar.gz: 9031005f81cffa1fe61c817b8e25fb17038d5ffe
 SHA512:
-  metadata.gz: 2ee789cbf8672495e67bb72537fc83a63c648695e73ba22d30144cb19f290b815c4d883743aa7a1507d2dfc4f493769f3b6673df0dcb7fd939fbdcb9eb2a5ae4
-  data.tar.gz: b7b13acf7da281ef64b8def0ca6ade7916f3fa50f7aa7ddb0da10655ad6e637cb5e8d3d5e625860b42037bc7ae96692e2ade5d56c38c36f3e7ae5f108e57697b
+  metadata.gz: 9bdc8e2382aa12229772012003692b34116b92ff90a760c0dbd34a3a859da4d3fcded838a5f054df5790ab5a33a62e9dbe1f3be8762a395163745e6858a56edc
+  data.tar.gz: df60487fb2c03b11209b818f55395836d722b3fccbbb22a93dd3991ca2b0717f9759141d7299ff103264e37f4266321e97f329870c9067bca574d44c5e895609

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# v0.0.11
+  * Added "Close" button to the HTML editor, to have an additional option to close the editor,
+    besides hitting "Esc".
+  * The new Scrivito SDK feature to serialize save requests allows editors to automatically save the
+    content on every input instead of every 3 seconds. The `string`, `text` and `html` editor now
+    all make use of this feature.
+  * The "Esc" key on `string`, `text` and `html` editors now just destroys the editor, without
+    resetting to any old content.
+  * All editors now trigger a `save.scrivito_editors` event, when the content was successfully
+    saved in the CMS.
+  * `string` and `text` editors now only save, if the content has changed, as it is already
+    the case for the `html` editor.
+  * `referencelist` and `linklist` editors now make use of the new single selection mode option of
+    the resource browser.
+
 # v0.0.10
   * Extracted resource browser into separate gem.
 

data/app/assets/javascripts/scrivito_editors/date_editor.js.coffee

@@ -23,6 +23,7 @@ $ ->
 
       cmsField.scrivito('save', dateTimeText)
         .done ->
+          cmsField.trigger('save.scrivito_editors')
           cmsField.trigger('scrivito_reload')
 
     $('body').on 'click', '[data-scrivito-field-type="date"]:not(.hasDatepicker):not([data-editor]), [data-editor="date"]', (event) ->

data/app/assets/javascripts/scrivito_editors/enum_editor.js.coffee

@@ -19,6 +19,7 @@ $ ->
       cmsField = element.data('cmsField')
       content = element.val()
       cmsField.scrivito('save', content).done ->
+        cmsField.trigger('save.scrivito_editors')
         cmsField.trigger('scrivito_reload')
 
     $(document).on 'click', '[data-scrivito-field-type="enum"]:not([data-editor]), [data-editor="enum"]', (event) ->

data/app/assets/javascripts/scrivito_editors/html_editor.js.coffee

@@ -1,43 +1,33 @@
-$ ->
-  # Configuration and behavior of Redactor html editor. The editor is used for all html CMS
-  # attributes and provides autosave, undo and redo functionality on top of the default Redactor
-  # settings.
-
-  # Stores the id of the last triggered timeout for later reference.
-  timeoutID = undefined
+# Configuration and behavior of Redactor html editor. The editor is used for all html CMS
+# attributes and provides autosave on top of the default Redactor settings.
 
-  # Milliseconds after which to save the content automatically.
-  autosaveInterval = 3000
+# Check if the namespace for plugins exists and create it otherwise.
+unless @RedactorPlugins?
+  @RedactorPlugins = {}
 
-  # Stores the last saved content written to the CMS to allow comparison with editor content.
-  savedContent = undefined
+# Plugin for closing the editor with a button in the toolbar.
+@RedactorPlugins.close =
+  init: ->
+    @buttonAddFirst('close', 'Close', @closeAction)
 
-  # Stores the content before the editor is opened and changes occur.
-  originalContent = undefined
+  closeAction: (buttonName, buttonDOM, buttonObj, event) ->
+    @.callback('blur')
 
+$ ->
   # Stores redactor options, custom settings and configures callbacks.
   redactorOptions = ->
     return {} =
-      # This option allows you to add your own buttons with callback to the toolbar.
-      # http://imperavi.com/redactor/docs/settings/#set-buttonsCustom
-      buttonsCustom:
-        undoButton:
-          title: 'Undo'
-          callback: undoAction
-        redoButton:
-          title: 'Redo'
-          callback: redoAction
-
       # This setting defines the array of toolbar buttons.
       # http://imperavi.com/redactor/docs/settings/#set-buttons
-      buttons: ['undoButton', 'redoButton',
-        '|', 'formatting',
-        '|', 'bold', 'italic', 'deleted', 'underline',
-        '|', 'unorderedlist', 'orderedlist',
-        '|', 'table', 'link',
-        '|', 'html'
+      buttons: [
+        'formatting', 'bold', 'italic', 'deleted', 'underline',
+        'unorderedlist', 'orderedlist', 'table', 'link', 'html',
       ]
 
+      # This options allows to configure what plugins are loaded. Plugins need to be defined in the
+      # +RedactorPlugins+ namespace.
+      plugins: ['close']
+
       # This option allows you to set whether Redactor gets cursor focus on load or not.
       # http://imperavi.com/redactor/docs/settings/#set-focus
       focus: true
@@ -46,22 +36,16 @@ $ ->
       # http://imperavi.com/redactor/docs/settings/#set-convertDivs
       convertDivs: false
 
-      # This callback is triggered after Redactor is launched.
-      # http://imperavi.com/redactor/docs/callbacks/#callback-initCallback
-      initCallback: ->
-        originalContent = @get()
-
       # This callback fires every time when content changes in Redactor.
       # http://imperavi.com/redactor/docs/callbacks/#callback-changeCallback
       changeCallback: ->
-        autosaveAction(@)
+        saveContents(@)
 
       # This callback is triggered when Redactor loses focus.
       # http://imperavi.com/redactor/docs/callbacks/#callback-blurCallback
       blurCallback: ->
-        saveContents(@).done =>
-          @.destroy()
-          reload(@)
+        @.destroy()
+        saveContents(@)
 
       # This callback is triggered when a key is released.
       # http://imperavi.com/redactor/docs/callbacks/#callback-keyupCallback
@@ -70,56 +54,27 @@ $ ->
         key = event.keyCode || event.which
 
         if key == 27
-          cancelEditing(@)
+          @.callback('blur')
         else
-          autosaveAction(@)
+          saveContents(@)
 
       # This callback allows to get pasted code after clean on paste.
       # http://imperavi.com/redactor/docs/callbacks/#callback-pasteAfterCallback
       pasteAfterCallback: (html) ->
-        autosaveAction(@)
+        saveContents(@)
         html
 
-  # Registers a timeout to save the editor content after a certain interval. The timeout gets reset
-  # on every change.
-  autosaveAction = (editor) ->
-    if timeoutID
-      clearTimeout(timeoutID)
-
-    timeoutID = setTimeout ( ->
-      saveContents(editor)
-    ), autosaveInterval
-
-  undoAction = ->
-    @execCommand('undo')
-
-  redoAction = ->
-    @execCommand('redo')
-
-  # Saves the current editor content to the CMS if it has changed.
+  # Saves the current editor content to the CMS.
   saveContents = (editor) ->
+    cmsField = editor.$element
     content = editor.get()
 
-    if savedContent != content
-      cmsField = editor.$element
+    if content != cmsField.scrivito('content')
       cmsField.scrivito('save', content).done ->
-        savedContent = content
-
+        cmsField.trigger('save.scrivito_editors')
     else
       $.Deferred().resolve()
 
-  reload = (editor) ->
-    cmsField = editor.$element
-    cmsField.trigger('scrivito_reload')
-
-  # Restores the original content before the editor was opened, also saves it back to the CMS
-  # because autosave could have overwritten the content and closes the editor.
-  cancelEditing = (editor) ->
-    editor.set(originalContent)
-    saveContents(editor).done ->
-      reload(editor)
-    editor.destroy()
-
   # Registers Redactor for all CMS html attributes found in the given scope of the DOM element.
   addOnclickRedactorHandlers = (domElement) ->
     domElement.on 'click', '[data-scrivito-field-type="html"]:not([data-editor]), [data-editor="html"]', (event) ->

data/app/assets/javascripts/scrivito_editors/linklist_editor.js.coffee

@@ -44,6 +44,7 @@ $ ->
 
     unless JSON.stringify(value) == JSON.stringify(lastSaved)
       cmsField.scrivito('save', value).done ->
+        cmsField.trigger('save.scrivito_editors')
         storeLastSaved(cmsField, value)
 
   # Run when clicking the '...' button inside a li.
@@ -57,6 +58,7 @@ $ ->
     Resourcebrowser.open
       selection: []
       filters: filters
+      selectionMode: 'single'
       onSave: (selection) =>
         onResourcebrowserSaveLinkItem(selection, linkItem)
 

data/app/assets/javascripts/scrivito_editors/multienum_editor.js.coffee

@@ -20,6 +20,7 @@ $ ->
       cmsField = element.data('cmsField')
       content = element.val()
       cmsField.scrivito('save', content).done ->
+        cmsField.trigger('save.scrivito_editors')
         cmsField.trigger('scrivito_reload')
 
     $(document).on 'click', '[data-scrivito-field-type="multienum"]:not([data-editor]), [data-editor="multienum"]', (event) ->

data/app/assets/javascripts/scrivito_editors/reference_editor.js.coffee

@@ -13,6 +13,7 @@ $ ->
       Resourcebrowser.open
         selection: selected
         filters: filters
+        selectionMode: 'single'
 
         onSave: (selection) =>
           onResourcebrowserSave(selection, cmsField)
@@ -23,6 +24,7 @@ $ ->
 
       cmsField.scrivito('save', value)
       .done ->
+        cmsField.trigger('save.scrivito_editors')
         cmsField.trigger('scrivito_reload')
 
       true

data/app/assets/javascripts/scrivito_editors/referencelist_editor.js.coffee

@@ -35,6 +35,7 @@ $ ->
       cmsField.scrivito('save', ids)
         .done ->
           storeLastSaved(cmsField, ids)
+          cmsField.trigger('save.scrivito_editors')
           cmsField.trigger('scrivito_reload')
 
   # Run when clicking the resource browser button.

data/app/assets/javascripts/scrivito_editors/slider_editor.js.coffee

@@ -9,6 +9,7 @@ $ ->
       cmsField = $(@).data('cmsField')
       content = ui.value
       cmsField.scrivito('save', content).done ->
+        cmsField.trigger('save.scrivito_editors')
         cmsField.trigger('scrivito_reload')
 
     onSlide = (event, ui) ->

data/app/assets/javascripts/scrivito_editors/string_editor.js.coffee

@@ -1,12 +1,7 @@
 $ ->
   # This file integrates contenteditable for string attributes.
 
-  timeout = undefined
-
   onKey = (event) ->
-    if timeout?
-      clearTimeout(timeout)
-
     cmsField = $(event.currentTarget)
     key = event.keyCode || event.which
 
@@ -15,18 +10,12 @@ $ ->
         event.preventDefault()
         cmsField.blur()
       when 27 # Esc
-        if event.type == 'keyup'
-          event.stopPropagation()
-          cmsField
-            .off('blur')
-            .trigger('scrivito_reload')
-      else
-        setTimeout ->
-          cleanUp(cmsField)
+        event.stopPropagation()
+        cmsField.blur()
 
-        timeout = setTimeout ( ->
-          save(cmsField, false)
-        ), 3000
+  onInput = (event) ->
+    cmsField = $(event.currentTarget)
+    save(cmsField, false)
 
   onBlur = (event) ->
     cmsField = $(event.currentTarget)
@@ -36,9 +25,6 @@ $ ->
         cmsField.trigger('scrivito_reload')
 
   save = (cmsField, andClose) ->
-    if timeout?
-      clearTimeout(timeout)
-
     cleanUp(cmsField)
 
     clone = cmsFieldAndPastedContent(cmsField).clone()
@@ -49,7 +35,12 @@ $ ->
     if andClose
       cmsField.text(content)
 
-    cmsField.scrivito('save', content)
+    # Save only if the content has changed.
+    if content != cmsField.scrivito('content')
+      cmsField.scrivito('save', content).done ->
+        cmsField.trigger('save.scrivito_editors')
+    else
+      $.Deferred().resolve()
 
   cleanUp = (cmsField) ->
     siblings = cmsFieldAndPastedContent(cmsField)
@@ -72,6 +63,7 @@ $ ->
           .blur(onBlur)
           .keypress(onKey)
           .keyup(onKey)
+          .on('input', onInput)
 
     # Prevent editable link strings to follow the link target on click.
     $('body').on 'click', '[data-scrivito-field-type="string"]:not([data-editor]), [data-editor="string"]', (event) ->

data/app/assets/javascripts/scrivito_editors/text_editor.js.coffee

@@ -2,29 +2,18 @@ $ ->
   # This file integrates contenteditable for text attributes.
   # It provides multiline editing support.
 
-  timeout = undefined
-
   onKey = (event) ->
-    if timeout?
-      clearTimeout(timeout)
-
     cmsField = $(event.currentTarget)
     key = event.keyCode || event.which
 
     switch key
       when 27 # Esc
-        if event.type == 'keyup'
-          event.stopPropagation()
-          cmsField
-            .off('blur')
-            .trigger('scrivito_reload')
-      else
-        setTimeout ->
-          cleanUp(cmsField)
-          
-        timeout = setTimeout ( ->
-          save(cmsField, false)
-        ), 3000
+        event.stopPropagation()
+        cmsField.blur()
+
+  onInput = (event) ->
+    cmsField = $(event.currentTarget)
+    save(cmsField, false)
 
   onBlur = (event) ->
     cmsField = $(event.currentTarget)
@@ -34,9 +23,6 @@ $ ->
         cmsField.trigger('scrivito_reload')
 
   save = (cmsField, andClose) ->
-    if timeout?
-      clearTimeout(timeout)
-
     cleanUp(cmsField)
 
     clone = cmsFieldAndPastedContent(cmsField).clone()
@@ -47,7 +33,12 @@ $ ->
     if andClose
       cmsField.text(content)
 
-    cmsField.scrivito('save', content)
+    # Save only if the content has changed.
+    if content != cmsField.scrivito('content')
+      cmsField.scrivito('save', content).done ->
+        cmsField.trigger('save.scrivito_editors')
+    else
+      $.Deferred().resolve()
 
   cleanUp = (cmsField) ->
     siblings = cmsFieldAndPastedContent(cmsField)
@@ -75,6 +66,7 @@ $ ->
           .blur(onBlur)
           .keypress(onKey)
           .keyup(onKey)
+          .on('input', onInput)
 
     # Prevent editable link text to follow the link target on click.
     $('body').on 'click', '[data-scrivito-field-type="text"]:not([data-editor]), [data-editor="text"]', (event) ->

data/app/assets/stylesheets/scrivito_editors/editors/html_editor.css

@@ -0,0 +1,18 @@
+/*
+  Plugin styles for the close button.
+*/
+
+.redactor_toolbar li a.re-close {
+  color: #aa4040;
+  font-family: 'editing_iconsregular';
+  font-size: 7px;
+  padding: 14px 10px 4px 10px;
+}
+
+.redactor_toolbar li a.re-close:before {
+  content: "\F028";
+}
+
+.redactor_toolbar li a.re-close:hover {
+  color: #fff;
+}

data/lib/scrivito_editors/version.rb

@@ -1,3 +1,3 @@
 module ScrivitoEditors
-  VERSION = '0.0.10'
+  VERSION = '0.0.11'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrivito_editors
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Scrivito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-27 00:00:00.000000000 Z
+date: 2014-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -123,6 +123,7 @@ files:
 - app/assets/javascripts/scrivito_editors/text_editor.js.coffee
 - app/assets/stylesheets/scrivito_editors.css
 - app/assets/stylesheets/scrivito_editors/buttons.css
+- app/assets/stylesheets/scrivito_editors/editors/html_editor.css
 - app/assets/stylesheets/scrivito_editors/editors/linklist_editor.css
 - app/assets/stylesheets/scrivito_editors/editors/referencelist_editor.css
 - app/assets/stylesheets/scrivito_editors/editors/text_editor.css