Change theme:   

Site custom data management toolkit

Javascript wrapper for Edicy custom data API. https://github.com/Edicy/edicy-jsplugins/blob/master/api-plugins/jquery.customData.js

Enables user to save, retrieve and manage custom key:value pairs on page, site and article objects. Set attributes are available in template when rendering via object.data.key.
For example : {{ article.data.bgcolor }}

Usage

Initiation:

var articleData = new CustomField({
    type: "article", // allowed values "article", "page", "site"
    id: {{ article.id }} // Must be defined for "page" ({{page.id}}) or "article" ({{ article.id }}) 
});
 

Events:

Avaliable events:

  • success
  • error
var handleSuccess =  function(data, request) {
  var type = request.type; // "get", "set" or "remove"
  var key = request.key // the specific key that was given or null for batch get request
};

articleData.on('success',   handleSuccess);

articleData.on('error', function(response,  request) {
  alert(response.message + ' Request:' +  request .type + ' Key:' + request.key);
});

articleData.off('success',  handleSuccess); 

Setting data:

articleData.set({
  "bgcolor": "#abcdef",
  "textcolor": "white" 
});
articleData.set("bgcolor", "#abcdef");
articleData.set("bgcolor", "#abcdef" {
  success: function(data) {
  },
  error: function(response) {
     alert(response.message);
  }
}); 

Getting data:

articleData.get();
articleData.get({
  success: function(data) {
  },
  error: function(response) {
  }
});
articleData.get("bgcolor");
articleData.get("bgcolor", {
  success: function(data) {
  },
  error: function(response) {
  }
}); 

Removing key:

articleData.remove("bgcolor");
articleData.remove("bgcolor", {
  success: function(data) {
  },
  error: function(response) {
  }
});