update param (#3304)

ONSdigital · Sep 5, 2024 · 371f03f · 371f03f
1 parent 87a148c
commit 371f03f
Show file tree

Hide file tree

Showing 11 changed files with 12 additions and 12 deletions.
diff --git a/src/components/external-link/_macro-options.md b/src/components/external-link/_macro-options.md
@@ -1,6 +1,6 @@
 | Name                 | Type   | Required | Description                                                                                        |
 | -------------------- | ------ | -------- | -------------------------------------------------------------------------------------------------- |
 | url                  | string | true     | The URL for the `href` attribute of the external link                                              |
-| linkText             | string | true     | Text for the external link                                                                         |
+| text                 | string | true     | Text for the external link                                                                         |
 | classes              | string | false    | Classes to apply to the link                                                                       |
 | newWindowDescription | string | false    | Use to set context after the `linkText` label for screen readers. Defaults to “opens in a new tab” |
diff --git a/src/components/external-link/_macro.njk b/src/components/external-link/_macro.njk
@@ -2,7 +2,7 @@
 
 {% macro onsExternalLink(params) %}
     <a href="{{ params.url }}" class="ons-external-link{{ ' ' + params.classes if params.classes else '' }}" target="_blank" rel="noopener">
-        <span class="ons-external-link__text"> {{- params.linkText | safe -}} </span
+        <span class="ons-external-link__text"> {{- params.text | safe -}} </span
         ><span class="ons-external-link__icon">&nbsp;{{- onsIcon({"iconType": 'external-link'}) -}} </span
         ><span class="ons-external-link__new-window-description ons-u-vh"
             >({{- params.newWindowDescription | default("opens in a new tab") -}})</span

diff --git a/src/components/external-link/_macro.spec.js b/src/components/external-link/_macro.spec.js
@@ -7,7 +7,7 @@ import { renderComponent, templateFaker } from '../../tests/helpers/rendering';
 
 const EXAMPLE_EXTERNAL_LINK = {
     url: 'http://example.com',
-    linkText: 'Example link',
+    text: 'Example link',
 };
 
 describe('macro: external-link', () => {

diff --git a/src/components/external-link/example-external-link.njk b/src/components/external-link/example-external-link.njk
@@ -5,7 +5,7 @@
     {{
         onsExternalLink({
             "url": "#0",
-            "linkText": "link to an external website"
+            "text": "link to an external website"
         })
     }}
 </p>
diff --git a/src/components/footer/_macro.njk b/src/components/footer/_macro.njk
@@ -147,15 +147,15 @@
                                         {{
                                             onsExternalLink({
                                                 "url": params.OGLLink.url | default('https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/'),
-                                                "linkText": params.OGLLink.link | default('Drwydded Llywodraeth Leol v3.0')
+                                                "text": params.OGLLink.link | default('Drwydded Llywodraeth Leol v3.0')
                                             })
                                         }}{{ params.OGLLink.post | default(', oni bai y nodir fel arall') }}
                                     {% else %}
                                         {{ params.OGLLink.pre | default('All content is available under the') }}
                                         {{
                                             onsExternalLink({
                                                 "url": params.OGLLink.url | default('https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/'),
-                                                "linkText": params.OGLLink.link | default('Open Government Licence v3.0')
+                                                "text": params.OGLLink.link | default('Open Government Licence v3.0')
                                             })
                                         }}{{ params.OGLLink.post | default(', except where otherwise stated') }}
                                     {% endif %}

diff --git a/src/components/footer/_macro.spec.js b/src/components/footer/_macro.spec.js
@@ -167,7 +167,7 @@ describe('macro: footer', () => {
             expect(externalLinkSpy.occurrences).toContainEqual(
                 expect.objectContaining({
                     url: 'https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/',
-                    linkText: 'Open Government Licence v3.0',
+                    text: 'Open Government Licence v3.0',
                 }),
             );
         });

diff --git a/src/components/list/_macro.njk b/src/components/list/_macro.njk
@@ -70,7 +70,7 @@
                     {{
                         onsExternalLink({
                             "url": item.url,
-                            "linkText": itemText
+                            "text": itemText
                         })
                     }}
                 {%- else -%}

diff --git a/src/components/list/_macro.spec.js b/src/components/list/_macro.spec.js
@@ -451,7 +451,7 @@ describe('macro: list', () => {
 
                 expect(externalLinkSpy.occurrences[0]).toEqual({
                     url: 'https://example.com/external-link',
-                    linkText: expectedItemText,
+                    text: expectedItemText,
                 });
             });
 

diff --git a/src/components/phase-banner/example-phase-banner-alpha.njk b/src/components/phase-banner/example-phase-banner-alpha.njk
@@ -9,7 +9,7 @@
     {{
         onsExternalLink({
             "url": "#0",
-            "linkText": "give feedback"
+            "text": "give feedback"
         })
     }}
 {% endset %}

diff --git a/src/components/phase-banner/example-phase-banner-beta.njk b/src/components/phase-banner/example-phase-banner-beta.njk
@@ -9,7 +9,7 @@
     {{
         onsExternalLink({
             "url": "#0",
-            "linkText": "give feedback"
+            "text": "give feedback"
         })
     }}
 {% endset %}

diff --git a/src/components/video/_macro.njk b/src/components/video/_macro.njk
@@ -19,7 +19,7 @@
             onsExternalLink({
                 "url": params.videoLinkURL,
                 "classes": "ons-video__link ons-js-video-placeholder ons-u-db",
-                "linkText": linkContents
+                "text": linkContents
             })
         }}
         <iframe