Skip to content

Remove deprecated ariaLabelMsg param from message list component#3726

Merged
rmccar merged 6 commits intomainfrom
remove-deprecated-ariaLabelMsg-param-from-message-list
Sep 8, 2025
Merged

Remove deprecated ariaLabelMsg param from message list component#3726
rmccar merged 6 commits intomainfrom
remove-deprecated-ariaLabelMsg-param-from-message-list

Conversation

@rmccar
Copy link
Copy Markdown
Contributor

@rmccar rmccar commented Sep 5, 2025

What is the context of this PR?

BREAKING CHANGE

Fixes: ONSDESYS-644

Removes the deprecated param ariaLabelMsg from the message list component ready for the major release (73.0.0).

This will impact the message list component

To mitigate the breaking changes:
Replace any references to the ariaLabelMsg when using the message list component with bodyLabel.

Here is an example with the param replaced

{{
    onsMessageList({
        "ariaLabel": "Message list for ONS Business Surveys",
		"ariaLabelMsg": "Body",
        "unreadText": "New",
        "fromLabel": "From",
        "dateLabel": "Sent",
        "hiddenReadLabel": "Read the message",
        "ariaLabelMetaData": "Message information",
        "messages": [
            {
                "id": "message-list-example-1",
                "subject": {
                    "url": "#0",
                    "text": "BRES 2016 survey response query"
                },
                "unread": true,
                "fromText": "ONS Business Surveys Team",
                "dateText": "Tue 4 Jul 2020 at 7:47",
                "body": "Hi Jacky. Thanks for that information. Your figures have allowed us to create more accurate…"
            },
            {
                "id": "message-list-example-2",
                "subject":{
                    "url": "#0",
                    "text": "BRES 2015 Enquiry on data"
                },
                "fromText": "Jacky Turner",
                "dateText": "Mon 1 Oct 2019 at 9:52",
                "body": "Hi Jacky, Thank you for returning the Business Register and Employment Survey (BRES) 2016…"
            }
        ]
    })
}}

How to review this PR

  • Compare this branch to main using both params and make sure that the resulting html is the same of using either param
  • Test with a screenreader to make sure what is read out is the same

Checklist

This needs to be completed by the person raising the PR.

  • I have selected the correct Assignee
  • I have linked the correct Issue

@netlify
Copy link
Copy Markdown

netlify bot commented Sep 5, 2025

Deploy Preview for ons-design-system-preview ready!

Name Link
🔨 Latest commit b73882d
🔍 Latest deploy log https://app.netlify.com/projects/ons-design-system-preview/deploys/68be9c47bd60d0000802f6af
😎 Deploy Preview https://deploy-preview-3726--ons-design-system-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@rmccar rmccar self-assigned this Sep 5, 2025
@rmccar rmccar added the Breaking changes This PR contains at least one breaking change label Sep 5, 2025
@rmccar rmccar marked this pull request as ready for review September 5, 2025 08:33
@rmccar rmccar requested a review from a team as a code owner September 5, 2025 08:33
@rmccar rmccar changed the title Remove deprecated ariaLabelMsg param from message list Remove deprecated ariaLabelMsg param from message list Sep 5, 2025
@rmccar rmccar merged commit b6bb712 into main Sep 8, 2025
14 checks passed
@rmccar rmccar deleted the remove-deprecated-ariaLabelMsg-param-from-message-list branch September 8, 2025 10:06
@rmccar rmccar changed the title Remove deprecated ariaLabelMsg param from message list Remove deprecated ariaLabelMsg param from message list component Sep 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Breaking changes This PR contains at least one breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants