Merge pull request #17 from Linkurious/LKE-6988-localisation-support

Support utf8 characters and custom delimiter

Author: bernardsemaan

README.md

@@ -21,6 +21,7 @@ Configuration keys supported only by the data-table plugin:
 | :-- | :-- | :-- | :-- |
 | `entityType`  | "edge" \| "node" (**required**)  | Whether to display nodes or edges in the table. | `"node"` |
 | `itemType`    | string (**required**)            | Name of the node category or edge type to display in the table. | `"Company"` |
+| `delimiter`    | string (**optional**)           | The delimiter used for csv files downloads. Only one character is allowed. By default "," is used | `";"` |
 | `properties`  | string\[] (**optional**)         | Property names to include in the table. Defaults to all the properties of `itemType`. | `["name", "address", "vat_number"]` |
 
 Configuration example for 1 data-table instance accesible via `/plugins/table`:

backend/routeHandler.js

@@ -26,9 +26,10 @@ module.exports = function configureRoutes(options) {
    * @param entityType
    * @param itemType
    * @param properties
+   * @param delimiter
    * @returns {{message: string}|{message: string}|{message: string}|null|{message: string}}
    */
-  function checkPluginsConfiguration(schemaTypes, entityType, itemType, properties) {
+  function checkPluginsConfiguration(schemaTypes, entityType, itemType, properties, delimiter) {
     if (entityType && entityType !== 'node' && entityType !== 'edge') {
       return {message: 'Invalid plugin configuration “entityType” (must be “node” or “edge”)'};
     }
@@ -40,6 +41,9 @@ module.exports = function configureRoutes(options) {
     if (properties && (!Array.isArray(properties) || properties.length === 0)) {
       return {message: 'Invalid plugin configuration “properties” (must be a non-empty array of property names)'};
     }
+    if (delimiter && delimiter.length != 1) {
+      return {message: 'Invalid plugin configuration “delimiter” (only one character is allowed)'};
+    }
     return null;
   }
 
@@ -48,7 +52,8 @@ module.exports = function configureRoutes(options) {
     const entityType = options.configuration.entityType;
     const itemType = options.configuration.itemType;
     const properties = options.configuration.properties;
-    const error = checkPluginsConfiguration(schemaTypes, entityType, itemType, properties);
+    const delimiter = options.configuration.delimiter;
+    const error = checkPluginsConfiguration(schemaTypes, entityType, itemType, properties, delimiter);
     if (error) {
       res.status(412);
       res.send(JSON.stringify({status: 412, body: {error}}));

public/js/main.js

@@ -525,7 +525,11 @@ function showModal() {
 function addButtons() {
     // EXPORT TO CSV BUTTON
     document.getElementById('button-export').addEventListener('click', () => {
-        table.download('csv', 'data.csv');
+        delimiterCharacter = ",";
+        if (pluginConfiguration.delimiter){
+            delimiterCharacter = pluginConfiguration.delimiter;
+        }
+        table.download('csv', 'data.csv', {delimiter:delimiterCharacter, bom:true});
     });
 
     // OPEN EDIT COLUMN MODAL