Normalize Sample Code URLs #979
Open
Conversation
This file contains hidden or 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
It prefixes the URL with the baseUrl value if the path is relative and the baseUrl is provided. If the path is absolute or the baseUrl is not provided, it does not prefixes the URL.
We only want to normalize the URL in the case that it links to an asset, that's why in this commit we introduce a new boolean prop for the CallToActionButton called `linksToAsset`.
Now that we have the prop linksToAsset available for CallToActionButton components, we want to pass it as true for the download button used for Sample Codes, since the URL links to an asset.
We want to use this function to check if urls are absolute or not.
For the normalizePath function to work, the path needs to be relative. This means that we need to normalize the relative path first, to make sure that the normalizePath function reads it as a relative path. For this, we should use the function isAbsoluteUrl to see if the url is absolute or not.
We want to make sure that simple-relative paths like 'foo/bar' also work when prefixing the baseUrl.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Bug/issue #165347857, if applicable:
Summary
We want to normalize Sample Code URLs, by adding the
baseUrlto them if the path is relative and the baseUrl is provided. If the path is absolute or the baseUrl is not provided, it does not prefixes the URL.Because the component
CallToActionButton.vueis not only being used for Sample Code links, we created a new prop calledlinksToAssetthat will normalize the relative URLs, in the cases that they are assets, like Sample Code.Dependencies
NA
Testing
Steps:
baseUrlChecklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
npm test, and it succeeded