0.2.5 • Published 1 year ago

react-controlled-form-subscriber v0.2.5

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Introduction

React Hook FormController를 모방한 제어 컴포넌트 방식의 폼 관리 Hook과 Component입니다.

  • FormSubscriber로 해당 필드의 상태만을 구독하여, 폼 상태 관리에서 불필요한 리렌더링을 최소화합니다.
  • 유효성 검사, 수정 여부 등 간단한 폼 관련 상태 및 유틸 함수 기능을 제공합니다.

Install

npm install react-controlled-form-subscriber

Getting started

Basic usage

import {
  FormSubscriber,
  useSubscribedForm,
} from "react-controlled-form-subscriber";

const getDefaultFields = () => ({
  name: "",
  age: 0,
});

const defaultFields = getDefaultFields();

const validators = {
  name: (value) => (value.length > 0 ? null : "Name is required"),
  age: (value) => (value > 0 ? null : "Age is required"),
};

const valueProcessors = {
  name: (event) => {
    const value = event.target.value;
    return value.trim();
  },
  age: (event) => {
    const value = event.target.value;
    return parseInt(value, 10);
  }
};


const MyForm = () => {
  const { control, getFields, reset } =
    useSubscribedForm(defaultFields, validators, valueProcessors);

  const onSubmit = (event) => {
    event.preventDefault();

    const fields = getFields();
    // Do anything with field values...
  };

  const onReset = (event) => {
    event.preventDefault();

    reset(getDefaultFields());
  };

  return (
    <form onSubmit={onSubmit}>
        <FormSubscriber control={control} fieldName="name">
          {({ register, error }) => {
            return (
              <>
                <input
                  type="text"
                  {...register()}
                />

                {error && <p>{error}</p>}
              </>
            );
          }}
        </FormSubscriber>
      </div>

      <FormSubscriber control={control} fieldName="age">
        {({ register, error }) => {
          return (
            <>
              <input
                type="number"
                {...register()}
              />

              {error && <p>{error}</p>}
            </>
          );
        }}
      </FormSubscriber>

      <div className="form-footer">
        <button type="submit" onClick={onSubmit}>
          Submit
        </button>

        <button type="button" onClick={onReset}>
          Reset
        </button>
    </form>
  );
};

API

useSubscribedForm

Arguments

Arguments nameTypeDescription
fieldsRecord<string, unknown>폼 필드 값들의 초기 상태를 정의합니다.
validatorsRecord<string, (value: unknown) => string | null>각 필드 별 유효성 검사 함수를 정의합니다.정의되지 않은 필드에 대해서는 항상 null을 반환합니다.
valueProcessorsRecord<string, (rawValue: unknown) => unknown>FormSubscriberonChange에서 인자로 받은 값을 가공하여 필드의 값으로 할당합니다.정의되지 않은 필드에 대해서는 rawValue를 그대로 사용합니다.
comparatorsRecord<string, (prevValue: unknown, nextValue: unknown) => boolean>해당 필드의 값을 비교하기 위해 사용합니다.정의되지 않은 필드에 대해서는 prevValue === nextValue의 결과값을 사용합니다.

Properties

Props nameTypeDescription
isValidboolean폼의 유효성 검사 결과입니다.
isTouchedboolean폼의 필드 요소가 사용자에 의해 선택 되었는지를 나타냅니다.
isDirtyboolean폼의 필드 내용이 사용자에 의해 수정 되었는지 여부를 나타냅니다.
controlFormControlCore폼을 관리하는 상태와 메서드가 담긴 Core instance입니다. FormSubscriber에게 전달하기 위해 사용합니다.
onChange(fieldName: string) => (rawValue: unknown) => void필드 외부에서 onChange를 호출하기 위해 사용합니다.(대부분의 경우는 FormSubscriber의 Props를 사용하면 됩니다.)
onTouched(fieldName: string) => () => void필드 외부에서 onFocus 등을 호출하기 위해 사용합니다.(대부분의 경우는 FormSubscriber의 Props를 사용하면 됩니다.)
getFields() => Record<string, unknown>현재 폼 Field들의 값을 반환합니다.
getErrors() => Record<string, string | null>현재 폼 Field들의 오류를 반환합니다.(어떤 필드 Property의 값이 null 또는 존재하지 않으면 유효한 필드입니다.)
getTouchedFields() => Record<string, boolean>현재 폼 Field들의 Focus 상호작용 여부를 반환합니다.
getDirtyFields() => Record<string, boolean>현재 폼 Field들의 수정 여부를 반환합니다.
getField(fieldName: string) => unknown해당 Field의 값을 반환합니다.
getError(fieldName: string) => string | null해당 Field의 오류 내용을 반환합니다.
getTouchedField(fieldName: string) => boolean해당 Field의 Focus 상호작용 여부를 반환합니다.
getDirtyField(fieldName: string) => boolean해당 Field의 수정 여부를 반환합니다.
reset(nextFields: Record<string, unknown>) => void현재 폼 Field들의 값을 초기화합니다.

FormSubscriber

Properties

Props nameTypeDescription
controlFormControlCore폼을 관리하는 상태와 메서드가 담긴 Core instance입니다. useSubscribedForm 에서 제공합니다.
fieldNamestringFormSubscriber가 폼 상태에서 구독할 Field의 이름입니다.
children(props: FormSubscriberChildProps) => ReactNode필드의 상태와 관련 메소드를 Props로 받아 구성 요소를 렌더링합니다.
watchedFieldsstring[]현재 필드 외의 다른 필드 값의 변경을 구독합니다.
0.2.5

1 year ago

0.2.4

1 year ago

0.2.3

1 year ago

0.2.2

1 year ago

0.2.1

1 year ago

0.2.0

1 year ago

0.1.4

1 year ago

0.1.3

1 year ago

0.1.2

1 year ago

0.1.1

1 year ago

0.1.0

1 year ago

0.0.5

1 year ago

0.0.4

1 year ago

0.0.3

1 year ago

0.0.2

1 year ago

0.0.1

1 year ago