Unverified Commit 76184ab0 authored by Jasper Moelker's avatar Jasper Moelker Committed by GitHub

docs: fix a11y router examples (#23031)

Non-interactive elements such as a `<span>` should not have event bindings as they are not accessible by everyone.
This fix solves this issue by replacing it with a `<button>` which is suitable for interaction.
Since a button defaults to `type="submit"` the button also explicitly has a `type="button"` to prevent accidental form submits (all examples aim to navigate, not to submit a form).

[More background on this a11y best practice](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/HEAD/docs/rules/no-static-element-interactions.md)
parent 3892453c
...@@ -87,7 +87,11 @@ import { useRouter } from 'next/router' ...@@ -87,7 +87,11 @@ import { useRouter } from 'next/router'
export default function Page() { export default function Page() {
const router = useRouter() const router = useRouter()
return <span onClick={() => router.push('/about')}>Click me</span> return (
<button type="button" onClick={() => router.push('/about')}>
Click me
</button>
)
} }
``` ```
...@@ -99,7 +103,11 @@ import { useRouter } from 'next/router' ...@@ -99,7 +103,11 @@ import { useRouter } from 'next/router'
export default function Page() { export default function Page() {
const router = useRouter() const router = useRouter()
return <button onClick={() => router.push('/post/abc')}>Click me</button> return (
<button type="button" onClick={() => router.push('/post/abc')}>
Click me
</button>
)
} }
``` ```
...@@ -138,6 +146,7 @@ export default function ReadMore({ post }) { ...@@ -138,6 +146,7 @@ export default function ReadMore({ post }) {
return ( return (
<button <button
type="button"
onClick={() => { onClick={() => {
router.push({ router.push({
pathname: '/post/[pid]', pathname: '/post/[pid]',
...@@ -171,7 +180,11 @@ import { useRouter } from 'next/router' ...@@ -171,7 +180,11 @@ import { useRouter } from 'next/router'
export default function Page() { export default function Page() {
const router = useRouter() const router = useRouter()
return <button onClick={() => router.replace('/home')}>Click me</button> return (
<button type="button" onClick={() => router.replace('/home')}>
Click me
</button>
)
} }
``` ```
...@@ -282,7 +295,11 @@ import { useRouter } from 'next/router' ...@@ -282,7 +295,11 @@ import { useRouter } from 'next/router'
export default function Page() { export default function Page() {
const router = useRouter() const router = useRouter()
return <button onClick={() => router.back()}>Click here to go back</button> return (
<button type="button" onClick={() => router.back()}>
Click here to go back
</button>
)
} }
``` ```
...@@ -298,7 +315,11 @@ import { useRouter } from 'next/router' ...@@ -298,7 +315,11 @@ import { useRouter } from 'next/router'
export default function Page() { export default function Page() {
const router = useRouter() const router = useRouter()
return <button onClick={() => router.reload()}>Click here to reload</button> return (
<button type="button" onClick={() => router.reload()}>
Click here to reload
</button>
)
} }
``` ```
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment