DEV: Use named parameters for dir-span helper #14195
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
Follow up to: e50a5c0 In order to improve code clarity this change introduces named parameters for the dir-span helper. This is specifically for the new `htmlSafe` parameter which you can use instead of just passing in a boolean if the strings you are passing in have already been escaped. Before: `{{dir-span category.description false}}` After: `{{dir-span category.description htmlSafe=true}}`
tgxworld
reviewed
Aug 31, 2021
Comment on lines
16
to
22
| export default registerUnbound("dir-span", function (str, params) { | ||
| let isHtmlSafe = false; | ||
| if (params) { | ||
| if (params.htmlSafe) { | ||
| isHtmlSafe = params.htmlSafe; | ||
| } | ||
| } |
There was a problem hiding this comment.
Suggested change
| export default registerUnbound("dir-span", function (str, params) { | |
| let isHtmlSafe = false; | |
| if (params) { | |
| if (params.htmlSafe) { | |
| isHtmlSafe = params.htmlSafe; | |
| } | |
| } | |
| export default registerUnbound("dir-span", function (str, params = {}) { | |
| let isHtmlSafe = false; | |
| if (params.htmlSafe) { | |
| isHtmlSafe = params.htmlSafe; | |
| } |
tgxworld
approved these changes
Aug 31, 2021
There was a problem hiding this comment.
I agree with @eviltrout that this makes the API much clearer. Awesome change and thank you for pushing this through 👍
|
Very nice! Thank you @oblakeerickson |
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.
Follow up to: e50a5c0
In order to improve code clarity this change introduces named parameters
for the dir-span helper. This is specifically for the new
htmlSafeparameter which you can use instead of just passing in a boolean if the
strings you are passing in have already been escaped.
Before:
{{dir-span category.description false}}After:
{{dir-span category.description htmlSafe=true}}