Skip to content

Rename ViewTransitions to ClientRouter#9391

Merged
sarah11918 merged 7 commits into
5.0.0-betafrom
vt-rename
Sep 13, 2024
Merged

Rename ViewTransitions to ClientRouter#9391
sarah11918 merged 7 commits into
5.0.0-betafrom
vt-rename

Conversation

@matthewp

Copy link
Copy Markdown
Contributor

Description (required)

Renames ViewTransitions component to ClientRouter in all of the documentation.

For Astro version: 5.x. See astro PR #11980.

@netlify

netlify Bot commented Sep 12, 2024

Copy link
Copy Markdown

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit e51af98
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/66e45f7878b3b5000825e907
😎 Deploy Preview https://deploy-preview-9391--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sarah11918

sarah11918 commented Sep 12, 2024

Copy link
Copy Markdown
Member

Thanks @matthewp !

I will have to do a bunch of find and replace for regular text paragraphs and explanations, so there are a few decisions to make.

Can you please also go through this section in the API reference and change any wording that you would no longer use when describing the API (including the name!). Knowing what you would now say on this page will help me with the questions I'll have (listed below):

https://5-0-0-beta.docs.astro.build/en/reference/api-reference/#view-transitions-client-api-astrotransitionsclient

In general, we'll need to figure out things like:

  • Is it still the "View Transitions API" ? If not, what's the name of the API/module when we need to reference it.

  • When we use it in a sentence, I'm assuming "enabling view transitions in your project" and "Astro's view transition support" should be changed to something like "enabling client-side routing in your project" and "Astro's client-side routing support"

  • When we talk about native browser support, or anything to do with the browser, we probably still should say "view transitions"? Because browsers don't have "client-side routing support" ?

  • Can you think of any other situations where saying "view transitions" would be the correct phrase to use?

  • And also making sure that we're still OK calling the page "View Transitions" as it stands, and this component is how to enable and achieve page transitions, persistence etc. etc.?

@matthewp

matthewp commented Sep 13, 2024

Copy link
Copy Markdown
Contributor Author

I don't think anything really needs to change. The name of the thing being imported is all that has changed here. It still uses view transitions as a core part of the routing. It still attempts to mimic native routing as much as possible. Only the import has changed. We can quibble that some things are better worded different to differentiate the "real" view transitions MPA router vs ours, but those things could have / should have been worded differently before this change.

The view transition guide itself could probably use a bit of refactoring to talk about the choice between the MPA routing and using ClientRouter (and breaking it up so that the ClientRouter parts are in their own sections), but I don't see why that needs to happen in this change.

@sarah11918

Copy link
Copy Markdown
Member

Perfect, thank you!

Comment thread src/content/docs/en/reference/api-reference.mdx Outdated
@sarah11918

Copy link
Copy Markdown
Member

Thanks @matthewp ! Will merge this in so I can start incorporating, check for any links that might have pointed to the changed header etc.!

Note that the config reference docs need to be changed in the JS Doc in the Astro repo. If you get to it before I do, great. If not, I've made a note!

@matthewp

Copy link
Copy Markdown
Contributor Author

Those are already done in my PR: withastro/astro#11980

@sarah11918

Copy link
Copy Markdown
Member

Perfect, yup, I see it now! They were also committed here, so I'll just undo these changes locally. All good!

@sarah11918 sarah11918 merged commit 3280963 into 5.0.0-beta Sep 13, 2024
@sarah11918 sarah11918 deleted the vt-rename branch September 13, 2024 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants