Actions

ButtonLink

Link styled as a button

Preview

size
variant
children

Code

import css from "./ButtonLink.module.css";

type Size = "xs" | "sm" | "md" | "lg";

interface ResponsiveSize {
  base: Size;
  mobile?: Size;
  tablet?: Size;
  desktop?: Size;
  wide?: Size;
}

interface ButtonLinkProps {
  size: Size | ResponsiveSize;
  variant: "solid" | "soft" | "outline" | "ghost";
  href: string;
  target?: string;
  children: React.ReactNode;
}

function getSizeClasses(size: Size | ResponsiveSize): string {
  if (typeof size === "string") {
    return css[size];
  }

  const classes = [css[`${size.base}_base`]];

  if (size.mobile) classes.push(css[`${size.mobile}_mobile`]);
  if (size.tablet) classes.push(css[`${size.tablet}_tablet`]);
  if (size.desktop) classes.push(css[`${size.desktop}_desktop`]);
  if (size.wide) classes.push(css[`${size.wide}_wide`]);

  return classes.join(" ");
}

export default function ButtonLink({
  size,
  variant,
  href,
  target,
  children,
}: ButtonLinkProps) {
  return (
    <a
      className={`
        ${css.button}
        ${getSizeClasses(size)}
        ${css[variant]}
      `}
      href={href}
      target={target}
      rel={target === "_blank" ? "noopener noreferrer" : undefined}
    >
      <span className={css.button_content}>{children}</span>
    </a>
  );
}

Props

PropTypeRequiredDescription
size"xs" | "sm" | "md" | "lg" | ResponsiveSizerequiredLink size (height, padding and type). Fixed or responsive.
variant"solid" | "soft" | "outline" | "ghost"requiredHeaviest to lightest. solid is filled, soft has a soft accent background, outline is a border that fills on hover, and ghost has no border or background and tints on hover.
hrefstringrequiredLink destination.
targetstring—Where it opens. With "_blank" it adds rel="noopener noreferrer".
childrenReact.ReactNoderequiredLink content (text, or icon + text).