desy-html 12.1.0 → 13.0.0

package/src/templates/components/table-advanced/params.table-advanced.yaml

@@ -1,161 +1,161 @@
-params:
-- name: rows
-  type: array
-  required: true
-  description: Array of table rows and cells.
-  params:
-  - name: text
-    type: string
-    required: true
-    description: If `html` is set, this is not required. Text for cells in table rows. 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 for cells in table rows. If `html` is provided, the `text` argument will be ignore
-  - name: classes
-    type: string
-    required: false
-    description: Classes to add to the table row cell.
-  - name: colspan
-    type: integer
-    required: false
-    description: Specify how many columns a cell extends.
-  - name: rowspan
-    type: integer
-    required: false
-    description: Specify how many rows a cell extends.
-  - name: attributes
-    type: object
-    required: false
-    description: HTML attributes (for example data attributes) to add to the table cell.
-- name: head
-  type: array
-  required: false
-  description: Array of table head cells.
-  params:
-  - name: text
-    type: string
-    required: false
-    description: If `html` is set, this is not required. Text for table head cells. If `html` is provided, the `text` argument will be ignored.
-  - name: html
-    type: string
-    required: false
-    description: If `text` is set, this is not required. HTML for table head cells. If `html` is provided, the `text` argument will be ignore
-  - name: colspan
-    type: integer
-    required: false
-    description: Specify how many columns a cell extends.
-  - name: rowspan
-    type: integer
-    required: false
-    description: Specify how many rows a cell extends.
-  - name: orderBy
-    type: string
-    required: false
-    description: Possible values `none`, `asc`, `desc`.
-  - name: hasFilter
-    type: boolean
-    required: false
-    description: If `true`, shows a filter input in head cell.
-  - name: filterText
-    type: string
-    required: false
-    description: Text for sr-only labels and placeholder for filter input in head cell.
-  - name: filterClasses
-    type: string
-    required: false
-    description: Classes to add to the table head cell input.
-  - name: select
-    type: object
-    required: false
-    description: Options for a select component to filter results in the column.
-    isComponent: true
-  - name: classes
-    type: string
-    required: false
-    description: Classes to add to the table head cell.
-  - name: attributes
-    type: object
-    required: false
-    description: HTML attributes (for example data attributes) to add to the table cell.
-- name: foot
-  type: array
-  required: false
-  description: Array of table tfoot cells.
-  params:
-  - name: text
-    type: string
-    required: false
-    description: If `html` is set, this is not required. Text for table tfoot cells. If `html` is provided, the `text` argument will be ignored.
-  - name: html
-    type: string
-    required: false
-    description: If `text` is set, this is not required. HTML for table tfoot cells. If `html` is provided, the `text` argument will be ignore
-  - name: colspan
-    type: integer
-    required: false
-    description: Specify how many columns a cell extends.
-  - name: rowspan
-    type: integer
-    required: false
-    description: Specify how many rows a cell extends.
-  - name: classes
-    type: string
-    required: false
-    description: Classes to add to the table tfoot cell.
-  - name: attributes
-    type: object
-    required: false
-    description: HTML attributes (for example data attributes) to add to the table cell.
-- name: caption
-  type: string
-  required: false
-  description: Caption text
-- name: captionClasses
-  type: string
-  required: false
-  description: Classes for caption text size. Classes should correspond to the available typography heading classes.
-- name: firstCellIsHeader
-  type: boolean
-  required: false
-  description: If set to true, first cell in table row will be a TH instead of a TD.
-- name: hasCheckboxes
-  type: boolean
-  required: false
-  description: If `true` the first column has checkboxes for every row.
-- name: checkboxesClasses
-  type: string
-  required: false
-  description: Classes for the cell that contain the checkboxes. This allows position the checkboxes inside the table.
-- name: idPrefix
-  type: string
-  required: false
-  description: String to prefix id for each checkbox item if no id is specified on each item. If not passed, fall back to using a generic one instead.
-- name: wrapper
-  type: object
-  required: false
-  description: Options for a wrapper div outside the table
-  params:
-  - name: classes
-    type: string
-    required: false
-    description: Classes to add to the wrapper (e.g. to show an horizontal scrollbar it there are many columns or in mobile)
-- name: classes
-  type: string
-  required: false
-  description: Classes to add to the table container.
-- name: attributes
-  type: object
-  required: false
-  description: HTML attributes (for example data attributes) to add to the table container.
-
-accessibilityCriteria: |
-  ## Tables must:
-    1. Debe tener al menos una celda de encabezado (TH) en las filas o columnas exteriores.
-    2. Si la tabla tiene más de un nivel de encabezado (si hay elementos th en dos filas o en dos columnas) las celdas de datos y de encabezado deben estar asociadas con los atributos id (en los th) /headers (en los td).
-    3. El título de la tabla debe estar marcado como <caption>
-    4. La primera fila de la tabla no puede tener todas las celdas unidas, o se interpreta que se está simulando un caption.
-    5. Después de un encabezado (h1, h2…) no puede ir directamente una tabla, o se entiende que se está usando el encabezado para lo que debería ser el <caption>
-    6. La tabla debe tener una descripción especialmente si la tabla es grande o compleja, tiene varios niveles de encabezados, tiene totales o enlaces, etc. La descripción intenta suplir la primera impresión que tienen de la tabla las personas que pueden verla, por ejemplo, vemos que en la última columna hay enlaces o en la última fila hay totales. Como en HTML 5 ya no está admitido el atributo summary en las tablas, lo que se hace es poner la descripción en un párrafo antes de la tabla y asociarlo a la tabla con aria-describedby (así se evita también el error 5). El caption y la descripción no deben ser iguales.
-    7. El validador del OAW dará error si hay tablas de una única columna y 3 o más filas con texto menor de 150 caracteres, pues considerará que se está simulando una lista.
+params:
+- name: rows
+  type: array
+  required: true
+  description: Array of table rows and cells.
+  params:
+  - name: text
+    type: string
+    required: true
+    description: If `html` is set, this is not required. Text for cells in table rows. 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 for cells in table rows. If `html` is provided, the `text` argument will be ignore
+  - name: classes
+    type: string
+    required: false
+    description: Classes to add to the table row cell.
+  - name: colspan
+    type: integer
+    required: false
+    description: Specify how many columns a cell extends.
+  - name: rowspan
+    type: integer
+    required: false
+    description: Specify how many rows a cell extends.
+  - name: attributes
+    type: object
+    required: false
+    description: HTML attributes (for example data attributes) to add to the table cell.
+- name: head
+  type: array
+  required: false
+  description: Array of table head cells.
+  params:
+  - name: text
+    type: string
+    required: false
+    description: If `html` is set, this is not required. Text for table head cells. If `html` is provided, the `text` argument will be ignored.
+  - name: html
+    type: string
+    required: false
+    description: If `text` is set, this is not required. HTML for table head cells. If `html` is provided, the `text` argument will be ignore
+  - name: colspan
+    type: integer
+    required: false
+    description: Specify how many columns a cell extends.
+  - name: rowspan
+    type: integer
+    required: false
+    description: Specify how many rows a cell extends.
+  - name: orderBy
+    type: string
+    required: false
+    description: Possible values `none`, `asc`, `desc`.
+  - name: hasFilter
+    type: boolean
+    required: false
+    description: If `true`, shows a filter input in head cell.
+  - name: filterText
+    type: string
+    required: false
+    description: Text for sr-only labels and placeholder for filter input in head cell.
+  - name: filterClasses
+    type: string
+    required: false
+    description: Classes to add to the table head cell input.
+  - name: select
+    type: object
+    required: false
+    description: Options for a select component to filter results in the column.
+    isComponent: true
+  - name: classes
+    type: string
+    required: false
+    description: Classes to add to the table head cell.
+  - name: attributes
+    type: object
+    required: false
+    description: HTML attributes (for example data attributes) to add to the table cell.
+- name: foot
+  type: array
+  required: false
+  description: Array of table tfoot cells.
+  params:
+  - name: text
+    type: string
+    required: false
+    description: If `html` is set, this is not required. Text for table tfoot cells. If `html` is provided, the `text` argument will be ignored.
+  - name: html
+    type: string
+    required: false
+    description: If `text` is set, this is not required. HTML for table tfoot cells. If `html` is provided, the `text` argument will be ignore
+  - name: colspan
+    type: integer
+    required: false
+    description: Specify how many columns a cell extends.
+  - name: rowspan
+    type: integer
+    required: false
+    description: Specify how many rows a cell extends.
+  - name: classes
+    type: string
+    required: false
+    description: Classes to add to the table tfoot cell.
+  - name: attributes
+    type: object
+    required: false
+    description: HTML attributes (for example data attributes) to add to the table cell.
+- name: caption
+  type: string
+  required: false
+  description: Caption text
+- name: captionClasses
+  type: string
+  required: false
+  description: Classes for caption text size. Classes should correspond to the available typography heading classes.
+- name: firstCellIsHeader
+  type: boolean
+  required: false
+  description: If set to true, first cell in table row will be a TH instead of a TD.
+- name: hasCheckboxes
+  type: boolean
+  required: false
+  description: If `true` the first column has checkboxes for every row.
+- name: checkboxesClasses
+  type: string
+  required: false
+  description: Classes for the cell that contain the checkboxes. This allows position the checkboxes inside the table.
+- name: idPrefix
+  type: string
+  required: false
+  description: String to prefix id for each checkbox item if no id is specified on each item. If not passed, fall back to using a generic one instead.
+- name: wrapper
+  type: object
+  required: false
+  description: Options for a wrapper div outside the table
+  params:
+  - name: classes
+    type: string
+    required: false
+    description: Classes to add to the wrapper (e.g. to show an horizontal scrollbar it there are many columns or in mobile)
+- name: classes
+  type: string
+  required: false
+  description: Classes to add to the table container.
+- name: attributes
+  type: object
+  required: false
+  description: HTML attributes (for example data attributes) to add to the table container.
+
+accessibilityCriteria: |
+  ## Tables must:
+    1. Debe tener al menos una celda de encabezado (TH) en las filas o columnas exteriores.
+    2. Si la tabla tiene más de un nivel de encabezado (si hay elementos th en dos filas o en dos columnas) las celdas de datos y de encabezado deben estar asociadas con los atributos id (en los th) /headers (en los td).
+    3. El título de la tabla debe estar marcado como <caption>
+    4. La primera fila de la tabla no puede tener todas las celdas unidas, o se interpreta que se está simulando un caption.
+    5. Después de un encabezado (h1, h2…) no puede ir directamente una tabla, o se entiende que se está usando el encabezado para lo que debería ser el <caption>
+    6. La tabla debe tener una descripción especialmente si la tabla es grande o compleja, tiene varios niveles de encabezados, tiene totales o enlaces, etc. La descripción intenta suplir la primera impresión que tienen de la tabla las personas que pueden verla, por ejemplo, vemos que en la última columna hay enlaces o en la última fila hay totales. Como en HTML 5 ya no está admitido el atributo summary en las tablas, lo que se hace es poner la descripción en un párrafo antes de la tabla y asociarlo a la tabla con aria-describedby (así se evita también el error 5). El caption y la descripción no deben ser iguales.
+    7. El validador del OAW dará error si hay tablas de una única columna y 3 o más filas con texto menor de 150 caracteres, pues considerará que se está simulando una lista.
     8. Las tablas complejas como esta deben tener una descripción. La descripción se incluye en un texto visible antes de la tabla (aunque puede estar en un <details>) y se asocia a la tabla mediante el atributo aria-describedby de la tabla.