aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/atoms/forms/form.tsx
blob: 8e80930e312ee9c33a66546f6efb54869f5ff3bd (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
import { Children, FC, FormEvent, Fragment } from 'react';
import styles from './forms.module.scss';

export type FormProps = {
  /**
   * An accessible name.
   */
  'aria-label'?: string;
  /**
   * One or more ids that refers to the form name.
   */
  'aria-labelledby'?: string;
  /**
   * Set additional classnames to the form wrapper.
   */
  className?: string;
  /**
   * Wrap each items with a div. Default: true.
   */
  grouped?: boolean;
  /**
   * A callback function to execute on submit.
   */
  onSubmit: () => void;
};

/**
 * Form component.
 *
 * Render children wrapped in a form element.
 */
const Form: FC<FormProps> = ({
  children,
  className = '',
  grouped = true,
  onSubmit,
  ...props
}) => {
  const arrayChildren = Children.toArray(children);

  /**
   * Get the form items.
   * @returns {JSX.Element[]} An array of child elements wrapped in a div.
   */
  const getFormItems = (): JSX.Element[] => {
    return arrayChildren.map((child, index) =>
      grouped ? (
        <div key={`item-${index}`} className={styles.item}>
          {child}
        </div>
      ) : (
        <Fragment key={`item-${index}`}>{child}</Fragment>
      )
    );
  };

  /**
   * Handle form submit.
   * @param {FormEvent} e - The form event.
   */
  const handleSubmit = (e: FormEvent) => {
    e.preventDefault();
    onSubmit();
  };

  return (
    <form onSubmit={handleSubmit} className={className} {...props}>
      {getFormItems()}
    </form>
  );
};

export default Form;