[ { "path": ".eslintrc", "content": "{\n \"extends\": [\n \"eslint:recommended\",\n \"plugin:@typescript-eslint/recommended\",\n \"plugin:react/recommended\",\n \"prettier\"\n ],\n \"ignorePatterns\": [\"node_modules/\", \"testing-app\"],\n \"parser\": \"@typescript-eslint/parser\",\n \"parserOptions\": {\n \"ecmaVersion\": \"latest\",\n \"sourceType\": \"module\"\n },\n \"plugins\": [\"@typescript-eslint\", \"react\", \"prettier\"],\n \"rules\": {\n \"@typescript-eslint/no-unnecessary-type-constraint\": \"off\",\n \"@typescript-eslint/no-explicit-any\": \"off\",\n \"no-console\": \"error\"\n },\n \"settings\": {\n \"react\": {\n \"version\": \"18\"\n }\n }\n}\n" }, { "path": ".github/FUNDING.yml", "content": "# These are supported funding model platforms\n\ngithub: [AlemTuzlak]\npatreon: # Replace with a single Patreon username\nopen_collective: # Replace with a single Open Collective username\nko_fi: # Replace with a single Ko-fi username\ntidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel\ncommunity_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry\nliberapay: # Replace with a single Liberapay username\nissuehunt: # Replace with a single IssueHunt username\notechie: # Replace with a single Otechie username\nlfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry\ncustom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']\n" }, { "path": ".github/workflows/publish-commit.yaml", "content": "name: šŸš€ pkg-pr-new\non: [push, pull_request]\n\njobs:\n build:\n runs-on: ubuntu-latest\n\n steps:\n - name: Checkout code\n uses: actions/checkout@v2\n\n - run: corepack enable\n - uses: actions/setup-node@v4\n with:\n node-version: 20\n cache: \"npm\"\n\n - name: Install dependencies\n run: npm install\n\n - name: Build\n run: npm run build\n\n - run: npx pkg-pr-new publish\n" }, { "path": ".github/workflows/publish.yaml", "content": "name: Publish Package to npmjs\non:\n release:\n types: [published]\n workflow_dispatch:\njobs:\n npm-publish:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n # Setup .npmrc file to publish to npm\n - uses: actions/setup-node@v4\n with:\n node-version: \"20.x\"\n registry-url: \"https://registry.npmjs.org\"\n - run: npm ci\n - run: npm publish\n env:\n NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}" }, { "path": ".github/workflows/validate.yaml", "content": "name: šŸš€ Validation Pipeline\nconcurrency:\n group: ${{ github.repository }}-${{ github.workflow }}-${{ github.ref }}\n cancel-in-progress: true\non:\n push:\n branches: [main]\n pull_request:\n branches: [main]\n\npermissions:\n actions: write\n contents: read\n # Required to put a comment into the pull-request\n pull-requests: write\njobs:\n# lint:\n# name: ā¬£ Biome lint\n# runs-on: ubuntu-latest\n# steps:\n# - name: ā¬‡ļø Checkout repo\n# uses: actions/checkout@v4\n# - name: Setup Biome\n# uses: biomejs/setup-biome@v2\n# - name: Run Biome\n# run: biome ci .\n\n typecheck:\n name: šŸ”Ž Type check\n runs-on: ubuntu-latest\n steps:\n - name: šŸ›‘ Cancel Previous Runs\n uses: styfle/cancel-workflow-action@0.12.1\n - name: ā¬‡ļø Checkout repo\n uses: actions/checkout@v4\n - name: āŽ” Setup node\n uses: actions/setup-node@v4\n with:\n node-version: 20\n - name: šŸ“„ Download deps\n uses: bahmutov/npm-install@v1\n with:\n useLockFile: false\n - name: šŸ”Ž Type check\n run: npm run typecheck\n\n vitest:\n name: āš” Unit Tests\n runs-on: ubuntu-latest\n steps:\n - name: šŸ›‘ Cancel Previous Runs\n uses: styfle/cancel-workflow-action@0.12.1\n - name: ā¬‡ļø Checkout repo\n uses: actions/checkout@v4\n - name: āŽ” Setup node\n uses: actions/setup-node@v4\n with:\n node-version: 20\n - name: šŸ“„ Download deps\n uses: bahmutov/npm-install@v1\n with:\n useLockFile: false\n - name: Install dotenv cli\n run: npm install -g dotenv-cli\n - name: āš” Run vitest\n run: npm run test\n# - name: \"Report Coverage\"\n # Only works if you set `reportOnFailure: true` in your vite config as specified above\n# if: always()\n# uses: davelosert/vitest-coverage-report-action@v2\n " }, { "path": ".gitignore", "content": "# Logs\nlogs\n*.log\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\nlerna-debug.log*\n\n# Diagnostic reports (https://nodejs.org/api/report.html)\nreport.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json\n\n# Runtime data\npids\n*.pid\n*.seed\n*.pid.lock\n\n# Directory for instrumented libs generated by jscoverage/JSCover\nlib-cov\n\n# Coverage directory used by tools like istanbul\ncoverage\n*.lcov\n\n# nyc test coverage\n.nyc_output\n\n# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)\n.grunt\n\n# Bower dependency directory (https://bower.io/)\nbower_components\n\n# node-waf configuration\n.lock-wscript\n\n# Compiled binary addons (https://nodejs.org/api/addons.html)\nbuild/Release\n\n# Dependency directories\nnode_modules/\njspm_packages/\n\n# TypeScript v1 declaration files\ntypings/\n\n# TypeScript cache\n*.tsbuildinfo\n\n# Optional npm cache directory\n.npm\n\n# Optional eslint cache\n.eslintcache\n\n# Microbundle cache\n.rpt2_cache/\n.rts2_cache_cjs/\n.rts2_cache_es/\n.rts2_cache_umd/\n\n# Optional REPL history\n.node_repl_history\n\n# Output of 'npm pack'\n*.tgz\n\n# Yarn Integrity file\n.yarn-integrity\n\n# dotenv environment variables file\n.env\n.env.test\n\n# parcel-bundler cache (https://parceljs.org/)\n.cache\n\n# Next.js build output\n.next\n\n# Nuxt.js build / generate output\n.nuxt\ndist\n\n# Gatsby files\n.cache/\n# Comment in the public line in if your project uses Gatsby and *not* Next.js\n# https://nextjs.org/blog/next-9-1#public-directory-support\n# public\n\n# vuepress build output\n.vuepress/dist\n\n# Serverless directories\n.serverless/\n\n# FuseBox cache\n.fusebox/\n\n# DynamoDB Local files\n.dynamodb/\n\n# TernJS port file\n.tern-port\n\n/build\n.history\n.react-router\n.turbo\n" }, { "path": ".prettierignore", "content": "node_modules\n/build" }, { "path": ".prettierrc", "content": "{\n \n}" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity\nand orientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n* Demonstrating empathy and kindness toward other people\n* Being respectful of differing opinions, viewpoints, and experiences\n* Giving and gracefully accepting constructive feedback\n* Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n* Focusing on what is best not just for us as individuals, but for the\n overall community\n\nExamples of unacceptable behavior include:\n\n* The use of sexualized language or imagery, and sexual attention or\n advances of any kind\n* Trolling, insulting or derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or email\n address, without their explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at\n.\nAll complaints will be reviewed and investigated promptly and fairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series\nof actions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or\npermanent ban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within\nthe community.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.0, available at\nhttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.\n\nCommunity Impact Guidelines were inspired by [Mozilla's code of conduct\nenforcement ladder](https://github.com/mozilla/diversity).\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see the FAQ at\nhttps://www.contributor-covenant.org/faq. Translations are available at\nhttps://www.contributor-covenant.org/translations." }, { "path": "LICENSE", "content": "MIT License\n\nCopyright (c) 2023 Code Forge\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "README.md", "content": "# remix-hook-form\n\n![GitHub Repo stars](https://img.shields.io/github/stars/forge-42/remix-hook-form?style=social)\n![npm](https://img.shields.io/npm/v/remix-hook-form?style=plastic)\n![GitHub](https://img.shields.io/github/license/forge-42/remix-hook-form?style=plastic)\n![npm](https://img.shields.io/npm/dy/remix-hook-form?style=plastic) \n![npm](https://img.shields.io/npm/dw/remix-hook-form?style=plastic) \n![GitHub top language](https://img.shields.io/github/languages/top/forge-42/remix-hook-form?style=plastic) \n\nRemix-hook-form is a powerful and lightweight wrapper around [react-hook-form](https://react-hook-form.com/) that streamlines the process of working with forms and form data in your [React Router](https://reactrouter.com) applications. With a comprehensive set of hooks and utilities, you'll be able to easily leverage the flexibility of react-hook-form without the headache of boilerplate code.\n\nAnd the best part? Remix-hook-form has zero dependencies, making it easy to integrate into your existing projects and workflows. Say goodbye to bloated dependencies and hello to a cleaner, more efficient development process with Remix-hook-form. \n\nOh, and did we mention that this is fully Progressively enhanced? That's right, you can use this with or without javascript!\n\n## Remix.run support\nVersions older than 6.0.0 are compatible with [Remix.run](https://remix.run) applications. If you are using Remix.run, please use version 5.1.1 or lower.\n\n## Install\n\n```bash\nnpm install remix-hook-form react-hook-form\n```\n\n## Basic usage\n\nHere is an example usage of remix-hook-form. It will work with **and without** JS. Before running the example, ensure to install additional dependencies:\n\n```bash\nnpm install zod @hookform/resolvers\n```\n\n```ts\nimport { useRemixForm, getValidatedFormData } from \"remix-hook-form\";\nimport { Form } from \"react-router\";\nimport { zodResolver } from \"@hookform/resolvers/zod\";\nimport * as zod from \"zod\";\nimport type { Route } from \"./+types/home\";\n\n\nconst schema = zod.object({\n name: zod.string().min(1),\n email: zod.string().email().min(1),\n});\n\ntype FormData = zod.infer;\n\nconst resolver = zodResolver(schema);\n\nexport const action = async ({ request }: Route.ActionArgs) => {\n const { errors, data, receivedValues: defaultValues } =\n await getValidatedFormData(request, resolver);\n if (errors) {\n // The keys \"errors\" and \"defaultValues\" are picked up automatically by useRemixForm\n return { errors, defaultValues };\n }\n\n // Do something with the data\n return data;\n};\n\nexport default function MyForm() {\n const {\n handleSubmit,\n formState: { errors },\n register,\n } = useRemixForm({\n mode: \"onSubmit\",\n resolver,\n });\n\n return (\n
\n \n \n \n
\n );\n}\n```\n\n## Serialization of values client => server\n\nBy default, all values are serialized to strings before being sent to the server. This is because that is how form data works, it only accepts strings, nulls or files, this means that even strings would get \"double stringified\" and become strings like this:\n```ts\nconst string = \"'123'\";\n```\nThis helps with the fact that validation on the server can't know if your stringified values received from the client are actually strings or numbers or dates or whatever.\n\nFor example, if you send this formData to the server:\n\n```ts\nconst formData = {\n name: \"123\",\n age: 30,\n hobbies: [\"Reading\", \"Writing\", \"Coding\"],\n boolean: true,\n a: null,\n // this gets omitted because it's undefined\n b: undefined,\n numbers: [1, 2, 3],\n other: {\n skills: [\"testing\", \"testing\"],\n something: \"else\",\n },\n};\n```\n\nIt would be sent to the server as:\n```ts\n{\n name: \"123\",\n age: \"30\",\n hobbies: \"[\\\"Reading\\\",\\\"Writing\\\",\\\"Coding\\\"]\",\n boolean: \"true\",\n a: \"null\",\n numbers: \"[1,2,3]\",\n other: \"{\\\"skills\\\":[\\\"testing\\\",\\\"testing\\\"],\\\"something\\\":\\\"else\\\"}\",\n}\n```\n\nThen the server does not know if the `name` property used to be a string or a number, your validation schema would fail if it parsed it back to a number and you expected it to be a string. Conversely, if you didn't parse the rest of this data you wouldn't have objects,\narrays etc. but strings. \n\nThe double stringification helps with this as it would correctly parse the data back to the original types, but it also means that you have to use the helpers provided by this package to parse the data back to the original types.\n\n\n\nThis is the default behavior, but you can change this behavior by setting the `stringifyAllValues` prop to `false` in the `useRemixForm` hook.\n\n```ts\nconst { handleSubmit, formState, register } = useRemixForm({\n mode: \"onSubmit\",\n resolver,\n stringifyAllValues: false,\n});\n```\n\nThis only affects strings really as it either double stringifies them or it doesn't. The bigger impact of all of this is on the server side.\n\nBy default all the server helpers expect the data to be double stringified which allows the utils to parse the data back to the original types easily. If you don't want to double stringify the data then you can set the `preserveStringified` prop to `true` in the `getValidatedFormData` function.\n\n```ts\n// Third argument is preserveStringified and is false by default\nconst { errors, data } = await getValidatedFormData(request, resolver, true);\n```\nBecause the data by default is double stringified the data returned by the util and sent to your validator would look like this:\n\n```ts\nconst data = {\n name: \"123\",\n age: 30,\n hobbies: [\"Reading\", \"Writing\", \"Coding\"],\n boolean: true,\n a: null,\n // this gets omitted because it's undefined\n b: undefined,\n numbers: [1, 2, 3],\n other: {\n skills: [\"testing\", \"testing\"],\n something: \"else\",\n },\n};\n```\n\nIf you set `preserveStringified` to `true` then the data would look like this:\n\n```ts\nconst data = {\n name: \"123\",\n age: \"30\",\n hobbies: [\"Reading\", \"Writing\", \"Coding\"],\n boolean: \"true\",\n a: \"null\",\n numbers: [\"1\",\"2\",\"3\"],\n other: {\n skills: [\"testing\", \"testing\"],\n something: \"else\",\n },\n};\n\n```\n\nThis means that your validator would have to handle all the type conversions and validations for all the different types of data. This is a lot of work and it's not worth it usually, the best place to use this approach if you store the info in searchParams. If you want to handle it like this what you can do is use something like `coerce` from `zod` to convert the data to the correct type before checking it.\n\n```ts\nimport { z } from \"zod\";\n\nconst formDataZodSchema = z.object({\n name: z.string().min(1),\n // converts the string to a number\n age: z.coerce.number().int().positive(), \n});\n\ntype SchemaFormData = z.infer;\n\nconst resolver = zodResolver(formDataZodSchema);\n\nexport const action = async ({ request }: Route.ActionArgs) => {\n const { errors, data } = await getValidatedFormData(\n request,\n resolver,\n true,\n );\n if (errors) {\n return { errors };\n }\n // Do something with the data\n};\n```\n\n \n\n## Fetcher usage\n\nYou can pass in a fetcher as an optional prop and `useRemixForm` will use that fetcher to submit the data and read the errors instead of the default behavior. For more info see the docs on `useRemixForm` below.\n\n\n## Video example and tutorial\n\nIf you wish to learn in depth on how form handling works in React router/Remix.run and want an example using this package I have prepared a video tutorial on how to do it. It's a bit long but it covers everything \nyou need to know about form handling in React Router/Remix. It also covers how to use this package. You can find it here:\n\nhttps://youtu.be/iom5nnj29sY?si=l52WRE2bqpkS2QUh\n\n\n## Middleware mode\n\nFrom v7 you can use middleware to extract the form data and access it anywhere in your actions and loaders. \nAll you have to do is set it up in your `root.tsx` file like this:\n\n```ts\nimport { unstable_extractFormDataMiddleware } from \"remix-hook-form/middleware\";\n\nexport const unstable_middleware = [unstable_extractFormDataMiddleware()];\n```\n\n\nAnd then access it in your actions and loaders like this:\n\n\n```ts\nimport { getFormData, getValidatedFormData } from \"remix-hook-form/middleware\";\n\nexport const loader = async ({ context }: LoaderFunctionArgs) => {\n const searchParamsFormData = await getFormData(context); \n return { result: \"success\" };\n};\nexport const action = async ({ context }: ActionFunctionArgs) => {\n // OR: const formData = await getFormData(context); \n const { data, errors, receivedValues } = await getValidatedFormData(\n context,\n resolver,\n );\n if (errors) {\n return { errors, receivedValues };\n } \n return { result: \"success\" };\n};\n```\n\n## API's\n\n### getValidatedFormData\n\nNow supports no-js form submissions!\n\nIf you made a GET request instead of a POST request and you are using this inside of a loader it will try to extract the data from the search params\n\nIf the form is submitted without js it will try to parse the formData object and covert it to the same format as the data object returned by `useRemixForm`. If the form is submitted with js it will automatically extract the data from the request object and validate it.\n\ngetValidatedFormData is a utility function that can be used to validate form data in your action. It takes two arguments: the request/formData object and the resolver function. It returns an object with three properties: `errors`, `receivedValues` and `data`. If there are no errors, `errors` will be `undefined`. If there are errors, `errors` will be an object with the same shape as the `errors` object returned by `useRemixForm`. If there are no errors, `data` will be an object with the same shape as the `data` object returned by `useRemixForm`.\n\nThe `receivedValues` property allows you to set the default values of your form to the values that were received from the request object. This is useful if you want to display the form again with the values that were submitted by the user when there is no JS present\n \n #### Example with errors only\n If you don't want the form to persist submitted values in the case of validation errors then you can just return the `errors` object directly from the action.\n```jsx\n/** all the same code from above */\n\nexport const action = async ({ request }: Route.ActionArgs) => {\n // Takes the request from the frontend, parses and validates it and returns the data\n const { errors, data } =\n await getValidatedFormData(request, resolver);\n if (errors) {\n return { errors };\n }\n // Do something with the data\n};\n```\n\n#### Example with errors and receivedValues\nIf your action returrns `defaultValues` key then it will be automatically used by `useRemixForm` to populate the default values of the form.\n```jsx\n/** all the same code from above */\n\nexport const action = async ({ request }: Route.ActionArgs) => {\n // Takes the request from the frontend, parses and validates it and returns the data\n const { errors, data, receivedValues: defaultValues } =\n await getValidatedFormData(request, resolver);\n if (errors) {\n return { errors, defaultValues };\n }\n // Do something with the data\n};\n\n```\n\n### validateFormData\n\nvalidateFormData is a utility function that can be used to validate form data in your action. It takes two arguments: the formData object and the resolver function. It returns an object with two properties: `errors` and `data`. If there are no errors, `errors` will be `undefined`. If there are errors, `errors` will be an object with the same shape as the `errors` object returned by `useRemixForm`. If there are no errors, `data` will be an object with the same shape as the `data` object returned by `useRemixForm`.\n\nThe difference between `validateFormData` and `getValidatedFormData` is that `validateFormData` only validates the data while the `getValidatedFormData` function also extracts the data automatically from the request object assuming you were using the default setup.\n\n```jsx\n/** all the same code from above */\n\nexport const action = async ({ request }: Route.ActionArgs) => {\n // Lets assume you get the data in a different way here but still want to validate it\n const formData = await yourWayOfGettingFormData(request);\n // Takes the request from the frontend, parses and validates it and returns the data\n const { errors, data } =\n await validateFormData(formData, resolver);\n if (errors) {\n return { errors };\n }\n // Do something with the data\n};\n\n```\n\n### createFormData\n\ncreateFormData is a utility function that can be used to create a FormData object from the data returned by the handleSubmit function from `react-hook-form`. It takes one argument, the `data` from the `handleSubmit` function and it converts everything it can to strings and appends files as well. It returns a FormData object.\n\n```jsx\n/** all the same code from above */\n\nexport default function MyForm() {\n const { ... } = useRemixForm({\n ...,\n submitHandlers: {\n onValid: data => {\n // This will create a FormData instance ready to be sent to the server, by default all your data is converted to a string before sent\n const formData = createFormData(data); \n // Do something with the formData\n }\n }\n });\n\n return (\n ...\n );\n}\n\n```\n\n### parseFormData\n\nparseFormData is a utility function that can be used to parse the data submitted to the action by the handleSubmit function from `react-hook-form`. It takes two arguments, first one is the `request` submitted from the frontend and the second one is `preserveStringified`, the form data you submit will be cast to strings because that is how form data works, when retrieving it you can either keep everything as strings or let the helper try to parse it back to original types (eg number to string), default is `false`. It returns an object that contains unvalidated `data` submitted from the frontend.\n\n\n```jsx\n/** all the same code from above */\n\nexport const action = async ({ request }: Route.ActionArgs) => {\n // Allows you to get the data from the request object without having to validate it\n const formData = await parseFormData(request);\n // formData.age will be a number\n const formDataStringified = await parseFormData(request, true);\n // formDataStringified.age will be a string\n // Do something with the data\n};\n\n```\n\n\n### getFormDataFromSearchParams\n\nIf you're using a GET request formData is not available on the request so you can use this method to extract your formData from the search parameters assuming you set all your data in the search parameters\n\n## Hooks\n\n### useRemixForm\n\n`useRemixForm` is a hook that can be used to create a form in your React Router / Remix application. It's basically the same as react-hook-form's [`useForm`](https://www.react-hook-form.com/api/useform/) hook, with the following differences:\n\n**Additional options**\n- `submitHandlers`: an object containing two properties:\n - `onValid`: can be passed into the function to override the default behavior of the `handleSubmit` success case provided by the hook. If you need to pass additional data not tracked in the form, you'll need to manually merge it here with your form data to be submitted, as the `submitData` hook option is ignored in this case.\n - `onInvalid`: can be passed into the function to override the default behavior of the `handleSubmit` error case provided by the hook.\n- `submitConfig`: allows you to pass additional configuration to the `useSubmit` function from React Router / Remix, such as `{ replace: true }` to replace the current history entry instead of pushing a new one. The `submitConfig` trumps `Form` props from React Router / Remix. The following props will be used from `Form` if no submitConfig is provided:\n - `method`\n - `action`\n - `encType`\n- `submitData`: allows you to pass additional data to the backend when the form is submitted.\n- `fetcher`: if provided then this fetcher will be used to submit data and get a response (errors / defaultValues) instead of React Router/Remix's `useSubmit` and `useActionData` hooks.\n\n**`register` will respect default values returned from the action**\n\nIf the React Router/Remix hook `useActionData` returns an object with `defaultValues` these will automatically be used as the default value when calling the `register` function. This is useful when the form has errors and you want to persist the values when JS is not enabled. If a `fetcher` is provided default values will be read from the fetcher's data.\n\n**`handleSubmit`**\n\nThe returned `handleSubmit` function does two additional things\n- The success case is provided by default where when the form is validated by the provided resolver, and it has no errors, it will automatically submit the form to the current route using a POST request. The data will be sent as `formData` to the action function.\n- The data that is sent is automatically wrapped into a formData object and passed to the server ready to be used. Easiest way to consume it is by using the `parseFormData` or `getValidatedFormData` function from the `remix-hook-form` package.\n\n**`formState.errors`**\n\nThe `errors` object inside `formState` is automatically populated with the errors returned by the action. If the action returns an `errors` key in it's data then that value will be used to populate errors, otherwise the whole action response is assumed to be the errors object. If a `fetcher` is provided then errors are read from the fetcher's data.\n\n#### Examples\n\n**Overriding the default onValid and onInvalid cases**\n\n```jsx\n const { ... } = useRemixForm({\n ...ALL_THE_SAME_CONFIG_AS_REACT_HOOK_FORM,\n submitHandlers: {\n onValid: data => { \n // Do something with the formData\n },\n onInvalid: errors => {\n // Do something with the errors\n }\n }\n });\n\n```\n\n**Overriding the submit from remix to do something else**\n\n```jsx\n const { ... } = useRemixForm({\n ...ALL_THE_SAME_CONFIG_AS_REACT_HOOK_FORM,\n submitConfig: {\n replace: true,\n method: \"PUT\",\n action: \"/api/youraction\",\n },\n });\n\n```\n\n**Passing additional data to the backend**\n\n```jsx\n const { ... } = useRemixForm({\n ...ALL_THE_SAME_CONFIG_AS_REACT_HOOK_FORM,\n submitData: {\n someFieldsOutsideTheForm: \"someValue\"\n },\n });\n\n // or if customizing with `onValid` handler\n const { ... } = useRemixForm({\n ...ALL_THE_SAME_CONFIG_AS_REACT_HOOK_FORM,\n submitHandlers: {\n onValid: data => { \n const mergedData = { ...data, someFieldsOutsideTheForm: \"someValue\" }\n const formData = createFormData(mergedData);\n // ... submit\n }\n }\n });\n```\n\n### RemixFormProvider\n\nIdentical to the [`FormProvider`](https://react-hook-form.com/api/formprovider/) from `react-hook-form`, but it also returns the changed `formState.errors` and `handleSubmit` object.\n```jsx\nexport default function Form() {\n const methods = useRemixForm();\n \n return (\n // pass all methods into the context\n
\n
\n \n \n \n );\n}\n" }, { "path": "test-apps/react-router/app/routes.ts", "content": "import { type RouteConfig, index } from \"@react-router/dev/routes\";\n\nexport default [index(\"routes/home.tsx\")] satisfies RouteConfig;\n" }, { "path": "test-apps/react-router/app/welcome/welcome.tsx", "content": "import logoDark from \"./logo-dark.svg\";\nimport logoLight from \"./logo-light.svg\";\n\nexport function Welcome() {\n return (\n
\n
\n
\n
\n \n \n
\n
\n
\n \n
\n
\n
\n );\n}\n\nconst resources = [\n {\n href: \"https://reactrouter.com/docs\",\n text: \"React Router Docs\",\n icon: (\n \n \n \n ),\n },\n {\n href: \"https://rmx.as/discord\",\n text: \"Join Discord\",\n icon: (\n \n \n \n ),\n },\n];\n" }, { "path": "test-apps/react-router/package.json", "content": "{\n \"name\": \"react-router-app\",\n \"private\": true,\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"react-router build\",\n \"dev\": \"react-router dev\",\n \"start\": \"react-router-serve ./build/server/index.js\",\n \"typecheck\": \"react-router typegen && tsc --build --noEmit\"\n },\n \"dependencies\": {\n \"@react-router/node\": \"^7.5.0\",\n \"@react-router/serve\": \"^7.5.0\",\n \"isbot\": \"^5.1.17\",\n \"react\": \"^18.3.1\",\n \"react-dom\": \"^18.3.1\",\n \"react-router\": \"^7.5.0\",\n \"react-hook-form\": \"7.55.0\",\n \"remix-hook-form\": \"*\"\n },\n \"devDependencies\": {\n \"@react-router/dev\": \"^7.5.0\",\n \"@types/node\": \"^20\",\n \"@types/react\": \"^18.3.12\",\n \"@types/react-dom\": \"^18.3.1\",\n \"autoprefixer\": \"^10.4.20\",\n \"postcss\": \"^8.4.49\",\n \"tailwindcss\": \"^3.4.15\",\n \"typescript\": \"^5.6.3\",\n \"vite\": \"^5.4.11\",\n \"vite-tsconfig-paths\": \"^5.1.2\",\n \"react-router-devtools\": \"^1.1.9\"\n }\n}" }, { "path": "test-apps/react-router/react-router.config.ts", "content": "import type { Config } from \"@react-router/dev/config\";\n\ndeclare module \"react-router\" {\n interface Future {\n unstable_middleware: true; // šŸ‘ˆ Enable middleware types\n }\n}\n\nexport default {\n future: {\n unstable_middleware: true, // šŸ‘ˆ Enable middleware\n },\n} satisfies Config;\n" }, { "path": "test-apps/react-router/tailwind.config.ts", "content": "import type { Config } from \"tailwindcss\";\n\nexport default {\n content: [\"./app/**/{**,.client,.server}/**/*.{js,jsx,ts,tsx}\"],\n theme: {\n extend: {\n fontFamily: {\n sans: [\n '\"Inter\"',\n \"ui-sans-serif\",\n \"system-ui\",\n \"sans-serif\",\n '\"Apple Color Emoji\"',\n '\"Segoe UI Emoji\"',\n '\"Segoe UI Symbol\"',\n '\"Noto Color Emoji\"',\n ],\n },\n },\n },\n plugins: [],\n} satisfies Config;\n" }, { "path": "test-apps/react-router/tsconfig.json", "content": "{\n \"include\": [\n \"**/*\",\n \"**/.server/**/*\",\n \"**/.client/**/*\",\n \".react-router/types/**/*\"\n ],\n \"compilerOptions\": {\n \"lib\": [\"DOM\", \"DOM.Iterable\", \"ES2022\"],\n \"types\": [\"node\", \"vite/client\"],\n \"target\": \"ES2022\",\n \"module\": \"ES2022\",\n \"moduleResolution\": \"bundler\",\n \"jsx\": \"react-jsx\",\n \"rootDirs\": [\".\", \"./.react-router/types\"],\n \"baseUrl\": \".\",\n \"paths\": {\n \"~/*\": [\"./app/*\"]\n },\n \"esModuleInterop\": true,\n \"forceConsistentCasingInFileNames\": true,\n \"isolatedModules\": true,\n \"noEmit\": true,\n \"resolveJsonModule\": true,\n \"skipLibCheck\": true,\n \"strict\": true\n }\n}\n" }, { "path": "test-apps/react-router/vite.config.ts", "content": "import { reactRouter } from \"@react-router/dev/vite\";\nimport autoprefixer from \"autoprefixer\";\nimport { reactRouterDevTools } from \"react-router-devtools\";\nimport tailwindcss from \"tailwindcss\";\nimport { defineConfig } from \"vite\";\nimport tsconfigPaths from \"vite-tsconfig-paths\";\n\nexport default defineConfig({\n css: {\n postcss: {\n plugins: [tailwindcss, autoprefixer],\n },\n },\n plugins: [reactRouterDevTools(), reactRouter(), tsconfigPaths()],\n});\n" }, { "path": "tsconfig.json", "content": "{\n \"compilerOptions\": {\n /* Visit https://aka.ms/tsconfig.json to read more about this file */\n\n /* Projects */\n // \"incremental\": true, /* Enable incremental compilation */\n // \"composite\": true, /* Enable constraints that allow a TypeScript project to be used with project references. */\n // \"tsBuildInfoFile\": \"./\", /* Specify the folder for .tsbuildinfo incremental compilation files. */\n // \"disableSourceOfProjectReferenceRedirect\": true, /* Disable preferring source files instead of declaration files when referencing composite projects */\n // \"disableSolutionSearching\": true, /* Opt a project out of multi-project reference checking when editing. */\n // \"disableReferencedProjectLoad\": true, /* Reduce the number of projects loaded automatically by TypeScript. */\n\n /* Language and Environment */\n \"target\": \"es2018\" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,\n \"lib\": [\n \"dom\",\n \"dom.iterable\",\n \"esnext\"\n ] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,\n \"jsx\": \"react\" /* Specify what JSX code is generated. */,\n\n \"module\": \"es2015\" /* Specify what module code is generated. */,\n \"rootDir\": \"./src\" /* Specify the root folder within your source files. */,\n \"moduleResolution\": \"node\" /* Specify how TypeScript looks up a file from a given module specifier. */,\n \"types\": [\n \"vitest/globals\"\n ] /* Specify type package names to be included without being referenced in a source file. */,\n\n /* Emit */\n \"declaration\": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,\n \"outDir\": \"./dist\" /* Specify an output folder for all emitted files. */,\n \"esModuleInterop\": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,\n // \"preserveSymlinks\": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */\n \"forceConsistentCasingInFileNames\": true /* Ensure that casing is correct in imports. */,\n\n /* Type Checking */\n \"strict\": true /* Enable all strict type-checking options. */,\n \"skipLibCheck\": true /* Skip type checking all .d.ts files. */,\n \"verbatimModuleSyntax\": true /* Require `type` prefix for type-only imports */\n },\n \"exclude\": [\n \"./bin/**/*.test.ts\",\n \"./dist/**/*\",\n \"./bin/mocks/**/*\",\n \"./*.config.ts\",\n \"./src/testing-app/**\",\n \"./test-apps\"\n ]\n}\n" }, { "path": "vitest.config.ts", "content": "import { defineConfig } from \"vitest/config\";\n\nexport default defineConfig({\n test: {\n globals: true,\n environment: \"happy-dom\",\n },\n});\n" } ]