Moved description into dl tag in message list component #3465
Conversation
✅ Deploy Preview for ons-design-system-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -15,10 +15,11 @@ | |||
| <dd class="ons-message-item__metadata-value ons-message-item__metadata-value--date ons-u-fs-s"> | |||
| {{ message.dateText }} | |||
| </dd> | |||
| <dt class="ons-message-item__metadata-term ons-message-item__metadata-term--body ons-u-d-no">{{ params.body }}:</dt> | |||
There was a problem hiding this comment.
params.body isn't a param thats being used or passed in the example or documented and you have removed the ariaLabelMsg param. This would be a breaking change, to avoid the breaking change for now we should probably use the ariaLabelMsg param for this and then record this as a breaking change that we would want to make in the next breaking release, check our confluence for the process for that. Because of this we should also default it to "Message text" like ariaLabelMsg already is
There was a problem hiding this comment.
As discussed we would keep the ariaLabelMsg param but introduce a new param params.bodyLabel, bodyLabel would set the new message label but if that doesn't exist it would fall back to use ariaLabelMsg
|
As this is a deprecation we need to follow the process outlined in the "Deprecation Implementation and Release Process" in confluence we have set out. You have added the "(DEPRECATED)" tag but we need to follow the other parts of the process |
I had doubt on this one. I will add the rest now now |
| @@ -39,7 +41,6 @@ const EXAMPLE_MESSAGE_LIST = { | |||
| ...EXAMPLE_MESSAGE_LIST_MINIMAL, | |||
| ariaLabel: 'Message list for ONS Business Surveys', | |||
| ariaLabelMetaData: 'Message information', | |||
| ariaLabelMsg: 'Message preview', | |||
There was a problem hiding this comment.
As we still support this param we still need to test it. We will need to add an example in where this is set instead of bodyLabel and a test similar to the new test you have added
| @@ -20,6 +20,7 @@ const EXAMPLE_MESSAGE_LIST_MINIMAL = { | |||
| }, | |||
| fromText: 'Example Sender 1', | |||
| dateText: 'Tue 4 Jul 2020 at 7:47', | |||
| bodyLabel: 'Body', | |||
There was a problem hiding this comment.
This param shouldn't be at the message level, it should be at the top param level like the other label params
…om/ONSdigital/design-system into fix/3427/move-message-body-into-dl
What is the context of this PR?
204
Moved description into dl tag in message list component.
To achieve this new param
bodyLabelwas added andariaLabelMsgparam was deprecated.As per the deprecation implementation process available in confluence
(DEPRECATED)is added to theariaLabelMsgparam andNEWis added to thebodyLabelparam in message list documentation.How to review this PR
Inspect example-message-list.html in send and reply message patterns and check that the description is inside the dl tag.
Checklist
This needs to be completed by the person raising the PR.