casraf/formplex-react
1
0
Fork 0
mirror of https://github.com/chenasraf/formplex-react.git synced 2026-05-18 01:49:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: f19d1933e0

Browse Source
This commit is contained in:
chenasraf
2022-11-10 23:10:46 +00:00
parent 8ca5923a90
commit 1b9917bd9a
7 changed files with 39 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
functions/useForm.html
View File

@@ -44,7 +44,7 @@
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/UseFormReturn.html" class="tsd-signature-type" data-tsd-kind="Interface">UseFormReturn</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/use-form.ts#L22">use-form.ts:22</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/use-form.ts#L22">use-form.ts:22</a></li></ul></aside></li></ul></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

7
index.html
View File

@@ -16,7 +16,12 @@
<a href="#formplex---react" id="formplex---react" style="color: inherit; text-decoration: none;">
<h1>FormPlex - React</h1>
</a>
<h2><a href="https://chenasraf.github.io/formplex-react/">Full documentation</a></h2>
<h2 align="center">
<p><a href="https://github.com/chenasraf/formplex-react">GitHub</a> |
<a href="https://casraf.blog/formplex-react">Documentation</a> |
<a href="https://npmjs.com/package/formplex-react">NPM</a> | <a href="https://casraf.dev">casraf.dev</a></p>
</h2>
<p>Handle forms in your React apps with incredible ease.</p>
<p>FormPlex lets you use React forms without the hassle; including easy validations, predictable and

6
interfaces/ErrorMessage.html
View File

@@ -33,7 +33,7 @@ under the field&#39;s key. Otherwise, it is <code>undefined</code>.</p>
<ul class="tsd-hierarchy">
<li><span class="target">ErrorMessage</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L239">types.ts:239</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L239">types.ts:239</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -59,14 +59,14 @@ under the field&#39;s key. Otherwise, it is <code>undefined</code>.</p>
</ul>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L248">types.ts:248</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L248">types.ts:248</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="message" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The error message for the field.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L253">types.ts:253</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L253">types.ts:253</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

8
interfaces/ErrorStrings.html
View File

@@ -28,7 +28,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">ErrorStrings</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L295">types.ts:295</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L295">types.ts:295</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -54,7 +54,7 @@
<h3>See</h3><p><a href="FieldOptions.html#maxLength">FieldOptions.maxLength</a> for defining a maximum length for the field</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L331">types.ts:331</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L331">types.ts:331</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="minLength" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>min<wbr/>Length</span><a href="#minLength" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">min<wbr/>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span></div>
@@ -67,7 +67,7 @@
<h3>See</h3><p><a href="FieldOptions.html#minLength">FieldOptions.minLength</a> for defining a minimum length for the field</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L317">types.ts:317</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L317">types.ts:317</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="required" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>required</span><a href="#required" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">required<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -77,7 +77,7 @@
<h3>See</h3><p><a href="FieldOptions.html#required">FieldOptions.required</a> for defining a field as required</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L303">types.ts:303</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L303">types.ts:303</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

20
interfaces/FieldOptions.html
View File

@@ -30,7 +30,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">FieldOptions</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L125">types.ts:125</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L125">types.ts:125</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -65,7 +65,7 @@
</ul>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L174">types.ts:174</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L174">types.ts:174</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="maxLength" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>max<wbr/>Length</span><a href="#maxLength" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">max<wbr/>Length<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -75,7 +75,7 @@ be provided in <a href="UseFormReturn.html#errors">UseFormReturn.errors</a>.</p>
<p>To provide a custom error message, use <a href="FieldOptions.html#errorMessages">errorMessages</a>.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L154">types.ts:154</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L154">types.ts:154</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="minLength" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>min<wbr/>Length</span><a href="#minLength" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">min<wbr/>Length<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -85,7 +85,7 @@ be provided in <a href="UseFormReturn.html#errors">UseFormReturn.errors</a>.</p>
<p>To provide a custom error message, use <a href="FieldOptions.html#errorMessages">errorMessages</a>.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L144">types.ts:144</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L144">types.ts:144</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="onBlur" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>on<wbr/>Blur</span><a href="#onBlur" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">on<wbr/>Blur<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ChangeEvent</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
@@ -113,7 +113,7 @@ be provided in <a href="UseFormReturn.html#errors">UseFormReturn.errors</a>.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L225">types.ts:225</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L225">types.ts:225</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="onChange" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>on<wbr/>Change</span><a href="#onChange" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">on<wbr/>Change<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ChangeEvent</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
@@ -141,7 +141,7 @@ be provided in <a href="UseFormReturn.html#errors">UseFormReturn.errors</a>.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L213">types.ts:213</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L213">types.ts:213</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="parse" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>parse</span><a href="#parse" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">parse<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span></div>
@@ -168,7 +168,7 @@ placed here.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L201">types.ts:201</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L201">types.ts:201</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pattern" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>pattern</span><a href="#pattern" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">pattern<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span></div>
@@ -177,7 +177,7 @@ placed here.</p>
error for a pattern, use <a href="FieldOptions.html#validate">validate</a> instead.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L162">types.ts:162</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L162">types.ts:162</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="required" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>required</span><a href="#required" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">required<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -187,7 +187,7 @@ error for a pattern, use <a href="FieldOptions.html#validate">validate</a> inste
<p>To provide a custom error message, use <a href="FieldOptions.html#errorMessages">errorMessages</a>.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L134">types.ts:134</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L134">types.ts:134</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="validate" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>validate</span><a href="#validate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">validate<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span></div>
@@ -219,7 +219,7 @@ error for a pattern, use <a href="FieldOptions.html#validate">validate</a> inste
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L189">types.ts:189</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L189">types.ts:189</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

10
interfaces/UseFormOptions.html
View File

@@ -30,7 +30,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">UseFormOptions</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L6">types.ts:6</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L6">types.ts:6</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -57,7 +57,7 @@
<h3>See</h3><p><a href="UseFormReturn.html#validate">validate</a> for manual validation trigger</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L42">types.ts:42</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L42">types.ts:42</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="errorMessages" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>error<wbr/>Messages</span><a href="#errorMessages" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">error<wbr/>Messages<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="ErrorStrings.html" class="tsd-signature-type" data-tsd-kind="Interface">ErrorStrings</a><span class="tsd-signature-symbol">&gt;</span></div>
@@ -73,7 +73,7 @@
</ul>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L27">types.ts:27</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L27">types.ts:27</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="initialState" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>initial<wbr/>State</span><a href="#initialState" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">initial<wbr/>State<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></div>
@@ -81,7 +81,7 @@
Any missing field will be empty.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L11">types.ts:11</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L11">types.ts:11</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="onSubmit" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>on<wbr/>Submit</span><a href="#onSubmit" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">on<wbr/>Submit<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FormEvent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLFormElement</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
@@ -103,7 +103,7 @@ Any missing field will be empty.</p>
<h5>e: <span class="tsd-signature-type">FormEvent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLFormElement</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L16">types.ts:16</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L16">types.ts:16</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

20
interfaces/UseFormReturn.html
View File

@@ -28,7 +28,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">UseFormReturn</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L48">types.ts:48</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L48">types.ts:48</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -61,7 +61,7 @@ Each property is the name of the field and the value is the error message, if an
<h3>See</h3><p><a href="ErrorMessage.html">ErrorMessage</a></p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L70">types.ts:70</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L70">types.ts:70</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="field" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>field</span><a href="#field" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">field<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">E</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span>, options<span class="tsd-signature-symbol">?: </span><a href="FieldOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FieldOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">FieldReturn</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">E</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div>
@@ -103,7 +103,7 @@ See each of the options for more information.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FieldReturn</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">E</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L60">types.ts:60</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L60">types.ts:60</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="handleSubmit" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>handle<wbr/>Submit</span><a href="#handleSubmit" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">handle<wbr/>Submit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FormEvent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLFormElement</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
@@ -126,21 +126,21 @@ You should inject this into the form&#39;s <code>onSubmit</code> prop.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L93">types.ts:93</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L93">types.ts:93</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="isValid" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>is<wbr/>Valid</span><a href="#isValid" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">is<wbr/>Valid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<div class="tsd-comment tsd-typography"><p>Indicates whether the form is valid.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L85">types.ts:85</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L85">types.ts:85</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="rawState" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>raw<wbr/>State</span><a href="#rawState" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">raw<wbr/>State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div>
<div class="tsd-comment tsd-typography"><p>The current form data, before parsing.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L80">types.ts:80</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L80">types.ts:80</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="setValue" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Value</span><a href="#setValue" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">set<wbr/>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
@@ -173,7 +173,7 @@ You should inject this into the form&#39;s <code>onSubmit</code> prop.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L110">types.ts:110</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L110">types.ts:110</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="setValues" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Values</span><a href="#setValues" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">set<wbr/>Values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
@@ -197,14 +197,14 @@ You should inject this into the form&#39;s <code>onSubmit</code> prop.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L101">types.ts:101</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L101">types.ts:101</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="state" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">state<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></div>
<div class="tsd-comment tsd-typography"><p>The current form data, after parsing.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L75">types.ts:75</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L75">types.ts:75</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="validate" class="tsd-anchor"></a>
@@ -223,7 +223,7 @@ You should inject this into the form&#39;s <code>onSubmit</code> prop.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/338d528/src/types.ts#L119">types.ts:119</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/f19d193/src/types.ts#L119">types.ts:119</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">