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

govuk_publishing_components 12.8.0 → 12.9.0

Files changed (53) hide show

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

@@ -78,121 +78,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">describedBy</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Text or element id to add to the `aria-describedby` attribute to provide description of the group of fields for screenreader users.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">legend</th>
-<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Arguments for the legend</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">legend.{}.text (or) legend.{}.html</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Legend text or HTML. If `html` is provided, the `text` argument will be ignored.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">legend.{}.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 legend container.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">legend.{}.isPageHeading</th>
-<td class="govuk-table__cell">boolean</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Whether the legend also acts as the heading for the page.</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 fieldset 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 fieldset 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/fieldset/#options-example-default) for details.
 ### Setting up Nunjucks views and paths

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

@@ -185,133 +185,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">name</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell">The name of the input, which is submitted with the form data.</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">Yes</td>
-<td class="govuk-table__cell">The id of the input</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">value</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional initial value of the input</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">label</th>
-<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell">Arguments for the label component. See <a href="../label/README.md#component-arguments">label</a> component.</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">Arguments for the hint component (e.g. text). 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">Arguments for the errorMessage component (e.g. text). 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">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 input 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 accept or data attributes) to add to the input 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/file-upload/#options-example-default) for details.
 ### Setting up Nunjucks views and paths

data/node_modules/govuk-frontend/components/file-upload/macro-options.json CHANGED Viewed

@@ -38,6 +38,20 @@
         "description": "Options for the errorMessage component.",
         "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": "classes",
         "type": "string",

data/node_modules/govuk-frontend/components/file-upload/template.njk CHANGED Viewed

@@ -5,7 +5,7 @@
 {#- a record of other elements that we need to associate with the input using
    aria-describedby – for example hints or error messages -#}
 {% set describedBy = "" %}
-<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 %}">
   {{ govukLabel({
     html: params.label.html,
     text: params.label.text,

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

@@ -77,241 +77,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">meta</th>
-<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Object containing parameters for the meta navigation.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">meta.text</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Text to add to the meta section of the footer, which will appear below any links specified using meta.items. If meta.html is specified, this option is ignored.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">meta.html</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">HTML to add to the meta section of the footer, which will appear below any links specified using meta.items. If you do not need to use HTML, use meta.text instead.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">meta.items</th>
-<td class="govuk-table__cell">array</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Array of items for use in the meta section of the footer.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">meta.items.{}.text</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">List item text in the meta section of the footer.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">meta.items.{}.href</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">List item href attribute in the meta section of the footer.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">meta.items.{}.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 anchor in the footer meta section.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">navigation</th>
-<td class="govuk-table__cell">array</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Array of items for use in the navigation section of the footer.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">navigation.{}.title</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Title for a section</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">navigation.{}.columns</th>
-<td class="govuk-table__cell">integer</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Amount of columns to display items in navigation section of the footer.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">navigation.items</th>
-<td class="govuk-table__cell">array</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Array of items to display in the list in navigation section of the footer.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">navigation.items.{}.text</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">List item text in the navigation section of the footer.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">navigation.items.{}.href</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">List item href attribute in the navigation section of the footer. Both `text` and `href` attributes need to be present to create a link.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">navigation.items.{}.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 anchor in the footer navigation section.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">containerClasses</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Classes that can be added to the inner container, useful if you want to make the footer full width.</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 footer component 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 footer component 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/footer/#options-example-default) for details.
 ### Setting up Nunjucks views and paths