61f56f997c
Some checks failed
Test examples / Test Examples (20) (push) Has been cancelled
Test examples / Test Examples (22) (push) Has been cancelled
Lock Threads / action (push) Has been cancelled
Trigger Release / start (push) Has been cancelled
Stale issue handler / stale (push) Has been cancelled
Update Font Data / create-pull-request (push) Has been cancelled
build-and-deploy / deploy-target (push) Has been cancelled
build-and-deploy / build (push) Has been cancelled
build-and-deploy / stable - aarch64-unknown-linux-musl - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-unknown-linux-musl - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-unknown-linux-gnu - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-unknown-linux-gnu - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-pc-windows-msvc - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-pc-windows-msvc - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-apple-darwin - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-apple-darwin - node@16 (push) Has been cancelled
build-and-deploy / build-wasm (nodejs) (push) Has been cancelled
build-and-deploy / build-wasm (web) (push) Has been cancelled
build-and-deploy / Deploy preview tarball (push) Has been cancelled
build-and-deploy / Potentially publish release (push) Has been cancelled
build-and-deploy / publish-turbopack-npm-packages (push) Has been cancelled
build-and-deploy / Deploy examples (push) Has been cancelled
build-and-deploy / thank you, build (push) Has been cancelled
build-and-deploy / Upload Turbopack Bytesize metrics to Datadog (push) Has been cancelled
Rspack Next.js development integration tests / Rspack integration tests (push) Has been cancelled
Rspack Next.js production integration tests / Rspack integration tests (push) Has been cancelled
Turbopack Next.js development integration tests / Next.js integration tests (push) Has been cancelled
Turbopack Next.js production integration tests / Next.js integration tests (push) Has been cancelled
Update Rspack test manifest / Update and upload Rspack development test manifest (push) Has been cancelled
Update Rspack test manifest / Update and upload Rspack production test manifest (push) Has been cancelled
Upload bundler test manifests to areweturboyet.com / Upload test results (push) Has been cancelled
Update React / create-pull-request (push) Has been cancelled
test-e2e-project-reset-cron / reset-test-project (push) Has been cancelled
Notify about the top 15 issues/PRs/feature requests (most reacted) in the last 90 days / run (push) Has been cancelled
66 lines
1.6 KiB
Plaintext
66 lines
1.6 KiB
Plaintext
---
|
|
title: No HTML link for pages
|
|
---
|
|
|
|
> Prevent usage of `<a>` elements to navigate to internal Next.js pages.
|
|
|
|
## Why This Error Occurred
|
|
|
|
An `<a>` element was used to navigate to a page route without using the `next/link` component, causing unnecessary full-page refreshes.
|
|
|
|
The `Link` component is required to enable client-side route transitions between pages and provide a single-page app experience.
|
|
|
|
## Possible Ways to Fix It
|
|
|
|
Make sure to import the `Link` component and wrap anchor elements that route to different page routes.
|
|
|
|
**Before:**
|
|
|
|
```jsx filename="pages/index.js"
|
|
function Home() {
|
|
return (
|
|
<div>
|
|
<a href="/about">About Us</a>
|
|
</div>
|
|
)
|
|
}
|
|
```
|
|
|
|
**After:**
|
|
|
|
```jsx filename="pages/index.js"
|
|
import Link from 'next/link'
|
|
|
|
function Home() {
|
|
return (
|
|
<div>
|
|
<Link href="/about">About Us</Link>
|
|
</div>
|
|
)
|
|
}
|
|
|
|
export default Home
|
|
```
|
|
|
|
### Options
|
|
|
|
#### `pagesDir`
|
|
|
|
This rule can normally locate your `pages` directory automatically.
|
|
|
|
If you're working in a monorepo, we recommend configuring the [`rootDir`](/docs/pages/api-reference/config/eslint#specifying-a-root-directory-within-a-monorepo) setting in `eslint-plugin-next`, which `pagesDir` will use to locate your `pages` directory.
|
|
|
|
In some cases, you may also need to configure this rule directly by providing a `pages` directory. This can be a path or an array of paths.
|
|
|
|
```json filename="eslint.config.json"
|
|
{
|
|
"rules": {
|
|
"@next/next/no-html-link-for-pages": ["error", "packages/my-app/pages/"]
|
|
}
|
|
}
|
|
```
|
|
|
|
## Useful Links
|
|
|
|
- [next/link API Reference](/docs/pages/api-reference/components/link)
|