aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/molecules/forms/switch/switch.tsx
blob: c6c1c69b8e2c51bbf20d5af7c600fa4735ce93f0 (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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
import {
  type FC,
  type ChangeEventHandler,
  type ReactNode,
  type ReactElement,
  forwardRef,
  type ForwardRefRenderFunction,
} from 'react';
import {
  Fieldset,
  type FieldsetProps,
  type LabelProps,
  type RadioProps,
  Label,
  Radio,
} from '../../../atoms';
import type { TooltipProps } from '../../modals';
import styles from './switch.module.scss';

type SwitchItemProps = Omit<LabelProps, 'children' | 'htmlFor' | 'isRequired'> &
  Pick<RadioProps, 'isDisabled' | 'name'> & {
    /**
     * The item id.
     */
    id: string;
    /**
     * Is the item selected?
     */
    isSelected?: boolean;
    /**
     * The label used to describe the switch item.
     */
    label: ReactNode;
    /**
     * The event handler on value change.
     */
    onSwitch: ChangeEventHandler<HTMLInputElement>;
    /**
     * The item value.
     */
    value: string;
  };

/**
 * SwitchItem component.
 */
const SwitchItem: FC<SwitchItemProps> = ({
  className = '',
  id,
  isDisabled = false,
  isSelected = false,
  label,
  name,
  onSwitch,
  value,
  ...props
}) => {
  const itemClass = `${styles.item} ${className}`;

  return (
    <Label {...props} className={itemClass} htmlFor={id}>
      <Radio
        className={styles.radio}
        id={id}
        isChecked={isSelected}
        isDisabled={isDisabled}
        isHidden
        name={name}
        onChange={onSwitch}
        value={value}
      />
      <span className={styles.label}>{label}</span>
    </Label>
  );
};

export type SwitchOption = Pick<SwitchItemProps, 'id' | 'label' | 'value'>;

export type SwitchProps = Omit<FieldsetProps, 'children'> & {
  /**
   * The switch items.
   */
  items: [SwitchOption, SwitchOption];
  /**
   * The switch group name.
   */
  name: string;
  /**
   * A function to handle selection change.
   */
  onSwitch: ChangeEventHandler<HTMLInputElement>;
  /**
   * A tooltip to display before switch options.
   */
  tooltip?: ReactElement<TooltipProps>;
  /**
   * The selected item value.
   */
  value: SwitchOption['value'];
};

const SwitchWithRef: ForwardRefRenderFunction<
  HTMLFieldSetElement,
  SwitchProps
> = (
  {
    className = '',
    isDisabled = false,
    items,
    name,
    onSwitch,
    tooltip,
    value,
    ...props
  },
  ref
) => {
  const fieldsetClass = `${styles.fieldset} ${className}`;

  return (
    <Fieldset
      {...props}
      className={fieldsetClass}
      isDisabled={isDisabled}
      ref={ref}
      // eslint-disable-next-line react/jsx-no-literals -- Role allowed
      role="radiogroup"
    >
      {tooltip}
      <div className={styles.switch}>
        {items.map((item) => (
          <SwitchItem
            {...item}
            isDisabled={isDisabled}
            isSelected={value === item.value}
            key={item.id}
            name={name}
            onSwitch={onSwitch}
          />
        ))}
      </div>
    </Fieldset>
  );
};

/**
 * Switch component.
 */
export const Switch = forwardRef(SwitchWithRef);