Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
examples(RHF): add support for useFormSyncContext (#149)
- Loading branch information
Showing
8 changed files
with
333 additions
and
101 deletions.
There are no files selected for viewing
265 changes: 265 additions & 0 deletions
265
examples/react-hook-form/pages/form-context/[index].tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,265 @@ | ||
| import { useEffect, useRef } from 'react' | ||
| import type { GetServerSideProps, NextPage } from 'next' | ||
| import Head from 'next/head' | ||
| import Router from 'next/router' | ||
| import { SubmitHandler } from 'react-hook-form/dist/types/form' | ||
| import { syncEffect } from 'recoil-sync' | ||
| import { array, object, string } from '@recoiljs/refine' | ||
| import { initializableAtomFamily } from 'recoil-sync-next' | ||
| import { Links } from '../../src/components/Links' | ||
| import { useFormSync } from '../../src/hooks/useFormSync' | ||
| import { | ||
| FormSyncProvider, | ||
| useFormSyncContext, | ||
| } from '../../src/hooks/useFormSyncContext' | ||
| import styles from '../../styles/form.module.css' | ||
|
|
||
| type FormState = { | ||
| name: string | ||
| comment: string | ||
| time: string | ||
| selectedRadio: string | ||
| selectedCheckbox: readonly string[] | ||
| items: readonly { | ||
| radio: string | ||
| checkbox: string | ||
| text: string | ||
| }[] | ||
| } | ||
|
|
||
| const formState = initializableAtomFamily<FormState, string>({ | ||
| key: 'historyFormState', | ||
| effects: [ | ||
| syncEffect({ | ||
| storeKey: 'history-store', | ||
| refine: object({ | ||
| name: string(), | ||
| comment: string(), | ||
| time: string(), | ||
| selectedRadio: string(), | ||
| selectedCheckbox: array(string()), | ||
| items: array( | ||
| object({ | ||
| radio: string(), | ||
| checkbox: string(), | ||
| text: string(), | ||
| }) | ||
| ), | ||
| }), | ||
| }), | ||
| ], | ||
| }) | ||
|
|
||
| type PageProps = { | ||
| index: string | ||
| defaultValues: FormState | ||
| } | ||
|
|
||
| let count = 1 | ||
| const createNewItem = (): FormState['items'][number] => ({ | ||
| radio: `${count}`, | ||
| checkbox: `${count++}`, | ||
| text: '', | ||
| }) | ||
|
|
||
| const HistoryFormContext: NextPage<PageProps> = ({ index, defaultValues }) => { | ||
| // check render | ||
| const renderRef = useRef(true) | ||
| if (renderRef.current) { | ||
| renderRef.current = false | ||
| console.log(`HistoryForm[${index}]: initial render`) | ||
| } else { | ||
| console.log(`HistoryForm[${index}]: re render`) | ||
| } | ||
|
|
||
| const methods = useFormSync<FormState>(formState(index, defaultValues)) | ||
| const { resetFormOnly } = methods | ||
|
|
||
| /* | ||
| * Next.js dynamic routes does not unmount page components | ||
| * when only slugs are changed (just re-rendering). | ||
| * Therefore, uncontrolled input elements are not updated | ||
| * from the previous page (i.e. slug). | ||
| * To solve this problem, when slugs ('index' in this case) change, | ||
| * reset the RHF form state to reflect the Recoil state. | ||
| * Unlike reset(), resetFormOnly() doesn't reset the Recoil state. | ||
| */ | ||
| useEffect(() => { | ||
| resetFormOnly() | ||
| }, [index, resetFormOnly]) | ||
|
|
||
| return ( | ||
| <FormSyncProvider {...methods}> | ||
| <HistoryFormChild index={index} defaultValues={defaultValues} /> | ||
| </FormSyncProvider> | ||
| ) | ||
| } | ||
|
|
||
| export default HistoryFormContext | ||
|
|
||
| const HistoryFormChild: React.FC<PageProps> = ({ index, defaultValues }) => { | ||
| const { | ||
| control, | ||
| registerWithDefaultValue, | ||
| registerWithDefaultChecked, | ||
| onChangeForm, | ||
| handleSubmit, | ||
| reset, | ||
| resetFormOnly, | ||
| useFieldArraySync, | ||
| } = useFormSyncContext<FormState>() | ||
| const { fields, append, prepend, remove, swap, move, insert } = | ||
| useFieldArraySync({ | ||
| control, | ||
| name: 'items', | ||
| }) | ||
|
|
||
| const onSubmit: SubmitHandler<FormState> = async (data) => { | ||
| console.log('submit data', data) | ||
| await Router.push('/success') | ||
| } | ||
|
|
||
| return ( | ||
| <div className={styles.container}> | ||
| <Head> | ||
| <title>FormContext[{index}]</title> | ||
| <link rel="icon" href="/favicon.ico" /> | ||
| </Head> | ||
|
|
||
| <main className={styles.main}> | ||
| <h1 className={styles.title}>FormContext[{index}]</h1> | ||
|
|
||
| <form onSubmit={handleSubmit(onSubmit)} onChange={onChangeForm}> | ||
| <dl className={styles.formList}> | ||
| <dt>name</dt> | ||
| <dd> | ||
| <input type="text" {...registerWithDefaultValue('name')} /> | ||
| </dd> | ||
| <dt>comment</dt> | ||
| <dd> | ||
| <input type="text" {...registerWithDefaultValue('comment')} /> | ||
| </dd> | ||
| <dt>time</dt> | ||
| <dd> | ||
| <input type="text" {...registerWithDefaultValue('time')} /> | ||
| </dd> | ||
| <dt>items</dt> | ||
| <dd> | ||
| <button type="button" onClick={() => prepend(createNewItem())}> | ||
| Prepend | ||
| </button> | ||
| <ul> | ||
| {fields.map((field, index) => ( | ||
| <li key={field.id}> | ||
| <span>{index} </span> | ||
| <input | ||
| type="radio" | ||
| {...registerWithDefaultChecked( | ||
| 'selectedRadio', | ||
| field.radio | ||
| )} | ||
| /> | ||
| <input | ||
| type="checkbox" | ||
| {...registerWithDefaultChecked( | ||
| 'selectedCheckbox', | ||
| field.checkbox | ||
| )} | ||
| /> | ||
| <input | ||
| {...registerWithDefaultValue( | ||
| `items.${index}.text` as const | ||
| )} | ||
| /> | ||
| <button | ||
| type="button" | ||
| onClick={() => insert(index, createNewItem())} | ||
| > | ||
| Insert before | ||
| </button> | ||
| <button | ||
| type="button" | ||
| onClick={() => insert(index + 1, createNewItem())} | ||
| > | ||
| Insert after | ||
| </button> | ||
| <button | ||
| type="button" | ||
| disabled={index >= fields.length - 1} | ||
| onClick={() => swap(index, index + 1)} | ||
| > | ||
| Swap to next | ||
| </button> | ||
| <button type="button" onClick={() => move(index, 0)}> | ||
| Move to first | ||
| </button> | ||
| <button type="button" onClick={() => remove(index)}> | ||
| Remove | ||
| </button> | ||
| </li> | ||
| ))} | ||
| </ul> | ||
| <button type="button" onClick={() => append(createNewItem())}> | ||
| Append | ||
| </button> | ||
| </dd> | ||
| </dl> | ||
| <div> | ||
| <button>Submit</button> | ||
| </div> | ||
| <div> | ||
| <button type="button" onClick={() => reset()}> | ||
| Reset (to Default Values) | ||
| </button> | ||
| <button | ||
| type="button" | ||
| onClick={() => | ||
| reset({ | ||
| name: '', | ||
| comment: '', | ||
| time: '', | ||
| selectedRadio: '', | ||
| selectedCheckbox: [], | ||
| items: [], | ||
| }) | ||
| } | ||
| > | ||
| Reset (to Empty Values) | ||
| </button> | ||
| </div> | ||
| </form> | ||
| <Links /> | ||
| </main> | ||
| </div> | ||
| ) | ||
| } | ||
|
|
||
| export const getServerSideProps: GetServerSideProps<PageProps> = async ({ | ||
| params, | ||
| }) => { | ||
| console.log(`HistoryForm[${params?.index}]: executing gSSP`) | ||
| return { | ||
| props: { | ||
| index: params?.index as string, | ||
| defaultValues: { | ||
| name: 'a', | ||
| comment: 'b', | ||
| time: new Date().toLocaleTimeString(), | ||
| selectedRadio: 'A', | ||
| selectedCheckbox: ['A'], | ||
| items: [ | ||
| { | ||
| radio: 'A', | ||
| checkbox: 'A', | ||
| text: '', | ||
| }, | ||
| { | ||
| radio: 'B', | ||
| checkbox: 'B', | ||
| text: '', | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.