# Link

An inline link with an underline that follows the text colour; renders any element through the render prop.

Source page: https://sproutboat.com/ikada/components/link

## Installation
```sh
npx shadcn@latest add https://sproutboat.com/ikada/r/link.json
```
Or from the package: `import { Link } from "@sproutboat/ikada";`
## Usage
```tsx
import { Link } from "@/components/ikada/link";

<Link href="/docs">
  Read the docs
</Link>
```
## Examples
### Inline

```tsx
<p>
  Read the <Link href="/docs/deploys">deploy guide</Link> before moving robin to eu-west.
</p>
```
### External
Opens in a new tab with a safe rel, shows an arrow, and tells screen readers.
```tsx
<Link href="https://robin.sproutboat.app" external>
  robin.sproutboat.app
</Link>
```
### Disabled

```tsx
<Link href="/docs/deploys" aria-disabled="true">
  Deploy guide
</Link>
```
## Props
### LinkProps
Also takes every prop of `useRender.ComponentProps<"a">`.
| Prop | Type | Description |
| --- | --- | --- |
| external? | `boolean` | Opens in a new tab with a safe rel, shows an arrow and announces it. Default `false`. |
| render? | `ReactElement<unknown, string \| JSXElementConstructor<any>> \| ComponentRenderFn<HTMLProps, {}>` | Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render. |
Source: https://github.com/baronunread/ikada/blob/main/src/components/link.tsx