aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/atoms/buttons/button-link.tsx
blob: 7182d94e2e70ebe732556b11c2fd53d22d83280f (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
68
69
70
71
72
73
74
75
76
import Link from 'next/link';
import { FC, ReactNode } from 'react';
import styles from './buttons.module.scss';

export type ButtonLinkProps = {
  /**
   * ButtonLink accessible label.
   */
  'aria-label'?: string;
  /**
   * One or more ids that refer to the accessible label.
   */
  'aria-labelledby'?: string;
  /**
   * The button link body.
   */
  children: ReactNode;
  /**
   * Set additional classnames to the button link.
   */
  className?: string;
  /**
   * True if it is an external link. Default: false.
   */
  external?: boolean;
  /**
   * ButtonLink kind. Default: secondary.
   */
  kind?: 'primary' | 'secondary' | 'tertiary';
  /**
   * ButtonLink shape. Default: rectangle.
   */
  shape?: 'circle' | 'rectangle' | 'square';
  /**
   * Define an URL as target.
   */
  target: string;
};

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

  return external ? (
    <a
      href={target}
      className={`${styles.btn} ${kindClass} ${shapeClass} ${className}`}
      {...props}
    >
      {children}
    </a>
  ) : (
    <Link
      {...props}
      className={`${styles.btn} ${kindClass} ${shapeClass} ${className}`}
      href={target}
    >
      {children}
    </Link>
  );
};

export default ButtonLink;