aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/atoms/buttons/button-link/button-link.tsx
blob: f8bbadce7990b6260f67557f9acbd906718895f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
import Link from 'next/link';
import type { AnchorHTMLAttributes, FC, ReactNode } from 'react';
import styles from './button-link.module.scss';

export type ButtonLinkProps = Omit<
  AnchorHTMLAttributes<HTMLAnchorElement>,
  'href'
> & {
  /**
   * The button link body.
   */
  children: ReactNode;
  /**
   * True if it is an external link.
   *
   * @default false
   */
  isExternal?: boolean;
  /**
   * Define the button kind.
   *
   * @default 'secondary'
   */
  kind?: 'primary' | 'secondary' | 'tertiary';
  /**
   * Define the button shape.
   *
   * @default 'rectangle'
   */
  shape?: 'circle' | 'rectangle' | 'square';
  /**
   * Define an URL or anchor as target.
   */
  to: string;
};

/**
 * ButtonLink component
 *
 * Use a button-like link as call to action.
 */
export const ButtonLink: FC<ButtonLinkProps> = ({
  children,
  className = '',
  kind = 'secondary',
  shape = 'rectangle',
  isExternal = false,
  rel = '',
  to,
  ...props
}) => {
  const kindClass = styles[`btn--${kind}`];
  const shapeClass = styles[`btn--${shape}`];
  const btnClass = `${styles.btn} ${kindClass} ${shapeClass} ${className}`;
  const linkRel =
    isExternal && !rel.includes('external') ? `external ${rel}` : rel;

  return isExternal ? (
    <a {...props} className={btnClass} href={to} rel={linkRel}>
      {children}
    </a>
  ) : (
    <Link {...props} className={btnClass} href={to} rel={rel}>
      {children}
    </Link>
  );
};