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

Rename items summary param for compatibility with Jinja #3382

Merged

Conversation

rmccar
Copy link
Contributor

@rmccar rmccar commented Oct 7, 2024

What is the context of this PR?

BREAKING CHANGE
Fixes: #3381

items is a reserved word in python so this was causing an error when we used the param in a Python environment. Renaming is itemsList which is what we have used in other components solves this.

The following parameter rename is included:

  • row.items is renamed to row.itemsList

This change is a breaking change because it alters the existing parameter names, which will require updates wherever these parameters are used.

How to Review this PR

Test that the summary component in both nunjucks and jinja environments, make sure it works as expected and does not error

Checklist

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

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

Copy link

netlify bot commented Oct 7, 2024

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

Name Link
🔨 Latest commit 6700b82
🔍 Latest deploy log https://app.netlify.com/sites/ons-design-system-preview/deploys/67044e9b826a2100085d9161
😎 Deploy Preview https://deploy-preview-3382--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.

@rmccar rmccar self-assigned this Oct 7, 2024
@rmccar rmccar added the Breaking changes This PR contains at least one breaking change label Oct 7, 2024
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.

You missed to update in the hub and spoke example pattern

@rmccar rmccar merged commit 11cda71 into major-release Oct 8, 2024
43 checks passed
@rmccar rmccar deleted the rename-items-summary-param-for-compatibility-with-jinja branch October 8, 2024 08:33
@rmccar rmccar linked an issue Oct 8, 2024 that may be closed by this pull request
@rmccar rmccar mentioned this pull request Oct 8, 2024
2 tasks
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: DS components not compatible with Jinja
3 participants