DEV Community

loading...
Cover image for Using React Hook Form v6+ with Ionic React Components - Update
Ionic

Using React Hook Form v6+ with Ionic React Components - Update

Aaron K Saunders
See more, like and subscribe 👉🏾 ‪Aaron Saunders 📺 https://www.youtube.com/aaronsaundersci?sub_confirmation=1
Updated on ・1 min read

🔆Click Here for Ionic Framework ReactJS and VueJS Tips/Tutorials?🔆

This is a quick post showing quickly how to make latest version of React Hook Form work with Ionic Framework ReactJS Components.

The previous post example will only work on older versions of the form library.

This is based on the Controller API discussed here in the documentation - https://react-hook-form.com/api#Controller

const App: React.FunctionComponent = () => {
  const { handleSubmit, control } = useForm();

  /**
   *
   * @param data
   */
  const onSubmit = (data: any) => {
    debugger;
    alert(JSON.stringify(data, null, 2));
  };

  return (
    <IonApp>
      <IonPage>
        <IonHeader>
          <IonToolbar>
            <IonButtons slot="start">
              <IonBackButton />
            </IonButtons>
            <IonTitle>Detail</IonTitle>
          </IonToolbar>
        </IonHeader>
        <IonContent>
          <p>Details</p>
          <form onSubmit={handleSubmit(data => console.log(data))}>
            <IonItem>
              <IonLabel>Gender</IonLabel>
              <Controller
                render={({ onChange, onBlur, value }) => (
                  <IonSelect placeholder="Select One" onIonChange={onChange}>
                    <IonSelectOption value="FEMALE">Female</IonSelectOption>
                    <IonSelectOption value="MALE">Male</IonSelectOption>
                  </IonSelect>
                )}
                control={control}
                name="gender"
                rules={{ required: true }}
              />
            </IonItem>
            <IonItem>
              <IonLabel>Email</IonLabel>
              <Controller
                render={({ onChange, onBlur, value }) => (<IonInput onIonChange={onChange}/>)}
                control={control}
                name="email"
                rules={{
                  required: true,
                  pattern: {
                    value: /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$/i,
                    message: "invalid email address"
                  }
                }}
              />
            </IonItem>
            <IonItem>
              <Controller
                render={({ onChange, onBlur, value }) => (
                  <IonRange
                    min={-200}
                    max={200}
                    color="secondary"
                    onIonChange={onChange}
                  >
                    <IonLabel slot="start">-200</IonLabel>
                    <IonLabel slot="end">200</IonLabel>
                  </IonRange>
                )}
                control={control}
                name="rangeInfo"
                rules={{ required: true }}
              />
            </IonItem>
            <IonButton type="submit">submit</IonButton>
          </form>
        </IonContent>
      </IonPage>
    </IonApp>
  );
};

Updated Example Source Code From Stackblitz

Original Video Showing the Use of React Hook Form

Discussion (13)

Collapse
aaronksaunders profile image
Aaron K Saunders Author • Edited

Saw this issue on Stackoverflow, stackoverflow.com/questions/630772...

here is a workaround

You can just add the interface...

export interface CheckboxChangeEventDetail {
  value: any;
  checked: boolean;
}
Enter fullscreen mode Exit fullscreen mode

and then set the code

<IonItem>
  <Controller
    render={({ onChange, onBlur }) => (
      <IonCheckbox
        onIonChange={(e: CustomEvent<CheckboxChangeEventDetail>) => {
          onChange(e?.detail.checked);
          console.log(e);
        }}
        onIonBlur={onBlur}
      />
    )}
    control={control}
    defaultValue={false}
    name="saveInfo"
    rules={{
      required: false,
    }}
  />
</IonItem>
Enter fullscreen mode Exit fullscreen mode
Collapse
curiouswebs profile image
curious-webs

Tried using interface for email field But still getting "Property 'onChange' does not exist on type"
in here
render={({ onChange, onBlur, value }) => (

Collapse
wendyperalta profile image
Wendy

Thank you for updating this. How would you go about testing this component? I have a simple Ionic Text Input component wrapped in a Controller just like the example above.

<Controller
      control={control}
      name="emailInput"
      rules={{ required: true }}
      render={({ value, onChange, onBlur }) => (
        <IonInput
          type="text"
          value={value}
          data-testid="input-email"
          onIonChange={onChange}
          onBlur={onBlur}
        />
      )}
    />

I've tried to use the example from this article:

import { ionFireEvent as fireIonEvent } from "@ionic/react-test-utils";
const emailInput = await findByTestId("input-email");
fireIonEvent.ionChange(emailInput, "test@email.com");

I've also tried this (since ion input components have a detail property that specifies the value of the input:

import { fireEvent } from "@testing-library/react";
fireEvent.change(emailInput, { target: { detail: { value: {"test@email.com" }}});

None of these methods get me what I need which is the value for these inputs being updated in the test. Any ideas?

Collapse
patelrikin profile image
Rikin Patel

You can probably do debug() from testing library after each fired event and see if the thing changed at all to investigate

Collapse
wendyperalta profile image
Wendy

I did do that, but it didn't change.

Thread Thread
aaronksaunders profile image
Aaron K Saunders Author

put the id on the Controller and fire a onChange event don't use the ionic events

Thread Thread
wendyperalta profile image
Wendy

When I moved the data-testid='input-email' to the Controller component wrapper, now I get an error in the test:
TestingLibraryElementError: Unable to find an element by: [data-testid="input-email"]
I'm assuming because it is a custom component.

Thread Thread
aaronksaunders profile image
Aaron K Saunders Author

can you put a simple project together on stackblitz?

Thread Thread
uxtx_tim profile image
Tim Proffitt

Im curious what came of this - having the same issues :(

Collapse
clementvp profile image
Van Peuter Clément

Hello, How do you reset the form ? Or how do you set values to the form (with a proper render of the form ?)

Collapse
aaronksaunders profile image
Aaron K Saunders Author

you reset the form using the reset method from the hook... you set the form using the default values, it is funny that you asked because i was working on a blog post about that!!

Collapse
aaronksaunders profile image
Aaron K Saunders Author
Collapse
patelrikin profile image
Rikin Patel

Thanks for this quick update