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: d19b931ff1

Browse Source
This commit is contained in:
chenasraf
2022-11-10 22:05:45 +00:00
parent 54d16512f9
commit 1512188e73
9 changed files with 35 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
functions/useForm.html
View File

@@ -33,7 +33,7 @@
<h5>__namedParameters: <a href="../interfaces/UseFormOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">UseFormOptions</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><span class="tsd-signature-symbol"> = {}</span></h5></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/20efe3d/src/use-form.ts#L14">use-form.ts:14</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/use-form.ts#L14">use-form.ts:14</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">

6
interfaces/ErrorMessage.html
View File

@@ -20,7 +20,7 @@
<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/20efe3d/src/types.ts#L147">types.ts:147</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L147">types.ts:147</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">
@@ -40,14 +40,14 @@
<code>validate</code> for custom validations</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L152">types.ts:152</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L152">types.ts:152</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/20efe3d/src/types.ts#L156">types.ts:156</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L156">types.ts:156</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/ErrorStrings.html
View File

@@ -23,7 +23,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/20efe3d/src/types.ts#L192">types.ts:192</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L192">types.ts:192</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">
@@ -48,7 +48,7 @@
</code></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L220">types.ts:220</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L220">types.ts:220</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>
@@ -59,7 +59,7 @@
</code></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L209">types.ts:209</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L209">types.ts:209</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"><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-symbol">(</span><span class="tsd-signature-symbol">(</span>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><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>
@@ -70,7 +70,7 @@
</code></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L231">types.ts:231</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L231">types.ts:231</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>
@@ -78,7 +78,7 @@
<p>Default: <code>&quot;Required&quot;</code></p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L198">types.ts:198</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L198">types.ts:198</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">

18
interfaces/FieldOptions.html
View File

@@ -27,7 +27,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/20efe3d/src/types.ts#L83">types.ts:83</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L83">types.ts:83</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">
@@ -52,7 +52,7 @@
<div class="tsd-comment tsd-typography"><p>Map of custom error messages for the default validation methods.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L119">types.ts:119</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L119">types.ts:119</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>
@@ -61,7 +61,7 @@
and an error message will be provided in <code>errors</code>.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L106">types.ts:106</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L106">types.ts:106</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>
@@ -70,7 +70,7 @@ and an error message will be provided in <code>errors</code>.</p>
and an error message will be provided in <code>errors</code>.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L98">types.ts:98</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L98">types.ts:98</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><a href="../types/ChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeEvent</a>, 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>
@@ -94,7 +94,7 @@ Use this callback instead, which acts right after the input&#39;s <code>onChange
<h5>value: <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></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/20efe3d/src/types.ts#L144">types.ts:144</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/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="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>
@@ -116,7 +116,7 @@ to be updated with the result of this function.</p>
<h5>value: <span class="tsd-signature-type">string</span></h5></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/20efe3d/src/types.ts#L136">types.ts:136</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L136">types.ts:136</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>
@@ -125,7 +125,7 @@ to be updated with the result of this function.</p>
To cause a validation error for a pattern, use <code>validate</code> instead.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L114">types.ts:114</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L114">types.ts:114</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>
@@ -134,7 +134,7 @@ To cause a validation error for a pattern, use <code>validate</code> instead.</p
and an error message will be provided in <code>errors</code>.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L90">types.ts:90</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L90">types.ts:90</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>
@@ -156,7 +156,7 @@ To cause a validation error for a pattern, use <code>validate</code> instead.</p
<h5>value: <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></h5></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/20efe3d/src/types.ts#L128">types.ts:128</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L128">types.ts:128</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

@@ -28,7 +28,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/20efe3d/src/types.ts#L4">types.ts:4</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L4">types.ts:4</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">
@@ -53,7 +53,7 @@
<p><code>never</code> - Show validations after the user has submitted the form only, or on manual trigger.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L33">types.ts:33</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L33">types.ts:33</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>
@@ -61,7 +61,7 @@
<h3>See</h3></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L20">types.ts:20</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L20">types.ts:20</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>
@@ -69,7 +69,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/20efe3d/src/types.ts#L9">types.ts:9</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L9">types.ts:9</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>
@@ -91,7 +91,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/20efe3d/src/types.ts#L14">types.ts:14</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L14">types.ts:14</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">

18
interfaces/UseFormReturn.html
View File

@@ -25,7 +25,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/20efe3d/src/types.ts#L36">types.ts:36</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L36">types.ts:36</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">
@@ -52,7 +52,7 @@ Each property is the name of the field and the value is the error message, if an
<p>If there is no error, the value will be <code>undefined</code>.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L49">types.ts:49</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L49">types.ts:49</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><a href="../types/FieldReturn.html" class="tsd-signature-type" data-tsd-kind="Type alias">FieldReturn</a><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>
@@ -82,7 +82,7 @@ See each of the options for more information.</p>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <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></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../types/FieldReturn.html" class="tsd-signature-type" data-tsd-kind="Type alias">FieldReturn</a><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/20efe3d/src/types.ts#L41">types.ts:41</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L41">types.ts:41</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>
@@ -103,21 +103,21 @@ You should inject this into the form&#39;s <code>onSubmit</code> prop.</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/20efe3d/src/types.ts#L70">types.ts:70</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/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="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/20efe3d/src/types.ts#L64">types.ts:64</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L64">types.ts:64</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/20efe3d/src/types.ts#L59">types.ts:59</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L59">types.ts:59</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>
@@ -144,7 +144,7 @@ You should inject this into the form&#39;s <code>onSubmit</code> prop.</p>
<h5>value: <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></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/20efe3d/src/types.ts#L80">types.ts:80</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/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="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>
@@ -164,14 +164,14 @@ You should inject this into the form&#39;s <code>onSubmit</code> prop.</p>
<h5>values: <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></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/20efe3d/src/types.ts#L75">types.ts:75</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L75">types.ts:75</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/20efe3d/src/types.ts#L54">types.ts:54</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L54">types.ts:54</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">

2
types/BlurEvent.html
View File

@@ -17,7 +17,7 @@
<h1>Type alias BlurEvent<code class="tsd-tag ts-flagInternal">Internal</code> </h1></div>
<div class="tsd-signature">Blur<wbr/>Event<span class="tsd-signature-symbol">:</span> <a href="ChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeEvent</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L187">types.ts:187</a></li></ul></aside></div>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L187">types.ts:187</a></li></ul></aside></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">

2
types/ChangeEvent.html
View File

@@ -22,7 +22,7 @@
<li class="tsd-parameter">
<h5>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L182">types.ts:182</a></li></ul></aside></div>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L182">types.ts:182</a></li></ul></aside></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">

2
types/FieldReturn.html
View File

@@ -63,7 +63,7 @@
<div class="tsd-comment tsd-typography"><p>The value of the field.</p>
</div></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/20efe3d/src/types.ts#L161">types.ts:161</a></li></ul></aside></div>
<li>Defined in <a href="https://github.com/chenasraf/formplex-react/blob/d19b931/src/types.ts#L161">types.ts:161</a></li></ul></aside></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">