analytics/PlausibleWeb.AuthView.html
2023-07-27 14:47:27 +00:00

887 lines
26 KiB
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.30.3">
<meta name="project" content="Plausible v0.0.1">
<title>PlausibleWeb.AuthView — Plausible v0.0.1</title>
<link rel="stylesheet" href="dist/html-elixir-P5GXSCHE.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-NBND3S2D.js"></script>
<script src="dist/sidebar_items-18EF995D.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-CGDDOCMI.js"></script>
</head>
<body data-type="modules" class="page-module">
<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">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<section class="sidebar">
<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" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<a href="readme.html">
<img src="assets/logo.png" alt="Plausible" class="sidebar-projectImage">
</a>
<div class="sidebar-projectDetails">
<a href="readme.html" class="sidebar-projectName" translate="no">
Plausible
</a>
<div class="sidebar-projectVersion" translate="no">
v0.0.1
</div>
</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>
<li><a id="tasks-list-link" href="#full-list"><span translate="no">Mix</span> Tasks</a></li>
</ul>
</div>
<div class="gradient"></div>
<ul id="full-list"></ul>
</section>
<section class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="icon-action display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L1" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span translate="no">PlausibleWeb.AuthView</span>
<small class="app-vsn" translate="no">(Plausible v0.0.1)</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>
Summary
</a>
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#__resource__/0" translate="no">__resource__()</a>
</div>
<div class="summary-synopsis"><p>The resource name, as an atom, for this view</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#activate.html/1" translate="no">activate.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#base_domain/0" translate="no">base_domain()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delimit_integer/1" translate="no">delimit_integer(number)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#format_invoices/1" translate="no">format_invoices(invoice_list)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#invitation_expired.html/1" translate="no">invitation_expired.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#login_form.html/1" translate="no">login_form.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#new_api_key.html/1" translate="no">new_api_key.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#password_form.html/1" translate="no">password_form.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#password_reset_form.html/1" translate="no">password_reset_form.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#password_reset_request_form.html/1" translate="no">password_reset_request_form.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#password_reset_request_success.html/1" translate="no">password_reset_request_success.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#plausible_url/0" translate="no">plausible_url()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#present_subscription_status/1" translate="no">present_subscription_status(status)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#register_form.html/1" translate="no">register_form.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#register_from_invitation_form.html/1" translate="no">register_from_invitation_form.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#register_success.html/1" translate="no">register_success.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#render/2" translate="no">render(template, assigns \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Renders the given template locally.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#subscription_colors/1" translate="no">subscription_colors(_)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#subscription_interval/1" translate="no">subscription_interval(subscription)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#subscription_quota/1" translate="no">subscription_quota(subscription)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#template_not_found/2" translate="no">template_not_found(template, assigns)</a>
</div>
<div class="summary-synopsis"><p>Callback invoked when no template is found.
By default it raises but can be customized
to render a particular template.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#user_settings.html/1" translate="no">user_settings.html(assigns)</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>
Functions
</a>
</h1>
<div class="functions-list">
<section class="detail" id="__resource__/0">
<div class="detail-header">
<a href="#__resource__/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">__resource__()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L2" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>The resource name, as an atom, for this view</p>
</section>
</section>
<section class="detail" id="activate.html/1">
<div class="detail-header">
<a href="#activate.html/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">activate.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L1" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="base_domain/0">
<div class="detail-header">
<a href="#base_domain/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">base_domain()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L5" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="delimit_integer/1">
<div class="detail-header">
<a href="#delimit_integer/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">delimit_integer(number)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L33" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="format_invoices/1">
<div class="detail-header">
<a href="#format_invoices/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">format_invoices(invoice_list)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L21" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="invitation_expired.html/1">
<div class="detail-header">
<a href="#invitation_expired.html/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">invitation_expired.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L1" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="login_form.html/1">
<div class="detail-header">
<a href="#login_form.html/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">login_form.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L1" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="new_api_key.html/1">
<div class="detail-header">
<a href="#new_api_key.html/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">new_api_key.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L1" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="password_form.html/1">
<div class="detail-header">
<a href="#password_form.html/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">password_form.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L1" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="password_reset_form.html/1">
<div class="detail-header">
<a href="#password_reset_form.html/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">password_reset_form.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L1" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="password_reset_request_form.html/1">
<div class="detail-header">
<a href="#password_reset_request_form.html/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">password_reset_request_form.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L1" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="password_reset_request_success.html/1">
<div class="detail-header">
<a href="#password_reset_request_success.html/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">password_reset_request_success.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L1" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="plausible_url/0">
<div class="detail-header">
<a href="#plausible_url/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">plausible_url()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L9" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="present_subscription_status/1">
<div class="detail-header">
<a href="#present_subscription_status/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">present_subscription_status(status)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L48" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="register_form.html/1">
<div class="detail-header">
<a href="#register_form.html/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">register_form.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L1" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="register_from_invitation_form.html/1">
<div class="detail-header">
<a href="#register_from_invitation_form.html/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">register_from_invitation_form.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L1" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="register_success.html/1">
<div class="detail-header">
<a href="#register_success.html/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">register_success.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L1" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="render/2">
<span id="render/1"></span>
<div class="detail-header">
<a href="#render/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">render(template, assigns \\ %{})</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L2" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Renders the given template locally.</p>
</section>
</section>
<section class="detail" id="subscription_colors/1">
<div class="detail-header">
<a href="#subscription_colors/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">subscription_colors(_)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L54" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="subscription_interval/1">
<div class="detail-header">
<a href="#subscription_interval/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">subscription_interval(subscription)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L17" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="subscription_quota/1">
<div class="detail-header">
<a href="#subscription_quota/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">subscription_quota(subscription)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L13" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="template_not_found/2">
<div class="detail-header">
<a href="#template_not_found/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">template_not_found(template, assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L2" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> template_not_found(<a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
</div>
<p>Callback invoked when no template is found.
By default it raises but can be customized
to render a particular template.</p>
</section>
</section>
<section class="detail" id="user_settings.html/1">
<div class="detail-header">
<a href="#user_settings.html/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">user_settings.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L1" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="Plausible.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.30.3) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</div>
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad: true})</script>
</body>
</html>