RubyGems - govuk_publishing_components - Versions diffs - 12.0.0 → 12.0.1 - Mend

govuk_publishing_components 12.0.0 → 12.0.1

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 (45) hide show

data/node_modules/govuk-frontend/components/character-count/macro-options.json ADDED Viewed

@@ -0,0 +1,83 @@
+[
+    {
+        "name": "id",
+        "type": "string",
+        "required": true,
+        "description": "The id of the textarea."
+    },
+    {
+        "name": "describedBy",
+        "type": "string",
+        "required": false,
+        "description": "Text or element id to add to the `aria-describedby` attribute to provide description for screenreader users."
+    },
+    {
+        "name": "name",
+        "type": "string",
+        "required": true,
+        "description": "The name of the textarea, which is submitted with the form data."
+    },
+    {
+        "name": "rows",
+        "type": "string",
+        "required": false,
+        "description": "Optional number of textarea rows (default is 5 rows)."
+    },
+    {
+        "name": "value",
+        "type": "string",
+        "required": false,
+        "description": "Optional initial value of the textarea."
+    },
+    {
+        "name": "maxlength",
+        "type": "string",
+        "required": true,
+        "description": "If `maxwords` is set, this is not required. The maximum number of characters. If `maxwords` is provided, the `maxlength` argument will be ignored."
+    },
+    {
+        "name": "maxwords",
+        "type": "string",
+        "required": true,
+        "description": "If `maxlength` is set, this is not required. The maximum number of words. If `maxwords` is provided, the `maxlength` argument will be ignored."
+    },
+    {
+        "name": "threshold",
+        "type": "string",
+        "required": true,
+        "description": "The percentage value of the limit at which point the count message is displayed. If this attribute is set, the count message will be hidden by default."
+    },
+    {
+        "name": "label",
+        "type": "object",
+        "required": true,
+        "description": "Options for the label component.",
+        "isComponent": true
+    },
+    {
+        "name": "hint",
+        "type": "object",
+        "required": false,
+        "description": "Options for the hint component.",
+        "isComponent": true
+    },
+    {
+        "name": "errorMessage",
+        "type": "object",
+        "required": false,
+        "description": "Options for the errorMessage component (e.g. text).",
+        "isComponent": true
+    },
+    {
+        "name": "classes",
+        "type": "string",
+        "required": false,
+        "description": "Classes to add to the textarea."
+    },
+    {
+        "name": "attributes",
+        "type": "object",
+        "required": false,
+        "description": "HTML attributes (for example data attributes) to add to the textarea."
+    }
+]

data/node_modules/govuk-frontend/components/character-count/macro.njk ADDED Viewed

@@ -0,0 +1,3 @@
+{% macro govukCharacterCount(params) %}
+  {%- include "./template.njk" -%}
+{% endmacro %}

data/node_modules/govuk-frontend/components/character-count/template.njk ADDED Viewed

@@ -0,0 +1,32 @@
+{% from "../error-message/macro.njk" import govukErrorMessage -%}
+{% from "../hint/macro.njk" import govukHint %}
+{% from "../label/macro.njk" import govukLabel %}
+{% from "../textarea/macro.njk" import govukTextarea %}
+<div class="govuk-character-count" data-module="character-count"
+{%- if params.maxlength %} data-maxlength="{{ params.maxlength }}"{% endif %}
+{%- if params.threshold %} data-threshold="{{ params.threshold }}"{% endif %}
+{%- if params.maxwords %} data-maxwords="{{ params.maxwords }}"{% endif %}>
+  {{ govukTextarea({
+    id: params.id,
+    name: params.name,
+    describedBy: params.id + '-info',
+    rows: params.rows,
+    value: params.value,
+    classes: 'js-character-count ' + (' govuk-textarea--error' if params.errorMessage) + (params.classes if params.classes),
+    label: {
+      html: params.label.html,
+      text: params.label.text,
+      classes: params.label.classes,
+      isPageHeading: params.label.isPageHeading,
+      attributes: params.label.attributes,
+      for: params.id
+    },
+    hint: params.hint,
+    errorMessage: params.errorMessage,
+    attributes: params.attributes
+  }) }}
+  <span id="{{ params.id }}-info" class="govuk-hint govuk-character-count__message" aria-live="polite">
+    You can enter up to {{ params.maxlength or params.maxwords }} {{'words' if params.maxwords else 'characters' }}
+  </span>
+</div>

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

@@ -721,11 +721,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">fieldset</th>
-<td class="govuk-table__cell ">object</td>
+<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell ">No</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>
+<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>
@@ -733,11 +733,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">hint</th>
-<td class="govuk-table__cell ">object</td>
+<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell ">No</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>
+<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>
@@ -745,11 +745,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">errorMessage</th>
-<td class="govuk-table__cell ">object</td>
+<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell ">No</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>
+<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>
@@ -757,11 +757,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">idPrefix</th>
-<td class="govuk-table__cell ">string</td>
+<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell ">No</td>
+<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell ">String to prefix id for each checkbox item if no id is specified on each item. If`idPrefix` is not passed, fallback to using the name attribute instead.</td>
+<td class="govuk-table__cell">String to prefix id for each checkbox item if no id is specified on each item. If`idPrefix` is not passed, fallback to using the name attribute instead.</td>
 </tr>
@@ -769,11 +769,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">name</th>
-<td class="govuk-table__cell ">string</td>
+<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell ">Yes</td>
+<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell ">Name attribute for each checkbox item.</td>
+<td class="govuk-table__cell">Name attribute for each checkbox item.</td>
 </tr>
@@ -781,11 +781,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items</th>
-<td class="govuk-table__cell ">array</td>
+<td class="govuk-table__cell">array</td>
-<td class="govuk-table__cell ">Yes</td>
+<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell ">Array of checkbox items objects.</td>
+<td class="govuk-table__cell">Array of checkbox items objects.</td>
 </tr>
@@ -793,11 +793,11 @@ If you are using Nunjucks,then macros take the following arguments
 <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">string</td>
-<td class="govuk-table__cell ">Yes</td>
+<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell ">Text or HTML to use within each checkbox item label. If `html` is provided, the `text` argument will be ignored.</td>
+<td class="govuk-table__cell">Text or HTML to use within each checkbox item label. If `html` is provided, the `text` argument will be ignored.</td>
 </tr>
@@ -805,11 +805,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items.{}.id</th>
-<td class="govuk-table__cell ">string</td>
+<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell ">No</td>
+<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell ">Specific id attribute for the checkbox item. If ommited, then `idPrefix` string will be applied.</td>
+<td class="govuk-table__cell">Specific id attribute for the checkbox item. If ommited, then `idPrefix` string will be applied.</td>
 </tr>
@@ -817,11 +817,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items.{}.name</th>
-<td class="govuk-table__cell ">string</td>
+<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell ">Yes</td>
+<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell ">Specific name for the checkbox item. If ommited, then component global `name` string will be applied.</td>
+<td class="govuk-table__cell">Specific name for the checkbox item. If ommited, then component global `name` string will be applied.</td>
 </tr>
@@ -829,11 +829,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items.{}.value</th>
-<td class="govuk-table__cell ">string</td>
+<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell ">Yes</td>
+<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell ">Value for the checkbox input.</td>
+<td class="govuk-table__cell">Value for the checkbox input.</td>
 </tr>
@@ -841,11 +841,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items.{}.label</th>
-<td class="govuk-table__cell ">object</td>
+<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell ">No</td>
+<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell ">Provide additional attributes and classes to each checkbox item label. See [label](../label/README.md#component-arguments) component for more details.</td>
+<td class="govuk-table__cell">Provide additional attributes and classes to each checkbox item label. See [label](../label/README.md#component-arguments) component for more details.</td>
 </tr>
@@ -853,11 +853,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items.{}.hint</th>
-<td class="govuk-table__cell ">object</td>
+<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell ">No</td>
+<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell ">Provide optional hint to each checkbox item. See `hint` component for more details.</td>
+<td class="govuk-table__cell">Provide optional hint to each checkbox item. See `hint` component for more details.</td>
 </tr>
@@ -865,11 +865,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items.{}.checked</th>
-<td class="govuk-table__cell ">boolean</td>
+<td class="govuk-table__cell">boolean</td>
-<td class="govuk-table__cell ">No</td>
+<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell ">If true, checkbox will be checked.</td>
+<td class="govuk-table__cell">If true, checkbox will be checked.</td>
 </tr>
@@ -877,11 +877,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items.{}.conditional</th>
-<td class="govuk-table__cell ">boolean</td>
+<td class="govuk-table__cell">boolean</td>
-<td class="govuk-table__cell ">No</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>
+<td class="govuk-table__cell">If true, content provided will be revealed when the item is checked.</td>
 </tr>
@@ -889,11 +889,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items.{}.conditional.html</th>
-<td class="govuk-table__cell ">boolean</td>
+<td class="govuk-table__cell">boolean</td>
-<td class="govuk-table__cell ">No</td>
+<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell ">Provide content for the conditional reveal.</td>
+<td class="govuk-table__cell">Provide content for the conditional reveal.</td>
 </tr>
@@ -901,11 +901,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items.{}.disabled</th>
-<td class="govuk-table__cell ">boolean</td>
+<td class="govuk-table__cell">boolean</td>
-<td class="govuk-table__cell ">No</td>
+<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell ">If true, checkbox will be disabled.</td>
+<td class="govuk-table__cell">If true, checkbox will be disabled.</td>
 </tr>
@@ -913,11 +913,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items.{}.attributes</th>
-<td class="govuk-table__cell ">object</td>
+<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell ">No</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 checkbox input tag.</td>
+<td class="govuk-table__cell">Any extra HTML attributes (for example data attributes) to add to the checkbox input tag.</td>
 </tr>
@@ -925,11 +925,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">classes</th>
-<td class="govuk-table__cell ">string</td>
+<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell ">No</td>
+<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell ">Optional additional classes to add to the checkboxes container.</td>
+<td class="govuk-table__cell">Optional additional classes to add to the checkboxes container.</td>
 </tr>
@@ -937,11 +937,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">attributes</th>
-<td class="govuk-table__cell ">object</td>
+<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell ">No</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 checkboxes container.</td>
+<td class="govuk-table__cell">Any extra HTML attributes (for example data attributes) to add to the checkboxes container.</td>
 </tr>

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

@@ -579,11 +579,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">id</th>
-<td class="govuk-table__cell ">string</td>
+<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell ">No</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>
+<td class="govuk-table__cell">Optional id. This is used for the main component and to compose id attribute for each item.</td>
 </tr>
@@ -591,11 +591,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">namePrefix</th>
-<td class="govuk-table__cell ">string</td>
+<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell ">No</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>
+<td class="govuk-table__cell">Optional prefix. This is used to prefix each `item.name` using `-`.</td>
 </tr>
@@ -603,11 +603,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items</th>
-<td class="govuk-table__cell ">array</td>
+<td class="govuk-table__cell">array</td>
-<td class="govuk-table__cell ">Yes</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>
+<td class="govuk-table__cell">An array of input objects with name, value and optional classes</td>
 </tr>
@@ -615,11 +615,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items.{}.id</th>
-<td class="govuk-table__cell ">string</td>
+<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell ">No</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>
+<td class="govuk-table__cell">Optional item-specific id. If provided, it will be used instead of the generated id.</td>
 </tr>
@@ -627,11 +627,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items.{}.name</th>
-<td class="govuk-table__cell ">array</td>
+<td class="govuk-table__cell">array</td>
-<td class="govuk-table__cell ">Yes</td>
+<td class="govuk-table__cell">Yes</td>
-<td class="govuk-table__cell ">Item-specific name attribute.</td>
+<td class="govuk-table__cell">Item-specific name attribute.</td>
 </tr>
@@ -639,11 +639,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items.{}.value</th>
-<td class="govuk-table__cell ">string</td>
+<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell ">No</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>
+<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>
@@ -651,11 +651,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">items.{}.label</th>
-<td class="govuk-table__cell ">string</td>
+<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell ">No</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>
+<td class="govuk-table__cell">Optional item-specific label text. If provided, this will be used instead of the items.{}.name.</td>
 </tr>
@@ -663,11 +663,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">hint</th>
-<td class="govuk-table__cell ">object</td>
+<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell ">No</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>
+<td class="govuk-table__cell">Optional hint. See <a href="../hint/README.md#component-arguments">hint</a> component.</td>
 </tr>
@@ -675,11 +675,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">errorMessage</th>
-<td class="govuk-table__cell ">object</td>
+<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell ">No</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>
+<td class="govuk-table__cell">Optional error message. See <a href="../error-message/README.md#component-arguments">errorMessage</a> component.</td>
 </tr>
@@ -687,11 +687,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">fieldset</th>
-<td class="govuk-table__cell ">object</td>
+<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell ">No</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>
+<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>
@@ -699,11 +699,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">classes</th>
-<td class="govuk-table__cell ">string</td>
+<td class="govuk-table__cell">string</td>
-<td class="govuk-table__cell ">No</td>
+<td class="govuk-table__cell">No</td>
-<td class="govuk-table__cell ">Optional additional classes to add to the date-input container.</td>
+<td class="govuk-table__cell">Optional additional classes to add to the date-input container.</td>
 </tr>
@@ -711,11 +711,11 @@ If you are using Nunjucks,then macros take the following arguments
 <th class="govuk-table__header" scope="row">attributes</th>
-<td class="govuk-table__cell ">object</td>
+<td class="govuk-table__cell">object</td>
-<td class="govuk-table__cell ">No</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>
+<td class="govuk-table__cell">Any extra HTML attributes (for example data attributes) to add to the date-input container.</td>
 </tr>