Merge pull request #136 from katywings/feat-submit-helper

Add form submit method #130
fabian-hiller · Sep 30, 2023 · 8639ba1 · 8639ba1
2 parents 23b619d + cd29b29
commit 8639ba1
Show file tree

Hide file tree

Showing 15 changed files with 124 additions and 0 deletions.
diff --git a/packages/preact/CHANGELOG.md b/packages/preact/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to the library will be documented in this file.
 
+## vX.X.X (Month DD, YYYY)
+
+- Add `submit` method (issue #130, pull request #136)
+
 ## v0.6.2 (August 23, 2023)
 
 - Fix `valiField` and `valiForm` adapter for Valibot v0.13.0

diff --git a/packages/preact/src/methods/index.ts b/packages/preact/src/methods/index.ts
@@ -16,5 +16,6 @@ export * from './setError';
 export * from './setResponse';
 export * from './setValue';
 export * from './setValues';
+export * from './submit';
 export * from './swap';
 export * from './validate';
diff --git a/packages/preact/src/methods/submit.ts b/packages/preact/src/methods/submit.ts
@@ -0,0 +1,13 @@
+import type { FieldValues, FormStore, ResponseData } from '../types';
+
+/**
+ * Validates and submits the form.
+ *
+ * @param form The form to be submitted.
+ */
+export function submit<
+  TFieldValues extends FieldValues,
+  TResponseData extends ResponseData
+>(form: FormStore<TFieldValues, TResponseData>): void {
+  form.element.peek()?.requestSubmit();
+}
diff --git a/packages/qwik/CHANGELOG.md b/packages/qwik/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to the library will be documented in this file.
 
+## vX.X.X (Month DD, YYYY)
+
+- Add `submit` method (issue #130, pull request #136)
+
 ## v0.20.2 (August 23, 2023)
 
 - Fix `valiField$` and `valiForm$` adapter for Valibot v0.13.0

diff --git a/packages/qwik/src/methods/index.ts b/packages/qwik/src/methods/index.ts
@@ -16,5 +16,6 @@ export * from './setError';
 export * from './setResponse';
 export * from './setValue';
 export * from './setValues';
+export * from './submit';
 export * from './swap';
 export * from './validate';
diff --git a/packages/qwik/src/methods/submit.ts b/packages/qwik/src/methods/submit.ts
@@ -0,0 +1,13 @@
+import type { FieldValues, FormStore, ResponseData } from '../types';
+
+/**
+ * Validates and submits the form.
+ *
+ * @param form The form to be submitted.
+ */
+export function submit<
+  TFieldValues extends FieldValues,
+  TResponseData extends ResponseData
+>(form: FormStore<TFieldValues, TResponseData>): void {
+  form.element?.requestSubmit();
+}
diff --git a/packages/react/CHANGELOG.md b/packages/react/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to the library will be documented in this file.
 
+## vX.X.X (Month DD, YYYY)
+
+- Add `submit` method (issue #130, pull request #136)
+
 ## v0.5.2 (August 23, 2023)
 
 - Fix `valiField` and `valiForm` adapter for Valibot v0.13.0

diff --git a/packages/react/src/methods/index.ts b/packages/react/src/methods/index.ts
@@ -16,5 +16,6 @@ export * from './setError';
 export * from './setResponse';
 export * from './setValue';
 export * from './setValues';
+export * from './submit';
 export * from './swap';
 export * from './validate';
diff --git a/packages/react/src/methods/submit.ts b/packages/react/src/methods/submit.ts
@@ -0,0 +1,13 @@
+import type { FieldValues, FormStore, ResponseData } from '../types';
+
+/**
+ * Validates and submits the form.
+ *
+ * @param form The form to be submitted.
+ */
+export function submit<
+  TFieldValues extends FieldValues,
+  TResponseData extends ResponseData
+>(form: FormStore<TFieldValues, TResponseData>): void {
+  form.element.peek()?.requestSubmit();
+}
diff --git a/packages/solid/CHANGELOG.md b/packages/solid/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to the library will be documented in this file.
 
+## vX.X.X (Month DD, YYYY)
+
+- Add `submit` method (issue #130, pull request #136)
+
 ## v0.19.2 (August 23, 2023)
 
 - Fix `valiField$` and `valiForm$` adapter for Valibot v0.13.0

diff --git a/packages/solid/src/methods/index.ts b/packages/solid/src/methods/index.ts
@@ -16,5 +16,6 @@ export * from './setError';
 export * from './setResponse';
 export * from './setValue';
 export * from './setValues';
+export * from './submit';
 export * from './swap';
 export * from './validate';
diff --git a/packages/solid/src/methods/submit.ts b/packages/solid/src/methods/submit.ts
@@ -0,0 +1,14 @@
+import { untrack } from 'solid-js';
+import type { FieldValues, FormStore, ResponseData } from '../types';
+
+/**
+ * Validates and submits the form.
+ *
+ * @param form The form to be submitted.
+ */
+export function submit<
+  TFieldValues extends FieldValues,
+  TResponseData extends ResponseData
+>(form: FormStore<TFieldValues, TResponseData>): void {
+  untrack(() => form.element)?.requestSubmit();
+}
diff --git a/website/public/sitemap.xml b/website/public/sitemap.xml
@@ -619,6 +619,12 @@
     <priority>0.40</priority>
     <changefreq>monthly</changefreq>
   </url>
+  <url>
+    <loc>https://modularforms.dev/solid/api/submit</loc>
+    <lastmod>2023-09-21</lastmod>
+    <priority>0.40</priority>
+    <changefreq>monthly</changefreq>
+  </url>
   <url>
     <loc>https://modularforms.dev/solid/api/swap</loc>
     <lastmod>2023-05-18</lastmod>
@@ -1041,6 +1047,12 @@
     <priority>0.40</priority>
     <changefreq>monthly</changefreq>
   </url>
+  <url>
+    <loc>https://modularforms.dev/qwik/api/submit</loc>
+    <lastmod>2023-09-21</lastmod>
+    <priority>0.40</priority>
+    <changefreq>monthly</changefreq>
+  </url>
   <url>
     <loc>https://modularforms.dev/qwik/api/swap</loc>
     <lastmod>2023-05-18</lastmod>
@@ -1493,6 +1505,12 @@
     <priority>0.40</priority>
     <changefreq>monthly</changefreq>
   </url>
+  <url>
+    <loc>https://modularforms.dev/preact/api/submit</loc>
+    <lastmod>2023-09-21</lastmod>
+    <priority>0.40</priority>
+    <changefreq>monthly</changefreq>
+  </url>
   <url>
     <loc>https://modularforms.dev/preact/api/swap</loc>
     <lastmod>2023-05-18</lastmod>
@@ -1915,6 +1933,12 @@
     <priority>0.40</priority>
     <changefreq>monthly</changefreq>
   </url>
+  <url>
+    <loc>https://modularforms.dev/react/api/submit</loc>
+    <lastmod>2023-09-21</lastmod>
+    <priority>0.40</priority>
+    <changefreq>monthly</changefreq>
+  </url>
   <url>
     <loc>https://modularforms.dev/react/api/swap</loc>
     <lastmod>2023-05-24</lastmod>

diff --git a/website/src/routes/(layout)/[framework]/api.tsx b/website/src/routes/(layout)/[framework]/api.tsx
@@ -40,6 +40,7 @@ export default function ApiLayout() {
             'setResponse',
             'setValue',
             'setValues',
+            'submit',
             'swap',
             'validate',
           ],

diff --git a/website/src/routes/(layout)/[framework]/api/submit.mdx b/website/src/routes/(layout)/[framework]/api/submit.mdx
@@ -0,0 +1,26 @@
+import { Description, Property, Title } from '~/components';
+
+<Title>submit</Title>
+<Description>Validates and submits the specified form.</Description>
+
+# submit
+
+Validates and submits the specified form.
+
+```ts
+submit(form);
+```
+
+## Parameters
+
+- `form` <Property {...properties.form} />
+
+export const properties = {
+  form: {
+    type: {
+      type: 'custom',
+      name: 'FormStore',
+      href: '../FormStore',
+    },
+  },
+};