RubyGems - govuk_publishing_components - Versions diffs - 12.8.0 → 12.9.0 - Mend

govuk_publishing_components 12.8.0 → 12.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (53) hide show

data/node_modules/govuk-frontend/components/date-input/README.md CHANGED Viewed

@@ -549,181 +549,11 @@ In order to include the images used in the components, you need to configure you
     app.use('/assets', express.static(path.join(__dirname, '/node_modules/govuk-frontend/assets')))
-## Component arguments
+## Component options
-If you are using Nunjucks,then macros take the following arguments
+Use options to customise the appearance, content and behaviour of a component when using a macro, for example, changing the text.
-**If you’re using Nunjucks macros in production be aware that using `html` arguments, or ones ending with `Html` can be a [security risk](https://en.wikipedia.org/wiki/Cross-site_scripting). More about it in the [Nunjucks documentation](https://mozilla.github.io/nunjucks/api.html#user-defined-templates-warning).**
-<table class="govuk-table">
-<thead class="govuk-table__head">
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="col">Name</th>
-<th class="govuk-table__header" scope="col">Type</th>
-<th class="govuk-table__header" scope="col">Required</th>
-<th class="govuk-table__header" scope="col">Description</th>
-</tr>
-</thead>
-<tbody class="govuk-table__body">
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">id</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional id. This is used for the main component and to compose id attribute for each item.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">namePrefix</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional prefix. This is used to prefix each `item.name` using `-`.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">items</th>
-<td class="govuk-table__cell">array</td>
-<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell">An array of input objects with name, value and optional classes</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">items.{}.id</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional item-specific id. If provided, it will be used instead of the generated id.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">items.{}.name</th>
-<td class="govuk-table__cell">array</td>
-<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell">Item-specific name attribute.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">items.{}.value</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional item-specific value attribute. If provided, it will be used as the initial value of the input.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">items.{}.label</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional item-specific label text. If provided, this will be used instead of the items.{}.name.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">hint</th>
-<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional hint. See <a href="../hint/README.md#component-arguments">hint</a> component.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">errorMessage</th>
-<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional error message. See <a href="../error-message/README.md#component-arguments">errorMessage</a> component.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">fieldset</th>
-<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Arguments for the fieldset component (e.g. legend). See <a href="../fieldset/README.md#component-arguments">fieldset</a> component.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">classes</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional additional classes to add to the date-input container.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">attributes</th>
-<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Any extra HTML attributes (for example data attributes) to add to the date-input container.</td>
-</tr>
-</tbody>
-</table>
-**If you’re using Nunjucks macros in production be aware that using `html` arguments, or ones ending with `Html` can be a [security risk](https://en.wikipedia.org/wiki/Cross-site_scripting). More about it in the [Nunjucks documentation](https://mozilla.github.io/nunjucks/api.html#user-defined-templates-warning).**
+See [options table](https://design-system.service.gov.uk/components/date-input/#options-example-default) for details.
 ### Setting up Nunjucks views and paths

data/node_modules/govuk-frontend/components/date-input/macro-options.json CHANGED Viewed

@@ -63,6 +63,20 @@
         "description": "Options for the error message.",
         "isComponent": true
     },
+    {
+        "name": "formGroup",
+        "type": "object",
+        "required": false,
+        "description": "Options for the form-group wrapper",
+        "params": [
+            {
+                "name": "classes",
+                "type": "string",
+                "required": false,
+                "description": "Optional classes to add to the form group (e.g. to show error state for the whole group)"
+            }
+        ]
+    },
     {
         "name": "fieldset",
         "type": "object",

data/node_modules/govuk-frontend/components/date-input/template.njk CHANGED Viewed

@@ -73,7 +73,7 @@
   </div>
 {% endset %}
-<div class="govuk-form-group {%- if params.errorMessage %} govuk-form-group--error{% endif %}">
+<div class="govuk-form-group {%- if params.errorMessage %} govuk-form-group--error{% endif %} {%- if params.formGroup.classes %} {{ params.formGroup.classes }}{% endif %}">
 {% if params.fieldset %}
 {#- We override the fieldset's role to 'group' because otherwise JAWS does not
     announce the description for a fieldset comprised of text inputs, but

data/node_modules/govuk-frontend/components/details/README.md CHANGED Viewed

@@ -114,109 +114,11 @@ In order to include the images used in the components, you need to configure you
     app.use('/assets', express.static(path.join(__dirname, '/node_modules/govuk-frontend/assets')))
-## Component arguments
+## Component options
-If you are using Nunjucks,then macros take the following arguments
+Use options to customise the appearance, content and behaviour of a component when using a macro, for example, changing the text.
-**If you’re using Nunjucks macros in production be aware that using `html` arguments, or ones ending with `Html` can be a [security risk](https://en.wikipedia.org/wiki/Cross-site_scripting). More about it in the [Nunjucks documentation](https://mozilla.github.io/nunjucks/api.html#user-defined-templates-warning).**
-<table class="govuk-table">
-<thead class="govuk-table__head">
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="col">Name</th>
-<th class="govuk-table__header" scope="col">Type</th>
-<th class="govuk-table__header" scope="col">Required</th>
-<th class="govuk-table__header" scope="col">Description</th>
-</tr>
-</thead>
-<tbody class="govuk-table__body">
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">summaryText (or) summaryHtml</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell">Text or HTML to use within the summary element (the visible part of the details element). If `summaryHtml` is provided, the `summaryText` argument will be ignored.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">text (or) html</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell">Text or HTML to use within the disclosed part of the details element. If `html` is provided, the `text` argument will be ignored.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">id</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional id to add to the details element.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">open</th>
-<td class="govuk-table__cell">boolean</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">If true, details element will be expanded.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">classes</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional additional classes to add to the details element.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">attributes</th>
-<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Any extra HTML attributes (for example data attributes) to add to the details element.</td>
-</tr>
-</tbody>
-</table>
-**If you’re using Nunjucks macros in production be aware that using `html` arguments, or ones ending with `Html` can be a [security risk](https://en.wikipedia.org/wiki/Cross-site_scripting). More about it in the [Nunjucks documentation](https://mozilla.github.io/nunjucks/api.html#user-defined-templates-warning).**
+See [options table](https://design-system.service.gov.uk/components/details/#options-example-default) for details.
 ### Setting up Nunjucks views and paths

data/node_modules/govuk-frontend/components/error-message/README.md CHANGED Viewed

@@ -44,85 +44,11 @@ In order to include the images used in the components, you need to configure you
     app.use('/assets', express.static(path.join(__dirname, '/node_modules/govuk-frontend/assets')))
-## Component arguments
+## Component options
-If you are using Nunjucks,then macros take the following arguments
+Use options to customise the appearance, content and behaviour of a component when using a macro, for example, changing the text.
-**If you’re using Nunjucks macros in production be aware that using `html` arguments, or ones ending with `Html` can be a [security risk](https://en.wikipedia.org/wiki/Cross-site_scripting). More about it in the [Nunjucks documentation](https://mozilla.github.io/nunjucks/api.html#user-defined-templates-warning).**
-<table class="govuk-table">
-<thead class="govuk-table__head">
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="col">Name</th>
-<th class="govuk-table__header" scope="col">Type</th>
-<th class="govuk-table__header" scope="col">Required</th>
-<th class="govuk-table__header" scope="col">Description</th>
-</tr>
-</thead>
-<tbody class="govuk-table__body">
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">text (or) html</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Text to use within the error message. If `html` is provided, the `text` argument will be ignored.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">id</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional id attribute to add to the error message span tag.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">classes</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional additional classes to add to the error message span tag.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">attributes</th>
-<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Any extra HTML attributes (for example data attributes) to add to the error message span tag</td>
-</tr>
-</tbody>
-</table>
-**If you’re using Nunjucks macros in production be aware that using `html` arguments, or ones ending with `Html` can be a [security risk](https://en.wikipedia.org/wiki/Cross-site_scripting). More about it in the [Nunjucks documentation](https://mozilla.github.io/nunjucks/api.html#user-defined-templates-warning).**
+See [options table](https://design-system.service.gov.uk/components/error-message/#options-example-default) for details.
 ### Setting up Nunjucks views and paths

data/node_modules/govuk-frontend/components/error-summary/README.md CHANGED Viewed

@@ -80,133 +80,11 @@ In order to include the images used in the components, you need to configure you
     app.use('/assets', express.static(path.join(__dirname, '/node_modules/govuk-frontend/assets')))
-## Component arguments
+## Component options
-If you are using Nunjucks,then macros take the following arguments
+Use options to customise the appearance, content and behaviour of a component when using a macro, for example, changing the text.
-**If you’re using Nunjucks macros in production be aware that using `html` arguments, or ones ending with `Html` can be a [security risk](https://en.wikipedia.org/wiki/Cross-site_scripting). More about it in the [Nunjucks documentation](https://mozilla.github.io/nunjucks/api.html#user-defined-templates-warning).**
-<table class="govuk-table">
-<thead class="govuk-table__head">
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="col">Name</th>
-<th class="govuk-table__header" scope="col">Type</th>
-<th class="govuk-table__header" scope="col">Required</th>
-<th class="govuk-table__header" scope="col">Description</th>
-</tr>
-</thead>
-<tbody class="govuk-table__body">
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">titleText (or) titleHtml</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell">Text or HTML to use for the heading of the error summary block. If `titleHtml` is provided, the `titleText` argument will be ignored.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">descriptionText (or) descriptionHtml</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional text or HTML description of the errors. If `descriptionhtml` is provided, the `descriptionText` argument will be ignored.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">errorList</th>
-<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell">Contains an array of error link items and all their available arguments.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">errorList.{}.href</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Href attribute for the error link item. If provided item will be an anchor.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">errorList.{}.text (or) errorList.{}.html</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell">Text or HTML for the error link item. If `html` is provided, the `text` argument will be ignored.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">errorList.{}.attributes</th>
-<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Any extra HTML attributes (for example data attributes) to add to the error link anchor.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">classes</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional additional classes to add to the error-summary container.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">attributes</th>
-<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Any extra HTML attributes (for example data attributes) to add to the error-summary container.</td>
-</tr>
-</tbody>
-</table>
-**If you’re using Nunjucks macros in production be aware that using `html` arguments, or ones ending with `Html` can be a [security risk](https://en.wikipedia.org/wiki/Cross-site_scripting). More about it in the [Nunjucks documentation](https://mozilla.github.io/nunjucks/api.html#user-defined-templates-warning).**
+See [options table](https://design-system.service.gov.uk/components/error-summary/#options-example-default) for details.
 ### Setting up Nunjucks views and paths