Link
A link takes people to a new location in the app or another website.Installation
| Install | yarn add @atlaskit/link |
|---|---|
| Source | Bitbucket.org, (opens new window) |
| npm | @atlaskit/link, (opens new window) |
| Bundle | unpkg.com, (opens new window) |
Props
| Description | Additional information to be included in the |
|---|---|
| Type | { [x: string]: any; } |
| Description | The appearance of the link. Defaults to |
|---|---|
| Type | "default" | "subtle" | "inverse" |
| Description | No description. |
|---|---|
| Type | string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal |
| Description | Standard links can be provided as a string, which should be mapped to the underlying router link component. Alternatively, you can provide an object for advanced link configurations by supplying the expected object type to the generic. @example |
|---|---|
| Type | string | RouterLinkConfig |
| Description | An optional name used to identify events for React UFO (Unified Frontend Observability) press interactions. For more information, see React UFO integration into Design System components. |
|---|---|
| Type | string |
| Description | Override the default text to signify that a link opens in a new window.
This is appended to the |
|---|---|
| Type | string |
| Description | Handler called on click. The second argument provides an Atlaskit UI analytics event that can be fired to a listening channel. See the 'analytics-next' package documentation for more information. |
|---|---|
| Type | (e: React.MouseEvent<HTMLAnchorElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent) => void |
| Description | No description. |
|---|---|
| Type | ((instance: HTMLAnchorElement) => void) | React.RefObject<HTMLAnchorElement> |
| Description | A unique string that appears as data attribute |
|---|---|
| Type | string |