Skip to main content
196

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Web docs
Navigation

ButtonLink

Gives navigation the visual emphasis of a button while retaining anchor semantics.

FrameworksAstro · React · Elements

Registry commandlumen add ButtonLink

InteractionNative markup

01

See it and copy it

Framework example

Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.

AstroCode target · live preview uses Astro
View ButtonLink code

Framework usage

Switch targets to compare the adapter code. This live preview runs the Astro example. React and Elements use their own behavior APIs; complete the matching framework setup before copying an example.
astro
---
import { ButtonLink, Icon } from '@santi020k/lumen-astro'
---

<div style="display: flex; gap: 0.75rem; flex-wrap: wrap; align-items: center;">
  <ButtonLink href="https://example.com" showArrow newTab>
    Visit Example
  </ButtonLink>
  <ButtonLink href="https://example.com" variant="secondary" showArrow newTab>
    Secondary
  </ButtonLink>
  <ButtonLink ariaLabel="GitHub" href="https://example.com" shape="icon" variant="ghost" newTab>
    <Icon name="github" decorative />
  </ButtonLink>
  <ButtonLink ariaLabel="Website" href="https://example.com" shape="icon" variant="secondary" newTab>
    <Icon name="globe" decorative />
  </ButtonLink>
</div>
Edit ButtonLink in browser

Framework differences

React: Use standard target, rel, and aria-label attributes. Compose Icon as a child for an arrow; showArrow and newTab belong to the Astro adapter.

02

Choose your target

Add this component

Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.

API reference

Lumen-specific props and runtime attributes for the Astro primitive. Use the framework differences above and the copyable examples for React composition and Elements attributes; the public adapter types define their supported contracts.

AttributeValuesDefaultDescription
hrefstring-Sets the link destination.
variant"primary" | "secondary" | "ghost" | "inline" | "unstyled""primary"Controls the link emphasis or removes presentation for migration use.
shape"default" | "icon""default"Renders a round icon-only link when set to "icon".
showArrowbooleanfalseAppends a directional arrow icon.
newTabbooleanfalseOpens the link in a new tab with safe rel attributes.
class, classNamestring""Merges custom classes with the generated ui-* root classes.
...native attributesHTML attributes-Forwards standard attributes to the root element unless the component consumes them.

Web docsFull catalog