govuk-frontend - npm Package Compare versions

Comparing version 3.13.0 to 3.13.1

govuk/components/accordion/macro-options.json

@@ -6,3 +6,3 @@ [
         "required": true,
-        "description": "Must be **unique** across the domain of your service (as the expanded state of individual instances of the component persists across page loads using [`sessionStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)). Used as an `id` in the HTML for the accordion as a whole, and also as a prefix for the `id`s of the section contents and the buttons that open them, so that those `id`s can be the target of `aria-labelledby` and `aria-control` attributes."
+        "description": "Must be unique across the domain of your service (as the expanded state of individual instances of the component persists across page loads using [`sessionStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)). Used as an `id` in the HTML for the accordion as a whole, and also as a prefix for the `id`s of the section contents and the buttons that open them, so that those `id`s can be the target of `aria-labelledby` and `aria-control` attributes."
     },
@@ -13,3 +13,3 @@ {
         "required": false,
-        "description": "Heading level, from 1 to 6. Default is `2`."
+        "description": "Heading level, from `1` to `6`. Default is `2`."
     },
@@ -16,0 +16,0 @@ {

govuk/components/back-link/macro-options.json

@@ -6,3 +6,3 @@ [
         "required": false,
-        "description": "Text to use within the back link component. If `html` is provided, the `text` argument will be ignored. Defaults to \"Back\"."
+        "description": "Text to use within the back link component. If `html` is provided, the `text` argument will be ignored. Defaults to 'Back'."
     },
@@ -13,3 +13,3 @@ {
         "required": false,
-        "description": "HTML to use within the back link component. If `html` is provided, the `text` argument will be ignored. Defaults to \"Back\"."
+        "description": "HTML to use within the back link component. If `html` is provided, the `text` argument will be ignored. Defaults to 'Back'."
     },
@@ -20,3 +20,3 @@ {
         "required": true,
-        "description": "The value of the link href attribute."
+        "description": "The value of the link's `href` attribute."
     },
@@ -23,0 +23,0 @@ {

govuk/components/button/fixtures.json

@@ -41,2 +41,11 @@ {
         {
+            "name": "start",
+            "options": {
+                "text": "Start now button",
+                "isStartButton": true
+            },
+            "html": "<button class=\"govuk-button govuk-button--start\" data-module=\"govuk-button\">\n  Start now button\n  <svg class=\"govuk-button__start-icon\" xmlns=\"http://www.w3.org/2000/svg\" width=\"17.5\" height=\"19\" viewBox=\"0 0 33 40\" aria-hidden=\"true\" focusable=\"false\">\n    <path fill=\"currentColor\" d=\"M0 0h13l20 20-20 20H0l20-20z\"/>\n  </svg></button>",
+            "hidden": false
+        },
+        {
             "name": "start link",
@@ -43,0 +52,0 @@ "options": {

govuk/components/character-count/macro-options.json

@@ -6,3 +6,3 @@ [
         "required": true,
-        "description": "The id of the textarea."
+        "description": "The ID of the textarea."
     },
@@ -70,3 +70,3 @@ {
         "required": false,
-        "description": "Options for the form-group wrapper",
+        "description": "Options for the form-group wrapper.",
         "params": [
@@ -77,3 +77,3 @@ {
                 "required": false,
-                "description": "Classes to add to the form group (for example to show error state for the whole group)"
+                "description": "Classes to add to the form group (for example to show error state for the whole group)."
             }
@@ -98,3 +98,3 @@ ]
         "required": false,
-        "description": "Optional field to enable or disable the spellcheck attribute on the character count."
+        "description": "Optional field to enable or disable the `spellcheck` attribute on the character count."
     },
@@ -105,3 +105,3 @@ {
         "required": false,
-        "description": "Options for the count message",
+        "description": "Options for the count message.",
         "params": [
@@ -112,3 +112,3 @@ {
                 "required": false,
-                "description": "Classes to add to the count message"
+                "description": "Classes to add to the count message."
             }
@@ -115,0 +115,0 @@ ]

govuk/components/checkboxes/macro-options.json

@@ -33,3 +33,3 @@ [
         "required": false,
-        "description": "Options for the form-group wrapper",
+        "description": "Options for the form-group wrapper.",
         "params": [
@@ -40,3 +40,3 @@ {
                 "required": false,
-                "description": "Classes to add to the form group (for example to show error state for the whole group)"
+                "description": "Classes to add to the form group (for example to show error state for the whole group)."
             }
@@ -79,3 +79,3 @@ ]
                 "required": false,
-                "description": "Specific id attribute for the checkbox item. If omitted, then component global `idPrefix` option will be applied."
+                "description": "Specific ID attribute for the checkbox item. If omitted, then component global `idPrefix` option will be applied."
             },
@@ -112,3 +112,3 @@ {
                 "required": false,
-                "description": "Divider text to separate checkbox items, for example the text \"or\"."
+                "description": "Divider text to separate checkbox items, for example the text 'or'."
             },
@@ -119,3 +119,3 @@ {
                 "required": false,
-                "description": "If true, checkbox will be checked."
+                "description": "If `true`, checkbox will be checked."
             },
@@ -126,3 +126,3 @@ {
                 "required": false,
-                "description": "If true, content provided will be revealed when the item is checked."
+                "description": "If `true`, content provided will be revealed when the item is checked."
             },
@@ -139,3 +139,3 @@ {
                 "required": false,
-                "description": "If set to `exclusive`, implements a \"None of these\" type behaviour via javascript when checkboxes are clicked"
+                "description": "If set to `exclusive`, implements a 'None of these' type behaviour via JavaScript when checkboxes are clicked."
             },
@@ -146,3 +146,3 @@ {
                 "required": false,
-                "description": "If true, checkbox will be disabled."
+                "description": "If `true`, checkbox will be disabled."
             },
@@ -149,0 +149,0 @@ {

govuk/components/cookie-banner/macro-options.json

@@ -6,3 +6,3 @@ [
         "required": false,
-        "description": "The text for the `aria-label` which labels the cookie banner region. This region applies to all messages that the cookie banner includes. For example, the cookie message and the confirmation message. Defaults to \"Cookie banner\"."
+        "description": "The text for the `aria-label` which labels the cookie banner region. This region applies to all messages that the cookie banner includes. For example, the cookie message and the confirmation message. Defaults to 'Cookie banner'."
     },
@@ -9,0 +9,0 @@ {

govuk/components/date-input/macro-options.json

@@ -6,3 +6,3 @@ [
         "required": true,
-        "description": "This is used for the main component and to compose id attribute for each item."
+        "description": "This is used for the main component and to compose the ID attribute for each item."
     },
@@ -25,3 +25,3 @@ {
                 "required": false,
-                "description": "Item-specific id. If provided, it will be used instead of the generated id."
+                "description": "Item-specific ID. If provided, it will be used instead of the generated ID."
             },
@@ -50,3 +50,3 @@ {
                 "required": false,
-                "description": "Attribute to [identify input purpose](https://www.w3.org/WAI/WCAG21/Understanding/identify-input-purpose.html), for instance \"bday-day\". See [autofill](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill) for full list of attributes that can be used."
+                "description": "Attribute to [identify input purpose](https://www.w3.org/WAI/WCAG21/Understanding/identify-input-purpose.html), for instance `bday-day`. See [autofill](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill) for full list of attributes that can be used."
             },
@@ -91,3 +91,3 @@ {
         "required": false,
-        "description": "Options for the form-group wrapper",
+        "description": "Options for the form-group wrapper.",
         "params": [
@@ -98,3 +98,3 @@ {
                 "required": false,
-                "description": "Classes to add to the form group (for example to show error state for the whole group)"
+                "description": "Classes to add to the form group (for example to show error state for the whole group)."
             }
@@ -101,0 +101,0 @@ ]

govuk/components/details/macro-options.json

@@ -30,3 +30,3 @@ [
         "required": false,
-        "description": "Id to add to the details element."
+        "description": "ID to add to the details element."
     },
@@ -37,3 +37,3 @@ {
         "required": false,
-        "description": "If true, details element will be expanded."
+        "description": "If `true`, details element will be expanded."
     },
@@ -40,0 +40,0 @@ {

govuk/components/error-message/macro-options.json

@@ -18,3 +18,3 @@ [
         "required": false,
-        "description": "Id attribute to add to the error message span tag."
+        "description": "ID attribute to add to the error message span tag."
     },
@@ -31,3 +31,3 @@ {
         "required": false,
-        "description": "HTML attributes (for example data attributes) to add to the error message span tag"
+        "description": "HTML attributes (for example data attributes) to add to the error message span tag."
     },
@@ -38,4 +38,4 @@ {
         "required": false,
-        "description": "A visually hidden prefix used before the error message. Defaults to \"Error\"."
+        "description": "A visually hidden prefix used before the error message. Defaults to 'Error'."
     }
 ]

govuk/components/fieldset/macro-options.json

@@ -68,4 +68,4 @@ [
         "required": false,
-        "description": "Not strictly a parameter but [Nunjucks code convention](https://mozilla.github.io/nunjucks/templating.html#call). Using a `call` block enables you to call a macro with all the text inside the tag. This is helpful if you want to pass a lot of content into a macro. To use it, you will need to wrap the entire fielset component in a `call` block."
+        "description": "Not strictly a parameter but [Nunjucks code convention](https://mozilla.github.io/nunjucks/templating.html#call). Using a `call` block enables you to call a macro with all the text inside the tag. This is helpful if you want to pass a lot of content into a macro. To use it, you will need to wrap the entire fieldset component in a `call` block."
     }
 ]

govuk/components/file-upload/macro-options.json

@@ -12,3 +12,3 @@ [
         "required": true,
-        "description": "The id of the input"
+        "description": "The ID of the input."
     },
@@ -19,3 +19,3 @@ {
         "required": false,
-        "description": "Optional initial value of the input"
+        "description": "Optional initial value of the input."
     },
@@ -53,3 +53,3 @@ {
         "required": false,
-        "description": "Options for the form-group wrapper",
+        "description": "Options for the form-group wrapper.",
         "params": [
@@ -60,3 +60,3 @@ {
                 "required": false,
-                "description": "Classes to add to the form group (for example to show error state for the whole group)"
+                "description": "Classes to add to the form group (for example to show error state for the whole group)."
             }
@@ -63,0 +63,0 @@ ]

govuk/components/footer/macro-options.json

@@ -12,3 +12,3 @@ [
                 "required": false,
-                "description": "Title for a meta item section, which defaults to Support links"
+                "description": "Title for a meta item section. Defaults to 'Support links'."
             },
@@ -65,3 +65,3 @@ {
                 "required": true,
-                "description": "Title for a section"
+                "description": "Title for a section."
             },
@@ -68,0 +68,0 @@ {

govuk/components/header/macro-options.json

@@ -6,3 +6,3 @@ [
         "required": false,
-        "description": "The url of the homepage. Defaults to /"
+        "description": "The URL of the homepage. Defaults to `/`"
     },
@@ -19,3 +19,3 @@ {
         "required": false,
-        "description": "Product name, used when the product name follows on directly from ‘GOV.UK’. For example, GOV.UK Pay or GOV.UK Design System. In most circumstances, you should use serviceName."
+        "description": "Product name, used when the product name follows on directly from ‘GOV.UK’. For example, GOV.UK Pay or GOV.UK Design System. In most circumstances, you should use `serviceName`."
     },
@@ -32,3 +32,3 @@ {
         "required": false,
-        "description": "Url for the service name anchor."
+        "description": "URL for the service name anchor."
     },
@@ -57,3 +57,3 @@ {
                 "required": false,
-                "description": "Url of the navigation item anchor."
+                "description": "URL of the navigation item anchor."
             },
@@ -84,3 +84,3 @@ {
         "required": false,
-        "description": "Text for the `aria-label` attribute of the navigation. Defaults to \"Navigation menu\"."
+        "description": "Text for the `aria-label` attribute of the navigation. Defaults to 'Navigation menu'."
     },
@@ -91,3 +91,3 @@ {
         "required": false,
-        "description": "Text for the `aria-label` attribute of the button that toggles the navigation. Defaults to \"Show or hide navigation menu\"."
+        "description": "Text for the `aria-label` attribute of the button that toggles the navigation. Defaults to 'Show or hide navigation menu'."
     },
@@ -94,0 +94,0 @@ {

govuk/components/hint/macro-options.json

@@ -18,3 +18,3 @@ [
         "required": false,
-        "description": "Optional id attribute to add to the hint span tag."
+        "description": "Optional ID attribute to add to the hint span tag."
     },
@@ -21,0 +21,0 @@ {

govuk/components/input/macro-options.json

@@ -6,3 +6,3 @@ [
         "required": true,
-        "description": "The id of the input."
+        "description": "The ID of the input."
     },
@@ -19,3 +19,3 @@ {
         "required": false,
-        "description": "Type of input control to render. Defaults to \"text\"."
+        "description": "Type of input control to render. Defaults to `text`."
     },
@@ -103,3 +103,3 @@ {
                 "required": true,
-                "description": "Required. If `html` is set, this is not required. Text to use within the label. If `html` is provided, the `text` argument will be ignored."
+                "description": "If `html` is set, this is not required. Text to use within the label. If `html` is provided, the `text` argument will be ignored."
             },
@@ -110,3 +110,3 @@ {
                 "required": true,
-                "description": "Required. If `text` is set, this is not required. HTML to use within the label. If `html` is provided, the `text` argument will be ignored."
+                "description": "If `text` is set, this is not required. HTML to use within the label. If `html` is provided, the `text` argument will be ignored."
             },
@@ -131,3 +131,3 @@ {
         "required": false,
-        "description": "Options for the form-group wrapper",
+        "description": "Options for the form-group wrapper.",
         "params": [
@@ -138,3 +138,3 @@ {
                 "required": false,
-                "description": "Classes to add to the form group (for example to show error state for the whole group)"
+                "description": "Classes to add to the form group (for example to show error state for the whole group)."
             }
@@ -165,3 +165,3 @@ ]
         "required": false,
-        "description": "Optional field to enable or disable the spellcheck attribute on the input."
+        "description": "Optional field to enable or disable the `spellcheck` attribute on the input."
     },
@@ -168,0 +168,0 @@ {

govuk/components/inset-text/macro-options.json

@@ -18,3 +18,3 @@ [
         "required": false,
-        "description": "Id attribute to add to the inset text container."
+        "description": "ID attribute to add to the inset text container."
     },
@@ -21,0 +21,0 @@ {

govuk/components/label/macro-options.json

@@ -18,3 +18,3 @@ [
         "required": false,
-        "description": "The value of the for attribute, the id of the input the label is associated with."
+        "description": "The value of the `for` attribute, the ID of the input the label is associated with."
     },
@@ -21,0 +21,0 @@ {

govuk/components/panel/macro-options.json

@@ -18,3 +18,3 @@ [
         "required": false,
-        "description": "Heading level, from 1 to 6. Default is 1."
+        "description": "Heading level, from `1` to `6`. Default is `1`."
     },
@@ -21,0 +21,0 @@ {

govuk/components/radios/macro-options.json

@@ -27,3 +27,3 @@ [
         "required": false,
-        "description": "Options for the form-group wrapper",
+        "description": "Options for the form-group wrapper.",
         "params": [
@@ -34,3 +34,3 @@ {
                 "required": false,
-                "description": "Classes to add to the form group (for example to show error state for the whole group)"
+                "description": "Classes to add to the form group (for example to show error state for the whole group)."
             }
@@ -43,3 +43,3 @@ ]
         "required": false,
-        "description": "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."
+        "description": "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."
     },
@@ -74,3 +74,3 @@ {
                 "required": false,
-                "description": "Specific id attribute for the radio item. If omitted, then `idPrefix` string will be applied."
+                "description": "Specific ID attribute for the radio item. If omitted, then `idPrefix` string will be applied."
             },
@@ -101,3 +101,3 @@ {
                 "required": false,
-                "description": "Divider text to separate radio items, for example the text \"or\"."
+                "description": "Divider text to separate radio items, for example the text 'or'."
             },
@@ -108,3 +108,3 @@ {
                 "required": false,
-                "description": "If true, radio will be checked."
+                "description": "If `true`, radio will be checked."
             },
@@ -115,3 +115,3 @@ {
                 "required": false,
-                "description": "If true, content provided will be revealed when the item is checked."
+                "description": "If `true`, content provided will be revealed when the item is checked."
             },
@@ -128,3 +128,3 @@ {
                 "required": false,
-                "description": "If true, radio will be disabled."
+                "description": "If `true`, radio will be disabled."
             },
@@ -131,0 +131,0 @@ {

govuk/components/select/macro-options.json

@@ -6,3 +6,3 @@ [
         "required": true,
-        "description": "Id for each select box."
+        "description": "ID for each select box."
     },
@@ -84,3 +84,3 @@ {
         "required": false,
-        "description": "Options for the form-group wrapper",
+        "description": "Options for the form-group wrapper.",
         "params": [
@@ -91,3 +91,3 @@ {
                 "required": false,
-                "description": "Classes to add to the form group (for example to show error state for the whole group)"
+                "description": "Classes to add to the form group (for example to show error state for the whole group)."
             }
@@ -94,0 +94,0 @@ ]

govuk/components/summary-list/macro-options.json

@@ -12,3 +12,3 @@ [
                 "required": false,
-                "description": "Classes to add to the row `div`"
+                "description": "Classes to add to the row `div`."
             },
@@ -30,3 +30,3 @@ {
                 "required": false,
-                "description": "Classes to add to the key wrapper"
+                "description": "Classes to add to the key wrapper."
             },
@@ -49,3 +49,3 @@ {
                 "required": false,
-                "description": "Classes to add to the value wrapper"
+                "description": "Classes to add to the value wrapper."
             },
@@ -56,3 +56,3 @@ {
                 "required": false,
-                "description": "Classes to add to the actions wrapper"
+                "description": "Classes to add to the actions wrapper."
             },
@@ -63,3 +63,3 @@ {
                 "required": false,
-                "description": "Array of action item objects",
+                "description": "Array of action item objects.",
                 "params": [
@@ -70,3 +70,3 @@ {
                         "required": true,
-                        "description": "The value of the link href attribute for an action item"
+                        "description": "The value of the link's `href` attribute for an action item."
                     },
@@ -89,3 +89,3 @@ {
                         "required": false,
-                        "description": "Actions rely on context from the surrounding content so may require additional accessible text, text supplied to this option is appended to the end, use `html` for more complicated scenarios."
+                        "description": "Actions rely on context from the surrounding content so may require additional accessible text. Text supplied to this option is appended to the end. Use `html` for more complicated scenarios."
                     },
@@ -92,0 +92,0 @@ {

govuk/components/tabs/macro-options.json

@@ -6,3 +6,3 @@ [
         "required": false,
-        "description": "This is used for the main component and to compose id attribute for each item."
+        "description": "This is used for the main component and to compose the ID attribute for each item."
     },
@@ -13,3 +13,3 @@ {
         "required": false,
-        "description": "String to prefix id for each tab item if no id is specified on each item"
+        "description": "String to prefix id for each tab item if no id is specified on each item."
     },
@@ -20,3 +20,3 @@ {
         "required": false,
-        "description": "Title for the tabs table of contents"
+        "description": "Title for the tabs table of contents."
     },
@@ -33,3 +33,3 @@ {
                 "required": true,
-                "description": "Specific id attribute for the tab item. If omitted, then `idPrefix` string is required instead."
+                "description": "Specific ID attribute for the tab item. If omitted, then `idPrefix` string is required instead."
             },
@@ -36,0 +36,0 @@ {

govuk/components/textarea/macro-options.json

@@ -6,3 +6,3 @@ [
         "required": true,
-        "description": "The id of the textarea."
+        "description": "The ID of the textarea."
     },
@@ -19,3 +19,3 @@ {
         "required": false,
-        "description": "Optional field to enable or disable the spellcheck attribute on the textarea."
+        "description": "Optional field to enable or disable the `spellcheck` attribute on the textarea."
     },
@@ -65,3 +65,3 @@ {
         "required": false,
-        "description": "Options for the form-group wrapper",
+        "description": "Options for the form-group wrapper.",
         "params": [
@@ -72,3 +72,3 @@ {
                 "required": false,
-                "description": "Classes to add to the form group (for example to show error state for the whole group)"
+                "description": "Classes to add to the form group (for example to show error state for the whole group)."
             }
@@ -87,3 +87,3 @@ ]
         "required": false,
-        "description": "Attribute to [identify input purpose](https://www.w3.org/WAI/WCAG21/Understanding/identify-input-purpose.html), for instance \"postal-code\" or \"username\". See [autofill](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill) for full list of attributes that can be used."
+        "description": "Attribute to [identify input purpose](https://www.w3.org/WAI/WCAG21/Understanding/identify-input-purpose.html), for example `postal-code` or `username`. See [autofill](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill) for full list of attributes that can be used."
     },
@@ -90,0 +90,0 @@ {

package.json

 {
   "name": "govuk-frontend",
   "description": "GOV.UK Frontend contains the code you need to start building a user interface for government platforms and services.",
-  "version": "3.13.0",
+  "version": "3.13.1",
   "main": "govuk/all.js",
@@ -6,0 +6,0 @@ "sass": "govuk/all.scss",

No alert changes

Improved metrics

Total package byte prevSize

1930482

increased by0.11%

Lines of code

25706

increased by0.04%

No dependency changes