Current section

Files

Jump to
form doc FORM.html
Raw

doc/FORM.html

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.28.4">
<meta name="project" content="form v7.8.0">
<title>FORM — form v7.8.0</title>
<link rel="stylesheet" href="dist/elixir-b6f1ed5df9b1d42a7309.css" />
<script src="dist/sidebar_items-f33faaa649.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/app-bd1cb213813bf4825aa2.js"></script>
</head>
<body data-type="modules">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<section class="sidebar">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
</button>
<label class="search-label">
<p class="sr-only">Search</p>
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<div class="sidebar-projectDetails">
<a href="api-reference.html" class="sidebar-projectName" translate="no">
form
</a>
<strong class="sidebar-projectVersion" translate="no">
v7.8.0
</strong>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list-link" href="#full-list">Pages</a></li>
<li><a id="modules-list-link" href="#full-list">Modules</a></li>
</ul>
</div>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="settings display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
<span translate="no">FORM</span>
<small class="app-vsn" translate="no">(form v7.8.0)</small>
</h1>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#but/1" translate="no">but(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#but/2" translate="no">but(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#document/1" translate="no">document(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#document/2" translate="no">document(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#field/1" translate="no">field(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#field/2" translate="no">field(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#formReg/1" translate="no">formReg(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#formReg/2" translate="no">formReg(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#opt/1" translate="no">opt(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#opt/2" translate="no">opt(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#otp/1" translate="no">otp(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#otp/2" translate="no">otp(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#phone/1" translate="no">phone(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#phone/2" translate="no">phone(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#sec/1" translate="no">sec(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#sec/2" translate="no">sec(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#sel/1" translate="no">sel(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#sel/2" translate="no">sel(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#validation/1" translate="no">validation(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#validation/2" translate="no">validation(record, args)</a>
</div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Functions
</h1>
<div class="functions-list">
<section class="detail" id="but/1">
<span id="but/0"></span>
<div class="detail-header">
<a href="#but/1" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">but(args \\ [])</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="but/2">
<div class="detail-header">
<a href="#but/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">but(record, args)</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="document/1">
<span id="document/0"></span>
<div class="detail-header">
<a href="#document/1" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">document(args \\ [])</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="document/2">
<div class="detail-header">
<a href="#document/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">document(record, args)</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="field/1">
<span id="field/0"></span>
<div class="detail-header">
<a href="#field/1" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">field(args \\ [])</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="field/2">
<div class="detail-header">
<a href="#field/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">field(record, args)</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="formReg/1">
<span id="formReg/0"></span>
<div class="detail-header">
<a href="#formReg/1" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">formReg(args \\ [])</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="formReg/2">
<div class="detail-header">
<a href="#formReg/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">formReg(record, args)</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="opt/1">
<span id="opt/0"></span>
<div class="detail-header">
<a href="#opt/1" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">opt(args \\ [])</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="opt/2">
<div class="detail-header">
<a href="#opt/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">opt(record, args)</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="otp/1">
<span id="otp/0"></span>
<div class="detail-header">
<a href="#otp/1" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">otp(args \\ [])</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="otp/2">
<div class="detail-header">
<a href="#otp/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">otp(record, args)</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="phone/1">
<span id="phone/0"></span>
<div class="detail-header">
<a href="#phone/1" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">phone(args \\ [])</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="phone/2">
<div class="detail-header">
<a href="#phone/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">phone(record, args)</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="sec/1">
<span id="sec/0"></span>
<div class="detail-header">
<a href="#sec/1" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">sec(args \\ [])</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="sec/2">
<div class="detail-header">
<a href="#sec/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">sec(record, args)</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="sel/1">
<span id="sel/0"></span>
<div class="detail-header">
<a href="#sel/1" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">sel(args \\ [])</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="sel/2">
<div class="detail-header">
<a href="#sel/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">sel(record, args)</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="validation/1">
<span id="validation/0"></span>
<div class="detail-header">
<a href="#validation/1" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">validation(args \\ [])</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="validation/2">
<div class="detail-header">
<a href="#validation/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">validation(record, args)</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
On Hex.pm:
<span class="line">
<a href="https://hex.pm/packages/form/7.8.0" class="line footer-hex-package">Package</a>
<a href="https://preview.hex.pm/preview/form/7.8.0" class="line">Preview</a>
<a href="https://preview.hex.pm/preview/form/7.8.0/show/lib/FORM.ex">(current file)</a>
</span>
<button class="line footer-button display-quick-switch">
Search
</button>
</p>
<p>
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.28.4) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>