@gov-cy/govcy-frontend-renderer 1.13.0 → 1.14.0

package/README.md

@@ -359,6 +359,7 @@ let inputString =
 
 If your using the `pageData.layout`, you can render html in each of the following [gov.cy page template](https://gov-cy.github.io/govcy-design-system-docs/getting-started/page-template/) blocks:
 - **bodyStart**: the start of the body
+- **userName**: the section where the username and logout links are rendered
 - **header**: the header section (where the gov.cy logo and service name are rendered)
 - **beforeMain**: the section before the main content
 - **main**: the main content
@@ -414,6 +415,7 @@ let inputJson =
 
 If your using the `pageData.layout`, you can render html in each of the following [gov.cy page template](https://gov-cy.github.io/govcy-design-system-docs/getting-started/page-template/) blocks, by using the `sections` array (in a similar way `blocks` is use ) :
 - **bodyStart**: the start of the body
+- **userName**: the section where the username and logout links are rendered
 - **header**: the header section (where the gov.cy logo and service name are rendered)
 - **beforeMain**: the section before the main content
 - **main**: the main content

package/dist/govcyCompiledTemplates.browser.js

@@ -7115,6 +7115,110 @@ root: root
 })();
 })();
 
+(function() {(window.nunjucksPrecompiled = window.nunjucksPrecompiled || {})["elements/userName.njk"] = (function() {
+function root(env, context, frame, runtime, cb) {
+var lineno = 0;
+var colno = 0;
+var output = "";
+try {
+var parentTemplate = null;
+output += "\r\n";
+var macro_t_1 = runtime.makeMacro(
+["params"], 
+[], 
+function (l_params, kwargs) {
+var callerFrame = frame;
+frame = new runtime.Frame();
+kwargs = kwargs || {};
+if (Object.prototype.hasOwnProperty.call(kwargs, "caller")) {
+frame.set("caller", kwargs.caller); }
+frame.set("params", l_params);
+var t_2 = "";env.getTemplate("utilities/govcyUtilities.njk", false, "elements/userName.njk", false, function(t_4,t_3) {
+if(t_4) { cb(t_4); return; }
+t_3.getExported(function(t_5,t_3) {
+if(t_5) { cb(t_5); return; }
+if(Object.prototype.hasOwnProperty.call(t_3, "govcyLocalizeContent")) {
+var t_6 = t_3.govcyLocalizeContent;
+} else {
+cb(new Error("cannot import 'govcyLocalizeContent'")); return;
+}
+context.setVariable("govcyLocalizeContent", t_6);
+if(Object.prototype.hasOwnProperty.call(t_3, "govcyLangAttribute")) {
+var t_7 = t_3.govcyLangAttribute;
+} else {
+cb(new Error("cannot import 'govcyLangAttribute'")); return;
+}
+context.setVariable("govcyLangAttribute", t_7);
+var t_8;
+t_8 = (lineno = 12, colno = 38, runtime.callWrap(t_6, "govcyLocalizeContent", context, [{"en": "Sign out","el": "Αποσύνδεση"},runtime.memberLookup((l_params),"lang")]));
+frame.set("signOut", t_8, true);
+if(frame.topLevel) {
+context.setVariable("signOut", t_8);
+}
+if(frame.topLevel) {
+context.addExport("signOut", t_8);
+}
+var t_9;
+t_9 = (lineno = 13, colno = 49, runtime.callWrap(t_6, "govcyLocalizeContent", context, [{"en": "from user","el": "από το χρήστη"},runtime.memberLookup((l_params),"lang")]));
+frame.set("userVisuallyHidden", t_9, true);
+if(frame.topLevel) {
+context.setVariable("userVisuallyHidden", t_9);
+}
+if(frame.topLevel) {
+context.addExport("userVisuallyHidden", t_9);
+}
+if(runtime.memberLookup((l_params),"name") && runtime.memberLookup((l_params),"signOutLink")) {
+t_2 += "\r\n    <div ";
+if(runtime.memberLookup((l_params),"id")) {
+t_2 += "id=\"";
+t_2 += runtime.suppressValue(runtime.memberLookup((l_params),"id"), env.opts.autoescape);
+t_2 += "\" ";
+;
+}
+t_2 += "class=\"govcy-header-top-area";
+if(runtime.memberLookup((l_params),"classes")) {
+t_2 += " ";
+t_2 += runtime.suppressValue(runtime.memberLookup((l_params),"classes"), env.opts.autoescape);
+;
+}
+t_2 += "\"";
+t_2 += runtime.suppressValue((lineno = 15, colno = 164, runtime.callWrap(t_7, "govcyLangAttribute", context, [runtime.memberLookup((l_params),"lang")])), env.opts.autoescape);
+t_2 += ">\r\n        <div class=\"govcy-container\">\r\n            <div class=\"govcy-header-top-area-wrapper\">\r\n                <ul class=\"govcy-sign-in\">\r\n                    <li>";
+t_2 += runtime.suppressValue((lineno = 19, colno = 47, runtime.callWrap(t_6, "govcyLocalizeContent", context, [runtime.memberLookup((l_params),"name"),runtime.memberLookup((l_params),"lang")])), env.opts.autoescape);
+t_2 += "</li>\r\n                    <li><span>|</span></li>\r\n                    <li><a href=\"";
+t_2 += runtime.suppressValue(runtime.memberLookup((l_params),"signOutLink"), env.opts.autoescape);
+t_2 += "\">";
+t_2 += runtime.suppressValue(runtime.contextOrFrameLookup(context, frame, "signOut"), env.opts.autoescape);
+t_2 += "<span class=\"govcy-visually-hidden-error\"> ";
+t_2 += runtime.suppressValue(runtime.contextOrFrameLookup(context, frame, "userVisuallyHidden"), env.opts.autoescape);
+t_2 += " ";
+t_2 += runtime.suppressValue((lineno = 21, colno = 163, runtime.callWrap(t_6, "govcyLocalizeContent", context, [runtime.memberLookup((l_params),"name"),runtime.memberLookup((l_params),"lang")])), env.opts.autoescape);
+t_2 += "</span></a></li>\r\n                </ul>\r\n            </div>\r\n        </div>\r\n    </div>";
+;
+}
+})});
+frame = callerFrame;
+return new runtime.SafeString(t_2);
+});
+context.addExport("userName");
+context.setVariable("userName", macro_t_1);
+if(parentTemplate) {
+parentTemplate.rootRenderFunc(env, context, frame, runtime, cb);
+} else {
+cb(null, output);
+}
+;
+} catch (e) {
+  cb(runtime.handleError(e, lineno, colno));
+}
+}
+return {
+root: root
+};
+
+})();
+})();
+
 (function() {(window.nunjucksPrecompiled = window.nunjucksPrecompiled || {})["govcyElement.njk"] = (function() {
 function root(env, context, frame, runtime, cb) {
 var lineno = 0;
@@ -7123,7 +7227,7 @@ var output = "";
 try {
 var parentTemplate = null;
 var t_1;
-t_1 = ["label","legend","hint","button","errorMessage","select","textElement","htmlElement","textInput","radios","checkboxes","fileInput","fileView","backLink","tag","table","summaryList","textArea","markdown","panel","datePicker","dateInput","taskList","errorSummary","details","stepByStepStatic","progressList"];
+t_1 = ["label","legend","hint","button","errorMessage","select","textElement","htmlElement","textInput","radios","checkboxes","fileInput","fileView","backLink","tag","table","summaryList","textArea","markdown","panel","datePicker","dateInput","taskList","errorSummary","details","stepByStepStatic","progressList","userName"];
 frame.set("macroSimpleBlocks", t_1, true);
 if(frame.topLevel) {
 context.setVariable("macroSimpleBlocks", t_1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gov-cy/govcy-frontend-renderer",
-  "version": "1.13.0",
+  "version": "1.14.0",
   "description": "Render html for design elements of the Unified design system using njk or json template.",
   "author": "DMRID - DSF Team",
   "license": "MIT",

package/src/njk/elements/userName.njk

@@ -0,0 +1,28 @@
+{# error userName 
+ @param {object} name The name text. Will escape text. Example `{en:"George Smith",el:"Γιώργος Σμιθ"}` 
+ @param {string} signOutLink The sign out url. Will escape text.
+ @param {string} id The id attribute. Will escape text. Optional 
+ @param {string} lang The language used. Can be 'en','el'. Optional, default is 'el'.
+ @param {string} classes Additional classes to add to the outer div. Optional 
+ @returns govcy user name html 
+#}
+{% macro userName(params) -%}
+{#- Import localizer from utilities -#}
+{%- from "../utilities/govcyUtilities.njk" import govcyLocalizeContent, govcyLangAttribute -%}
+{#- set localizations -#}
+{%- set signOut = govcyLocalizeContent({en:'Sign out',el:'Αποσύνδεση'} , params.lang) -%}
+{%- set userVisuallyHidden = govcyLocalizeContent({en:'from user',el:'από το χρήστη'} , params.lang) -%}
+{%- if params.name and params.signOutLink %}
+    <div {% if params.id %}id="{{ params.id }}" {% endif %}class="govcy-header-top-area{% if params.classes %} {{ params.classes }}{% endif %}"{{ govcyLangAttribute(params.lang) }}>
+        <div class="govcy-container">
+            <div class="govcy-header-top-area-wrapper">
+                <ul class="govcy-sign-in">
+                    <li>{{ govcyLocalizeContent(params.name , params.lang) }}</li>
+                    <li><span>|</span></li>
+                    <li><a href="{{ params.signOutLink }}">{{ signOut }}<span class="govcy-visually-hidden-error"> {{ userVisuallyHidden }} {{ govcyLocalizeContent(params.name , params.lang) }}</span></a></li>
+                </ul>
+            </div>
+        </div>
+    </div>
+{%- endif %}
+{%- endmacro %}

package/src/njk/govcyElement.njk

@@ -26,7 +26,7 @@ To use:
     'errorMessage','select','textElement','htmlElement','textInput','radios','checkboxes',
     'fileInput','fileView','backLink','tag','table', 'summaryList', 'textArea','markdown', 
     'panel', 'datePicker','dateInput', 'taskList', 'errorSummary', 'details', 'stepByStepStatic',
-    'progressList'] -%}
+    'progressList', 'userName'] -%}
 {%- set macroCallerBlocks = ['formControl','form','fieldset'] -%}
 {%- macro govcyElement(component, params) -%}
     {#- Simple blocks -#}

package/src/njk/layouts/govcyBase.njk

@@ -87,6 +87,7 @@ To use this template you need to pass the following data:
 
     <!--Header-->
     <header class="govcy-header govcy-d-print-none" id="headerContainer">
+        {% block userName %}{% endblock %}
         {% block header %}
         <div class="govcy-header-main-area">
             <div class="govcy-container govcy-main-area-items">