Refactor timeline macro for compatibility with Jinja2 templates #3180
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for ons-design-system-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
oh sorry I wasn't clear. Items is a reserved name mainly used as a built-in function for dictionary data structure. So when trying to iterate over this parameter named 'items', we get this error |
Can this information be put into the description |
rmccar
changed the title
rmccar
requested changes
May 9, 2024
rmccar
added
Breaking changes
|
Can we have a "breaking changes" section added to the description that tells the user how to update their service to fix the breaking change we have introduced |
7 tasks
rmccar
reviewed
May 9, 2024
rmccar
reviewed
May 9, 2024
rmccar
reviewed
May 10, 2024
alessioventuriniAND
suggested changes
May 17, 2024
alessioventuriniAND
approved these changes
Jun 17, 2024
precious-onyenaucheya-ons
approved these changes
Jun 17, 2024
rmccar
approved these changes
Jun 17, 2024
alessioventuriniAND
deleted the
fix/3171/refactor-timeline-to-suit-Jinja2
branch
alessioventuriniAND
removed
the
Do not merge
This was referenced Sep 10, 2024
Closed
Merged
rmccar
added a commit
that referenced
this pull request
Oct 9, 2024
* Removed .push method * Changed items name * Removing conflicts * changes as per comments * changes as per comments * Changing indentation * Update src/components/timeline/example-timeline.njk Co-authored-by: rmccar <[email protected]> --------- Co-authored-by: rmccar <[email protected]> Co-authored-by: Alessio Venturini <[email protected]>
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the context of this PR?
#3171 ...
BREAKING CHANGE
We have made a breaking change to the timeline macro by renaming the items parameter to timelineItems. This change affects all instances where the timeline macro is used. Below, we provide detailed instructions on how to update your service to accommodate this change.
How to Update Your Code
To update your service, you need to replace the items parameter with timelineItems wherever the timeline macro is used. Here is an example of how to make this change:
Before:
{{ onsTimeline({ "items": [. . . ] }) }}After:
{{ onsTimeline({ "timelineItems": [. . . ] }) }}How to review this PR
Checklist
This needs to be completed by the person raising the PR.