Skip to content

link

Jump to bottom
Jacob Martella edited this page Feb 1, 2026 · 3 revisions

title: Link Component

Link Component

The Link component is used to display hyperlinks with customizable styling options. It provides a consistent way to style links throughout your application with support for icons, tooltips, and external link behavior.

Basic Usage

<x-artisanpack-link href="https://github.com/%3Cspan%20class="pl-c">//example.com">
    Visit Example Website
</x-artisanpack-link>

Examples

Default Link

<x-artisanpack-link href="https://github.com/%3Cspan%20class="pl-c">//example.com">
    This is a standard link with default styling
</x-artisanpack-link>

External Links

<x-artisanpack-link href="https://github.com/%3Cspan%20class="pl-c">//example.com" external>
    External Link (opens in new tab)
</x-artisanpack-link>

Links with Icons

<x-artisanpack-link href="https://github.com/%3Cspan%20class="pl-c">//example.com" icon="heroicon-o-arrow-right">
    Link with Icon Before Text
</x-artisanpack-link>

<x-artisanpack-link href="https://github.com/%3Cspan%20class="pl-c">//example.com" iconRight="heroicon-o-arrow-right">
    Link with Icon After Text
</x-artisanpack-link>

Underline Options

<x-artisanpack-link href="https://github.com/%3Cspan%20class="pl-c">#" hoverUnderline>
    Underline on Hover (Default)
</x-artisanpack-link>

<x-artisanpack-link href="https://github.com/%3Cspan%20class="pl-c">#" underline>
    Always Underlined
</x-artisanpack-link>

<x-artisanpack-link href="https://github.com/%3Cspan%20class="pl-c">#" :hoverUnderline="false">
    Never Underlined
</x-artisanpack-link>

Custom Colors

<x-artisanpack-link href="https://github.com/%3Cspan%20class="pl-c">#">Default Primary Color Link</x-artisanpack-link>
<x-artisanpack-link href="https://github.com/%3Cspan%20class="pl-c">#" color="text-secondary hover:text-secondary-focus">Secondary Color Link</x-artisanpack-link>
<x-artisanpack-link href="https://github.com/%3Cspan%20class="pl-c">#" color="text-accent hover:text-accent-focus">Accent Color Link</x-artisanpack-link>

With Tooltips

<x-artisanpack-link href="https://github.com/%3Cspan%20class="pl-c">#" tooltip="Click to learn more">
    Link with Tooltip
</x-artisanpack-link>

<x-artisanpack-link href="https://github.com/%3Cspan%20class="pl-c">#" tooltipBottom="Click to learn more">
    Link with Bottom Tooltip
</x-artisanpack-link>

Livewire Navigation

<x-artisanpack-link href="https://github.com/dashboard">
    Navigate with wire:navigate (Default)
</x-artisanpack-link>

<x-artisanpack-link href="https://github.com/dashboard" noWireNavigate>
    Navigate without wire:navigate
</x-artisanpack-link>

With ID

<x-artisanpack-link href="https://github.com/%3Cspan%20class="pl-c">#section-1" id="section-1-link">
    Jump to Section 1
</x-artisanpack-link>

Props

Prop Type Default Description
id string null Optional ID for the link
href string null The URL the link points to
color string null Text color class (defaults to text-primary hover:text-primary-focus)
underline boolean false Whether to show underline
hoverUnderline boolean true Whether to show underline only on hover
external boolean false Whether the link should open in a new tab
noWireNavigate boolean false Disable wire:navigate for links
icon string null Optional icon to display before the text
iconRight string null Optional icon to display after the text
tooltip string null Optional tooltip text
tooltipLeft string null Optional tooltip text (left position)
tooltipRight string null Optional tooltip text (right position)
tooltipBottom string null Optional tooltip text (bottom position)

Slots

Slot Description
default The link text content

Styling

The Link component uses Tailwind CSS classes for styling. By default, it renders as an anchor element with:

  • Text color: text-primary hover:text-primary-focus
  • Underline: no-underline hover:underline (when hoverUnderline is true)
  • Display: inline-flex items-center gap-1 (for proper icon alignment)

You can customize the appearance by:

  1. Using the provided props (color, underline, hoverUnderline, etc.)
  2. Adding custom classes via the class attribute

Custom Styling Example

<x-artisanpack-link href="https://github.com/%3Cspan%20class="pl-c">#" class="font-bold italic text-emerald-600 hover:text-emerald-800">
    Custom styled link
</x-artisanpack-link>

Accessibility

The Link component follows accessibility best practices:

  • Uses the semantic anchor element
  • Adds appropriate attributes for external links (target="_blank" and rel="noopener noreferrer")
  • Supports tooltips for additional context
  • Maintains focus states for keyboard navigation

Related Components

Clone this wiki locally