@bradgarropy/next-link
TypeScript icon, indicating that this package has built-in type declarations

1.1.0Β β€’Β PublicΒ β€’Β Published

πŸ”— next link

version downloads size github actions coverage typescript contributing contributors discord

πŸ”— link component for next

Next provides a <Link> component for routing between internal pages. For external links, you have to use a regular <a> tag. This next-link package solves that issue by providing a <Link> component that handles both internal and external urls.

next link

πŸ“¦ Installation

This package is hosted on npm.

npm install @bradgarropy/next-link

πŸ₯‘ Usage

For both internal and external links, use the Link component and pass it a to prop.

import Link from "@bradgarropy/next-link"

const App = () => {
    return <Link to="https://bradgarropy.com">website</Link>
}

πŸ“– API Reference

<Link>

Name Required Default Example Description
to true "/home"
"https://bradgarropy.com"
Internal or external url.

The component also passes through all other props, like className or passHref. See the next/link documentation for other relevant props. The examples below cover some common uses.

// internal link
<Link to="/home">home</Link>

// internal link with additional props
<Link to="/home" className="nav-link">home</Link>

// external link
<Link to="https://bradgarropy.com">website</Link>

// external link with additional props
<Link to="https://bradgarropy.com" className="nav-link">website</Link>

❔ Questions

πŸ› report bugs by filing issues
πŸ“’ provide feedback with issues or on twitter
πŸ™‹πŸΌβ€β™‚οΈ use my ama or twitter to ask any other questions

✨ contributors


Brad Garropy

πŸ’» πŸ“– ⚠️ πŸš‡

Package Sidebar

Install

npm i @bradgarropy/next-link

Weekly Downloads

70

Version

1.1.0

License

MIT

Unpacked Size

10.6 kB

Total Files

9

Last publish

Collaborators

  • bradgarropy