@soleil-se/app-util 1.1.3 → 1.1.4

package/README.md

@@ -6,7 +6,7 @@
 ```javascript
 import { renderApp, getRouteUri, getResourceUri, renderTemplate, isOffline } from '@soleil-se/webapp-util';
 ```
-### `renderApp(name, data, [noScript])` ⇒ `String`
+### `renderApp(name, [data], [settings])` ⇒ `String`
 Get HTML string for rendering an application.   
 To be used together with `@soleil-se/webapp-util/render-vue` or a custom render function in the client code. 
 
@@ -15,8 +15,8 @@ To be used together with `@soleil-se/webapp-util/render-vue` or a custom render
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | name | <code>String</code> |  | Name of the app, has to match the name of the application. |
-| data | <code>Object</code> |  | Server data that will be available in the app. In Vue it will be available in the `$options` object. |
-| settings | <code>Object</code> |  | Settings object. |
+| [data] | <code>Object</code> | <code>{}</code> | Server data that will be available in the app. In Vue it will be available in the `$options` object. |
+| [settings] | <code>Object</code> | <code>{}</code> | Settings object. |
 | [settings.noScript] | <code>String</code> | <code>&#x27;&#x27;</code> | HTML that will be rendered when JavaScript is not available. |
 | [settings.selector] | <code>String</code> | <code>&#x60;[data-portlet-id&#x3D;&quot;${portletId}&quot;]&#x60;</code> | Query selector for where the app should be mounted. |
 | [settings.async] | <code>Boolean</code> | <code>true</code> | If the app script should be loaded asynchronously. [Read more about async and defer.](https://flaviocopes.com/javascript-async-defer/) |
@@ -38,7 +38,7 @@ router.get('/', (req, res) => {
   }));
 });
 ```
-Vue example.   
+##### **Vue**
 In `app_src/vue/index.js`.
 ```javascript
 import render from '@soleil-se/webapp-util/render-vue';

package/dist/index.js

@@ -38,9 +38,9 @@ export function renderTemplate(template, values) {
 /**
  * Get HTML string for rendering an application.
  * @param {String} name Name of the app, has to match the name of the application.
- * @param {Object} data Server data that will be available in the app.
+ * @param {Object} [data={}] Server data that will be available in the app.
  * In Vue it will be available in the `$options` object.
- * @param {Object} settings Settings object.
+ * @param {Object} [settings={}] Settings object.
  * @param {String} [settings.noScript=''] HTML that will be rendered when JavaScript
  * is not available.
  * @param {String} [settings.selector=`[data-portlet-id="${portletId}"]`] Query selector for
@@ -62,9 +62,9 @@ export function renderApp(name, data, ref) {
   var clientUri = getResourceUri('client/index.js');
 
   if (isOffline) {
-    return ("\n<!-- Generated by WebappUtil.renderApp() -->\n<div data-portlet-id=\"" + portletId + "\">" + noScript + "</div>\n<script src=\"" + clientUri + "\"></script>\n<script>  \n  Soleil.webapps['" + name + "'].render('" + name + "', '" + selector + "', " + (JSON.stringify(options)) + ");\n</script>\n");
+    return ("\n<!-- Generated by WebappUtil." + (this.name) + "() -->\n<div data-portlet-id=\"" + portletId + "\">" + noScript + "</div>\n<script src=\"" + clientUri + "\"></script>\n<script>  \n  Soleil.webapps['" + name + "'].render('" + name + "', '" + selector + "', " + (JSON.stringify(options)) + ");\n</script>\n");
   }
-  return ("\n<!-- Generated by WebappUtil.renderApp() -->\n<div data-portlet-id=\"" + portletId + "\">" + noScript + "</div>\n<script>\n  function renderApp" + portletId + "() {\n    Soleil.webapps['" + name + "'].render('" + name + "', '" + selector + "', " + (JSON.stringify(options)) + ");\n  }  \n</script>\n<script src=\"" + clientUri + "\" " + (async && !defer ? 'async' : '') + " " + (defer ? 'defer' : '') + " onload=\"renderApp" + portletId + "();\"></script>\n");
+  return ("\n<!-- Generated by WebappUtil." + (this.name) + "() -->\n<div data-portlet-id=\"" + portletId + "\">" + noScript + "</div>\n<script>\n  function renderApp" + portletId + "() {\n    Soleil.webapps['" + name + "'].render('" + name + "', '" + selector + "', " + (JSON.stringify(options)) + ");\n  }  \n</script>\n<script src=\"" + clientUri + "\" " + (async && !defer ? 'async' : '') + " " + (defer ? 'defer' : '') + " onload=\"renderApp" + portletId + "();\"></script>\n");
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soleil-se/app-util",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "main": "./dist/index.js",
   "author": "Soleil AB",
   "license": "UNLICENSED",

package/src/index.js

@@ -36,9 +36,9 @@ export function renderTemplate(template, values = {}) {
 /**
  * Get HTML string for rendering an application.
  * @param {String} name Name of the app, has to match the name of the application.
- * @param {Object} data Server data that will be available in the app.
+ * @param {Object} [data={}] Server data that will be available in the app.
  * In Vue it will be available in the `$options` object.
- * @param {Object} settings Settings object.
+ * @param {Object} [settings={}] Settings object.
  * @param {String} [settings.noScript=''] HTML that will be rendered when JavaScript
  * is not available.
  * @param {String} [settings.selector=`[data-portlet-id="${portletId}"]`] Query selector for