aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/molecules/forms/labelled-field/labelled-field.tsx
blob: ea0bd67097d59c9d108d0732505e6115e31a924c (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 {
  forwardRef,
  type HTMLAttributes,
  type ReactElement,
  type ForwardRefRenderFunction,
} from 'react';
import type {
  CheckboxProps,
  InputProps,
  LabelProps,
  RadioProps,
  SelectProps,
  TextAreaProps,
} from '../../../atoms';
import styles from './labelled-field.module.scss';

export type LabelledFieldProps = Omit<
  HTMLAttributes<HTMLDivElement>,
  'children'
> & {
  /**
   * The field.
   */
  field: ReactElement<
    CheckboxProps | InputProps | RadioProps | SelectProps | TextAreaProps
  >;
  /**
   * Should the label and the field be inlined?
   *
   * @default false
   */
  isInline?: boolean;
  /**
   * If true, the label is displayed after the field.
   *
   * @default false
   */
  isReversedOrder?: boolean;
  /**
   * The field label.
   */
  label: ReactElement<LabelProps>;
};

const LabelledFieldWithRef: ForwardRefRenderFunction<
  HTMLDivElement,
  LabelledFieldProps
> = (
  {
    className = '',
    field,
    isInline = false,
    isReversedOrder = false,
    label,
    ...props
  },
  ref
) => {
  const layoutClass = isInline ? 'wrapper--inline' : 'wrapper--stack';
  const orderClass = isReversedOrder ? 'wrapper--reverse' : '';
  const wrapperClass = `${styles.wrapper} ${styles[layoutClass]} ${styles[orderClass]} ${className}`;

  return (
    <div {...props} className={wrapperClass} ref={ref}>
      {label}
      {field}
    </div>
  );
};

/**
 * LabelledField component
 *
 * Render a field tied to a label.
 */
export const LabelledField = forwardRef(LabelledFieldWithRef);