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.22.2">
<meta name="project" content="form v5.8.6">
<title>FORM — form v5.8.6</title>
<link rel="stylesheet" href="dist/elixir-d678dad126d82ddc061f.css" />
<link rel="canonical" href="https://hexdocs.pm/form/FORM.html" />
<script src="dist/sidebar_items-bd9957f240.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/app-0103364119015b97e56c.js"></script>
</head>
<body data-type="modules">
<script>try { if(localStorage.getItem('night-mode') === 'true') document.body.className += ' night-mode'; } catch (e) { }</script>
<div class="main">
<button class="sidebar-button sidebar-toggle">
<span class="icon-menu" title="Collapse/expand sidebar"></span>
</button>
<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button">
<span class="icon-search" aria-hidden="true"></span>
</button>
<button type="button" tabindex="-1" class="search-close-button">
<span class="icon-cross" title="Cancel search"></span>
</button>
<label class="search-label">
<input name="q" type="text" id="search-list" class="search-input" placeholder="Search..." aria-label="Search" 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">
form </a>
<h2 class="sidebar-projectVersion">
v5.8.6
</h2>
</div>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>
<li><a id="modules-list" href="#full-list">Modules</a></li>
</ul>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<small class="app-vsn">form v5.8.6</small>
FORM </h1>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<span class="icon-link" aria-hidden="true"></span>
<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">but(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#but/2">but(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#document/1">document(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#document/2">document(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#field/1">field(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#field/2">field(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#formReg/1">formReg(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#formReg/2">formReg(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#opt/1">opt(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#opt/2">opt(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#otp/1">otp(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#otp/2">otp(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#phone/1">phone(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#phone/2">phone(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#sec/1">sec(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#sec/2">sec(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#sel/1">sel(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#sel/2">sel(record, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#validation/1">validation(args \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#validation/2">validation(record, args)</a>
</div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<span class="icon-link" aria-hidden="true"></span>
<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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">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">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature">validation(record, args)</h1>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener">ExDoc</a> (v0.22.2),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" rel="noopener" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</p>
<p>
<button class="line footer-button display-shortcuts-help">
Display keyboard shortcuts
</button>
<button class="line footer-button night-mode-toggle">
Toggle night mode
</button>
<button class="line footer-button display-quick-switch">
Go to a HexDocs package
</button>
<button class="line footer-button tooltips-toggle">
<span class="tooltips-option-disable">Disable tooltips</span>
<span class="tooltips-option-enable">Enable tooltips</span>
</button>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>