analytics/PlausibleWeb.LayoutView.html

858 lines
26 KiB
HTML
Raw Normal View History

<!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.LayoutView — 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-679F5E33.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/layout_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.LayoutView</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="#app.html/1" translate="no">app.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#base_email.html/1" translate="no">base_email.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#base_error.html/1" translate="no">base_error.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#embedded.html/1" translate="no">embedded.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#feedback_link/1" translate="no">feedback_link(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#flat_settings_options/1" translate="no">flat_settings_options(conn)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#focus.html/1" translate="no">focus.html(assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#grace_period_end/1" translate="no">grace_period_end(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#home_dest/1" translate="no">home_dest(conn)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#is_current_tab/2" translate="no">is_current_tab(conn, tab)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#logo_path/1" translate="no">logo_path(filename)</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="#priority_email.html/1" translate="no">priority_email.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="#render_layout/3" translate="no">render_layout(layout, assigns, list)</a>
</div>
<div class="summary-synopsis"><p><a href="http://blog.plataformatec.com.br/2018/05/nested-layouts-with-phoenix/">http://blog.plataformatec.com.br/2018/05/nested-layouts-with-phoenix/</a></p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#settings_tabs/1" translate="no">settings_tabs(conn)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#site_settings.html/1" translate="no">site_settings.html(assigns)</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="#trial_notificaton/1" translate="no">trial_notificaton(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#websocket_url/0" translate="no">websocket_url()</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/layout_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="app.html/1">
<div class="detail-header">
<a href="#app.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">app.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_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_email.html/1">
<div class="detail-header">
<a href="#base_email.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">base_email.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_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_error.html/1">
<div class="detail-header">
<a href="#base_error.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">base_error.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_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="embedded.html/1">
<div class="detail-header">
<a href="#embedded.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">embedded.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_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="feedback_link/1">
<div class="detail-header">
<a href="#feedback_link/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">feedback_link(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_view.ex#L18" 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="flat_settings_options/1">
<div class="detail-header">
<a href="#flat_settings_options/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">flat_settings_options(conn)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_view.ex#L78" 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="focus.html/1">
<div class="detail-header">
<a href="#focus.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">focus.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_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="grace_period_end/1">
<div class="detail-header">
<a href="#grace_period_end/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">grace_period_end(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_view.ex#L106" 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="home_dest/1">
<div class="detail-header">
<a href="#home_dest/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">home_dest(conn)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_view.ex#L35" 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="is_current_tab/2">
<div class="detail-header">
<a href="#is_current_tab/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">is_current_tab(conn, tab)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_view.ex#L121" 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="logo_path/1">
<div class="detail-header">
<a href="#logo_path/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">logo_path(filename)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_view.ex#L43" 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/layout_view.ex#L6" 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="priority_email.html/1">
<div class="detail-header">
<a href="#priority_email.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">priority_email.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_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/layout_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="render_layout/3">
<div class="detail-header">
<a href="#render_layout/3" 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_layout(layout, assigns, list)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_view.ex#L117" 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><a href="http://blog.plataformatec.com.br/2018/05/nested-layouts-with-phoenix/">http://blog.plataformatec.com.br/2018/05/nested-layouts-with-phoenix/</a></p>
</section>
</section>
<section class="detail" id="settings_tabs/1">
<div class="detail-header">
<a href="#settings_tabs/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">settings_tabs(conn)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_view.ex#L51" 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="site_settings.html/1">
<div class="detail-header">
<a href="#site_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">site_settings.html(assigns)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_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="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/layout_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="trial_notificaton/1">
<div class="detail-header">
<a href="#trial_notificaton/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">trial_notificaton(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_view.ex#L93" 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="websocket_url/0">
<div class="detail-header">
<a href="#websocket_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">websocket_url()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/views/layout_view.ex#L10" 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>