Link

Enable seamless navigation with hyperlinked text for a user-friendly website experience.

Installation

API Reference

Important Note

This is the documentation for gluestack-ui v2 (beta). For @gluestack-ui/themed (stable) documentation, refer to gluestack-ui v1.

This is an illustration of Link component.

<Link href="https://gluestack.io/">
  <LinkText>gluestack</LinkText>
</Link>

Installation

CLI

Manual

Run the following command:

npx gluestack-ui add link

Step 1: Install the following dependencies:

npm i @gluestack-ui/link

Step 2: Copy and paste the following code into your project.

"use client"
import { createLink } from "@gluestack-ui/link"
import { Pressable, Platform } from "react-native"
import { Text } from "react-native"

import { tva } from "@gluestack-ui/nativewind-utils/tva"
import { withStyleContext } from "@gluestack-ui/nativewind-utils/withStyleContext"
import { withStyleContextAndStates } from "@gluestack-ui/nativewind-utils/withStyleContextAndStates"
import { cssInterop } from "nativewind"
import { withStates } from "@gluestack-ui/nativewind-utils/withStates"
import type { VariantProps } from "@gluestack-ui/nativewind-utils"

import React from "react"
export const UILink = createLink({
  Root:
    Platform.OS === "web"
      ? withStyleContext(Pressable)
      : withStyleContextAndStates(Pressable),
  Text: Platform.OS === "web" ? Text : withStates(Text),
})

cssInterop(UILink, { className: "style" })
cssInterop(UILink.Text, { className: "style" })

const linkStyle = tva({
  base: "group/link web:outline-0 data-[disabled=true]:web:cursor-not-allowed data-[focus-visible=true]:web:ring-2 data-[focus-visible=true]:web:ring-indicator-primary data-[focus-visible=true]:web:outline-0 data-[disabled=true]:opacity-4 ",
})

const linkTextStyle = tva({
  base: "underline text-info-700 data-[hover=true]:text-info-600 data-[hover=true]:no-underline data-[active=true]:text-info-700 font-normal font-body web:font-sans web:tracking-sm web:my-0 web:bg-transparent web:border-0 web:box-border web:display-inline web:list-none web:margin-0 web:padding-0 web:position-relative web:text-start web:whitespace-pre-wrap web:word-wrap-break-word",

  variants: {
    isTruncated: {
      true: "web:truncate",
    },
    bold: {
      true: "font-bold",
    },
    underline: {
      true: "underline",
    },
    strikeThrough: {
      true: "line-through",
    },
    size: {
      "2xs": "text-2xs",
      xs: "text-xs",
      sm: "text-sm",
      md: "text-base",
      lg: "text-lg",
      xl: "text-xl",
      "2xl": "text-2xl",
      "3xl": "text-3xl",
      "4xl": "text-4xl",
      "5xl": "text-5xl",
      "6xl": "text-6xl",
    },
    sub: {
      true: "text-xs",
    },
    italic: {
      true: "italic",
    },
    highlight: {
      true: "bg-yellow-500",
    },
  },
})

type ILinkProps = React.ComponentProps<typeof UILink> &
  VariantProps<typeof linkStyle>
const Link = React.forwardRef(
  ({ className, ...props }: { className?: string } & ILinkProps, ref?: any) => {
    return (
      <UILink
        ref={ref}
        {...props}
        className={linkStyle({ class: className })}
      />
    )
  }
)

type ILinkTextProps = React.ComponentProps<typeof UILink.Text> &
  VariantProps<typeof linkTextStyle>
const LinkText = React.forwardRef(
  (
    {
      className,
      size = "md",
      ...props
    }: { className?: string } & ILinkTextProps,
    ref?: any
  ) => {
    return (
      <UILink.Text
        ref={ref}
        {...props}
        className={linkTextStyle({
          class: className,
          size,
        })}
      />
    )
  }
)

Link.displayName = "Link"
LinkText.displayName = "LinkText"

export { Link, LinkText }

Step 3: Update the import paths to match your project setup.

API Reference

To use this component in your project, include the following import statement in your file.

import { Link } from "@/components/ui/link"

export default () => (
  <Link>
    <LinkText />
  </Link>
)

Component Props

This section provides a comprehensive reference list for the component props, detailing descriptions, properties, types, and default behavior for easy project integration.

Link

Contains all link related layout style props and actions. It inherits all the properties of React Native's Pressable component.

Prop	Type	Default	Description
href	string	-	URL that should be opened on Link press.
onPress	(event?: GestureResponderEvent) => any	-	Callback that will be invoked on Link press.
isExternal	boolean	false	If true, link will be opened in new tab on web. It uses _target property to achieve this.
isHovered	boolean	false	When true, the link displays a hover state.
isFocusVisible	boolean	false	To manually set focus visible state to the link.

LinkText

Contains all text related layout style props and actions. It inherits all the properties of React Native's Text component.

Accessibility

We have outlined the various features that ensure the Link component is accessible to all users, including those with disabilities. These features help ensure that your application is inclusive and meets accessibility standards. Adheres to the WAI-ARIA design pattern.

Keyboard

Tab: Moves focus to the next focusable element.
Enter: Users should be able to open a link.

VoiceOver: When a link receives focus, screen readers should announce a descriptive link name.

Props

Link component is created using Pressable component from react-native. It extends all the props supported by React Native Pressable.

Link

Name	Value	Default
size	xs \| sm \| md \| lg \| xl \| 2xl \| 3xl \| 4xl \| 5xl \| 6xl	md

Important Note

Note: These props are exclusively applicable when utilizing the default configuration of gluestack-ui/config. If you are using a custom theme, these props may not be available.

Examples

The Examples section provides visual representations of the different variants of the component, allowing you to quickly and easily determine which one best fits your needs. Simply copy the code and integrate it into your project.

Default

<HStack>
  <Text size="lg">Design inspiration from </Text>
  <Link href="https://gluestack.io/" isExternal>
    <LinkText size="lg">pinterest.com</LinkText>
  </Link>
</HStack>

Link with icon

<HStack>
  <Text size="lg">Go to </Text>
  <Link href="https://gluestack.io/" isExternal>
    <HStack alignItems="center">
      <LinkText size="lg">Pinterest</LinkText>
      <Icon as={ArrowUpRightIcon} size="lg" className="mt-0.5 text-info-600" />
    </HStack>
  </Link>
</HStack>

Link

Installation

Run the following command:

Step 1: Install the following dependencies:

Step 2: Copy and paste the following code into your project.

Step 3: Update the import paths to match your project setup.

API Reference

Component Props

Link

LinkText

Accessibility

Keyboard

Screen Reader

Props

Link

Examples

Default

Link with icon