Link Preview
A rich Open Graph link card with thumbnail, favicon, domain, title and description, wrapped as a single anchor.
Preview
Controls
Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.
Installation
php artisan ui:add link-preview
Registry contract
Install confidence
php artisan ui:add link-preview
writes only the generated targets below. The CLI validates each file hash before writing and
prompts before replacing local changes unless --force is used.
- Version
- 1.0.0
- License
- open
- Stability
- stable
- Contract
- v2
- Foundation
- ≥ 1.0.0
| Type | Generated target |
|---|---|
| blade | resources/views/components/ui/link-preview.blade.php |
Registry dependencies
None.
Package dependencies
composer: jml/brok:^1.0
Guidance
Card and content widgetPresent a self-contained content object with local context.
Use when
- Use when self-contained content objects benefit from a recognizable card-like presentation with local actions or metadata. Do not use card widgets where a simpler list, table, or plain text block would make comparison faster.
Avoid when
- Avoid using link-preview as a default simply because it is available in the library. Choose it only when its interaction cost, visibility, and behavior match the job to be done.
- Task length
- short
- Interaction cost
- medium
- Interruptiveness
- none
- Input precision
- none
- Mobile / touch risk
- medium
- Accessibility risk
- medium
- Needs background context
- No
- Comparison needed
- Yes
Preferred alternatives
- List for compact scanning
- Table for exact comparison
Anti-patterns
- Using cards for dense cross-item comparison
API
manifest knowledge + registry-derived coverageProps
| Prop | Type / values | Default | Description |
|---|---|---|---|
| href | string | # | Declared by @props in the registry Blade source. |
| title | string | Designing a token-first UI system | Declared by @props in the registry Blade source. |
| description | string | How semantic design tokens keep light, dark and RTL themes in sync without touching a single component. | Declared by @props in the registry Blade source. |
| image | mixed|null | null | Declared by @props in the registry Blade source. |
| domain | string | heygaia.io | Declared by @props in the registry Blade source. |
| favicon | mixed|null | null | Declared by @props in the registry Blade source. |
Slots
Components use the default Blade slot unless a documented subcomponent is installed by the registry item.
Data slots
link-preview
Capabilities
Behavior
- Uses server-rendered Blade and semantic HTML.
- Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.
Usage
<div class="mx-auto w-full max-w-md space-y-3">
<x-ui.link-preview
href="https://ui.heygaia.io"
domain="heygaia.io"
title="Designing a token-first UI system"
description="How semantic design tokens keep light, dark and RTL themes in sync without touching a single component."
/>
<x-ui.link-preview
href="https://laravel.com/docs"
domain="laravel.com"
title="Laravel — The PHP framework for web artisans"
description="Documentation for the elegant, expressive framework that powers this registry."
/>
</div>
Accessibility & localization
data-slot
Keyboard focus-visible
Localized labels
- Accessibility target: wcag-2.2-aa-target.
- Uses semantic HTML and a stable
data-slotattribute for styling/scripting hooks. - Focus-visible rings use the
ringtoken so keyboard focus is always visible. - Disabled and invalid states are conveyed to assistive tech, not by color alone.
- Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces above.
- Labels go through
__()and the component uses logical properties (ms-*,text-start,start-*) so it mirrors correctly — flip the preview to RTL to confirm.
Source
The exact, editable file ui:add writes
into your app — copy it or own the whole thing. Previews
render this same code; there are no preview-only components.
Changelog
Current version: v1.0.0. See the site changelog for the full release history.