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/input/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/inset-text/README.md CHANGED Viewed

@@ -4,6 +4,10 @@
 Use bordered inset text to draw attention to important content on the page.
+## Guidance
+Find out when to use the inset text component in your service in the [GOV.UK Design System](https://design-system.service.gov.uk/components/inset-text).
 ## Quick start examples
 ### Inset text
@@ -58,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
-If you are using Nunjucks,then macros take the following arguments
-**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">Yes</td>
-<td class="govuk-table__cell">Text or HTML to use within the inset text. 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 inset text container.</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 inset text 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 inset text container.</td>
-</tr>
-</tbody>
+## Component options
-</table>
+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).**
+See [options table](https://design-system.service.gov.uk/components/inset-text/#options-example-default) for details.
 ### Setting up Nunjucks views and paths

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

@@ -82,97 +82,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">Yes</td>
-<td class="govuk-table__cell">Text or HTML to use within the label. If `html` is provided, the `text` argument will be ignored.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">for</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell">The value of the for attribute, the id of the input the label is associated with.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">isPageHeading</th>
-<td class="govuk-table__cell">boolean</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Whether the label 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 label 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 label 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--label) for details.
 ### Setting up Nunjucks views and paths

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

@@ -79,97 +79,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 for the panel title. If `titleHtml` is provided, the `titleText` argument is ignored.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">headingLevel</th>
-<td class="govuk-table__cell">number</td>
-<td class="govuk-table__cell">no</td>
-<td class="govuk-table__cell">Optional heading level, from 1 to 6\. Default is 2.</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">No</td>
-<td class="govuk-table__cell">Text or HTML for the panel content. If `html` is provided, the `text` argument is ignored.</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 panel 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 panel 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/panel/#options-example-default) for details.
 ### Setting up Nunjucks views and paths

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

@@ -53,85 +53,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">Yes</td>
-<td class="govuk-table__cell">HTML to use for the phase-banner 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">tag</th>
-<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Arguments for the tag object. See <a href="../tag/README.md#component-arguments">tag</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 phase banner 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 phase banner 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/phase-banner/#options-example-default) for details.
 ### Setting up Nunjucks views and paths

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

@@ -651,277 +651,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">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">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 errorMessage component.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">idPrefix</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">String to prefix id for each radio item if no id is specified on each item. If`idPrefix` is not passed, fallback to using the name attribute instead.</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">Name attribute for each radio item.</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">Array of checkbox items objects.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">items.{}.text (or) items.{}.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 each radio item label. If `html` is provided, the `text` argument will be ignored.</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">Specific id attribute for the radio item. If ommited, then `idPrefix` string will be applied.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">items.{}.name</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell">Specific name for the radio item. If ommited, then component global `name` string will be applied.</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">Yes</td>
-<td class="govuk-table__cell">Value for the radio input.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">items.{}.label</th>
-<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Provide additional attributes and classes to each radio item label. See [label](../label/README.md#component-arguments) component for more details.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">items.{}.hint</th>
-<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Provide optional hint to each radio item. See `hint` component for more details.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">items.{}.divider</th>
-<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Optional divider text to separate radio items, for example the text "or".</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">items.{}.checked</th>
-<td class="govuk-table__cell">boolean</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">If true, radio will be checked.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">items.{}.conditional</th>
-<td class="govuk-table__cell">boolean</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">If true, content provided will be revealed when the item is checked.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">items.{}.conditional.html</th>
-<td class="govuk-table__cell">boolean</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">Provide content for the conditional reveal.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">items.{}.disabled</th>
-<td class="govuk-table__cell">boolean</td>
-<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell">If true, radio will be disabled.</td>
-</tr>
-<tr class="govuk-table__row">
-<th class="govuk-table__header" scope="row">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 radio input 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 radios 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 radios 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/radios/#options-example-default) for details.
 ### Setting up Nunjucks views and paths