context-form-ts v1.0.0

context-form-ts

Made with create-react-library

Install

npm install context-form-ts

or...

yarn add context-form-ts

Usage

import { withForm, useForm, Field, email, min } from 'context-form-ts';

const Form = withForm(() => {
  const form = useForm();

  const onSubmit = (values) => {
    console.log(values);
    alert(values);
  };

  return (
    <>
      <Field
        name="email"
        placeholder="E-mail"
        type="email"
        className="input"
        validate={email('Must be an email')}
      >
        {({ input, info, ...props }) => (
          <div className="inputContainer">
            <input {...input} {...props} />
            {!!info.error && info.hasBeenTouched && (
              <div className="error">{info.error}</div>
            )}
          </div>
        )}
      </Field>
      <Field
        name="password"
        placeholder="Password"
        type="password"
        className="input"
        validate={min(7, 'Must have 7 characters minimum')}
      >
        >
        {({ input, info, ...props }) => (
          <div className="inputContainer">
            <input {...input} {...props} />
            {!!info.error && info.hasBeenTouched && (
              <div className="error">{info.error}</div>
            )}
          </div>
        )}
      </Field>
      <button onClick={form.handleSubmit(console.log)}>Submit</button>
    </>
  );
});

API

withForm (hoc)

Embeds your component inside the neccesary context to work.

Usage

const Form = withForm(() => {
  ...
  return (
    <>
      {...}
    </>
  );
});

useForm (hook)

A hook that returns the form context value.

const form = useForm();

Context Value

values

Immutable object with the form values.

console.log(form.values);

setValues

Function that receive an object with new form values which will overwrite the past values.

form.setValues({ ...newValues });

setValue

function that sets the value of a key of the form values ​​object.

form.setValue('email', 'fabiosaac12@gmail.com');

errors

Immutable object with the form value errors.

console.log(form.errors);

setErrors

Function that receive an object with new form value errors which will overwrite the past errors.

form.setErrors({ ...newErrors });

setError

function that sets the value of a key of the form errors ​​object.

form.setError('email', 'Must be a registered e-mail.');

defaultValues

Immutable object with the form defaultValues.

console.log(form.defaultValues);

setDefaultValues

Function that receive an object with new form default values which will overwrite the past default values.

form.setDefaultValues({ ...newDefaultValues });

setDefaultValue

function that sets the value of a key of the form default values ​​object.

form.setDefaultValue('email', 'fabiosaac12@gmail.com');

cleanForm

function that sets the form values as a new empty object.

form.cleanForm();

resetForm

function that returns the form values object to its initial value (with the default values)

form.cleanForm();

handleSubmit

Function that receives a submit function as param and returns the received function bound with new functionality for the form, such as the corresponding verification of the form values before calling the submit function.

const onSubmit = (values) => {
  console.log(values);
  alert(values);
};

return (
  <>
    {...}
    <button onClick={form.handleSubmit(onSubmit)}>
      Submit
    </button>
    {...}
  </>
);

Field (React Component)

A component that receives as children a function which will be have as params all the necessary data for the field.

Props

children

A function that will render the input with some data that it will receive as param

Param that will be sent to the children function

param {
  name: string,
  input: {
    onChange: input onBlur event handler function,
    onBlur: input onBlur event handler function,
    value: any,
  },
  info: {
    hasBeenTouched: boolean,
    hasChanged: boolean,
    error: string | true | undefiend,
  },
  {...allTheOtherPropsThatYouPassedToTheFieldComponent}
}

Example

<Field name="email" validate={email('Must be an email')}>
  ({name, input, info, ...props}) => {
    <input
      name={name} // unnecesary
      {...props}
      {...info}/>
    {!!info.error && info.hasBeenTouched && (
      <p>{info.error}</p>
    )}
  }
</Field>

validate

Function that receives the input value as param and returns true or string if there is any error.

  const validate = (value) => {
    if (!(value === 'correct value')) return 'Incorrect value';
  };

  return (
    {...}
      <Field {...props} validate={validate} />
    {...}
  );

This library has various validate function generators that you can use. See below.

Validate function generators by the library

import {
  required,
  min,
  max,
  email,
  alphanumeric,
  alpha,
  numeric,
  lowercase,
  uppercase,
} from 'context-form-ts';

required

<Field
  name="name"
  type="text"
  validate={required()}>
  {...}
</Field>

min

<Field
  name="age"
  type="number"
  validate={min(0, 'You must born first')}>
  {...}
</Field>
<Field
  name="name"
  type="text"
  validate={min(4, 'Must have 4 characters minimum')}>
  {...}
</Field>

max

<Field
  name="age"
  type="number"
  validate={max(150, 'You must be alive')}>
  {...}
</Field>
<Field
  name="name"
  type="text"
  validate={max(19, 'Must have 19 characters maximum')}>
  {...}
</Field>

email

<Field
  name="email"
  type="email"
  validate={email('Must be an e-mail')}>
  {...}
</Field>

alphanumeric

<Field
  name="username"
  validate={alphanumeric('Must be alphanumeric')}>
  {...}
</Field>

alpha

<Field
  name="username"
  validate={alpha('Must have only letters')}>
  {...}
</Field>

numeric

<Field
  name="code"
  validate={numeric('Must have only numbers')}>
  {...}
</Field>

lowercase

<Field
  name="username"
  validate={lowercase('Must be lowecase')}>
  {...}
</Field>

uppercase

<Field
  name="username"
  validate={uppercase('Must be lowecase')}>
  {...}
</Field>

License

MIT © fabiosaac12