Box Link

BoxLink provides a component that renders a context rich link object with an icon, title and description.

Usage

Basic BoxLink usage

  import React, { useEffect } from 'react';
  import { BoxLink } from '~/ui/components/BoxLink'
  import { BoxIcon } from 'lucide-react';

  export default function App() {
    return (
      <div style={styles.container}>
        <p>Box Link Example</p>
        <BoxLink
          title="Sample Title for Box Link"
          description="Lorem Ipsum Dipsum description to add for Box Link"
          href="/components/BoxLink"
          Icon={BoxIcon}
        />
      </div>
    );
  }

Example

Sample Title for Box Link

Lorem Ipsum Dipsum description to add for Box Link

Props

Prop Name	Type	Default	Description
title	string	-	The title of the box link.
description	ReactNode	-	The description content of the box link.
testID	string	`undefined`	Optional test ID for testing purposes.
Icon	React.ReactNode	`undefined`	An optional icon component to be rendered alongside the box link.
imageUrl	string	`undefined`	An optional URL for an image to be displayed as part of the box link.
...	AnchorHTMLAttributes (Inherited from HTMLLinkElement)	-	Additional props inherited from HTMLLinkElement, such as href, target, rel, etc. (e.g., `href`, `target`, etc.)