Replace/Rename Astro.canonicalURL with new Astro.url helper #3959
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
🦋 Changeset detectedLatest commit: 85eede3 The changes in this PR will be included in the next version bump. This PR includes changesets to release 12 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
pkg: astro
FredKSchott
force-pushed
the
rename-canonical-url
branch
from
9714672 to
7722191
Compare
matthewp
reviewed
Jul 18, 2022
FredKSchott
force-pushed
the
rename-canonical-url
branch
from
cf6add2 to
06f8893
Compare
FredKSchott
force-pushed
the
rename-canonical-url
branch
from
06f8893 to
3bc3e31
Compare
tony-sull
approved these changes
Jul 20, 2022
| * [Astro reference](https://docs.astro.build/en/reference/api-reference/#astrocanonicalurl) | ||
| /** | ||
| * Canonical URL of the current page. | ||
| * @deprecated Use `Astro.url` instead. |
There was a problem hiding this comment.
nit: this may be a nice place for an example using new URL(Astro.url.pathname, Astro.site)
There was a problem hiding this comment.
I updated this with an example.
| @@ -220,6 +214,13 @@ ${extra}` | |||
| slots: astroSlots, | |||
| } as unknown as AstroGlobal; | |||
|
|
|||
| Object.defineProperty(Astro, 'canonicalURL', { | |||
| get: function() { | |||
| console.warn('Astro.canonicalURL is deprecated! Use \`Astro.url\` instead.'); | |||
There was a problem hiding this comment.
nit: same as above, an example recreating the canonical may be useful for anyone hitting this API
tony-sull
approved these changes
Jul 21, 2022
Merged
1 task
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.
Changes
Testing
Docs