Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update parameter subject from text to object type in Message list component #3291

Conversation

SriHV
Copy link
Contributor

@SriHV SriHV commented Aug 12, 2024

What is the context of this PR?

#86...

As per the ticket tech notes, subject is made an object with text and url params.
Updated _macro-options.md file

BREAKING CHANGES

  • Description of change: In Message List component, subject parameter is changed to an object which contains text and url parameter. url parameter is moved inside subject

  • Reason for change: This update helps to standardise the parameter names within the project.

  • Migration steps:

    1. Locate all instances of subject parameter, and include text and url within the subject.
    Click for example
         OLD    
             {{
                   onsMessageList({
                       "messages": [{
                                "url": "#0",
                                 "subject": "survey response query",
                       }]
                   })
             }}
    
    
         NEW            
         {{
                 onsMessageList({
                       "messages": [{
                           "subject":{ 
                              "url": "#0",
                              "text":"survey response query",
                          } 
                      }]
                })
          }}
    

How to review this PR

Check that all the references to the parameters have been updated
Check that all the visual tests pass

Checklist

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

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

@SriHV SriHV added the Enhancement Change of existing feature label Aug 12, 2024
@SriHV SriHV self-assigned this Aug 12, 2024
Copy link

netlify bot commented Aug 12, 2024

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

Name Link
🔨 Latest commit c13c337
🔍 Latest deploy log https://app.netlify.com/sites/ons-design-system-preview/deploys/66be20036a086d00086852f6
😎 Deploy Preview https://deploy-preview-3291--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 site configuration.

@SriHV SriHV added Breaking changes This PR contains at least one breaking change Do not merge Don't merge this PR until this label is removed labels Aug 12, 2024
@SriHV SriHV linked an issue Aug 12, 2024 that may be closed by this pull request
@SriHV SriHV requested a review from a team August 12, 2024 16:48
@SriHV SriHV linked an issue Aug 12, 2024 that may be closed by this pull request
2 tasks
Copy link
Contributor

@precious-onyenaucheya-ons precious-onyenaucheya-ons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update the description to include a description for the breaking change

@SriHV SriHV changed the title Change Parameter Naming convention in Message list Update Parameter Naming convention in Message list Aug 13, 2024
@SriHV SriHV changed the title Update Parameter Naming convention in Message list Update parameter subject from text to object convention in Message list component Aug 15, 2024
@SriHV SriHV changed the title Update parameter subject from text to object convention in Message list component Update parameter subject from text to object type in Message list component Aug 15, 2024
@alessioventuriniAND alessioventuriniAND changed the base branch from main to major-release September 3, 2024 08:50
@alessioventuriniAND alessioventuriniAND removed the Do not merge Don't merge this PR until this label is removed label Sep 5, 2024
@alessioventuriniAND alessioventuriniAND merged commit 01a535b into major-release Sep 5, 2024
9 of 11 checks passed
@alessioventuriniAND alessioventuriniAND deleted the enhancement/86/change-parameter-name-convention-messageList branch September 5, 2024 10:55
This was referenced Sep 10, 2024
rmccar pushed a commit that referenced this pull request Oct 9, 2024
* Standardise setting heading level across components #3111

* Update param names to camel case naming standard #3188

* Renamed utility class from ons-grid--flex to ons-grid-flex #3268

* Removed metadata component #3275

* Remove call to action component and all references #3143

* Update parameter from UnreadLink to UnreadLinkUrl in Message component #3290

* Update parameter subject from text to object type in Message list component #3291

* Add option for additional logo in footer #3227

* Update parameter from link to text in Footer Component #3294

* Update parameter name from url to src in Image Component #3293

* Update parameter names from LogoImage and LogoURL to image and url a in header component #3292

* Update parameter name from url to linkUrl in feedback component #3295

* Rename summary component parameters #3224

* Refactor timeline macro for compatibility with Jinja2 templates #3180

* Update parameter names in document list component #3299

* Update param name settingsLinkTextURL to settingsLinkURL in Cookies Banner component #3300

* Update parameter names in card component #3303

* Update parameter from linkText to text in external link component #3304

* Update param name from title to text in section navigation component #3305

* Update parameter from linkText to videoLinkText in Video Component #3306

* Update parameter from manualLink to manualLinkUrl in Address Input component #3307

* Ensure list item custom attributes are always set on list item #3336

* Rename items summary param for compatibility with Jinja #3382

* Update DS components to ensure compatibility with Jinja #3380

* Rename html OGL Link param to current naming standard #3379

* Format migration guide #3377

* Introduction of new spacing grid #3285
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 Enhancement Change of existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Message List - Change parameter naming convention
4 participants