Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

4.9 KB
Raw Blame
import { Plus, Trash } from 'lucide-react'
import {
  Control,
  FieldArray,
  FieldArrayPath,
  FieldArrayWithId,
  FieldPath,
  FieldValues,
  useFieldArray,
} from 'react-hook-form'
import { Button, cn, FormControl, FormField, FormItem, FormMessage, Input } from 'ui'

export interface SingleValueFieldArrayProps<
  TFieldValues extends FieldValues,
  TFieldArrayName extends FieldArrayPath<TFieldValues>,
  TItem extends FieldArray<TFieldValues, TFieldArrayName> = FieldArray<
    TFieldValues,
    TFieldArrayName
  >,
> {
  control: Control<TFieldValues>
  name: TFieldArrayName
  valueFieldName: Extract<keyof TItem, string>
  createEmptyRow: () => TItem
  placeholder: string
  addLabel: string
  removeLabel?: string
  disabled?: boolean
  pasteSeparator?: RegExp
  minimumRows?: number
  inputSize?: React.ComponentProps<typeof Input>['size']
  inputAutoComplete?: string
  className?: string
  rowsClassName?: string
  rowClassName?: string
  inputClassName?: string
  addButtonClassName?: string
  addButtonType?: React.ComponentProps<typeof Button>['variant']
  addButtonSize?: React.ComponentProps<typeof Button>['size']
  removeButtonClassName?: string
  removeButtonType?: React.ComponentProps<typeof Button>['variant']
  removeButtonSize?: React.ComponentProps<typeof Button>['size']
}

const toFieldPath = <TFieldValues extends FieldValues>(path: string) => {
  return path as FieldPath<TFieldValues>
}

export const SingleValueFieldArray = <
  TFieldValues extends FieldValues,
  TFieldArrayName extends FieldArrayPath<TFieldValues>,
  TItem extends FieldArray<TFieldValues, TFieldArrayName> = FieldArray<
    TFieldValues,
    TFieldArrayName
  >,
>({
  control,
  name,
  valueFieldName,
  createEmptyRow,
  placeholder,
  addLabel,
  removeLabel = 'Remove row',
  disabled = false,
  pasteSeparator,
  minimumRows = 0,
  inputSize = 'small',
  inputAutoComplete,
  className,
  rowsClassName = 'space-y-3 mt-1',
  rowClassName,
  inputClassName,
  addButtonClassName,
  addButtonType = 'default',
  addButtonSize,
  removeButtonClassName,
  removeButtonType = 'default',
  removeButtonSize = 'tiny',
}: SingleValueFieldArrayProps<TFieldValues, TFieldArrayName, TItem>) => {
  const { fields, append, insert, remove } = useFieldArray<
    TFieldValues,
    TFieldArrayName,
    'fieldId'
  >({
    control,
    name,
    keyName: 'fieldId',
  })

  const typedFields = fields as FieldArrayWithId<TFieldValues, TFieldArrayName, 'fieldId'>[]
  const disableRemove = disabled || typedFields.length <= minimumRows

  const createRow = (value: string) =>
    ({ ...(createEmptyRow() as object), [valueFieldName]: value }) as TItem

  const handlePaste = (
    event: React.ClipboardEvent<HTMLInputElement>,
    index: number,
    onChange: (value: string) => void
  ) => {
    if (!pasteSeparator) return

    const values = event.clipboardData
      .getData('text')
      .split(pasteSeparator)
      .map((value) => value.trim())
      .filter(Boolean)
    if (values.length <= 1) return

    event.preventDefault()
    onChange(values[0])
    insert(index + 1, values.slice(1).map(createRow))
  }

  return (
    <div className={cn('space-y-3', className)}>
      <div className={rowsClassName}>
        {typedFields.map((field, index) => (
          <div key={field.fieldId} className={cn('flex items-start space-x-2', rowClassName)}>
            <FormField
              control={control}
              name={toFieldPath<TFieldValues>(`${name}.${index}.${valueFieldName}`)}
              render={({ field }) => (
                <FormItem className="flex-1">
                  <FormControl>
                    <Input
                      {...field}
                      size={inputSize}
                      autoComplete={inputAutoComplete}
                      className={cn('w-full', inputClassName)}
                      placeholder={placeholder}
                      disabled={disabled}
                      onPaste={(event) => handlePaste(event, index, field.onChange)}
                    />
                  </FormControl>
                  <FormMessage />
                </FormItem>
              )}
            />

            <Button
              variant={removeButtonType}
              size={removeButtonSize}
              type="button"
              icon={<Trash size={12} />}
              aria-label={removeLabel}
              disabled={disableRemove}
              onClick={() => remove(index)}
              className={cn('h-[34px] w-[34px] shrink-0', removeButtonClassName)}
            />
          </div>
        ))}
      </div>

      <div className="flex items-center">
        <Button
          variant={addButtonType}
          size={addButtonSize}
          type="button"
          icon={<Plus strokeWidth={1.5} />}
          disabled={disabled}
          onClick={() => append(createEmptyRow())}
          className={addButtonClassName}
        >
          {addLabel}
        </Button>
      </div>
    </div>
  )
}