govuk_publishing_components 12.8.0 → 12.9.0

data/node_modules/govuk-frontend/components/header/README.md

@@ -337,205 +337,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">homepageUrl</th>
-
-<td class="govuk-table__cell">string</td>
-
-<td class="govuk-table__cell">No</td>
-
-<td class="govuk-table__cell">The url of the homepage. Defaults to /</td>
-
-</tr>
-
-<tr class="govuk-table__row">
-
-<th class="govuk-table__header" scope="row">assetsPath</th>
-
-<td class="govuk-table__cell">string</td>
-
-<td class="govuk-table__cell">No</td>
-
-<td class="govuk-table__cell">The public path for the assets folder. If not provided it defaults to /assets/images</td>
-
-</tr>
-
-<tr class="govuk-table__row">
-
-<th class="govuk-table__header" scope="row">productName</th>
-
-<td class="govuk-table__cell">string</td>
-
-<td class="govuk-table__cell">No</td>
-
-<td class="govuk-table__cell">Header title that is placed next to GOV.UK. Used for product names (i.e. Pay, Verify)</td>
-
-</tr>
-
-<tr class="govuk-table__row">
-
-<th class="govuk-table__header" scope="row">serviceName</th>
-
-<td class="govuk-table__cell">string</td>
-
-<td class="govuk-table__cell">No</td>
-
-<td class="govuk-table__cell">Header title that is placed next to GOV.UK. Used for product names (i.e. Pay, Verify)</td>
-
-</tr>
-
-<tr class="govuk-table__row">
-
-<th class="govuk-table__header" scope="row">serviceUrl</th>
-
-<td class="govuk-table__cell">string</td>
-
-<td class="govuk-table__cell">No</td>
-
-<td class="govuk-table__cell">Url for the service name anchor.</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">An array of navigation item objects.</td>
-
-</tr>
-
-<tr class="govuk-table__row">
-
-<th class="govuk-table__header" scope="row">navigation.{}.text</th>
-
-<td class="govuk-table__cell">string</td>
-
-<td class="govuk-table__cell">No</td>
-
-<td class="govuk-table__cell">Text of the navigation item.</td>
-
-</tr>
-
-<tr class="govuk-table__row">
-
-<th class="govuk-table__header" scope="row">navigation.{}.href</th>
-
-<td class="govuk-table__cell">string</td>
-
-<td class="govuk-table__cell">No</td>
-
-<td class="govuk-table__cell">Url of the navigation item anchor. Both `href` and `text` attributes for navigation items need to be provided to create an item.</td>
-
-</tr>
-
-<tr class="govuk-table__row">
-
-<th class="govuk-table__header" scope="row">navigation.{}.active</th>
-
-<td class="govuk-table__cell">boolean</td>
-
-<td class="govuk-table__cell">No</td>
-
-<td class="govuk-table__cell">Flag to mark the navigation item as active or not.</td>
-
-</tr>
-
-<tr class="govuk-table__row">
-
-<th class="govuk-table__header" scope="row">navigation.{}.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 navigation item anchor.</td>
-
-</tr>
-
-<tr class="govuk-table__row">
-
-<th class="govuk-table__header" scope="row">navigationClasses</th>
-
-<td class="govuk-table__cell">string</td>
-
-<td class="govuk-table__cell">No</td>
-
-<td class="govuk-table__cell">Optional classes that can be added to the navigation section of the header.</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">Optional classes that can be added to the container, useful if you want to make the header fixed 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 header 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 header 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/header/#options-example-default) for details.
 
 ### Setting up Nunjucks views and paths
 

data/node_modules/govuk-frontend/components/hint/README.md

@@ -62,85 +62,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) 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 hint. 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">Yes</td>
-
-<td class="govuk-table__cell">Optional id attribute o add to the hint 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 hint 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 hint 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/file-upload/#options-example-default--hint) for details.
 
 ### Setting up Nunjucks views and paths
 

data/node_modules/govuk-frontend/components/input/README.md

@@ -393,145 +393,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">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">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">type</th>
-
-<td class="govuk-table__cell">string</td>
-
-<td class="govuk-table__cell">No</td>
-
-<td class="govuk-table__cell">Type of input control to render. Defaults to "text".</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">No</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 add to the input component.</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 input component.</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/text-input/#options-example-default) for details.
 
 ### Setting up Nunjucks views and paths
 

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

@@ -37,6 +37,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",