desy-html 10.2.2 → 11.0.1

package/src/templates/components/fieldset/params.fieldset.yaml

@@ -1,50 +1,50 @@
-params:
-- name: describedBy
-  type: string
-  required: false
-  description: One or more element IDs to add to the `aria-describedby` attribute, used to provide additional descriptive information for screenreader users.
-- name: errorId
-  type: string
-  required: false
-  description: One or more element IDs to add to the `aria-errormessage` attribute, used to provide additional error information for screenreader users.
-- name: legend
-  type: object
-  required: false
-  description: Options for the legend
-  params:
-  - name: text
-    type: string
-    required: true
-    description: If `html` is set, this is not required. Text to use within the legend. 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 the legend. If `html` is provided, the `text` argument will be ignored.
-  - name: classes
-    type: string
-    required: false
-    description: Classes to add to the legend.
-  - name: isPageHeading
-    type: boolean
-    required: false
-    description: Whether the legend also acts as the heading for the page.
-- name: headingLevel
-  type: number
-  required: false
-  description: If headingLevel is 1, the parent heading tag needed inside this component will be a h1, if 2 will be a h2, and so on.
-- name: classes
-  type: string
-  required: false
-  description: Classes to add to the fieldset container.
-- name: role
-  type: string
-  required: false
-  description: Optional ARIA role attribute.
-- name: attributes
-  type: object
-  required: false
-  description: HTML attributes (for example data attributes) to add to the fieldset container.
-- name: caller
-  type: nunjucks-block
-  required: false
+params:
+- name: describedBy
+  type: string
+  required: false
+  description: One or more element IDs to add to the `aria-describedby` attribute, used to provide additional descriptive information for screenreader users.
+- name: errorId
+  type: string
+  required: false
+  description: One or more element IDs to add to the `aria-errormessage` attribute, used to provide additional error information for screenreader users.
+- name: legend
+  type: object
+  required: false
+  description: Options for the legend
+  params:
+  - name: text
+    type: string
+    required: true
+    description: If `html` is set, this is not required. Text to use within the legend. 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 the legend. If `html` is provided, the `text` argument will be ignored.
+  - name: classes
+    type: string
+    required: false
+    description: Classes to add to the legend.
+  - name: isPageHeading
+    type: boolean
+    required: false
+    description: Whether the legend also acts as the heading for the page.
+- name: headingLevel
+  type: number
+  required: false
+  description: If headingLevel is 1, the parent heading tag needed inside this component will be a h1, if 2 will be a h2, and so on.
+- name: classes
+  type: string
+  required: false
+  description: Classes to add to the fieldset container.
+- name: role
+  type: string
+  required: false
+  description: Optional ARIA role attribute.
+- name: attributes
+  type: object
+  required: false
+  description: HTML attributes (for example data attributes) to add to the fieldset container.
+- name: caller
+  type: nunjucks-block
+  required: false
   description: Not strictly a parameter but [Nunjucks code convention](https://mozilla.github.io/nunjucks/templating.html#call). Using a `call` block enables you to call a macro with all the text inside the tag. This is helpful if you want to pass a lot of content into a macro. To use it, you will need to wrap the entire fielset component in a `call` block.

package/src/templates/components/file-upload/_examples.file-upload.njk

@@ -1,85 +1,85 @@
-{% set exampleComponent = "file-upload" %}
-{% set examples =  [
-  {
-    "name": "por defecto",
-    "data": {
-      "id": "file-upload-1",
-      "name": "file-upload-1",
-      "label": {
-        "text": "Sube un archivo"
-      },
-      "classes": "overflow-x-auto max-w-64 lg:max-w-none"
-    }
-  },
-  {
-    "name": "con pista",
-    "data": {
-      "id": "file-upload-2",
-      "name": "file-upload-2",
-      "label": {
-        "text": "Sube una foto"
-      },
-      "hint": {
-        "text": "Tu foto puede estar en tus Imágenes, Fotos, Descargas o el Escritorio. O en una aplicación como Fotos."
-      },
-      "classes": "overflow-x-auto max-w-64 lg:max-w-none"
-    }
-  },
-  {
-    "name": "con mensaje de error",
-    "data": {
-      "id": "file-upload-3",
-      "name": "file-upload-3",
-      "label": {
-        "text": "Sube un archivo"
-      },
-      "hint": {
-        "text": "Tu foto puede estar en tus Imágenes, Fotos, Descargas o el Escritorio. O en una aplicación como Fotos."
-      },
-      "errorMessage": {
-        "text": "Error: esto es un mensaje de error"
-      },
-      "classes": "overflow-x-auto max-w-64 lg:max-w-none"
-    }
-  },
-  {
-    "name": "con atributos",
-    "data": {
-      "id": "file-upload-4",
-      "name": "file-upload-4",
-      "label": {
-        "text": "Sube una foto"
-      },
-      "attributes": {
-        "accept": ".jpg, .jpeg, .png"
-      },
-      "classes": "overflow-x-auto max-w-64 lg:max-w-none"
-    }
-  },
-  {
-    "name": "con label como encabezado",
-    "data": {
-      "id": "file-upload-5",
-      "name": "file-upload-5",
-      "label": {
-        "text": "Sube un archivo",
-        "isPageHeading": true
-      },
-      "classes": "overflow-x-auto max-w-64 lg:max-w-none"
-    }
-  },
-  {
-    "name": "con clases de form-group opcionales",
-    "data": {
-      "id": "file-upload-6",
-      "name": "file-upload-6",
-      "label": {
-        "text": "Sube un archivo"
-      },
-      "classes": "overflow-x-auto max-w-64 lg:max-w-none",
-      "formGroup": {
-        "classes": "p-base bg-warning-light"
-      }
-    }
-  }
+{% set exampleComponent = "file-upload" %}
+{% set examples =  [
+  {
+    "name": "por defecto",
+    "data": {
+      "id": "file-upload-1",
+      "name": "file-upload-1",
+      "label": {
+        "text": "Sube un archivo"
+      },
+      "classes": "overflow-x-auto max-w-64 lg:max-w-none"
+    }
+  },
+  {
+    "name": "con pista",
+    "data": {
+      "id": "file-upload-2",
+      "name": "file-upload-2",
+      "label": {
+        "text": "Sube una foto"
+      },
+      "hint": {
+        "text": "Tu foto puede estar en tus Imágenes, Fotos, Descargas o el Escritorio. O en una aplicación como Fotos."
+      },
+      "classes": "overflow-x-auto max-w-64 lg:max-w-none"
+    }
+  },
+  {
+    "name": "con mensaje de error",
+    "data": {
+      "id": "file-upload-3",
+      "name": "file-upload-3",
+      "label": {
+        "text": "Sube un archivo"
+      },
+      "hint": {
+        "text": "Tu foto puede estar en tus Imágenes, Fotos, Descargas o el Escritorio. O en una aplicación como Fotos."
+      },
+      "errorMessage": {
+        "text": "Error: esto es un mensaje de error"
+      },
+      "classes": "overflow-x-auto max-w-64 lg:max-w-none"
+    }
+  },
+  {
+    "name": "con atributos",
+    "data": {
+      "id": "file-upload-4",
+      "name": "file-upload-4",
+      "label": {
+        "text": "Sube una foto"
+      },
+      "attributes": {
+        "accept": ".jpg, .jpeg, .png"
+      },
+      "classes": "overflow-x-auto max-w-64 lg:max-w-none"
+    }
+  },
+  {
+    "name": "con label como encabezado",
+    "data": {
+      "id": "file-upload-5",
+      "name": "file-upload-5",
+      "label": {
+        "text": "Sube un archivo",
+        "isPageHeading": true
+      },
+      "classes": "overflow-x-auto max-w-64 lg:max-w-none"
+    }
+  },
+  {
+    "name": "con clases de form-group opcionales",
+    "data": {
+      "id": "file-upload-6",
+      "name": "file-upload-6",
+      "label": {
+        "text": "Sube un archivo"
+      },
+      "classes": "overflow-x-auto max-w-64 lg:max-w-none",
+      "formGroup": {
+        "classes": "p-base bg-warning-light"
+      }
+    }
+  }
 ] %}

package/src/templates/components/file-upload/_macro.file-upload.njk

@@ -1,3 +1,3 @@
-{% macro componentFileUpload(params) %}
-{% include "./_template.file-upload.njk" %}
+{% macro componentFileUpload(params) %}
+{% include "./_template.file-upload.njk" %}
 {% endmacro %}

package/src/templates/components/file-upload/_template.file-upload.njk

@@ -1,47 +1,47 @@
-{% from "../error-message/_macro.error-message.njk" import componentErrorMessage -%}
-{% from "../hint/_macro.hint.njk" import componentHint %}
-{% from "../label/_macro.label.njk" import componentLabel %}
-
-{#- a record of other elements that we need to associate with the input using
-   aria-describedby – for example hints or error messages -#}
-{% set describedBy = params.describedBy if params.describedBy else "" %}
-<!-- file-upload -->
-<div class="c-form-group {%- if params.errorMessage %} c-form-group--error{% endif %} {%- if params.formGroup.classes %} {{ params.formGroup.classes }}{% endif %}">
-  {{ componentLabel({
-    html: params.label.html,
-    text: params.label.text,
-    classes: params.label.classes,
-    isPageHeading: params.label.isPageHeading,
-    attributes: params.label.attributes,
-    for: params.id
-  }) | indent(2) | trim }}
-{% if params.hint %}
-  {% set hintId = params.id + '-hint' %}
-  {% set describedBy = describedBy + ' ' + hintId if describedBy else hintId %}
-  {{ componentHint({
-    id: hintId,
-    classes: params.hint.classes,
-    attributes: params.hint.attributes,
-    html: params.hint.html,
-    text: params.hint.text
-  }) | indent(2) | trim }}
-{% endif %}
-{% if params.errorMessage %}
-  {% set errorId = params.id + '-error' %}
-  {% set describedBy = describedBy + " " + errorId if describedBy else errorId %}
-  {{ componentErrorMessage({
-    id: errorId,
-    classes: params.errorMessage.classes,
-    attributes: params.errorMessage.attributes,
-    html: params.errorMessage.html,
-    text: params.errorMessage.text,
-    visuallyHiddenText: params.errorMessage.visuallyHiddenText
-  }) | indent(2) | trim }}
-{% endif %}
-  <input class="mt-sm p-xs file:mr-base focus:outline-none file:inline-flex file:items-baseline file:px-3 file:py-2 file:bg-white file:border file:border-solid file:border-primary-base file:rounded file:align-baseline file:font-semibold file:text-primary-base file:transition-all file:duration-100 file:ease-out file:whitespace-nowrap file:cursor-pointer file:focus:bg-warning-base file:focus:border-warning-base file:focus:shadow-outline-black file:focus:text-black file:focus:outline-none file:hover:bg-neutral-light file:hover:border-primary-base file:hover:text-primary-base {%- if params.classes %} {{ params.classes }}{% endif %} {%- if params.errorMessage %} c-file-upload--error{% endif %}" id="{{ params.id }}" name="{{ params.name }}" type="file"
-  {%- if params.value %} value="{{ params.value }}"{% endif %}
-  {%- if describedBy %} aria-describedby="{{ describedBy }}"{% endif %}
-  {%- if params.errorMessage %} aria-errormessage="{{ errorId }}" aria-invalid="true"{% endif %}
-  {%- for attribute, value in params.attributes %} {{attribute}}="{{value}}"{% endfor %}>
-</div>
+{% from "../error-message/_macro.error-message.njk" import componentErrorMessage -%}
+{% from "../hint/_macro.hint.njk" import componentHint %}
+{% from "../label/_macro.label.njk" import componentLabel %}
+
+{#- a record of other elements that we need to associate with the input using
+   aria-describedby – for example hints or error messages -#}
+{% set describedBy = params.describedBy if params.describedBy else "" %}
+<!-- file-upload -->
+<div class="c-form-group {%- if params.errorMessage %} c-form-group--error{% endif %} {%- if params.formGroup.classes %} {{ params.formGroup.classes }}{% endif %}">
+  {{ componentLabel({
+    html: params.label.html,
+    text: params.label.text,
+    classes: params.label.classes,
+    isPageHeading: params.label.isPageHeading,
+    attributes: params.label.attributes,
+    for: params.id
+  }) | indent(2) | trim }}
+{% if params.hint %}
+  {% set hintId = params.id + '-hint' %}
+  {% set describedBy = describedBy + ' ' + hintId if describedBy else hintId %}
+  {{ componentHint({
+    id: hintId,
+    classes: params.hint.classes,
+    attributes: params.hint.attributes,
+    html: params.hint.html,
+    text: params.hint.text
+  }) | indent(2) | trim }}
+{% endif %}
+{% if params.errorMessage %}
+  {% set errorId = params.id + '-error' %}
+  {% set describedBy = describedBy + " " + errorId if describedBy else errorId %}
+  {{ componentErrorMessage({
+    id: errorId,
+    classes: params.errorMessage.classes,
+    attributes: params.errorMessage.attributes,
+    html: params.errorMessage.html,
+    text: params.errorMessage.text,
+    visuallyHiddenText: params.errorMessage.visuallyHiddenText
+  }) | indent(2) | trim }}
+{% endif %}
+  <input class="mt-sm p-xs file:mr-base focus:outline-none file:inline-flex file:items-baseline file:px-3 file:py-2 file:bg-white file:border file:border-solid file:border-primary-base file:rounded file:align-baseline file:font-semibold file:text-primary-base file:transition-all file:duration-100 file:ease-out file:whitespace-nowrap file:cursor-pointer file:focus:bg-warning-base file:focus:border-warning-base file:focus:shadow-outline-black file:focus:text-black file:focus:outline-none file:hover:bg-neutral-light file:hover:border-primary-base file:hover:text-primary-base {%- if params.classes %} {{ params.classes }}{% endif %} {%- if params.errorMessage %} c-file-upload--error{% endif %}" id="{{ params.id }}" name="{{ params.name }}" type="file"
+  {%- if params.value %} value="{{ params.value }}"{% endif %}
+  {%- if describedBy %} aria-describedby="{{ describedBy }}"{% endif %}
+  {%- if params.errorMessage %} aria-errormessage="{{ errorId }}" aria-invalid="true"{% endif %}
+  {%- for attribute, value in params.attributes %} {{attribute}}="{{value}}"{% endfor %}>
+</div>
 <!-- /file-upload -->

package/src/templates/components/file-upload/params.file-upload.yaml

@@ -1,49 +1,49 @@
-params:
-- name: name
-  type: string
-  required: true
-  description: The name of the input, which is submitted with the form data.
-- name: id
-  type: string
-  required: true
-  description: The id of the input
-- name: value
-  type: string
-  required: false
-  description: Optional initial value of the input
-- name: describedBy
-  type: string
-  required: false
-  description: One or more element IDs to add to the `aria-describedby` attribute, used to provide additional descriptive information for screenreader users.
-- name: label
-  type: object
-  required: true
-  description: Options for the label component.
-  isComponent: true
-- name: hint
-  type: object
-  required: false
-  description: Options for the hint component.
-  isComponent: true
-- name: errorMessage
-  type: object
-  required: false
-  description: Options for the error message component. The error message component will not display if you use a falsy value for `errorMessage`, for example `false` or `null`.
-  isComponent: true
-- name: formGroup
-  type: object
-  required: false
-  description: Options for the form-group wrapper
-  params:
-  - name: classes
-    type: string
-    required: false
-    description: Classes to add to the form group (e.g. to show error state for the whole group)
-- name: classes
-  type: string
-  required: false
-  description: Classes to add to the file upload component.
-- name: attributes
-  type: object
-  required: false
+params:
+- name: name
+  type: string
+  required: true
+  description: The name of the input, which is submitted with the form data.
+- name: id
+  type: string
+  required: true
+  description: The id of the input
+- name: value
+  type: string
+  required: false
+  description: Optional initial value of the input
+- name: describedBy
+  type: string
+  required: false
+  description: One or more element IDs to add to the `aria-describedby` attribute, used to provide additional descriptive information for screenreader users.
+- name: label
+  type: object
+  required: true
+  description: Options for the label component.
+  isComponent: true
+- name: hint
+  type: object
+  required: false
+  description: Options for the hint component.
+  isComponent: true
+- name: errorMessage
+  type: object
+  required: false
+  description: Options for the error message component. The error message component will not display if you use a falsy value for `errorMessage`, for example `false` or `null`.
+  isComponent: true
+- name: formGroup
+  type: object
+  required: false
+  description: Options for the form-group wrapper
+  params:
+  - name: classes
+    type: string
+    required: false
+    description: Classes to add to the form group (e.g. to show error state for the whole group)
+- name: classes
+  type: string
+  required: false
+  description: Classes to add to the file upload component.
+- name: attributes
+  type: object
+  required: false
   description: HTML attributes (for example data attributes) to add to the file upload component.