From e85baf3f7691aada929b1d7c646d07c16c8cf246 Mon Sep 17 00:00:00 2001 From: Colin Rotherham Date: Fri, 10 Nov 2023 13:17:03 +0000 Subject: [PATCH 01/13] Update descriptions for nested Nunjucks macro options --- .../src/govuk/components/accordion/accordion.yaml | 8 ++++---- .../govuk/components/breadcrumbs/breadcrumbs.yaml | 2 +- .../character-count/character-count.yaml | 8 ++++---- .../govuk/components/checkboxes/checkboxes.yaml | 6 +++--- .../govuk/components/date-input/date-input.yaml | 6 +++--- .../components/error-summary/error-summary.yaml | 2 +- .../src/govuk/components/fieldset/fieldset.yaml | 2 +- .../govuk/components/file-upload/file-upload.yaml | 6 +++--- .../src/govuk/components/footer/footer.yaml | 12 ++++++------ .../src/govuk/components/header/header.yaml | 2 +- .../govuk/components/pagination/pagination.yaml | 2 +- .../src/govuk/components/radios/radios.yaml | 6 +++--- .../src/govuk/components/select/select.yaml | 8 ++++---- .../components/summary-list/summary-list.yaml | 14 +++++++------- .../src/govuk/components/table/table.yaml | 4 ++-- .../src/govuk/components/tabs/tabs.yaml | 4 ++-- .../src/govuk/components/task-list/task-list.yaml | 8 ++++---- .../src/govuk/components/textarea/textarea.yaml | 6 +++--- 18 files changed, 53 insertions(+), 53 deletions(-) diff --git a/packages/govuk-frontend/src/govuk/components/accordion/accordion.yaml b/packages/govuk-frontend/src/govuk/components/accordion/accordion.yaml index 6e54638800..ba1826f5f2 100644 --- a/packages/govuk-frontend/src/govuk/components/accordion/accordion.yaml +++ b/packages/govuk-frontend/src/govuk/components/accordion/accordion.yaml @@ -46,12 +46,12 @@ params: - name: items type: array required: true - description: An array of sections within the accordion. + description: The items within sections of the accordion. params: - name: heading type: object required: true - description: The heading of each section. + description: The heading of each accordion section. params: - name: text type: string @@ -64,7 +64,7 @@ params: - name: summary type: object required: false - description: The summary line of each section. + description: The summary line of each accordion section. params: - name: text type: string @@ -77,7 +77,7 @@ params: - name: content type: object required: true - description: The content of each section. + description: The content of each accordion section. params: - name: text type: string diff --git a/packages/govuk-frontend/src/govuk/components/breadcrumbs/breadcrumbs.yaml b/packages/govuk-frontend/src/govuk/components/breadcrumbs/breadcrumbs.yaml index 2020bf5bcd..934691dced 100644 --- a/packages/govuk-frontend/src/govuk/components/breadcrumbs/breadcrumbs.yaml +++ b/packages/govuk-frontend/src/govuk/components/breadcrumbs/breadcrumbs.yaml @@ -2,7 +2,7 @@ params: - name: items type: array required: true - description: Array of breadcrumbs item objects. + description: The items within breadcrumbs. params: - name: text type: string diff --git a/packages/govuk-frontend/src/govuk/components/character-count/character-count.yaml b/packages/govuk-frontend/src/govuk/components/character-count/character-count.yaml index 1667dd276a..e3f56339dc 100644 --- a/packages/govuk-frontend/src/govuk/components/character-count/character-count.yaml +++ b/packages/govuk-frontend/src/govuk/components/character-count/character-count.yaml @@ -30,12 +30,12 @@ params: - name: label type: object required: true - description: Options for the label component. + description: Can be used to add a label to a character count component. isComponent: true - name: hint type: object required: false - description: Options for the hint component. + description: Can be used to add a hint to the character count component. isComponent: true - name: errorMessage type: object @@ -45,7 +45,7 @@ params: - name: formGroup type: object required: false - description: Options for the form-group wrapper. + description: Additional options for the form group containing the character count component. params: - name: classes type: string @@ -66,7 +66,7 @@ params: - name: countMessage type: object required: false - description: Options for the count message. + description: The message for the character count component. params: - name: classes type: string diff --git a/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml b/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml index c4357c1ce7..fa001448de 100644 --- a/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml +++ b/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml @@ -11,7 +11,7 @@ params: - name: hint type: object required: false - description: Options for the hint component (for example text). + description: Can be used to add a hint to the checkboxes component. isComponent: true - name: errorMessage type: object @@ -21,7 +21,7 @@ params: - name: formGroup type: object required: false - description: Options for the form-group wrapper. + description: Additional options for the form group containing the checkboxes component. params: - name: classes type: string @@ -38,7 +38,7 @@ params: - name: items type: array required: true - description: Array of checkbox items objects. + description: The items within the checkboxes component. params: - name: text type: string diff --git a/packages/govuk-frontend/src/govuk/components/date-input/date-input.yaml b/packages/govuk-frontend/src/govuk/components/date-input/date-input.yaml index 97e2086cc1..2248eb5947 100644 --- a/packages/govuk-frontend/src/govuk/components/date-input/date-input.yaml +++ b/packages/govuk-frontend/src/govuk/components/date-input/date-input.yaml @@ -10,7 +10,7 @@ params: - name: items type: array required: false - description: An array of input objects with name, value and classes. + description: The items of each date input component. params: - name: id type: string @@ -47,7 +47,7 @@ params: - name: hint type: object required: false - description: Options for the hint component. + description: Can be used to add a hint to a date input component. isComponent: true - name: errorMessage type: object @@ -57,7 +57,7 @@ params: - name: formGroup type: object required: false - description: Options for the form-group wrapper. + description: Additional options for the form group containing the date input component. params: - name: classes type: string diff --git a/packages/govuk-frontend/src/govuk/components/error-summary/error-summary.yaml b/packages/govuk-frontend/src/govuk/components/error-summary/error-summary.yaml index ef3ccedde1..b00e49885b 100644 --- a/packages/govuk-frontend/src/govuk/components/error-summary/error-summary.yaml +++ b/packages/govuk-frontend/src/govuk/components/error-summary/error-summary.yaml @@ -22,7 +22,7 @@ params: - name: errorList type: array required: true - description: The list of errors to include in the summary. + description: The list of errors to include in the error summary. params: - name: href type: string diff --git a/packages/govuk-frontend/src/govuk/components/fieldset/fieldset.yaml b/packages/govuk-frontend/src/govuk/components/fieldset/fieldset.yaml index f7591a8853..5ae9613961 100644 --- a/packages/govuk-frontend/src/govuk/components/fieldset/fieldset.yaml +++ b/packages/govuk-frontend/src/govuk/components/fieldset/fieldset.yaml @@ -6,7 +6,7 @@ params: - name: legend type: object required: false - description: Options for the legend. + description: The legend for the fieldset component. params: - name: text type: string diff --git a/packages/govuk-frontend/src/govuk/components/file-upload/file-upload.yaml b/packages/govuk-frontend/src/govuk/components/file-upload/file-upload.yaml index 5c7805a6c8..4e083253fc 100644 --- a/packages/govuk-frontend/src/govuk/components/file-upload/file-upload.yaml +++ b/packages/govuk-frontend/src/govuk/components/file-upload/file-upload.yaml @@ -22,12 +22,12 @@ params: - name: label type: object required: true - description: Options for the label component. + description: Can be used to add a label to the file upload component. isComponent: true - name: hint type: object required: false - description: Options for the hint component. + description: Can be used to add a hint to the file upload component. isComponent: true - name: errorMessage type: object @@ -37,7 +37,7 @@ params: - name: formGroup type: object required: false - description: Options for the form-group wrapper. + description: Additional options for the form group containing the file upload component. params: - name: classes type: string diff --git a/packages/govuk-frontend/src/govuk/components/footer/footer.yaml b/packages/govuk-frontend/src/govuk/components/footer/footer.yaml index 2839b2327e..0686dd98c6 100644 --- a/packages/govuk-frontend/src/govuk/components/footer/footer.yaml +++ b/packages/govuk-frontend/src/govuk/components/footer/footer.yaml @@ -2,7 +2,7 @@ params: - name: meta type: object required: false - description: Object containing options for the meta navigation. + description: The section to add content before the standard footer component. params: - name: visuallyHiddenTitle type: string @@ -19,7 +19,7 @@ params: - name: items type: array required: false - description: Array of items for use in the meta section of the footer. + description: The meta items add content within a unordered list to the meta section of the footer component. These appear above any text or custom html in the meta section. params: - name: text type: string @@ -36,7 +36,7 @@ params: - name: navigation type: array required: false - description: Array of items for use in the navigation section of the footer. + description: The navigation section of the footer before a section break and the standard footer component. params: - name: title type: string @@ -53,7 +53,7 @@ params: - name: items type: array required: false - description: Array of items to display in the list in navigation section of the footer. + description: The items within the navigation section of the footer component. params: - name: text type: string @@ -70,7 +70,7 @@ params: - name: contentLicence type: object required: false - description: The content licence information. Defaults to Open Government Licence (OGL) v3 licence. + description: The content licence information within the footer component. Defaults to Open Government Licence (OGL) v3 licence. params: - name: text type: string @@ -83,7 +83,7 @@ params: - name: copyright type: object required: false - description: The copyright information, this defaults to Crown Copyright. + description: The copyright information in the footer component, this defaults to Crown Copyright. params: - name: text type: string diff --git a/packages/govuk-frontend/src/govuk/components/header/header.yaml b/packages/govuk-frontend/src/govuk/components/header/header.yaml index 60d9a9ffd0..cf91ce0d0b 100644 --- a/packages/govuk-frontend/src/govuk/components/header/header.yaml +++ b/packages/govuk-frontend/src/govuk/components/header/header.yaml @@ -18,7 +18,7 @@ params: - name: navigation type: array required: false - description: An array of navigation item objects. + description: Can be used to add navigation to the header component. params: - name: text type: string diff --git a/packages/govuk-frontend/src/govuk/components/pagination/pagination.yaml b/packages/govuk-frontend/src/govuk/components/pagination/pagination.yaml index cef703046c..9b8da7634a 100644 --- a/packages/govuk-frontend/src/govuk/components/pagination/pagination.yaml +++ b/packages/govuk-frontend/src/govuk/components/pagination/pagination.yaml @@ -2,7 +2,7 @@ params: - name: items type: array required: false - description: The array of link objects. + description: The items within the pagination component. params: - name: number type: string diff --git a/packages/govuk-frontend/src/govuk/components/radios/radios.yaml b/packages/govuk-frontend/src/govuk/components/radios/radios.yaml index c4b526b25e..3d10d22037 100644 --- a/packages/govuk-frontend/src/govuk/components/radios/radios.yaml +++ b/packages/govuk-frontend/src/govuk/components/radios/radios.yaml @@ -7,7 +7,7 @@ params: - name: hint type: object required: false - description: Options for the hint component (for example text). + description: Can be used to add a hint to the radios component. isComponent: true - name: errorMessage type: object @@ -17,7 +17,7 @@ params: - name: formGroup type: object required: false - description: Options for the form-group wrapper. + description: Additional options for the form group containing the radios component. params: - name: classes type: string @@ -34,7 +34,7 @@ params: - name: items type: array required: true - description: Array of radio items objects. + description: The items within each radio component. params: - name: text type: string diff --git a/packages/govuk-frontend/src/govuk/components/select/select.yaml b/packages/govuk-frontend/src/govuk/components/select/select.yaml index c18056e408..9edc160089 100644 --- a/packages/govuk-frontend/src/govuk/components/select/select.yaml +++ b/packages/govuk-frontend/src/govuk/components/select/select.yaml @@ -10,7 +10,7 @@ params: - name: items type: array required: true - description: Array of option items for the select. + description: The items within the select component. params: - name: value type: string @@ -47,12 +47,12 @@ params: - name: label type: object required: false - description: Label text or HTML by specifying value for either text or html keys. + description: Can be used to add a label to the select component. isComponent: true - name: hint type: object required: false - description: Options for the hint component. + description: Can be used to add a hint to the select component. isComponent: true - name: errorMessage type: object @@ -62,7 +62,7 @@ params: - name: formGroup type: object required: false - description: Options for the form-group wrapper. + description: Additional options for the form group containing the select component. params: - name: classes type: string diff --git a/packages/govuk-frontend/src/govuk/components/summary-list/summary-list.yaml b/packages/govuk-frontend/src/govuk/components/summary-list/summary-list.yaml index 2a9c04050c..8fb1649a92 100644 --- a/packages/govuk-frontend/src/govuk/components/summary-list/summary-list.yaml +++ b/packages/govuk-frontend/src/govuk/components/summary-list/summary-list.yaml @@ -2,7 +2,7 @@ params: - name: rows type: array required: true - description: Array of row item objects. + description: The rows within the summary list component. params: - name: classes type: string @@ -11,7 +11,7 @@ params: - name: key type: object required: true - description: The key of each row. + description: The reference content (key) for each row item in the summary list component. params: - name: text type: string @@ -28,7 +28,7 @@ params: - name: value type: object required: true - description: The value of each row. + description: The value for each row item in the summary list component. params: - name: text type: string @@ -45,12 +45,12 @@ params: - name: actions type: object required: false - description: The actions of each row. + description: The action link content for each row item in the summary list component. params: - name: items type: array required: false - description: Array of action item objects. + description: The items within the summary list component. params: - name: href type: string @@ -109,12 +109,12 @@ params: - name: actions type: object required: false - description: The actions of each summary card. + description: The action link content for each summary card variant of the summary list component. params: - name: items type: array required: false - description: Array of action item objects. + description: The items within the summary card variant of the summary list component. params: - name: href type: string diff --git a/packages/govuk-frontend/src/govuk/components/table/table.yaml b/packages/govuk-frontend/src/govuk/components/table/table.yaml index fb7ff8795f..1e5bd17589 100644 --- a/packages/govuk-frontend/src/govuk/components/table/table.yaml +++ b/packages/govuk-frontend/src/govuk/components/table/table.yaml @@ -2,7 +2,7 @@ params: - name: rows type: array required: true - description: Array of table rows and cells. + description: The rows within the table component. params: - name: text type: string @@ -35,7 +35,7 @@ params: - name: head type: array required: false - description: Array of table head cells. + description: The head cells within the table component. params: - name: text type: string diff --git a/packages/govuk-frontend/src/govuk/components/tabs/tabs.yaml b/packages/govuk-frontend/src/govuk/components/tabs/tabs.yaml index c4a108ff43..eecc112170 100644 --- a/packages/govuk-frontend/src/govuk/components/tabs/tabs.yaml +++ b/packages/govuk-frontend/src/govuk/components/tabs/tabs.yaml @@ -14,7 +14,7 @@ params: - name: items type: array required: true - description: Array of tab items. + description: The items within the tabs component. params: - name: id type: string @@ -29,7 +29,7 @@ params: required: false description: HTML attributes (for example data attributes) to add to the tab. - name: panel - description: Content for the panel. + description: The contents of each tab within the tabs component. This is referenced as a panel. type: object required: true params: diff --git a/packages/govuk-frontend/src/govuk/components/task-list/task-list.yaml b/packages/govuk-frontend/src/govuk/components/task-list/task-list.yaml index 1a03a4fdf9..9f2b3afd11 100644 --- a/packages/govuk-frontend/src/govuk/components/task-list/task-list.yaml +++ b/packages/govuk-frontend/src/govuk/components/task-list/task-list.yaml @@ -2,12 +2,12 @@ params: - name: items type: array required: true - description: Array of tasks within the task list. + description: The items for each task within the task list component. params: - name: title type: object required: true - description: Object containing the main title for the task. + description: The main title for the task within the task list component. params: - name: text type: string @@ -24,7 +24,7 @@ params: - name: hint type: object required: false - description: Object containing a hint for the task. + description: The hint for each task within the task list component. params: - name: text type: string @@ -37,7 +37,7 @@ params: - name: status type: object required: true - description: Object containing the status of the task. + description: The status tag for each task within the task list component. params: - name: tag type: object diff --git a/packages/govuk-frontend/src/govuk/components/textarea/textarea.yaml b/packages/govuk-frontend/src/govuk/components/textarea/textarea.yaml index 866386e533..0cc666c3f7 100644 --- a/packages/govuk-frontend/src/govuk/components/textarea/textarea.yaml +++ b/packages/govuk-frontend/src/govuk/components/textarea/textarea.yaml @@ -30,12 +30,12 @@ params: - name: label type: object required: true - description: Options for the label component. + description: Can be used to add a label to the textarea component. isComponent: true - name: hint type: object required: false - description: Options for the hint component. + description: Can be used to add a hint to the textarea component. isComponent: true - name: errorMessage type: object @@ -45,7 +45,7 @@ params: - name: formGroup type: object required: false - description: Options for the form-group wrapper. + description: Additional options for the form group containing the textarea component. params: - name: classes type: string From 5c1f5917de085b512f6e3e512552e0b3a9eca8d3 Mon Sep 17 00:00:00 2001 From: Colin Rotherham Date: Fri, 10 Nov 2023 13:18:41 +0000 Subject: [PATCH 02/13] Update missing `fieldset` descriptions --- .../src/govuk/components/checkboxes/checkboxes.yaml | 2 +- .../src/govuk/components/date-input/date-input.yaml | 2 +- packages/govuk-frontend/src/govuk/components/radios/radios.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml b/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml index fa001448de..b180b311a8 100644 --- a/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml +++ b/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml @@ -6,7 +6,7 @@ params: - name: fieldset type: object required: false - description: Options for the fieldset component (for example legend). + description: Can be used to add a fieldset to the checkboxes component. isComponent: true - name: hint type: object diff --git a/packages/govuk-frontend/src/govuk/components/date-input/date-input.yaml b/packages/govuk-frontend/src/govuk/components/date-input/date-input.yaml index 2248eb5947..f1e4df95be 100644 --- a/packages/govuk-frontend/src/govuk/components/date-input/date-input.yaml +++ b/packages/govuk-frontend/src/govuk/components/date-input/date-input.yaml @@ -66,7 +66,7 @@ params: - name: fieldset type: object required: false - description: Options for the fieldset component (for example legend). + description: Can be used to add a fieldset to the date input component. isComponent: true - name: classes type: string diff --git a/packages/govuk-frontend/src/govuk/components/radios/radios.yaml b/packages/govuk-frontend/src/govuk/components/radios/radios.yaml index 3d10d22037..80b8b217d7 100644 --- a/packages/govuk-frontend/src/govuk/components/radios/radios.yaml +++ b/packages/govuk-frontend/src/govuk/components/radios/radios.yaml @@ -2,7 +2,7 @@ params: - name: fieldset type: object required: false - description: Options for the fieldset component (for example legend). + description: Can be used to add a fieldset to the radios component. isComponent: true - name: hint type: object From 70ae6d186919b4cac2f6f3902a11efd5c6d7cd77 Mon Sep 17 00:00:00 2001 From: Colin Rotherham Date: Fri, 10 Nov 2023 13:27:47 +0000 Subject: [PATCH 03/13] Suggestion to update `label` and `hint` for checkboxes/radios items --- .../src/govuk/components/checkboxes/checkboxes.yaml | 4 ++-- .../govuk-frontend/src/govuk/components/radios/radios.yaml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml b/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml index b180b311a8..e663a9c5c6 100644 --- a/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml +++ b/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml @@ -63,12 +63,12 @@ params: - name: label type: object required: false - description: Provide attributes and classes to each checkbox item label. + description: Additional options for the label used by each checkbox item within the checkboxes component. isComponent: true - name: hint type: object required: false - description: Provide hint to each checkbox item. + description: Can be used to add a hint to each checkbox item within the checkboxes component. isComponent: true - name: divider type: string diff --git a/packages/govuk-frontend/src/govuk/components/radios/radios.yaml b/packages/govuk-frontend/src/govuk/components/radios/radios.yaml index 80b8b217d7..568acc150b 100644 --- a/packages/govuk-frontend/src/govuk/components/radios/radios.yaml +++ b/packages/govuk-frontend/src/govuk/components/radios/radios.yaml @@ -55,12 +55,12 @@ params: - name: label type: object required: false - description: Provide attributes and classes to each radio item label. + description: Additional options for the label used by each radio item within the radios component. isComponent: true - name: hint type: object required: false - description: Provide hint to each radio item. + description: Can be used to add a hint to each radio item within the radios component. isComponent: true - name: divider type: string From 200d8ba5b17bf3652cb97c7a4cef57842dca7dd7 Mon Sep 17 00:00:00 2001 From: Colin Rotherham Date: Fri, 10 Nov 2023 13:27:51 +0000 Subject: [PATCH 04/13] Suggestion to adjust required versus optional descriptions --- .../components/character-count/character-count.yaml | 4 ++-- .../src/govuk/components/file-upload/file-upload.yaml | 2 +- .../src/govuk/components/input/input.yaml | 10 +++++----- .../govuk/components/phase-banner/phase-banner.yaml | 2 +- .../src/govuk/components/select/select.yaml | 2 +- .../src/govuk/components/task-list/task-list.yaml | 2 +- .../src/govuk/components/textarea/textarea.yaml | 2 +- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/packages/govuk-frontend/src/govuk/components/character-count/character-count.yaml b/packages/govuk-frontend/src/govuk/components/character-count/character-count.yaml index e3f56339dc..d3c4e4f754 100644 --- a/packages/govuk-frontend/src/govuk/components/character-count/character-count.yaml +++ b/packages/govuk-frontend/src/govuk/components/character-count/character-count.yaml @@ -30,7 +30,7 @@ params: - name: label type: object required: true - description: Can be used to add a label to a character count component. + description: Additional options for the label used by the character count component. isComponent: true - name: hint type: object @@ -66,7 +66,7 @@ params: - name: countMessage type: object required: false - description: The message for the character count component. + description: Additional options for the count message used by the character count component. params: - name: classes type: string diff --git a/packages/govuk-frontend/src/govuk/components/file-upload/file-upload.yaml b/packages/govuk-frontend/src/govuk/components/file-upload/file-upload.yaml index 4e083253fc..787282f15d 100644 --- a/packages/govuk-frontend/src/govuk/components/file-upload/file-upload.yaml +++ b/packages/govuk-frontend/src/govuk/components/file-upload/file-upload.yaml @@ -22,7 +22,7 @@ params: - name: label type: object required: true - description: Can be used to add a label to the file upload component. + description: Additional options for the label used by the file upload component. isComponent: true - name: hint type: object diff --git a/packages/govuk-frontend/src/govuk/components/input/input.yaml b/packages/govuk-frontend/src/govuk/components/input/input.yaml index ec2a858033..06f6de02c6 100644 --- a/packages/govuk-frontend/src/govuk/components/input/input.yaml +++ b/packages/govuk-frontend/src/govuk/components/input/input.yaml @@ -30,12 +30,12 @@ params: - name: label type: object required: true - description: Options for the label component. + description: Additional options for the label used by the text input component. isComponent: true - name: hint type: object required: false - description: Options for the hint component. + description: Can be used to add a hint to a text input component. isComponent: true - name: errorMessage type: object @@ -45,7 +45,7 @@ params: - name: prefix type: object required: false - description: Options for the prefix element. + description: Can be used to add a prefix to the text input component. params: - name: text type: string @@ -66,7 +66,7 @@ params: - name: suffix type: object required: false - description: Options for the suffix element. + description: Can be used to add a suffix to the text input component. params: - name: text type: string @@ -87,7 +87,7 @@ params: - name: formGroup type: object required: false - description: Options for the form-group wrapper. + description: Additional options for the form group containing the text-input component. params: - name: classes type: string diff --git a/packages/govuk-frontend/src/govuk/components/phase-banner/phase-banner.yaml b/packages/govuk-frontend/src/govuk/components/phase-banner/phase-banner.yaml index 6b0216f858..e2ecb6a560 100644 --- a/packages/govuk-frontend/src/govuk/components/phase-banner/phase-banner.yaml +++ b/packages/govuk-frontend/src/govuk/components/phase-banner/phase-banner.yaml @@ -10,7 +10,7 @@ params: - name: tag type: object required: true - description: Options for the tag component. + description: Additional options for the tag used by the phase banner component. isComponent: true - name: classes type: string diff --git a/packages/govuk-frontend/src/govuk/components/select/select.yaml b/packages/govuk-frontend/src/govuk/components/select/select.yaml index 9edc160089..636b274f59 100644 --- a/packages/govuk-frontend/src/govuk/components/select/select.yaml +++ b/packages/govuk-frontend/src/govuk/components/select/select.yaml @@ -47,7 +47,7 @@ params: - name: label type: object required: false - description: Can be used to add a label to the select component. + description: Additional options for the label used by the select component. isComponent: true - name: hint type: object diff --git a/packages/govuk-frontend/src/govuk/components/task-list/task-list.yaml b/packages/govuk-frontend/src/govuk/components/task-list/task-list.yaml index 9f2b3afd11..7a03b477ff 100644 --- a/packages/govuk-frontend/src/govuk/components/task-list/task-list.yaml +++ b/packages/govuk-frontend/src/govuk/components/task-list/task-list.yaml @@ -43,7 +43,7 @@ params: type: object isComponent: true required: false - description: Options for the tag component. + description: Can be used to add a tag to the status of the task within the task list component. - name: text required: false type: string diff --git a/packages/govuk-frontend/src/govuk/components/textarea/textarea.yaml b/packages/govuk-frontend/src/govuk/components/textarea/textarea.yaml index 0cc666c3f7..f94a243016 100644 --- a/packages/govuk-frontend/src/govuk/components/textarea/textarea.yaml +++ b/packages/govuk-frontend/src/govuk/components/textarea/textarea.yaml @@ -30,7 +30,7 @@ params: - name: label type: object required: true - description: Can be used to add a label to the textarea component. + description: Additional options for the label used by the textarea component. isComponent: true - name: hint type: object From 5c3d003b27c1c0f79ca6f9ea3a541a39ef6e65af Mon Sep 17 00:00:00 2001 From: Colin Rotherham Date: Fri, 10 Nov 2023 13:23:38 +0000 Subject: [PATCH 05/13] =?UTF-8?q?Suggestion=20to=20remove=20=E2=80=9Ctag?= =?UTF-8?q?=E2=80=9D=20from=20status=20description?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The status can be text without a tag (optional) --- .../src/govuk/components/task-list/task-list.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/govuk-frontend/src/govuk/components/task-list/task-list.yaml b/packages/govuk-frontend/src/govuk/components/task-list/task-list.yaml index 7a03b477ff..d64f094e6c 100644 --- a/packages/govuk-frontend/src/govuk/components/task-list/task-list.yaml +++ b/packages/govuk-frontend/src/govuk/components/task-list/task-list.yaml @@ -37,7 +37,7 @@ params: - name: status type: object required: true - description: The status tag for each task within the task list component. + description: The status for each task within the task list component. params: - name: tag type: object From 3df7d08887226b988da7130848cacab0a2072b8e Mon Sep 17 00:00:00 2001 From: Colin Rotherham Date: Mon, 13 Nov 2023 10:14:57 +0000 Subject: [PATCH 06/13] =?UTF-8?q?Fix=20default=20value=20for=20`=C2=A9=20C?= =?UTF-8?q?rown=20copyright`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../govuk-frontend/src/govuk/components/footer/footer.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/govuk-frontend/src/govuk/components/footer/footer.yaml b/packages/govuk-frontend/src/govuk/components/footer/footer.yaml index 0686dd98c6..c5f6eabae8 100644 --- a/packages/govuk-frontend/src/govuk/components/footer/footer.yaml +++ b/packages/govuk-frontend/src/govuk/components/footer/footer.yaml @@ -83,16 +83,16 @@ params: - name: copyright type: object required: false - description: The copyright information in the footer component, this defaults to Crown Copyright. + description: The copyright information in the footer component, this defaults to `© Crown copyright`. params: - name: text type: string required: false - description: If `html` is set, this is not required. If `html` is provided, the `text` option will be ignored. If neither are provided, Crown copyright is used. + description: If `html` is set, this is not required. If `html` is provided, the `text` option will be ignored. If neither are provided, `© Crown copyright` is used. - name: html type: string required: false - description: If `text` is set, this is not required. If `html` is provided, the `text` option will be ignored. If neither are provided, Crown copyright is used. The copyright notice is inside an `` element, so you can only use text formatting elements within it. + description: If `text` is set, this is not required. If `html` is provided, the `text` option will be ignored. If neither are provided, `© Crown copyright` is used. The copyright notice is inside an `` element, so you can only use text formatting elements within it. - name: containerClasses type: string required: false From e49036cfdacf1296e1570771e4b964e8c27d42ba Mon Sep 17 00:00:00 2001 From: Colin Rotherham Date: Mon, 13 Nov 2023 10:15:34 +0000 Subject: [PATCH 07/13] Fix default value for `full` width --- packages/govuk-frontend/src/govuk/components/footer/footer.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/govuk-frontend/src/govuk/components/footer/footer.yaml b/packages/govuk-frontend/src/govuk/components/footer/footer.yaml index c5f6eabae8..d695934781 100644 --- a/packages/govuk-frontend/src/govuk/components/footer/footer.yaml +++ b/packages/govuk-frontend/src/govuk/components/footer/footer.yaml @@ -49,7 +49,7 @@ params: - name: width type: string required: false - description: Width of each navigation section in the footer. Defaults to full width. You can pass any design system grid width here, for example, 'one-third'; 'two-thirds'; 'one-half'. + description: Width of each navigation section in the footer. Defaults to `full`. You can pass any design system grid width here, for example, 'one-third'; 'two-thirds'; 'one-half'. - name: items type: array required: false From b39b679d32636a052c1e504110cfa4205b339fbe Mon Sep 17 00:00:00 2001 From: Colin Rotherham Date: Wed, 15 Nov 2023 18:10:11 +0000 Subject: [PATCH 08/13] Fix select label `required: false` The label is rendered using `params.label` and is required --- packages/govuk-frontend/src/govuk/components/select/select.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/govuk-frontend/src/govuk/components/select/select.yaml b/packages/govuk-frontend/src/govuk/components/select/select.yaml index 636b274f59..372558e082 100644 --- a/packages/govuk-frontend/src/govuk/components/select/select.yaml +++ b/packages/govuk-frontend/src/govuk/components/select/select.yaml @@ -46,7 +46,7 @@ params: description: One or more element IDs to add to the `aria-describedby` attribute, used to provide additional descriptive information for screenreader users. - name: label type: object - required: false + required: true description: Additional options for the label used by the select component. isComponent: true - name: hint From 6cc8006c4d0373adaf5caff74da6992a522f9065 Mon Sep 17 00:00:00 2001 From: Colin Rotherham Date: Mon, 13 Nov 2023 11:08:38 +0000 Subject: [PATCH 09/13] Wrap all values in backticks (with quotes for strings) --- .../govuk/components/accordion/accordion.yaml | 6 ++--- .../govuk/components/back-link/back-link.yaml | 4 ++-- .../src/govuk/components/button/button.yaml | 8 +++---- .../components/checkboxes/checkboxes.yaml | 4 ++-- .../cookie-banner/cookie-banner.yaml | 10 ++++---- .../components/date-input/date-input.yaml | 4 ++-- .../error-message/error-message.yaml | 2 +- .../exit-this-page/exit-this-page.yaml | 14 +++++------ .../src/govuk/components/footer/footer.yaml | 24 +++++++++---------- .../src/govuk/components/header/header.yaml | 4 ++-- .../src/govuk/components/input/input.yaml | 2 +- .../notification-banner.yaml | 12 +++++----- .../components/pagination/pagination.yaml | 10 ++++---- .../src/govuk/components/radios/radios.yaml | 2 +- .../govuk/components/skip-link/skip-link.yaml | 2 +- .../govuk/components/task-list/task-list.yaml | 2 +- .../govuk/components/textarea/textarea.yaml | 2 +- .../components/warning-text/warning-text.yaml | 2 +- 18 files changed, 57 insertions(+), 57 deletions(-) diff --git a/packages/govuk-frontend/src/govuk/components/accordion/accordion.yaml b/packages/govuk-frontend/src/govuk/components/accordion/accordion.yaml index ba1826f5f2..cdeb32d485 100644 --- a/packages/govuk-frontend/src/govuk/components/accordion/accordion.yaml +++ b/packages/govuk-frontend/src/govuk/components/accordion/accordion.yaml @@ -2,7 +2,7 @@ params: - name: id type: string required: true - description: Must be unique across the domain of your service if `rememberExpanded` is `true` (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 if `rememberExpanded` is `true` (as the expanded state of individual instances of the component persists across page loads using [session storage](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. - name: headingLevel type: integer required: false @@ -30,7 +30,7 @@ params: - name: hideSectionAriaLabelText type: string required: false - description: Text made available to assistive technologies, like screen-readers, as the final part of the toggle's accessible name when the section is expanded. Defaults to 'Hide this section'. + description: Text made available to assistive technologies, like screen-readers, as the final part of the toggle's accessible name when the section is expanded. Defaults to `"Hide this section"`. - name: showAllSectionsText type: string required: false @@ -42,7 +42,7 @@ params: - name: showSectionAriaLabelText type: string required: false - description: Text made available to assistive technologies, like screen-readers, as the final part of the toggle's accessible name when the section is collapsed. Defaults to 'Show this section'. + description: Text made available to assistive technologies, like screen-readers, as the final part of the toggle's accessible name when the section is collapsed. Defaults to `"Show this section"`. - name: items type: array required: true diff --git a/packages/govuk-frontend/src/govuk/components/back-link/back-link.yaml b/packages/govuk-frontend/src/govuk/components/back-link/back-link.yaml index cb97d1d900..14790fdaa2 100644 --- a/packages/govuk-frontend/src/govuk/components/back-link/back-link.yaml +++ b/packages/govuk-frontend/src/govuk/components/back-link/back-link.yaml @@ -2,11 +2,11 @@ params: - name: text type: string required: false - description: Text to use within the back link component. If `html` is provided, the `text` option will be ignored. Defaults to 'Back'. + description: Text to use within the back link component. If `html` is provided, the `text` option will be ignored. Defaults to `"Back"`. - name: html type: string required: false - description: HTML to use within the back link component. If `html` is provided, the `text` option will be ignored. Defaults to 'Back'. + description: HTML to use within the back link component. If `html` is provided, the `text` option will be ignored. Defaults to `"Back"`. - name: href type: string required: true diff --git a/packages/govuk-frontend/src/govuk/components/button/button.yaml b/packages/govuk-frontend/src/govuk/components/button/button.yaml index fa5437d2b2..cb30f70d83 100644 --- a/packages/govuk-frontend/src/govuk/components/button/button.yaml +++ b/packages/govuk-frontend/src/govuk/components/button/button.yaml @@ -6,11 +6,11 @@ params: - name: text type: string required: true - description: If `html` is set, this is not required. Text for the `input`, `button` or `a` element. If `html` is provided, the `text` option will be ignored and `element` will be automatically set to `button` unless `href` is also set, or it has already been defined. + description: If `html` is set, this is not required. Text for the `input`, `button` or `a` element. If `html` is provided, the `text` option will be ignored and `element` will be automatically set to `"button"` unless `href` is also set, or it has already been defined. - name: html type: string required: true - description: If `text` is set, this is not required. HTML for the `button` or `a` element only. If `html` is provided, the `text` option will be ignored and `element` will be automatically set to `button` unless `href` is also set, or it has already been defined. This option has no effect if `element` is set to `input`. + description: If `text` is set, this is not required. HTML for the `button` or `a` element only. If `html` is provided, the `text` option will be ignored and `element` will be automatically set to `"button"` unless `href` is also set, or it has already been defined. This option has no effect if `element` is set to `"input"`. - name: name type: string required: false @@ -18,7 +18,7 @@ params: - name: type type: string required: false - description: Type of `input` or `button` – `button`, `submit` or `reset`. Defaults to `submit`. This has no effect on `a` elements. + description: Type for the `input` or `button` element – `"button"`, `"submit"` or `"reset"`. Defaults to `"submit"`. This has no effect on `a` elements. - name: value type: string required: false @@ -30,7 +30,7 @@ params: - name: href type: string required: false - description: The URL that the button component should link to. If this is set, `element` will be automatically set to `a` if it has not already been defined. + description: The URL that the button component should link to. If this is set, `element` will be automatically set to `"a"` if it has not already been defined. - name: classes type: string required: false diff --git a/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml b/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml index e663a9c5c6..0511e9c22b 100644 --- a/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml +++ b/packages/govuk-frontend/src/govuk/components/checkboxes/checkboxes.yaml @@ -73,7 +73,7 @@ params: - name: divider type: string 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"`. - name: checked type: boolean required: false @@ -90,7 +90,7 @@ params: - name: behaviour type: string 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. - name: disabled type: boolean required: false diff --git a/packages/govuk-frontend/src/govuk/components/cookie-banner/cookie-banner.yaml b/packages/govuk-frontend/src/govuk/components/cookie-banner/cookie-banner.yaml index 98d8433749..b8d0cb0231 100644 --- a/packages/govuk-frontend/src/govuk/components/cookie-banner/cookie-banner.yaml +++ b/packages/govuk-frontend/src/govuk/components/cookie-banner/cookie-banner.yaml @@ -2,7 +2,7 @@ params: - name: ariaLabel type: string 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"`. - name: hidden type: boolean required: false @@ -39,7 +39,7 @@ params: - name: actions type: array required: false - description: The buttons and links that you want to display in the message. `actions` defaults to `button` unless you set `href`, which renders the action as a link. + description: The buttons and links that you want to display in the message. `actions` defaults to `"button"` unless you set `href`, which renders the action as a link. params: - name: text type: string @@ -48,11 +48,11 @@ params: - name: type type: string required: false - description: The type of button. You can set `button` or `submit`. Set `button` and `href` to render a link styled as a button. If you set `href`, it overrides `submit`. + description: The type of button. You can set `"button"` or `"submit"`. Set `type` to `"button"` and set `href` to render a link styled as a button. If you set `href`, it overrides `type` `"submit"`. - name: href type: string required: false - description: The `href` for a link. Set `button` and `href` to render a link styled as a button. + description: The `href` for a link. Set `type` to `"button"` and set `href` to render a link styled as a button. - name: name type: string required: false @@ -76,7 +76,7 @@ params: - name: role type: string required: false - description: Set `role` to `alert` on confirmation messages to allow assistive tech to automatically read the message. You will also need to move focus to the confirmation message using JavaScript you have written yourself. + description: Set `role` to `"alert"` on confirmation messages to allow assistive tech to automatically read the message. You will also need to move focus to the confirmation message using JavaScript you have written yourself. - name: classes type: string required: false diff --git a/packages/govuk-frontend/src/govuk/components/date-input/date-input.yaml b/packages/govuk-frontend/src/govuk/components/date-input/date-input.yaml index f1e4df95be..c7e32de13d 100644 --- a/packages/govuk-frontend/src/govuk/components/date-input/date-input.yaml +++ b/packages/govuk-frontend/src/govuk/components/date-input/date-input.yaml @@ -6,7 +6,7 @@ params: - name: namePrefix type: string required: false - description: Optional prefix. This is used to prefix each `item.name` using `-`. + description: Optional prefix. This is used to prefix each item `name` using `-`. - name: items type: array required: false @@ -31,7 +31,7 @@ params: - name: autocomplete type: string 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. - name: pattern type: string required: false diff --git a/packages/govuk-frontend/src/govuk/components/error-message/error-message.yaml b/packages/govuk-frontend/src/govuk/components/error-message/error-message.yaml index 1a546b6d72..0c96ffb266 100644 --- a/packages/govuk-frontend/src/govuk/components/error-message/error-message.yaml +++ b/packages/govuk-frontend/src/govuk/components/error-message/error-message.yaml @@ -22,7 +22,7 @@ params: - name: visuallyHiddenText type: string 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"`. accessibilityCriteria: | When used with a single input, the error message MUST: diff --git a/packages/govuk-frontend/src/govuk/components/exit-this-page/exit-this-page.yaml b/packages/govuk-frontend/src/govuk/components/exit-this-page/exit-this-page.yaml index 196a627560..cd89e0c721 100644 --- a/packages/govuk-frontend/src/govuk/components/exit-this-page/exit-this-page.yaml +++ b/packages/govuk-frontend/src/govuk/components/exit-this-page/exit-this-page.yaml @@ -2,15 +2,15 @@ params: - name: text type: string required: false - description: Text for the link. If `html` is provided, the `text` option will be ignored. Defaults to 'Emergency Exit this page' with 'Emergency' visually hidden. + description: Text for the link. If `html` is provided, the `text` option will be ignored. Defaults to `"Emergency Exit this page"` with 'Emergency' visually hidden. - name: html type: string required: false - description: HTML for the link. If `html` is provided, the `text` option will be ignored. Defaults to 'Emergency Exit this page' with 'Emergency' visually hidden. + description: HTML for the link. If `html` is provided, the `text` option will be ignored. Defaults to `"Emergency Exit this page"` with 'Emergency' visually hidden. - name: redirectUrl type: string required: false - description: URL to redirect the current tab to. Defaults to `https://www.bbc.co.uk/weather`. + description: URL to redirect the current tab to. Defaults to `"https://www.bbc.co.uk/weather"`. - name: id type: string required: false @@ -26,19 +26,19 @@ params: - name: activatedText type: string required: false - description: Text announced by screen readers when Exit this Page has been activated via the keyboard shortcut. Defaults to 'Loading.'. + description: Text announced by screen readers when Exit this Page has been activated via the keyboard shortcut. Defaults to `"Loading."`. - name: timedOutText type: string required: false - description: Text announced by screen readers when the keyboard shortcut has timed out without successful activation. Defaults to 'Exit this page expired.'. + description: Text announced by screen readers when the keyboard shortcut has timed out without successful activation. Defaults to `"Exit this page expired."`. - name: pressTwoMoreTimesText type: string required: false - description: Text announced by screen readers when the user must press Shift two more times to activate the button. Defaults to 'Shift, press 2 more times to exit.'. + description: Text announced by screen readers when the user must press Shift two more times to activate the button. Defaults to `"Shift, press 2 more times to exit."`. - name: pressOneMoreTimeText type: string required: false - description: Text announced by screen readers when the user must press Shift one more time to activate the button. Defaults to 'Shift, press 1 more time to exit.'. + description: Text announced by screen readers when the user must press Shift one more time to activate the button. Defaults to `"Shift, press 1 more time to exit."`. examples: - name: default diff --git a/packages/govuk-frontend/src/govuk/components/footer/footer.yaml b/packages/govuk-frontend/src/govuk/components/footer/footer.yaml index d695934781..693f4f263d 100644 --- a/packages/govuk-frontend/src/govuk/components/footer/footer.yaml +++ b/packages/govuk-frontend/src/govuk/components/footer/footer.yaml @@ -7,19 +7,19 @@ params: - name: visuallyHiddenTitle type: string required: false - description: Title for a meta item section. Defaults to 'Support links'. + description: Title for a meta item section. Defaults to `"Support links"`. - name: html type: string required: false - description: HTML to add to the meta section of the footer, which will appear below any links specified using meta.items. + description: HTML to add to the meta section of the footer, which will appear below any links specified using meta `items`. - name: text type: string required: false - description: Text to add to the meta section of the footer, which will appear below any links specified using meta.items. If meta.html is specified, this option is ignored. + description: Text to add to the meta section of the footer, which will appear below any links specified using meta `items`. If meta `html` is specified, this option is ignored. - name: items type: array required: false - description: The meta items add content within a unordered list to the meta section of the footer component. These appear above any text or custom html in the meta section. + description: The meta `items` add content within a unordered list to the meta section of the footer component. These appear above any text or custom html in the meta section. params: - name: text type: string @@ -28,7 +28,7 @@ params: - name: href type: string required: true - description: List item href attribute in the meta section of the footer. + description: List item link `href` attribute in the meta section of the footer. - name: attributes type: object required: false @@ -49,7 +49,7 @@ params: - name: width type: string required: false - description: Width of each navigation section in the footer. Defaults to `full`. You can pass any design system grid width here, for example, 'one-third'; 'two-thirds'; 'one-half'. + description: Width of each navigation section in the footer. Defaults to `"full"`. You can pass any design system grid width here, for example, `"one-third"`; `"two-thirds"`; `"one-half"`. - name: items type: array required: false @@ -62,7 +62,7 @@ params: - name: href type: string required: true - description: List item href attribute in the navigation section of the footer. Both `text` and `href` attributes need to be present to create a link. + description: List item link `href` attribute in the navigation section of the footer. Both `text` and `href` attributes need to be present to create a link. - name: attributes type: object required: false @@ -83,16 +83,16 @@ params: - name: copyright type: object required: false - description: The copyright information in the footer component, this defaults to `© Crown copyright`. + description: The copyright information in the footer component, this defaults to `"© Crown copyright"`. params: - name: text type: string required: false - description: If `html` is set, this is not required. If `html` is provided, the `text` option will be ignored. If neither are provided, `© Crown copyright` is used. + description: If `html` is set, this is not required. If `html` is provided, the `text` option will be ignored. If neither are provided, `"© Crown copyright"` is used. - name: html type: string required: false - description: If `text` is set, this is not required. If `html` is provided, the `text` option will be ignored. If neither are provided, `© Crown copyright` is used. The copyright notice is inside an `` element, so you can only use text formatting elements within it. + description: If `text` is set, this is not required. If `html` is provided, the `text` option will be ignored. If neither are provided, `"© Crown copyright"` is used. The copyright notice is inside an `` element, so you can only use text formatting elements within it. - name: containerClasses type: string required: false @@ -130,10 +130,10 @@ accessibilityCriteria: | Note: This decision has been made based on prior experience seeing removal of overuse of `