diff --git a/CHANGELOG.md b/CHANGELOG.md index f1b6372b1..a2fb524f8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # NHS digital service manual Changelog -## 5.0.0 - Unreleased +## 5.0.0 - 14 June 2021 :new: **New features** @@ -10,7 +10,6 @@ - Update dependencies to the latest versions -<<<<<<< HEAD ## 4.2.0 - 10 June 2021 :new: **New content** @@ -26,8 +25,6 @@ - Fix broken health literacy link on the service standard pages [Issue 1136](https://github.com/nhsuk/nhsuk-service-manual/issues/1136) -======= ->>>>>>> update dependencies to latest versions ## 4.1.3 - 8 June 2021 :wrench: **Fixes** diff --git a/app/views/design-system/components/action-link/macro-options.json b/app/views/design-system/components/action-link/macro-options.json index c0813650c..717bb088e 100644 --- a/app/views/design-system/components/action-link/macro-options.json +++ b/app/views/design-system/components/action-link/macro-options.json @@ -16,7 +16,7 @@ "name": "openInNewWindow", "type": "boolean", "required": false, - "description": "If set to true, then the link will open in a new window" + "description": "If set to true, then the link will open in a new window." }, { "name": "classes", diff --git a/app/views/design-system/components/breadcrumbs/macro-options.json b/app/views/design-system/components/breadcrumbs/macro-options.json index d0f169b61..693b63827 100644 --- a/app/views/design-system/components/breadcrumbs/macro-options.json +++ b/app/views/design-system/components/breadcrumbs/macro-options.json @@ -16,7 +16,7 @@ "name": "href", "type": "string", "required": false, - "description": "Link for the breadcrumbs item." + "description": "The value of the breadcrumb item link href attribute." }, { "name": "attributes", diff --git a/app/views/design-system/components/card/macro-options.json b/app/views/design-system/components/card/macro-options.json index eb3fd9d51..916d3ee5b 100644 --- a/app/views/design-system/components/card/macro-options.json +++ b/app/views/design-system/components/card/macro-options.json @@ -22,25 +22,25 @@ "name": "headingLevel", "type": "integer", "required": false, - "description": "Classes to add to the card heading." + "description": "Optional heading level for the card heading. Default: 2" }, { "name": "href", "type": "string", - "required": true, + "required": false, "description": "The value of the card link href attribute." }, { "name": "clickable", "type": "boolean", "required": false, - "description": "If set to true, then the class `nhsuk-card--clickable` will be applied." + "description": "If set to true, then the whole Card will become a clickable Card variant." }, { "name": "feature", "type": "boolean", "required": false, - "description": "If set to true, then the class `nhsuk-card__heading--feature` and `nhsuk-card__content--feature` will be applied." + "description": "If set to true, then the Card will become a feature Card variant." }, { "name": "imgURL", diff --git a/app/views/design-system/components/details/macro-options.json b/app/views/design-system/components/details/macro-options.json index 9971e650a..e302a38a1 100644 --- a/app/views/design-system/components/details/macro-options.json +++ b/app/views/design-system/components/details/macro-options.json @@ -12,18 +12,6 @@ "required": true, "description": "HTML content to be displayed within the details component." }, - { - "name": "id", - "type": "string", - "required": false, - "description": "Id to add to the details element." - }, - { - "name": "open", - "type": "boolean", - "required": false, - "description": "If true, details element will be expanded." - }, { "name": "classes", "type": "string", diff --git a/app/views/design-system/components/do-and-dont-lists/macro-options.json b/app/views/design-system/components/do-and-dont-lists/macro-options.json index 892e0a946..2b4111108 100644 --- a/app/views/design-system/components/do-and-dont-lists/macro-options.json +++ b/app/views/design-system/components/do-and-dont-lists/macro-options.json @@ -4,25 +4,25 @@ "name": "title", "type": "string", "required": true, - "description": "Title to be displayed on the do and don't list component.." + "description": "Title to be displayed on the do and don't list component." }, { "name": "type", "type": "string", "required": true, - "description": "Type of do and don't list component, \"cross\", \"tick\"" + "description": "Type of do and don't list component, \"cross\", \"tick\"." }, { "name": "items", "type": "array", "required": true, - "description": "Array of do and dont items objects.", + "description": "Array of do and don't items objects.", "params": [ { "name": "item", "type": "string", "required": true, - "description": "Text to use within each do and dont item label." + "description": "Text to use within each do and don't item label." } ] }, @@ -30,7 +30,7 @@ "name": "hidePrefix", "type": "boolean", "required": false, - "description": "If set to true when type is \"cross\", then removes the default \"do not\" text prefix to each item" + "description": "If set to true when type is \"cross\", then removes the default \"do not\" text prefix to each item." }, { "name": "headingLevel", @@ -42,13 +42,13 @@ "name": "classes", "type": "string", "required": false, - "description": "Classes to add to the details element." + "description": "Classes to add to the do and don't list container." }, { "name": "attributes", "type": "object", "required": false, - "description": "HTML attributes (for example data attributes) to add to the details element." + "description": "HTML attributes (for example data attributes) to add to the do and don't list container." } ] } diff --git a/app/views/design-system/components/error-message/macro-options.json b/app/views/design-system/components/error-message/macro-options.json index 4b02a8da1..5162756e0 100644 --- a/app/views/design-system/components/error-message/macro-options.json +++ b/app/views/design-system/components/error-message/macro-options.json @@ -28,7 +28,7 @@ "name": "attributes", "type": "object", "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." } ] } diff --git a/app/views/design-system/components/header/macro-options.json b/app/views/design-system/components/header/macro-options.json index 932c8b27a..5e63cc1f3 100644 --- a/app/views/design-system/components/header/macro-options.json +++ b/app/views/design-system/components/header/macro-options.json @@ -80,7 +80,7 @@ "name": "transactionalService", "type": "object", "required": false, - "description": "Settings for transactional service header", + "description": "Settings for transactional service header.", "params": [ { "name": "name", diff --git a/app/views/design-system/components/hint-text/macro-options.json b/app/views/design-system/components/hint-text/macro-options.json index 78543cbd7..3a9cd15bb 100644 --- a/app/views/design-system/components/hint-text/macro-options.json +++ b/app/views/design-system/components/hint-text/macro-options.json @@ -16,7 +16,7 @@ "name": "id", "type": "string", "required": false, - "description": "Optional id attribute to add to the hint." + "description": "Id attribute to add to the hint." }, { "name": "classes", diff --git a/app/views/design-system/components/images/macro-options.json b/app/views/design-system/components/images/macro-options.json index c443697d4..3156de293 100644 --- a/app/views/design-system/components/images/macro-options.json +++ b/app/views/design-system/components/images/macro-options.json @@ -34,13 +34,13 @@ "name": "classes", "type": "string", "required": false, - "description": "Classes to add to the button component." + "description": "Classes to add to the image container." }, { "name": "attributes", "type": "object", "required": false, - "description": "HTML attributes (for example data attributes) to add to the button component." + "description": "HTML attributes (for example data attributes) to add to the image container." } ] } diff --git a/app/views/design-system/components/skip-link/macro-options.json b/app/views/design-system/components/skip-link/macro-options.json index c5dc085b5..08375a33a 100644 --- a/app/views/design-system/components/skip-link/macro-options.json +++ b/app/views/design-system/components/skip-link/macro-options.json @@ -3,14 +3,14 @@ { "name": "text", "type": "string", - "required": true, - "description": "Text to use within the skip link component." + "required": false, + "description": "Text to use within the skip link component. Defaults to `Skip to main content` if you do not provide a value." }, { "name": "href", "type": "string", "required": false, - "description": "The value of the skip link’s `href` attribute. Defaults to `#content` if you do not provide a value." + "description": "The value of the skip link’s `href` attribute. Defaults to `#maincontent` if you do not provide a value." }, { "name": "classes", diff --git a/app/views/design-system/components/summary-list/macro-options.json b/app/views/design-system/components/summary-list/macro-options.json index 98259c57a..42bd71bae 100644 --- a/app/views/design-system/components/summary-list/macro-options.json +++ b/app/views/design-system/components/summary-list/macro-options.json @@ -10,7 +10,7 @@ "name": "classes", "type": "string", "required": false, - "description": "Classes to add to the row `div`" + "description": "Classes to add to the row `div`." }, { "name": "key.text", @@ -27,7 +27,7 @@ "name": "key.classes", "type": "string", "required": false, - "description": "Classes to add to the key wrapper" + "description": "Classes to add to the key wrapper." }, { "name": "value.text", @@ -45,25 +45,25 @@ "name": "value.classes", "type": "string", "required": false, - "description": "Classes to add to the value wrapper" + "description": "Classes to add to the value wrapper." }, { "name": "actions.classes", "type": "string", "required": false, - "description": "Classes to add to the actions wrapper" + "description": "Classes to add to the actions wrapper." }, { "name": "actions.items", "type": "array", "required": false, - "description": "Array of action item objects", + "description": "Array of action item objects.", "params": [ { "name": "href", "type": "string", "required": true, - "description": "The value of the link href attribute for an action item" + "description": "The value of the link href attribute for an action item." }, { "name": "text", @@ -91,13 +91,13 @@ "name": "classes", "type": "string", "required": false, - "description": "Classes to add to the container." + "description": "Classes to add to the summary list container." }, { "name": "attributes", "type": "object", "required": false, - "description": "HTML attributes (for example data attributes) to add to the container." + "description": "HTML attributes (for example data attributes) to add to the summary list container." } ] } diff --git a/app/views/design-system/components/table/macro-options.json b/app/views/design-system/components/table/macro-options.json index 1ec5057d0..5f826ae8d 100644 --- a/app/views/design-system/components/table/macro-options.json +++ b/app/views/design-system/components/table/macro-options.json @@ -92,7 +92,7 @@ "name": "caption", "type": "string", "required": false, - "description": "Caption text" + "description": "Caption text." }, { "name": "captionClasses", diff --git a/app/views/design-system/components/text-input/macro-options.json b/app/views/design-system/components/text-input/macro-options.json index a25ec2449..6cb44930c 100644 --- a/app/views/design-system/components/text-input/macro-options.json +++ b/app/views/design-system/components/text-input/macro-options.json @@ -163,7 +163,7 @@ "name": "attributes", "type": "object", "required": false, - "description": "HTML attributes (for example data attributes) to add to the anchor tag." + "description": "HTML attributes (for example data attributes) to add to the input." } ] } diff --git a/app/views/design-system/components/warning-callout/macro-options.json b/app/views/design-system/components/warning-callout/macro-options.json index fba4a78d6..21e1ab17f 100644 --- a/app/views/design-system/components/warning-callout/macro-options.json +++ b/app/views/design-system/components/warning-callout/macro-options.json @@ -4,7 +4,13 @@ "name": "heading", "type": "string", "required": true, - "description": "Heading to be used within the warning callout." + "description": "Heading to be used on the warning callout." + }, + { + "name": "headingLevel", + "type": "integer", + "required": false, + "description": "Optional heading level for the heading. Default: 3" }, { "name": "html", diff --git a/package-lock.json b/package-lock.json index 5536bf238..84a3e2ffb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,16 +1,5 @@ { "name": "nhsuk-service-manual", -<<<<<<< HEAD -<<<<<<< HEAD - "version": "4.2.0", -======= -<<<<<<< HEAD - "version": "4.1.3", ->>>>>>> populate CHANGELOG for nunjucks macro options and bump version - "lockfileVersion": 2, -======= -======= ->>>>>>> update dependencies to latest versions "version": "5.0.0", "lockfileVersion": 2, "requires": true, diff --git a/package.json b/package.json index dc9bd4332..05a2ec892 100755 --- a/package.json +++ b/package.json @@ -1,18 +1,6 @@ { "name": "nhsuk-service-manual", -<<<<<<< HEAD -<<<<<<< HEAD - "version": "4.2.0", -======= -<<<<<<< HEAD - "version": "4.1.3", -======= "version": "5.0.0", ->>>>>>> populate CHANGELOG for nunjucks macro options and bump version ->>>>>>> populate CHANGELOG for nunjucks macro options and bump version -======= - "version": "5.0.0", ->>>>>>> update dependencies to latest versions "description": "NHS digital service manual", "main": "app.js", "directories": {