<!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.31.1"> <meta name="project" content="Plausible v0.0.1"> <title>PlausibleWeb.AuthView — Plausible v0.0.1</title> <link rel="stylesheet" href="dist/html-elixir-FM2CSD74.css" /> <script src="dist/handlebars.runtime-NWIB6V2M.js"></script> <script src="dist/handlebars.templates-43PMFBC7.js"></script> <script src="dist/sidebar_items-4B488B2F.js"></script> <script src="docs_config.js"></script> <script async src="dist/html-L4O5OK2K.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 id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar"> <i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i> </button> <div class="background-layer"></div> <nav id="sidebar" class="sidebar"> <div class="sidebar-header"> <div class="sidebar-projectInfo"> <a href="readme.html" class="sidebar-projectImage"> <img src="assets/logo.png" alt="Plausible" /> </a> <div> <a href="readme.html" class="sidebar-projectName" translate="no"> Plausible </a> <div class="sidebar-projectVersion" translate="no"> v0.0.1 </div> </div> </div> <ul id="sidebar-listNav" class="sidebar-listNav" role="tablist"> <li> <button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0"> Pages </button> </li> <li> <button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1"> Modules </button> </li> <li> <button id="tasks-list-tab-button" role="tab" data-type="tasks" aria-controls="tasks-tab-panel" aria-selected="false" tabindex="-1"> <span translate="no">Mix</span> Tasks </button> </li> </ul> </div> <div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button"> <ul id="extras-full-list" class="full-list"></ul> </div> <div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden> <ul id="modules-full-list" class="full-list"></ul> </div> <div id="tasks-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="tasks-list-tab-button" hidden> <ul id="tasks-full-list" class="full-list"></ul> </div> </nav> <main class="content"> <output role="status" id="toast"></output> <div class="content-outer"> <div id="content" class="content-inner"> <div class="top-search"> <div class="search-settings"> <form class="search-bar" action="search.html"> <label class="search-label"> <span class="sr-only">Search documentation of Plausible</span> <input name="q" type="text" class="search-input" placeholder="Search Documentation (press /)" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" /> </label> <button type="submit" class="search-button" aria-label="Submit Search"> <i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i> </button> <button type="button" tabindex="-1" class="search-close-button" aria-hidden="true"> <i class="ri-close-line ri-lg" title="Cancel search"></i> </button> </form> <div class="autocomplete"> </div> <button class="icon-settings display-settings"> <i class="ri-settings-3-line"></i> <span class="sr-only">Settings</span> </button> </div> </div> <h1> <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> </a> <span class="text">Summary</span> </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="#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="#generate_2fa_recovery_codes.html/1" translate="no">generate_2fa_recovery_codes.html(assigns)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#initiate_2fa_setup.html/1" translate="no">initiate_2fa_setup.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_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="#present_subscription_status/1" translate="no">present_subscription_status(status)</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/2" translate="no">subscription_quota(subscription, options \\ [])</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 class="summary-row"> <div class="summary-signature"> <a href="#verify_2fa.html/1" translate="no">verify_2fa.html(assigns)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#verify_2fa_recovery_code.html/1" translate="no">verify_2fa_recovery_code.html(assigns)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#verify_2fa_setup.html/1" translate="no">verify_2fa_setup.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> </a> <span class="text">Functions</span> </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#L3" 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="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#L38" 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#L26" 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="generate_2fa_recovery_codes.html/1"> <div class="detail-header"> <a href="#generate_2fa_recovery_codes.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">generate_2fa_recovery_codes.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="initiate_2fa_setup.html/1"> <div class="detail-header"> <a href="#initiate_2fa_setup.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">initiate_2fa_setup.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_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="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#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"> <div class="specs"> <pre translate="no"><span class="attribute">@spec</span> present_subscription_status(<a href="Plausible.Billing.Subscription.Status.html#t:status/0">Plausible.Billing.Subscription.Status.status</a>()) :: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()</pre> </div> </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#L3" 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#L61" 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> subscription_colors(<a href="Plausible.Billing.Subscription.Status.html#t:status/0">Plausible.Billing.Subscription.Status.status</a>()) :: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()</pre> </div> </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#L22" 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/2"> <span id="subscription_quota/1"></span> <div class="detail-header"> <a href="#subscription_quota/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">subscription_quota(subscription, options \\ [])</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/auth_view.ex#L7" 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#L3" 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> <section class="detail" id="verify_2fa.html/1"> <div class="detail-header"> <a href="#verify_2fa.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">verify_2fa.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="verify_2fa_recovery_code.html/1"> <div class="detail-header"> <a href="#verify_2fa_recovery_code.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">verify_2fa_recovery_code.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="verify_2fa_setup.html/1"> <div class="detail-header"> <a href="#verify_2fa_setup.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">verify_2fa_setup.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.31.1) for the <a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a> </p> </footer> </div> </div> </main> </div> <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script> <script>mermaid.initialize({startOnLoad: true})</script> </body> </html>