desy-html 6.4.1 → 6.6.0

package/src/templates/components/links-list/params.links-list.yaml

@@ -0,0 +1,82 @@
+params:
+- name: idPrefix
+  type: string
+  required: false
+  description: String to prefix id for each item if no id is specified on each item.
+- name: hasNav
+  type: boolean
+  required: false
+  description: Defaults to `true`. If `false`, there will be no nav assuming the component will be wrapped with a custom nav with it's own aria-label.
+- name: items
+  type: array
+  required: true
+  description: Array of nav items objects.
+  params:
+  - name: href
+    type: string
+    required: false
+    description: Item link.
+  - name: target
+    type: string
+    required: false
+    description: The target where the item should link to.
+  - name: text
+    type: string
+    required: true
+    description: If `html` is set, this is not required. Text to use within each nav item label. If `html` is provided, the `text` argument will be ignored.
+  - name: html
+    type: string
+    required: true
+    description: If `text` is set, this is not required. HTML to use within each nav item label. If `html` is provided, the `text` argument will be ignored.
+  - name: id
+    type: string
+    required: false
+    description: Specific id attribute for the item. If omitted, then idPrefix option will be applied.
+  - name: disabled
+    type: boolean
+    required: false
+    description: If true, nav will be disabled.
+  - name: sub
+    type: boolean
+    required: false
+    description: If true, content provided will be revealed when the item is expanded.
+    - name: html
+      type: string
+      required: true
+      description: Provide content for the sub.
+    - name: classes
+      type: string
+      required: false
+      description: Classes to add to the sub container.
+  - name: icon
+    type: object
+    required: false
+    description: This is the optional icon at left
+    - name: html
+      type: string
+      required: true
+      description: Use this html to insert a custom svg inline icon. If this is set, the type are not used.
+    - name: containerClasses
+      type: string
+      required: false
+      description: Classes applied to the parent div of icon. Useful to vertical align the icon.
+  - name: containerClasses
+    type: string
+    required: false
+    description: Classes to add to the parent `<li> of the item.
+  - name: classes
+    type: string
+    required: false
+    description: Classes to add to the item.
+  - name: attributes
+    type: object
+    required: false
+    description: HTML attributes (for example data attributes) to add to the item.
+- name: classes
+  type: string
+  required: false
+  description: Classes to add to the nav container.
+- name: attributes
+  type: object
+  required: false
+  description: HTML attributes (for example data attributes) to add to the nav container.

package/src/templates/components/menu-vertical/params.menu-vertical.yaml

@@ -37,10 +37,6 @@ params:
     required: false
     description: Provide hint to each nav item.
     isComponent: true
-  - name: expanded
-    type: boolean
-    required: false
-    description: If true, nav sub will be expanded.
   - name: divider
     required: false
     description: If true, a divider border will be shown after the item.

package/src/templates/components/table/_examples.table.njk

@@ -1,54 +1,10 @@
 {% set exampleComponent = "table" %}
 {% set examples =  [
   {
-    "name": "default",
-    "data": {
-      "rows": [
-        [
-          {
-            "text": "January"
-          },
-          {
-            "text": "85€",
-            "classes": "text-right"
-          },
-          {
-            "text": "95€",
-            "classes": "text-right"
-          }
-        ],
-        [
-          {
-            "text": "February"
-          },
-          {
-            "text": "75€",
-            "classes": "text-right"
-          },
-          {
-            "text": "55€",
-            "classes": "text-right"
-          }
-        ],
-        [
-          {
-            "text": "March"
-          },
-          {
-            "text": "165€",
-            "classes": "text-right"
-          },
-          {
-            "text": "125€",
-            "classes": "text-right"
-          }
-        ]
-      ]
-    }
-  },
-  {
-    "name": "table with head",
+    "name": "table default",
     "data": {
+      "caption": "Caption de la tabla",
+      "captionClasses": "sr-only mb-base font-bold text-left text-lg",
       "head": [
         {
           "text": "Month you apply"
@@ -106,7 +62,7 @@
     }
   },
   {
-    "name": "table with head and caption",
+    "name": "table with caption visible",
     "data": {
       "caption": "Caption 1: Months and rates",
       "captionClasses": "mb-base font-bold text-left text-lg",

package/src/templates/components/table-advanced/_examples.table-advanced.njk

@@ -1,56 +1,11 @@
 {% set exampleComponent = "table-advanced" %}
 {% set examples =  [
   {
-    "name": "default",
+    "name": "table default",
     "data": {
-      "rows": [
-        [
-          {
-            "text": "January"
-          },
-          {
-            "text": "85€",
-            "classes": "text-right"
-          },
-          {
-            "text": "95€",
-            "classes": "text-right"
-          }
-        ],
-        [
-          {
-            "text": "February"
-          },
-          {
-            "text": "75€",
-            "classes": "text-right"
-          },
-          {
-            "text": "55€",
-            "classes": "text-right"
-          }
-        ],
-        [
-          {
-            "text": "March"
-          },
-          {
-            "text": "165€",
-            "classes": "text-right"
-          },
-          {
-            "text": "125€",
-            "classes": "text-right"
-          }
-        ]
-      ],
-      "classes": "min-w-full"
-    }
-  },
-  {
-    "name": "table with head",
-    "data": {
-      "idPrefix": "table-with-head",
+      "idPrefix": "table-default",
+      "caption": "Caption de la tabla",
+      "captionClasses": "sr-only mb-base font-bold text-left text-lg",
       "head": [
         {
           "text": "Month you apply"
@@ -109,10 +64,10 @@
     }
   },
   {
-    "name": "table with head and caption",
+    "name": "table with caption visible",
     "description": "Also with firstCellIsHeader: true",
     "data": {
-      "idPrefix": "table-with-head-and-caption",
+      "idPrefix": "table-with-caption",
       "caption": "Caption 1: Months and rates",
       "captionClasses": "mb-base font-bold text-left text-lg",
       "firstCellIsHeader": true,

package/docs/examples-header-advanced-2.html

@@ -1,5 +0,0 @@
-{% set title = "Header advanced. Componente, parámetros y ejemplos. Documentación de desy-html. Gobierno de Aragón" %}
-{% extends "_template.examples.njk" %}
-{% block contentBlock %}
-  {% import "components/header-advanced/_examples.header-advanced-2.njk" as exampleData %}
-{% endblock %}