Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update examples of dynamic pageKey #22920

Merged
merged 2 commits into from Aug 31, 2023
Merged

docs: update examples of dynamic pageKey #22920

merged 2 commits into from Aug 31, 2023

Conversation

danielroe
Copy link
Member

πŸ”— Linked issue

resolves #22908

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

Using $route to define a dynamic pageKey for <NuxtPage> can cause odd errors as it's not compatible with the way we render different routes.

This updates the examples and adds a warning.

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@stackblitz
Copy link

stackblitz bot commented Aug 31, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@nuxt-studio
Copy link

nuxt-studio bot commented Aug 31, 2023

βœ… Live Preview ready!

Name Edit Preview Latest Commit
Nuxt Docs Edit on Studio β†—οΈŽ View Live Preview 9c50816

Copy link
Member

@manniL manniL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Do we also have an example in the examples repo that needs to be updated?

@danielroe danielroe merged commit 559a723 into main Aug 31, 2023
3 checks passed
@danielroe danielroe deleted the docs/page-key branch August 31, 2023 10:27
@danielroe
Copy link
Member Author

I don't think so.

@github-actions github-actions bot mentioned this pull request Aug 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Problem with route in version 3.7
2 participants