@digigov/form 2.0.0-6452adf3 → 2.0.0-66d7c5e2

package/src/inputs/Input/index.tsx

@@ -1,6 +1,6 @@
 import React from 'react';
 import { useWatch } from 'react-hook-form';
-import { UncontrolledFieldProps } from '@digigov/form/Field/types';
+import type { UncontrolledFieldProps } from '@digigov/form/Field/types';
 import { TextArea } from '@digigov/ui/form/TextArea';
 import { TextInput } from '@digigov/ui/form/TextInput';
 import { useTranslation } from '@digigov/ui/i18n';
@@ -8,12 +8,14 @@ import { Hint } from '@digigov/ui/typography/Hint';
 
 const TYPES_MAP = {
   string: 'text',
+  password: 'password',
   int: 'text',
   text: 'text',
   date: 'date',
 };
 
-export interface InputProps extends Omit<UncontrolledFieldProps, 'extra'> {
+export interface InputProps
+  extends Omit<UncontrolledFieldProps, 'extra' | 'Field'> {
   extra?: {
     fullWidth?: boolean;
     multiline?: boolean;
@@ -25,82 +27,91 @@ export interface InputProps extends Omit<UncontrolledFieldProps, 'extra'> {
       max?: number;
     };
   };
+  Field?: UncontrolledFieldProps['Field'];
 }
 
-export const Input: React.ExoticComponent<InputProps> = React.forwardRef(
-  function WrappedInput({ name, control, type, extra, Field, ...props }, ref: never) {
-    // eslint-disable-next-line prefer-const
-    let { multiline = false, rows, limit } = extra || {};
-    const { className } = extra || {};
-    // if enforced to multiline use true. Derive from type otherwise.
-    multiline = multiline === true || type === 'text';
-    // use explicit rows value if set. Derive from multiline otherwise.
-    rows = rows || (multiline ? 4 : 1);
-    // translate dilosi type to HTML Input type
-    const fieldType = TYPES_MAP[type || 'text'] || 'text';
-    const { t } = useTranslation();
-    const currentValue: string | '' = useWatch({ control, name });
+export const Input = React.forwardRef<
+  HTMLInputElement | HTMLTextAreaElement,
+  InputProps
+>(function WrappedInput({ name, control, type, extra, ...props }, ref) {
+  delete props['Field'];
+  // eslint-disable-next-line prefer-const
+  let { multiline = false, rows, limit } = extra || {};
+  const { className } = extra || {};
+  // if enforced to multiline use true. Derive from type otherwise.
+  multiline = multiline === true || type === 'text';
+  // use explicit rows value if set. Derive from multiline otherwise.
+  rows = rows || (multiline ? 4 : 1);
+  // translate dilosi type to HTML Input type
+  const fieldType = TYPES_MAP[type || 'text'] || 'text';
+  const { t } = useTranslation();
+  const currentValue: string | '' = useWatch({ control, name });
 
-    const getRemainingChars = (currentValue, limit) => {
-      if (currentValue) {
-        return limit?.max - currentValue.length;
-      }
-      return limit?.max;
-    };
+  const getRemainingChars = (currentValue, limit) => {
+    if (currentValue) {
+      return limit?.max - currentValue.length;
+    }
+    return limit?.max;
+  };
 
-    const constructRemainingText = (currentValue, limit) => {
-      const remainingChars = getRemainingChars(currentValue, limit);
-      let remainingText =
-        Math.abs(remainingChars) === 1
-          ? t('form.info.text.character')
-          : t('form.info.text.characters');
-      remainingText +=
-        remainingChars > 0
-          ? ` ${t('form.info.text.remaining')}.`
-          : ` ${t('form.info.text.too_many')}.`;
-      return remainingText;
-    };
+  const constructRemainingText = (currentValue, limit) => {
+    const remainingChars = getRemainingChars(currentValue, limit);
+    let remainingText =
+      Math.abs(remainingChars) === 1
+        ? t('form.info.text.character')
+        : t('form.info.text.characters');
+    remainingText +=
+      remainingChars > 0
+        ? ` ${t('form.info.text.remaining')}.`
+        : ` ${t('form.info.text.too_many')}.`;
+    return remainingText;
+  };
 
-    if (multiline === true) {
-      return (
-        <>
-          <TextArea
-            name={name}
-            className={className}
-            rows={rows}
-            ref={ref}
-            {...{
-              ...props,
-              reset: undefined,
-              required: undefined,
-              type: fieldType,
-            }}
-          />
-          {limit?.max && (
-            <Hint display={'flex'}>
-              {t('form.info.text.you_have')}
-              <Hint fontWeight="bold">
-                &nbsp;{`${Math.abs(getRemainingChars(currentValue, limit))}`}
-                &nbsp;
-              </Hint>
-              {constructRemainingText(currentValue, limit)}
-            </Hint>
-          )}
-        </>
-      );
-    } else {
-      return (
-        <TextInput
+  if (multiline === true) {
+    return (
+      <>
+        <TextArea
           name={name}
-          type={fieldType}
-          data-type={type}
           className={className}
-          ref={ref}
-          {...{ ...props, reset: undefined, required: undefined }}
+          rows={rows}
+          ref={ref as React.RefObject<HTMLTextAreaElement>}
+          id={name}
+          {...{
+            ...props,
+            reset: undefined,
+            required: undefined,
+            type: fieldType,
+          }}
         />
-      );
-    }
+        {limit?.max && (
+          <Hint display={'flex'}>
+            {t('form.info.text.you_have')}
+            <Hint fontWeight="bold">
+              &nbsp;{`${Math.abs(getRemainingChars(currentValue, limit))}`}
+              &nbsp;
+            </Hint>
+            {constructRemainingText(currentValue, limit)}
+          </Hint>
+        )}
+      </>
+    );
+  } else {
+    return (
+      <TextInput
+        name={name}
+        id={name}
+        type={fieldType}
+        data-type={type}
+        className={className}
+        ref={ref as React.RefObject<HTMLInputElement>}
+        {...{
+          ...props,
+          reset: undefined,
+          required: undefined,
+        }}
+      />
+    );
   }
-);
+});
 
 export default Input;

package/src/inputs/Label/Label.stories.js

@@ -1,7 +1,10 @@
 import Label from '@digigov/form/inputs/Label';
+import doc from './doc.mdx?raw';
 export default {
   title: 'Digigov Form/inputs/Label',
   component: Label,
+  tags: ['autodocs'],
+  markdown: doc,
   displayName: 'Label',
 };
 export { Default } from '@digigov/form/inputs/Label/__stories__/Default';

package/src/inputs/Label/__stories__/Default.tsx

@@ -4,7 +4,7 @@ import Field from '@digigov/form/Field';
 import Label from '@digigov/form/inputs/Label';
 import { Button } from '@digigov/ui/form/Button';
 
-export const Default = () => (
+export const Default = (_: any) => (
   <FormBuilder
     onSubmit={(data) => {
       console.log(data);

package/src/inputs/Label/index.test.tsx

@@ -14,6 +14,10 @@ test('renders the All Label variants', async ({ mount, page }) => {
   )
   await page.evaluate(() => document.fonts.ready);
 
+  // Move the mouse to the top-left corner to avoid random hover issues
+  await page.mouse.move(0, 0);
+
+
   const screenshot = await page.screenshot({ fullPage: true, animations: 'disabled' });
   expect(screenshot).toMatchSnapshot();
 });

package/src/inputs/Label/index.tsx

@@ -1,5 +1,5 @@
 import React from 'react';
-import { FieldLabelProps } from '@digigov/form/types';
+import type { FieldLabelProps } from '@digigov/form/types';
 import { LabelTitle } from '@digigov/ui/form/LabelContainer';
 import { useTranslation } from '@digigov/ui/i18n';
 import { Hint } from '@digigov/ui/typography/Hint';
@@ -16,9 +16,6 @@ export interface FieldOptionProps {
 export interface LabelProps {
   primary?: string;
   secondary?: string;
-}
-
-export interface LabelProps {
   className?: string;
   value?: string;
   label?: FieldLabelProps;

package/src/inputs/OtpInput/OtpInput.stories.js

@@ -1,7 +1,10 @@
 import OtpInput from '@digigov/form/inputs/OtpInput';
+import doc from './doc.mdx?raw';
 export default {
   title: 'Digigov Form/inputs/OtpInput',
   component: OtpInput,
+  tags: ['autodocs'],
+  markdown: doc,
   displayName: 'OtpInput',
 };
 export { Default } from '@digigov/form/inputs/OtpInput/__stories__/Default';

package/src/inputs/OtpInput/__stories__/Default.tsx

@@ -14,7 +14,7 @@ const FIELDS: FieldSpec[] = [
   },
 ];
 
-export const Default = () => (
+export const Default = (_: any) => (
   <FormBuilder
     fields={FIELDS}
     onSubmit={(data) => {

package/src/inputs/OtpInput/index.test.tsx

@@ -14,6 +14,10 @@ test('renders the All OtpInput variants', async ({ mount, page }) => {
   )
   await page.evaluate(() => document.fonts.ready);
 
+  // Move the mouse to the top-left corner to avoid random hover issues
+  await page.mouse.move(0, 0);
+
+
   const screenshot = await page.screenshot({ fullPage: true, animations: 'disabled' });
   expect(screenshot).toMatchSnapshot();
 });

package/src/inputs/OtpInput/index.tsx

@@ -40,7 +40,8 @@ export function useOtp(onChange, maxLength) {
   }, []);
 
   const focusToPrevInput = useCallback((target: HTMLElement) => {
-    const previousElement = target.previousElementSibling as HTMLInputElement | null;
+    const previousElement =
+      target.previousElementSibling as HTMLInputElement | null;
     if (previousElement) {
       previousElement.focus();
     }
@@ -119,39 +120,49 @@ export function useOtp(onChange, maxLength) {
   };
 }
 
-const SingleCharacterInputPart = ({ ...props }) => {
-  return <SingleCharacterInput {...props} />;
-};
+const SingleCharacterInputPart = React.forwardRef<
+  HTMLInputElement,
+  Record<string, any>
+>(({ ...props }, ref) => {
+  return <SingleCharacterInput {...props} ref={ref} />;
+});
+SingleCharacterInputPart.displayName = 'SingleCharacterInputPart';
 
-export const OtpInput = ({ name, maxLength = 6, ...props }) => {
-  const otp = useOtp(props.onChange, maxLength);
-  return (
-    <SingleCharacterInputs>
-      {otp.otpValues.map((digit, idx) => (
-        <SingleCharacterInputPart
-          name={`${name}-${idx}`}
-          type="text"
-          key={idx}
-          autoComplete="one-time-code"
-          pattern="\d{1}"
-          maxLength={maxLength}
-          value={digit}
-          disabled={props.disabled}
-          aria-required={props['aria-required']}
-          onChange={(e) => otp.handleOtpChange(e, idx)}
-          onInput={(e) => {
-            if (e.target.value === digit) {
-              otp.handleOtpChange(e, idx);
-            }
-          }}
-          onKeyDown={(e) => otp.handleKeyDown(e, idx)}
-          onFocus={otp.handleFocus}
-          onPaste={otp.handlePaste}
-          error={!digit ? props.error : false}
-        />
-      ))}
-    </SingleCharacterInputs>
-  );
-};
+export const OtpInput = React.forwardRef<HTMLInputElement, Record<string, any>>(
+  ({ name, maxLength = 6, ...props }, ref) => {
+    const otp = useOtp(props.onChange, maxLength);
+    return (
+      <SingleCharacterInputs>
+        {otp.otpValues.map((digit, idx) => (
+          <SingleCharacterInputPart
+            ref={idx === 0 ? ref : null}
+            name={`${name}-${idx}`}
+            id={`${name}-${idx}`}
+            type="text"
+            key={idx}
+            autoComplete="one-time-code"
+            pattern="\d{1}"
+            maxLength={maxLength}
+            value={digit}
+            disabled={props.disabled}
+            aria-required={props['aria-required']}
+            onChange={(e) => otp.handleOtpChange(e, idx)}
+            onInput={(e) => {
+              if (e.target.value === digit) {
+                otp.handleOtpChange(e, idx);
+              }
+            }}
+            onKeyDown={(e) => otp.handleKeyDown(e, idx)}
+            onFocus={otp.handleFocus}
+            onPaste={otp.handlePaste}
+            error={!digit ? props.error : false}
+          />
+        ))}
+      </SingleCharacterInputs>
+    );
+  }
+);
+
+OtpInput.displayName = 'OtpInput';
 
 export default OtpInput;

package/src/inputs/Radio/Radio.stories.js

@@ -1,7 +1,10 @@
 import Radio from '@digigov/form/inputs/Radio';
+import doc from './doc.mdx?raw';
 export default {
   title: 'Digigov Form/inputs/Radio',
   component: Radio,
+  tags: ['autodocs'],
+  markdown: doc,
   displayName: 'Radio',
 };
 export { Default } from '@digigov/form/inputs/Radio/__stories__/Default';

package/src/inputs/Radio/__stories__/Conditional.tsx

@@ -85,7 +85,7 @@ const fields: FieldSpec[] = [
   },
 ];
 
-export const Conditional = () => (
+export const Conditional = (_: any) => (
   <FormBuilder
     onSubmit={(data) => {
       console.log(data);

package/src/inputs/Radio/__stories__/Default.tsx

@@ -2,7 +2,7 @@ import React from 'react';
 import FormBuilder, { Field } from '@digigov/form';
 import { Button } from '@digigov/ui/form/Button';
 
-export const Default = () => (
+export const Default = (_: any) => (
   <FormBuilder
     onSubmit={(data) => {
       console.log(data);

package/src/inputs/Radio/__stories__/WithDivider.tsx

@@ -2,7 +2,7 @@ import React from 'react';
 import FormBuilder, { Field } from '@digigov/form';
 import { Button } from '@digigov/ui/form/Button';
 
-export const WithDivider = () => (
+export const WithDivider = (_: any) => (
   <FormBuilder
     onSubmit={(data) => {
       console.log(data);

package/src/inputs/Radio/index.test.tsx

@@ -22,6 +22,10 @@ test('renders the All Radio variants', async ({ mount, page }) => {
   )
   await page.evaluate(() => document.fonts.ready);
 
+  // Move the mouse to the top-left corner to avoid random hover issues
+  await page.mouse.move(0, 0);
+
+
   const screenshot = await page.screenshot({ fullPage: true, animations: 'disabled' });
   expect(screenshot).toMatchSnapshot();
 });

package/src/inputs/Radio/index.tsx

@@ -1,7 +1,7 @@
 import React from 'react';
 import { useWatch } from 'react-hook-form';
-import { UncontrolledFieldProps } from '@digigov/form/Field/types';
-import { FieldOptionProps } from '@digigov/form/inputs/Label';
+import type { UncontrolledFieldProps } from '@digigov/form/Field/types';
+import type { FieldOptionProps } from '@digigov/form/inputs/Label';
 import {
   RadioContainer,
   RadioItem,
@@ -15,7 +15,7 @@ export interface RadioButtonsGroupProps
   extends Omit<UncontrolledFieldProps, 'extra'> {
   extra: {
     className?: string;
-    options: Array<FieldOptionProps>;
+    options: FieldOptionProps[];
     dense?: boolean;
   };
   fieldComponent?: React.FC<Omit<UncontrolledFieldProps, 'register'>>;
@@ -78,32 +78,40 @@ export const RadioButtonsGroup: React.FC<RadioButtonsGroupProps> = ({
     </RadioContainer>
   );
 };
-export const ControlledRadioButtonsGroup: React.FC<
+export const ControlledRadioButtonsGroup = React.forwardRef<
+  HTMLInputElement,
   RadioButtonsGroupProps & { onChange: (e: any) => void; value: any }
-> = ({
-  name,
-  extra: { options, className },
-  disabled,
-  onChange,
-  value,
-  Field,
-  ...props
-}) => {
+>(function ControlledRadioButtonsGroup(
+  {
+    name,
+    extra: { options, className },
+    disabled,
+    onChange,
+    value,
+    Field,
+    ...props
+  },
+  ref
+) {
   const currentValue: string | undefined = value;
   const { t } = useTranslation();
   return (
     <RadioContainer className={className} id={name}>
       {options.map(
-        ({
-          label,
-          value: v,
-          show,
-          disabled: optionDisabled,
-          selected,
-          ...option
-        }) => (
+        (
+          {
+            label,
+            value: v,
+            show,
+            disabled: optionDisabled,
+            selected,
+            ...option
+          },
+          index
+        ) => (
           <React.Fragment key={`${name}.${v}`}>
             <RadioItem
+              ref={index === 0 ? ref : undefined}
               onChange={(e) => {
                 console.log(e);
                 onChange(e);
@@ -118,6 +126,7 @@ export const ControlledRadioButtonsGroup: React.FC<
                 reset: undefined,
                 required: undefined,
                 error: undefined,
+                Field: undefined,
                 'aria-describedby': undefined,
                 type: 'radio',
               }}
@@ -138,6 +147,6 @@ export const ControlledRadioButtonsGroup: React.FC<
       )}
     </RadioContainer>
   );
-};
+});
 
 export default RadioButtonsGroup;

package/src/inputs/Select/Select.stories.js

@@ -1,7 +1,10 @@
 import Select from '@digigov/form/inputs/Select';
+import doc from './doc.mdx?raw';
 export default {
   title: 'Digigov Form/inputs/Select',
   component: Select,
+  tags: ['autodocs'],
+  markdown: doc,
   displayName: 'Select',
 };
 export { Default } from '@digigov/form/inputs/Select/__stories__/Default';

package/src/inputs/Select/__stories__/Default.tsx

@@ -2,7 +2,7 @@ import React from 'react';
 import FormBuilder, { Field } from '@digigov/form';
 import { Button } from '@digigov/ui/form/Button';
 
-export const Default = () => (
+export const Default = (_: any) => (
   <FormBuilder
     onSubmit={(data) => {
       console.log(data);

package/src/inputs/Select/index.test.tsx

@@ -14,6 +14,10 @@ test('renders the All Select variants', async ({ mount, page }) => {
   )
   await page.evaluate(() => document.fonts.ready);
 
+  // Move the mouse to the top-left corner to avoid random hover issues
+  await page.mouse.move(0, 0);
+
+
   const screenshot = await page.screenshot({ fullPage: true, animations: 'disabled' });
   expect(screenshot).toMatchSnapshot();
 });

package/src/inputs/Select/index.tsx

@@ -1,13 +1,18 @@
 import React from 'react';
-import { UncontrolledFieldProps } from '@digigov/form/Field/types';
-import { FieldOptionProps } from '@digigov/form/inputs/Label';
-import { SelectContainer, SelectOption } from '@digigov/ui/form/SelectContainer';
+import type { UncontrolledFieldProps } from '@digigov/form/Field/types';
+import type { FieldOptionProps } from '@digigov/form/inputs/Label';
+import {
+  SelectContainer,
+  SelectOption,
+} from '@digigov/ui/form/SelectContainer';
 
-export interface SelectProps extends Omit<UncontrolledFieldProps, 'extra'> {
+export interface SelectProps
+  extends Omit<UncontrolledFieldProps, 'extra' | 'Field'> {
   extra: {
     className?: string;
-    options: Array<FieldOptionProps>;
+    options: FieldOptionProps[];
   };
+  Field?: UncontrolledFieldProps['Field'];
 }
 
 export const Select: React.ExoticComponent<SelectProps> = React.forwardRef(
@@ -15,16 +20,23 @@ export const Select: React.ExoticComponent<SelectProps> = React.forwardRef(
     { name, extra: { options, className }, disabled, ...props },
     ref: never
   ) {
+    delete props.Field;
     return (
       <SelectContainer
         className={className}
         ref={ref}
         name={name}
+        id={name}
         disabled={disabled}
-        {...{ ...props, reset: undefined, required: undefined }}
+        {...{
+          ...props,
+          reset: undefined,
+          error: undefined,
+          required: undefined,
+        }}
       >
-        {options.map(({ value, label }) => (
-          <SelectOption key={value} value={value}>
+        {options.map(({ value, label }, index) => (
+          <SelectOption key={index} value={value}>
             {label && label.primary ? label.primary : value}
           </SelectOption>
         ))}

package/src/{Field/utils/index.ts → inputs/registry.ts}

@@ -1,7 +1,8 @@
-import { FieldComponentRegistry } from '@digigov/form/Field/types';
+import { type FieldComponentItem } from '@digigov/form/Field/types';
 import AutoCompleteInput from '@digigov/form/inputs/AutoCompleteInput';
 import Checkboxes from '@digigov/form/inputs/Checkboxes';
 import DateInput from '@digigov/form/inputs/DateInput';
+import DateTimeInput from '@digigov/form/inputs/DateTimeInput';
 import FileInput from '@digigov/form/inputs/FileInput';
 import ImageInput from '@digigov/form/inputs/ImageInput';
 import Input from '@digigov/form/inputs/Input';
@@ -9,6 +10,8 @@ import OtpInput from '@digigov/form/inputs/OtpInput';
 import Radio, { ControlledRadioButtonsGroup } from '@digigov/form/inputs/Radio';
 import Select from '@digigov/form/inputs/Select';
 
+export type FieldComponentRegistry = Record<string, FieldComponentItem>;
+
 export const FIELD_COMPONENTS: FieldComponentRegistry = {
   text: {
     component: Input,
@@ -19,16 +22,23 @@ export const FIELD_COMPONENTS: FieldComponentRegistry = {
   file: {
     wrapper: 'fieldset',
     component: FileInput,
+    // controlled: true,
   },
   image: {
     wrapper: 'fieldset',
     component: ImageInput,
+    controlled: true,
   },
   date: {
     wrapper: 'fieldset',
     controlled: true,
     component: DateInput,
   },
+  datetime: {
+    wrapper: 'fieldset',
+    controlled: true,
+    component: DateTimeInput,
+  },
   otp: {
     wrapper: 'fieldset',
     controlled: true,