@gov-cy/govcy-frontend-renderer 1.15.0 → 1.16.1

package/README.md

@@ -5,14 +5,16 @@
 
 Use this package to render HTML for gov.cy elements, as they are defined in the [Unified Design System](https://gov-cy.github.io/govcy-design-system-docs/), using njk or json templates.
 
-The rendered HTML should:
-- Be as close of a representation as possible of the design elements as they are defined in the [Unified Design System](https://gov-cy.github.io/govcy-design-system-docs/)
-- Include the gov.cy branding
-- Use the [govcy design system](https://gov-cy.github.io/govcy-design-system-docs/) css classes and javascript functions
-- Use HTML best practices and be valid HTML
-- Use accessibility best practices
-- Allow multiple languages
-- Be tested
+![govcy-frontend-renderer](DSF-govcy-frontend-renderer.png)
+
+The project was developed to support the [gov.cy Unified Design System](https://gov-cy.github.io/govcy-design-system-docs/), so that the rendered HTML:
+- is as close of a representation as possible of the design elements as they are defined in the [Unified Design System](https://gov-cy.github.io/govcy-design-system-docs/)
+- includes the gov.cy branding
+- uses the [govcy design system](https://gov-cy.github.io/govcy-design-system-docs/) css classes and javascript functions
+- uses HTML best practices and be valid HTML
+- uses accessibility best practices
+- allows multiple languages
+- is tested
 
 Though the project is not intended to be used for production purposes and does provide any guaranties, your welcome to try it.
 
@@ -82,6 +84,7 @@ const inputData =
         "headerTitle" : {"en":"Header title", "el":"Τιτλός επικεφαλιδας"},
         "description" : {"en":"Service description", "el":"Περιγραφή υπηρεσίας"},
         "url" : "https://gov.cy",
+        "manifest": "/manifest.json",
         "matomo": {
             "url": "//wp.matomo.dits.dmrid.gov.cy/",
             "siteId": "1234"
@@ -175,6 +178,7 @@ const inputData =
         "headerTitle" : {"en":"Header title", "el":"Τιτλός επικεφαλιδας"},
         "description" : {"en":"Service description", "el":"Περιγραφή υπηρεσίας"},
         "url" : "https://gov.cy",
+        "manifest": "manifest.json",
         "matomo": {
             "url": "//wp.matomo.dits.dmrid.gov.cy/",
             "siteId": "1234"
@@ -315,6 +319,7 @@ The `inputData` object has the following structure:
 - **site.title**: the title of the site. It is used in the `<title>`, `<meta property="og:title"` and `<meta property="twitter:title"` tags of the head.
 - **site.description**: the description of the site. It is used in the `<meta name="description"`, `<meta property="og:description"` and `<meta property="twitter:description"` tags of the head.
 - **site.url**: the URL of the site. It is used in the `<meta property="og:url"` and `<meta property="twitter:url"` tags of the head.
+- **site.manifest**: the manifest of the site. It is used to add the manifest location to the page.
 - **site.matomo**: the matomo data. It is used to add the Matomo code to the page. If you don't want to use Matomo tracking, you can remove this value. Use `site.matomo.url` to define the URL of the Matomo server and `site.matomo.siteId` to define the site ID to be tracked.
 - **site.cdn.dist**: the CDN of the site. It is used to define the URL of the CDN used for the CSS and JS files. If you need to change the version of the CDN, you can do it by changing this value (in this case you will need to change the `site.cdn.cssIntegrity` and `site.cdn.jsIntegrity` values as well)
 - **site.cdn.cssIntegrity**: the integrity of the CSS file. It is used to define the integrity of the CSS file. If you need to change the version of the CDN, you will need to change this value. https://www.srihash.org/ can help you generate the integrity value.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gov-cy/govcy-frontend-renderer",
-  "version": "1.15.0",
+  "version": "1.16.1",
   "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/layouts/govcyBase.njk

@@ -22,6 +22,7 @@ To use this template you need to pass the following data:
     "description" : {"en":"Service description", "el":"Περιγραφή υπηρεσίας"},
     "isTesting" : true,
     "url": "https://gov.cy",
+    "manifest": "manifest.json",
     "matomo": {
       "url": "//wp.matomo.dits.dmrid.gov.cy/",
       "siteId": 1234
@@ -63,7 +64,9 @@ To use this template you need to pass the following data:
     <meta property="twitter:image" content="{{ site.cdn.dist }}/img/icons-512.png">
  
     <!-- Theme --> 
-    {# <link rel="manifest" href="manifest.json"> #}
+    {% if site.manifest %}
+    <link rel="manifest" href="{{ site.manifest }}">
+    {% endif %}
     <meta name="theme-color" content="#31576F">
     <link rel="icon" type="image/png" sizes="48x48" href="{{ site.cdn.dist }}/img/favicon-48x48.png">
     <link rel="icon" type="image/png" sizes="32x32" href="{{ site.cdn.dist }}/img/favicon-32x32.png">