Text link
A typographic component for creating hyperlinks.
import { ... } from '@ag.ds-next/react/text-link';
Usage
Text link components can be imported via the text-link
entrypoint in the @ag.ds-next/react
package.
For example:
import { ... } from '@ag.ds-next/react/text-link';
Props
Prop | Type | Description |
---|---|---|
aria-label? | string | Describes the anchor element to assistive technologies. |
children? | ReactNode | |
download? | any | Causes the browser to treat the linked URL as a download. |
href? | string | The URL that the hyperlink points to. |
id? | string | The ID of the hyperlink. |
onClick? | MouseEventHandler<HTMLAnchorElement> | Function to be fired following a click event of the link. |
ref? | Ref<HTMLAnchorElement> | |
referrerPolicy? | HTMLAttributeReferrerPolicy | How much of the referrer to send when following the link. |
rel? | string | The relationship of the linked URL as space-separated link types. |
role? | AriaRole | WAI-ARIA role. |
target? | HTMLAttributeAnchorTarget | Where to display the linked URL, as the name for a browsing context (a tab, window, or <iframe>). |
Prop | Type | Description |
---|---|---|
aria-label? | string | Describes the anchor element to assistive technologies. |
children? | ReactNode | |
download? | any | Causes the browser to treat the linked URL as a download. |
href? | string | The URL that the hyperlink points to. |
id? | string | The ID of the hyperlink. |
onClick? | MouseEventHandler<HTMLAnchorElement> | Function to be fired following a click event of the link. |
referrerPolicy? | HTMLAttributeReferrerPolicy | How much of the referrer to send when following the link. |
rel? | string | The relationship of the linked URL as space-separated link types. |
role? | AriaRole | WAI-ARIA role. |
target? | HTMLAttributeAnchorTarget | Where to display the linked URL, as the name for a browsing context (a tab, window, or <iframe>). |
Source
You can view the full source code for this package on Github.