Implement optional default for override_tag #125
Merged
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
bcdickinson
changed the title
bcdickinson
suggested changes
Sep 26, 2020
tests/templates/patterns/atoms/tags_test_atom/tags_test_atom.yaml
Outdated
Show resolved
Hide resolved
William-Blackie
force-pushed
the
feature/override_page_url_tag
branch
from
ec2ab0d to
021300c
Compare
bcdickinson
suggested changes
Oct 28, 2020
docs/overview.md
Outdated
| @@ -134,6 +134,21 @@ The override process has two parts: | |||
| 1. Override your template tag with a mock implementation | |||
| 2. Define fake result for your tag in a `yaml` file | |||
|
|
|||
|
|
|||
| ### Providing a default value for template tags | |||
| To provide a default for a template tag, you need to provide a keyword argument default when overriding your tag. | |||
docs/overview.md
Outdated
| This default is used for any tag that's not passed its own context, allowing specificity for those elements that need it while preventing the tag from breaking when it's not structural to the component. | ||
|
|
||
| #### limitation | ||
| Currently the default override is limited to direct references only i.e. {% a_tag_name page.url %} and not {% a_tag_name page.url as variable_name %} |
There was a problem hiding this comment.
I'm not sure about the wording here. What's actually not supported is modifying context, so it might be better to say something along the lines of "Only providing a default for the output of the tag is supporting, it's not possible to modify context like <example of simpletag as>".
There was a problem hiding this comment.
Fair point, thanks.
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.
Description
This PR provides away for a template tag to be provided a default value, across any template that is rendered. This default can be overridden in template specific context if desired so still allows for specific functionality when required.
Please include a summary of the changes and which issue this relates to (if applicable). Please list any dependencies that are required for this change.
Fixes # Request from feedback sheet.
Type of change
Please delete options that are not relevant.
Checklist: