aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/atoms/buttons/button/button.tsx
blob: 8489b313e3b1c71374215ffa34c3f03aaf3d2800 (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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
import {
  type ButtonHTMLAttributes,
  forwardRef,
  type ForwardRefRenderFunction,
  type ReactNode,
} from 'react';
import styles from './button.module.scss';

export type ButtonProps = Omit<
  ButtonHTMLAttributes<HTMLButtonElement>,
  'aria-busy' | 'aria-disabled' | 'aria-pressed' | 'aria-selected' | 'disabled'
> & {
  /**
   * The button body.
   */
  children: ReactNode;
  /**
   * Should the button be disabled?
   *
   * @default undefined
   */
  isDisabled?: boolean;
  /**
   * Is the button already executing some action?
   *
   * @default undefined
   */
  isLoading?: boolean;
  /**
   * Is the button a toggle and is it currently pressed?
   *
   * @default undefined
   */
  isPressed?: boolean;
  /**
   * Button kind.
   *
   * @default 'secondary'
   */
  kind?: 'primary' | 'secondary' | 'tertiary' | 'neutral';
  /**
   * Button shape.
   *
   * @default 'rectangle'
   */
  shape?: 'circle' | 'rectangle' | 'square' | 'initial';
  /**
   * Button type attribute.
   *
   * @default 'button'
   */
  type?: 'button' | 'reset' | 'submit';
};

const ButtonWithRef: ForwardRefRenderFunction<
  HTMLButtonElement,
  ButtonProps
> = (
  {
    className = '',
    children,
    isPressed,
    isDisabled,
    isLoading,
    kind = 'secondary',
    shape = 'rectangle',
    type = 'button',
    ...props
  },
  ref
) => {
  const kindClass = styles[`btn--${kind}`];
  const shapeClass = styles[`btn--${shape}`];
  const btnClass = `${styles.btn} ${kindClass} ${shapeClass} ${className}`;

  return (
    <button
      {...props}
      aria-busy={isLoading}
      aria-disabled={isDisabled}
      aria-pressed={isPressed}
      className={btnClass}
      disabled={isDisabled ?? isLoading}
      ref={ref}
      // eslint-disable-next-line react/button-has-type -- Default value is set.
      type={type}
    >
      {children}
    </button>
  );
};

/**
 * Button component
 *
 * Use a button as call to action.
 */
export const Button = forwardRef(ButtonWithRef);