Skip to content

docs: Add missing deprecation notice for legacyBehavior in Link component #78405

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

Merged

Conversation

mrbadri
Copy link
Contributor

@mrbadri mrbadri commented Apr 22, 2025

What?

The Pages Router section of the Link component documentation now clearly states the deprecation notice for the legacyBehavior prop.

Why?

The Pages Router documentation was missing the deprecation notice that appears in the App Router docs, which could lead developers to continue using a feature that is scheduled for removal in Next.js v16.

How?

Added the deprecation notice to the legacyBehavior section in the Pages Router part of the documentation, making it consistent with the notice already present in the App Router section. The notice clearly states that the prop will be removed in Next.js v16 and provides information about migrating to the new behavior.

Fixes #78381

…nent

This adds a clear deprecation notice for the legacyBehavior prop in the Pages Router documentation of the Link component, making users aware that the prop will be removed in Next.js v16. This addresses issue vercel#78381
@ijjk ijjk added the Documentation Related to Next.js' official documentation. label Apr 22, 2025
@ijjk
Copy link
Member

ijjk commented Apr 22, 2025

Allow CI Workflow Run

  • approve CI run for commit: a46d770

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

Copy link
Contributor

@delbaoliveira delbaoliveira left a comment

Choose a reason for hiding this comment

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

Thank you @mrbadri, some suggestions.

mrbadri and others added 2 commits April 22, 2025 11:42
…'Warning'

Co-authored-by: Delba de Oliveira <32464864+delbaoliveira@users.noreply.github.com>
Co-authored-by: Delba de Oliveira <32464864+delbaoliveira@users.noreply.github.com>
@mrbadri
Copy link
Contributor Author

mrbadri commented Apr 22, 2025

Thank you @mrbadri, some suggestions.

Thank you for the suggestions, @delbaoliveira! I’ve made the changes you requested. Please let me know if anything else needs to be updated.

@mrbadri
Copy link
Contributor Author

mrbadri commented Apr 28, 2025

Hi @ijjk, @delbaoliveira, @mischnic, and @leerob — could you please review this pull request when you have time? Let me know if any changes are needed.

@leerob leerob merged commit 85f087d into vercel:canary Apr 28, 2025
39 of 42 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Related to Next.js' official documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Missing deprecation notice for legacyBehavior in Link component docs
4 participants