deploy: eec73e9749
This commit is contained in:
448
api/mail/layout.ts/index.html
Normal file
448
api/mail/layout.ts/index.html
Normal file
@@ -0,0 +1,448 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>api/mail/layout.ts - gerbeur documentation</title>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="doc-current-file" content="">
|
||||
<link rel="stylesheet" href="../../../styles.css">
|
||||
<link rel="stylesheet" href="../../../page.css">
|
||||
<link id="ddocResetStylesheet" rel="stylesheet" href="../../../reset.css"><link href="../../../comrak.css" rel="stylesheet" /><link href="../../../prism.css" rel="stylesheet" /><script src="../../../prism.js"></script><script src="../../../script.js" defer></script>
|
||||
<script src="../../../darkmode_toggle.js"></script><script src="../../../search_index.js" defer></script>
|
||||
<script src="../../../fuse.js" defer></script>
|
||||
<script src="../../../search.js" defer></script></head>
|
||||
<body>
|
||||
<div class="ddoc">
|
||||
<div><nav id="topnav">
|
||||
<div class="h-full">
|
||||
<div class="flex items-center"><ul class="breadcrumbs">
|
||||
<li>
|
||||
<a href="../../../" class="contextLink">gerbeur</a>
|
||||
</li><span class="text-black dark:text-white"><svg
|
||||
width="16"
|
||||
height="16"
|
||||
viewBox="0 0 16 16"
|
||||
fill="none"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
fill-rule="evenodd"
|
||||
clip-rule="evenodd"
|
||||
d="M5.76748 11.8159C5.5378 11.577 5.54525 11.1972 5.78411 10.9675L8.93431 8L5.78411 5.0325C5.54525 4.80282 5.5378 4.423 5.76748 4.18413C5.99715 3.94527 6.37698 3.93782 6.61584 4.1675L10.2158 7.5675C10.3335 7.68062 10.4 7.83679 10.4 8C10.4 8.16321 10.3335 8.31938 10.2158 8.4325L6.61584 11.8325C6.37698 12.0622 5.99715 12.0547 5.76748 11.8159Z"
|
||||
fill="currentColor"
|
||||
/>
|
||||
</svg>
|
||||
</span>api/mail/layout.ts</ul>
|
||||
</div>
|
||||
|
||||
<div class="flex items-center gap-2">
|
||||
<button id="theme-toggle" type="button" aria-label="Toggle dark mode" style="display: none;"><svg
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
width="14"
|
||||
height="14"
|
||||
viewBox="0 0 24 24"
|
||||
fill="currentColor"
|
||||
>
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path
|
||||
d="M12 1.992a10 10 0 1 0 9.236 13.838c.341 -.82 -.476 -1.644 -1.298 -1.31a6.5 6.5 0 0 1 -6.864 -10.787l.077 -.08c.551 -.63 .113 -1.653 -.758 -1.653h-.266l-.068 -.006l-.06 -.002z"
|
||||
/>
|
||||
</svg>
|
||||
<svg
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
width="14"
|
||||
height="14"
|
||||
viewBox="0 0 24 24"
|
||||
fill="currentColor"
|
||||
class="hidden"
|
||||
>
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path
|
||||
d="M12 19a1 1 0 0 1 .993 .883l.007 .117v1a1 1 0 0 1 -1.993 .117l-.007 -.117v-1a1 1 0 0 1 1 -1z"
|
||||
/>
|
||||
<path
|
||||
d="M18.313 16.91l.094 .083l.7 .7a1 1 0 0 1 -1.32 1.497l-.094 -.083l-.7 -.7a1 1 0 0 1 1.218 -1.567l.102 .07z"
|
||||
/>
|
||||
<path
|
||||
d="M7.007 16.993a1 1 0 0 1 .083 1.32l-.083 .094l-.7 .7a1 1 0 0 1 -1.497 -1.32l.083 -.094l.7 -.7a1 1 0 0 1 1.414 0z"
|
||||
/>
|
||||
<path
|
||||
d="M4 11a1 1 0 0 1 .117 1.993l-.117 .007h-1a1 1 0 0 1 -.117 -1.993l.117 -.007h1z"
|
||||
/>
|
||||
<path
|
||||
d="M21 11a1 1 0 0 1 .117 1.993l-.117 .007h-1a1 1 0 0 1 -.117 -1.993l.117 -.007h1z"
|
||||
/>
|
||||
<path
|
||||
d="M6.213 4.81l.094 .083l.7 .7a1 1 0 0 1 -1.32 1.497l-.094 -.083l-.7 -.7a1 1 0 0 1 1.217 -1.567l.102 .07z"
|
||||
/>
|
||||
<path
|
||||
d="M19.107 4.893a1 1 0 0 1 .083 1.32l-.083 .094l-.7 .7a1 1 0 0 1 -1.497 -1.32l.083 -.094l.7 -.7a1 1 0 0 1 1.414 0z"
|
||||
/>
|
||||
<path
|
||||
d="M12 2a1 1 0 0 1 .993 .883l.007 .117v1a1 1 0 0 1 -1.993 .117l-.007 -.117v-1a1 1 0 0 1 1 -1z"
|
||||
/>
|
||||
<path
|
||||
d="M12 7a5 5 0 1 1 -4.995 5.217l-.005 -.217l.005 -.217a5 5 0 0 1 4.995 -4.783z"
|
||||
/>
|
||||
</svg>
|
||||
</button>
|
||||
|
||||
<input
|
||||
type="text"
|
||||
id="searchbar"
|
||||
style="display: none;"
|
||||
class="py-2 px-2.5 mx-1 rounded text-sm border border-gray-300 bg-transparent dark:bg-gray-800 dark:border-gray-700"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="searchResults"></div><div id="content">
|
||||
<main><section>
|
||||
<div class="space-y-2 flex-1"><div class="space-y-7" id="module_doc"><div class="markdown"><p>Every email the site sends shares one layout: the site's emoji and name,
|
||||
then a card holding the content, then a footer. The templates beside this
|
||||
module (welcome, password reset, digest) build their content with an
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html">EmailKit</a>, which draws each block in a style from <code>styles.ts</code>, and
|
||||
<code>email-service.ts</code> sends what they return.</p>
|
||||
<p>Mail clients drop stylesheets, so every block carries inline styles. A
|
||||
reader on the "auto" scheme gets the light palette inline and the dark one
|
||||
in a <code>prefers-color-scheme</code> block that Apple's mail apps honour; elsewhere
|
||||
the light one shows.</p>
|
||||
</div><section class="section" id="api/mail/layout_ts_classes"><div>
|
||||
<h2 class="anchorable mb-1"><a href="#api/mail/layout_ts_classes" class="anchor" aria-label="Anchor" tabIndex="-1"><svg
|
||||
width="16"
|
||||
height="16"
|
||||
viewBox="0 0 14 14"
|
||||
fill="none"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<g clip-path="url(#clip0_1081_1237)">
|
||||
<path
|
||||
fill-rule="evenodd"
|
||||
clip-rule="evenodd"
|
||||
d="M6.80328 2.8656C6.68736 2.99 6.62425 3.15454 6.62725 3.32456C6.63025 3.49457 6.69913 3.65678 6.81936 3.77702C6.9396 3.89725 7.10181 3.96613 7.27182 3.96913C7.44184 3.97213 7.60638 3.90902 7.73078 3.7931L8.82453 2.69935C8.98712 2.53676 9.18015 2.40778 9.39259 2.31978C9.60503 2.23179 9.83272 2.1865 10.0627 2.1865C10.2926 2.1865 10.5203 2.23179 10.7327 2.31978C10.9452 2.40778 11.1382 2.53676 11.3008 2.69935C11.4634 2.86194 11.5923 3.05497 11.6803 3.2674C11.7683 3.47984 11.8136 3.70753 11.8136 3.93747C11.8136 4.16741 11.7683 4.3951 11.6803 4.60754C11.5923 4.81998 11.4634 5.013 11.3008 5.1756L9.11328 7.3631C8.95075 7.52581 8.75775 7.65488 8.5453 7.74295C8.33285 7.83102 8.10513 7.87635 7.87516 7.87635C7.64518 7.87635 7.41746 7.83102 7.20501 7.74295C6.99256 7.65488 6.79956 7.52581 6.63703 7.3631C6.51263 7.24718 6.34809 7.18407 6.17807 7.18707C6.00806 7.19007 5.84585 7.25894 5.72561 7.37918C5.60538 7.49942 5.5365 7.66163 5.5335 7.83164C5.5305 8.00165 5.59361 8.1662 5.70953 8.2906C5.99391 8.57501 6.33154 8.80062 6.70312 8.95455C7.0747 9.10847 7.47296 9.18769 7.87516 9.18769C8.27736 9.18769 8.67562 9.10847 9.0472 8.95455C9.41878 8.80062 9.7564 8.57501 10.0408 8.2906L12.2283 6.1031C12.8026 5.52874 13.1253 4.74974 13.1253 3.93747C13.1253 3.12521 12.8026 2.34621 12.2283 1.77185C11.6539 1.19749 10.8749 0.874817 10.0627 0.874817C9.25039 0.874817 8.47139 1.19749 7.89703 1.77185L6.80328 2.8656ZM2.69953 11.3006C2.53682 11.1381 2.40774 10.9451 2.31968 10.7326C2.23161 10.5202 2.18628 10.2924 2.18628 10.0625C2.18628 9.8325 2.23161 9.60477 2.31968 9.39233C2.40774 9.17988 2.53682 8.98688 2.69953 8.82435L4.88703 6.63685C5.04956 6.47414 5.24256 6.34506 5.45501 6.25699C5.66746 6.16893 5.89518 6.1236 6.12516 6.1236C6.35513 6.1236 6.58285 6.16893 6.7953 6.25699C7.00775 6.34506 7.20075 6.47414 7.36328 6.63685C7.48768 6.75277 7.65223 6.81588 7.82224 6.81288C7.99225 6.80988 8.15446 6.741 8.2747 6.62077C8.39494 6.50053 8.46381 6.33832 8.46681 6.1683C8.46981 5.99829 8.4067 5.83375 8.29078 5.70935C8.0064 5.42494 7.66878 5.19933 7.2972 5.0454C6.92562 4.89148 6.52736 4.81225 6.12516 4.81225C5.72296 4.81225 5.3247 4.89148 4.95312 5.0454C4.58154 5.19933 4.24391 5.42494 3.95953 5.70935L1.77203 7.89685C1.19767 8.47121 0.875 9.25021 0.875 10.0625C0.875 10.8747 1.19767 11.6537 1.77203 12.2281C2.34639 12.8025 3.12539 13.1251 3.93766 13.1251C4.74992 13.1251 5.52892 12.8025 6.10328 12.2281L7.19703 11.1343C7.31295 11.0099 7.37606 10.8454 7.37306 10.6754C7.37006 10.5054 7.30119 10.3432 7.18095 10.2229C7.06071 10.1027 6.8985 10.0338 6.72849 10.0308C6.55848 10.0278 6.39393 10.0909 6.26953 10.2068L5.17578 11.3006C5.01325 11.4633 4.82025 11.5924 4.6078 11.6805C4.39535 11.7685 4.16763 11.8138 3.93766 11.8138C3.70768 11.8138 3.47996 11.7685 3.26751 11.6805C3.05506 11.5924 2.86206 11.4633 2.69953 11.3006Z"
|
||||
fill="currentColor"
|
||||
/>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id="clip0_1081_1237">
|
||||
<rect width="14" height="14" fill="white" />
|
||||
</clipPath>
|
||||
</defs>
|
||||
</svg>
|
||||
</a>
|
||||
Classes</h2></div><div class="namespaceSection"><div id="namespace_emailkit" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Class bg-Class/15 dark:text-ClassDark dark:bg-ClassDark/15" title="Class">c</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html" title="EmailKit">
|
||||
<span>EmailKit</span><span>(<span><span>look<span>: <span class="td-ref">EmailLook</span></span></span></span>)</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Draws an email in one <a href="../../.././api/mail/layout.ts/~/EmailLook.html">EmailLook</a>. A template writes the email as
|
||||
Markdown and hands it to EmailKit.render, which draws each block in
|
||||
the style. The block methods return HTML: text passed to them must already
|
||||
be escaped with <a href="../../.././api/mail/layout.ts/~/esc.html">esc</a>.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_blocks_0">
|
||||
<span>blocks</span><span>(<span><span>tokens<span>: <span class="td-ref">Token</span>[]</span></span></span>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Draws the body's blocks, gathering each <code>##</code> section with its content.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_button_0">
|
||||
<span>button</span><span>(<div class="ml-4"><div><span>label<span>: <span class="td-kw">string</span></span></span>,</div><div><span>href<span>: <span class="td-kw">string</span></span></span></div></div>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns a button linking to <code>href</code>.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_darkcss_0">
|
||||
<span>darkCss</span><span>()<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns the CSS that recolors every painted element in dark mode, or
|
||||
nothing off the "auto" scheme.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#property_darkpalette">
|
||||
<span>darkPalette</span><span>: <span><span class="td-ref">EmailPalette</span><span class="td-op"> | </span><span class="td-kw">null</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>The palette that replaces it in dark mode, on the "auto" scheme only.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_document_0">
|
||||
<span>document</span><span>(<span><span><span class="italic">unnamed 0</span><span>: { subject<span>: <span class="td-kw">string</span></span>; preheader<span>: <span class="td-kw">string</span></span>; body<span>: <span class="td-kw">string</span></span>; footer<span>: <span class="td-kw">string</span></span>; }</span></span></span>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns the whole HTML document: the brand, the card holding <code>body</code>, and
|
||||
the <code>footer</code>. <code>preheader</code> is the hidden first line inboxes show beside the
|
||||
subject.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_eyebrow_0">
|
||||
<span>eyebrow</span><span>(<span><span>html<span>: <span class="td-kw">string</span></span></span></span>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns the small uppercase line above the heading.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#property_font">
|
||||
<span>font</span><span>: <span class="td-kw">string</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>The font stack, for templates that set their own blocks.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_fs_0">
|
||||
<span>fs</span><span>(<span><span>px<span>: <span class="td-kw">number</span></span></span></span>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns <code>px</code>, scaled for the style, as a CSS length.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_heading_0">
|
||||
<span>heading</span><span>(<div class="ml-4"><div><span>html<span>: <span class="td-kw">string</span></span></span>,</div><div><span>marginBottom<span class="td-op">?</span><span>: <span class="td-kw">number</span></span></span></div></div>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns the email's heading, in the style's title type.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_image_0">
|
||||
<span>image</span><span>(<div class="ml-4"><div><span>src<span>: <span class="td-kw">string</span></span></span>,</div><div><span>alt<span>: <span class="td-kw">string</span></span></span>,</div><div><span>width<span>: <span class="td-kw">number</span></span></span>,</div><div><span>height<span>: <span class="td-kw">number</span></span></span>,</div><div><span>href<span class="td-op">?</span><span>: <span class="td-kw">string</span></span></span></div></div>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns an image block, rounded as the style rounds images.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_inline_0">
|
||||
<span>inline</span><span>(<div class="ml-4"><div><span>tokens<span>: <span class="td-ref">Token</span>[]</span></span>,</div><div><span>mode<span>: <span class="td-ref">EmailKit</span>[<span class="td-str">"mode"</span>]</span></span></div></div>)<span>: <span class="td-kw">string</span></span></span></a></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_link_0">
|
||||
<span>link</span><span>(<div class="ml-4"><div><span>html<span>: <span class="td-kw">string</span></span></span>,</div><div><span>href<span>: <span class="td-kw">string</span></span></span>,</div><div><span>strong<span class="td-op">?</span><span>: <span class="td-kw">boolean</span></span></span></div></div>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns a link to <code>href</code> around <code>html</code>, in the link color.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_linkbox_0">
|
||||
<span>linkBox</span><span>(<span><span>html<span>: <span class="td-kw">string</span></span></span></span>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns a raw link set in a box, for clients that break buttons.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_list_0">
|
||||
<span>list</span><span>(<span><span>list<span>: <span class="td-ref">Tokens.List</span></span></span></span>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Draws a list as rows, ranked when it is numbered.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#property_marked">
|
||||
<span>marked</span><span>: <span class="td-ref">Marked</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Draws Markdown's inline tokens with the kit's colors.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#property_mode">
|
||||
<span>mode</span><span>: <span><span class="td-str">"text"</span><span class="td-op"> | </span><span class="td-str">"footer"</span><span class="td-op"> | </span><span class="td-str">"row"</span><span class="td-op"> | </span><span class="td-str">"sentence"</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>How inline draws emphasis and links, by where they sit.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_note_0">
|
||||
<span>note</span><span>(<div class="ml-4"><div><span>html<span>: <span class="td-kw">string</span></span></span>,</div><div><span>css<span class="td-op">?</span><span>: <span class="td-kw">string</span></span></span></div></div>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns a smaller paragraph in the muted color.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_paint_0">
|
||||
<span>paint</span><span>(<div class="ml-4"><div><span>roles<span>: { fg<span class="td-op">?</span><span>: <span class="td-ref">PaletteRole</span></span>; bg<span class="td-op">?</span><span>: <span class="td-ref">PaletteRole</span></span>; bd<span class="td-op">?</span><span>: <span class="td-ref">PaletteRole</span></span>; extra<span class="td-op">?</span><span>: <span class="td-kw">string</span>[]</span>; }</span></span>,</div><div><span>css<span class="td-op">?</span><span>: <span class="td-kw">string</span></span></span></div></div>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns the <code>class</code> and <code>style</code> attributes of an element colored by
|
||||
roles: <code>fg</code> for its text, <code>bg</code> for its fill, <code>bd</code> for its border. The
|
||||
classes let the dark block recolor it; <code>css</code> is the rest of its style.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#property_palette">
|
||||
<span>palette</span><span>: <span class="td-ref">EmailPalette</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>The palette inlined into the HTML.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_para_0">
|
||||
<span>para</span><span>(<div class="ml-4"><div><span>html<span>: <span class="td-kw">string</span></span></span>,</div><div><span>css<span class="td-op">?</span><span>: <span class="td-kw">string</span></span></span></div></div>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns a paragraph. <code>css</code> adds to or overrides its style.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_pill_0">
|
||||
<span>pill</span><span>(<span><span>label<span>: <span class="td-kw">string</span></span></span></span>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns a small uppercase pill, as on one's own dump in a list.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_quote_0">
|
||||
<span>quote</span><span>(<span><span>html<span>: <span class="td-kw">string</span></span></span></span>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns a quoted comment or message.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_render_0">
|
||||
<span>render</span><span>(<span><span><span class="italic">unnamed 0</span><span>: { subject<span>: <span class="td-kw">string</span></span>; preheader<span>: <span class="td-kw">string</span></span>; markdown<span>: <span class="td-kw">string</span></span>; }</span></span></span>)<span>: <span class="td-ref">RenderedEmail</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns the email written as <code>markdown</code>: the Markdown itself is the
|
||||
plain-text part, and its blocks, drawn in this kit's style, are the HTML.
|
||||
Each template writes its email once this way. The blocks map as follows.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_section_0">
|
||||
<span>section</span><span>(<div class="ml-4"><div><span>title<span>: <span class="td-kw">string</span></span></span>,</div><div><span>html<span>: <span class="td-kw">string</span></span></span>,</div><div><span>first<span class="td-op">?</span><span>: <span class="td-kw">boolean</span></span></span></div></div>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns a section of the card: a divider in the style's rule (none before
|
||||
the first), an uppercase title in the accent color, and <code>html</code>.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#property_style">
|
||||
<span>style</span><span>: <span class="td-ref">EmailStyle</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>The style being drawn.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailKit.html#method_subhead_0">
|
||||
<span>subhead</span><span>(<span><span>html<span>: <span class="td-kw">string</span></span></span></span>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns a small bold heading inside a section.</p>
|
||||
</div></div></li></ul></div>
|
||||
</div></div>
|
||||
</section>
|
||||
<section class="section" id="api/mail/layout_ts_functions"><div>
|
||||
<h2 class="anchorable mb-1"><a href="#api/mail/layout_ts_functions" class="anchor" aria-label="Anchor" tabIndex="-1"><svg
|
||||
width="16"
|
||||
height="16"
|
||||
viewBox="0 0 14 14"
|
||||
fill="none"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<g clip-path="url(#clip0_1081_1237)">
|
||||
<path
|
||||
fill-rule="evenodd"
|
||||
clip-rule="evenodd"
|
||||
d="M6.80328 2.8656C6.68736 2.99 6.62425 3.15454 6.62725 3.32456C6.63025 3.49457 6.69913 3.65678 6.81936 3.77702C6.9396 3.89725 7.10181 3.96613 7.27182 3.96913C7.44184 3.97213 7.60638 3.90902 7.73078 3.7931L8.82453 2.69935C8.98712 2.53676 9.18015 2.40778 9.39259 2.31978C9.60503 2.23179 9.83272 2.1865 10.0627 2.1865C10.2926 2.1865 10.5203 2.23179 10.7327 2.31978C10.9452 2.40778 11.1382 2.53676 11.3008 2.69935C11.4634 2.86194 11.5923 3.05497 11.6803 3.2674C11.7683 3.47984 11.8136 3.70753 11.8136 3.93747C11.8136 4.16741 11.7683 4.3951 11.6803 4.60754C11.5923 4.81998 11.4634 5.013 11.3008 5.1756L9.11328 7.3631C8.95075 7.52581 8.75775 7.65488 8.5453 7.74295C8.33285 7.83102 8.10513 7.87635 7.87516 7.87635C7.64518 7.87635 7.41746 7.83102 7.20501 7.74295C6.99256 7.65488 6.79956 7.52581 6.63703 7.3631C6.51263 7.24718 6.34809 7.18407 6.17807 7.18707C6.00806 7.19007 5.84585 7.25894 5.72561 7.37918C5.60538 7.49942 5.5365 7.66163 5.5335 7.83164C5.5305 8.00165 5.59361 8.1662 5.70953 8.2906C5.99391 8.57501 6.33154 8.80062 6.70312 8.95455C7.0747 9.10847 7.47296 9.18769 7.87516 9.18769C8.27736 9.18769 8.67562 9.10847 9.0472 8.95455C9.41878 8.80062 9.7564 8.57501 10.0408 8.2906L12.2283 6.1031C12.8026 5.52874 13.1253 4.74974 13.1253 3.93747C13.1253 3.12521 12.8026 2.34621 12.2283 1.77185C11.6539 1.19749 10.8749 0.874817 10.0627 0.874817C9.25039 0.874817 8.47139 1.19749 7.89703 1.77185L6.80328 2.8656ZM2.69953 11.3006C2.53682 11.1381 2.40774 10.9451 2.31968 10.7326C2.23161 10.5202 2.18628 10.2924 2.18628 10.0625C2.18628 9.8325 2.23161 9.60477 2.31968 9.39233C2.40774 9.17988 2.53682 8.98688 2.69953 8.82435L4.88703 6.63685C5.04956 6.47414 5.24256 6.34506 5.45501 6.25699C5.66746 6.16893 5.89518 6.1236 6.12516 6.1236C6.35513 6.1236 6.58285 6.16893 6.7953 6.25699C7.00775 6.34506 7.20075 6.47414 7.36328 6.63685C7.48768 6.75277 7.65223 6.81588 7.82224 6.81288C7.99225 6.80988 8.15446 6.741 8.2747 6.62077C8.39494 6.50053 8.46381 6.33832 8.46681 6.1683C8.46981 5.99829 8.4067 5.83375 8.29078 5.70935C8.0064 5.42494 7.66878 5.19933 7.2972 5.0454C6.92562 4.89148 6.52736 4.81225 6.12516 4.81225C5.72296 4.81225 5.3247 4.89148 4.95312 5.0454C4.58154 5.19933 4.24391 5.42494 3.95953 5.70935L1.77203 7.89685C1.19767 8.47121 0.875 9.25021 0.875 10.0625C0.875 10.8747 1.19767 11.6537 1.77203 12.2281C2.34639 12.8025 3.12539 13.1251 3.93766 13.1251C4.74992 13.1251 5.52892 12.8025 6.10328 12.2281L7.19703 11.1343C7.31295 11.0099 7.37606 10.8454 7.37306 10.6754C7.37006 10.5054 7.30119 10.3432 7.18095 10.2229C7.06071 10.1027 6.8985 10.0338 6.72849 10.0308C6.55848 10.0278 6.39393 10.0909 6.26953 10.2068L5.17578 11.3006C5.01325 11.4633 4.82025 11.5924 4.6078 11.6805C4.39535 11.7685 4.16763 11.8138 3.93766 11.8138C3.70768 11.8138 3.47996 11.7685 3.26751 11.6805C3.05506 11.5924 2.86206 11.4633 2.69953 11.3006Z"
|
||||
fill="currentColor"
|
||||
/>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id="clip0_1081_1237">
|
||||
<rect width="14" height="14" fill="white" />
|
||||
</clipPath>
|
||||
</defs>
|
||||
</svg>
|
||||
</a>
|
||||
Functions</h2></div><div class="namespaceSection"><div id="namespace_esc" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Function bg-Function/15 dark:text-FunctionDark dark:bg-FunctionDark/15" title="Function">f</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../../.././api/mail/layout.ts/~/esc.html" title="esc">
|
||||
<span>esc</span><span>(<span><span>value<span>: <span class="td-kw">string</span></span></span></span>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Escapes <code>value</code> for HTML text and attributes. Everything users wrote (names,
|
||||
titles, quotes) goes through it, since none of it may become markup.</p>
|
||||
</div></div></div>
|
||||
</div><div id="namespace_escmd" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Function bg-Function/15 dark:text-FunctionDark dark:bg-FunctionDark/15" title="Function">f</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../../.././api/mail/layout.ts/~/escMd.html" title="escMd">
|
||||
<span>escMd</span><span>(<span><span>value<span>: <span class="td-kw">string</span></span></span></span>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Escapes <code>value</code> for Markdown, so that user text in a plain-text part (a
|
||||
title with <code>*</code> or <code>[</code>, say) stays text.</p>
|
||||
</div></div></div>
|
||||
</div><div id="namespace_lookof" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Function bg-Function/15 dark:text-FunctionDark dark:bg-FunctionDark/15" title="Function">f</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../../.././api/mail/layout.ts/~/lookOf.html" title="lookOf">
|
||||
<span>lookOf</span><span>(<span><span>settings<span class="td-op">?</span><span>: <span><span class="td-ref">Pick</span><<span class="td-ref">UserSettings</span><span>, </span><span><span class="td-str">"style"</span><span class="td-op"> | </span><span class="td-str">"colorScheme"</span></span>><span class="td-op"> | </span><span class="td-kw">null</span></span></span></span></span>)<span>: <span class="td-ref">EmailLook</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns the look of a reader's settings. An unset style is the instance's,
|
||||
as on the site, and an unset scheme the system's; with no settings at all,
|
||||
as for the welcome and reset emails, both are.</p>
|
||||
</div></div></div>
|
||||
</div><div id="namespace_mdlink" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Function bg-Function/15 dark:text-FunctionDark dark:bg-FunctionDark/15" title="Function">f</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../../.././api/mail/layout.ts/~/mdLink.html" title="mdLink">
|
||||
<span>mdLink</span><span>(<div class="ml-4"><div><span>text<span>: <span class="td-kw">string</span></span></span>,</div><div><span>url<span>: <span class="td-kw">string</span></span></span></div></div>)<span>: <span class="td-kw">string</span></span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returns a Markdown link to <code>url</code> labelled with <code>text</code>, escaped.</p>
|
||||
</div></div></div>
|
||||
</div></div>
|
||||
</section>
|
||||
<section class="section" id="api/mail/layout_ts_interfaces"><div>
|
||||
<h2 class="anchorable mb-1"><a href="#api/mail/layout_ts_interfaces" class="anchor" aria-label="Anchor" tabIndex="-1"><svg
|
||||
width="16"
|
||||
height="16"
|
||||
viewBox="0 0 14 14"
|
||||
fill="none"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<g clip-path="url(#clip0_1081_1237)">
|
||||
<path
|
||||
fill-rule="evenodd"
|
||||
clip-rule="evenodd"
|
||||
d="M6.80328 2.8656C6.68736 2.99 6.62425 3.15454 6.62725 3.32456C6.63025 3.49457 6.69913 3.65678 6.81936 3.77702C6.9396 3.89725 7.10181 3.96613 7.27182 3.96913C7.44184 3.97213 7.60638 3.90902 7.73078 3.7931L8.82453 2.69935C8.98712 2.53676 9.18015 2.40778 9.39259 2.31978C9.60503 2.23179 9.83272 2.1865 10.0627 2.1865C10.2926 2.1865 10.5203 2.23179 10.7327 2.31978C10.9452 2.40778 11.1382 2.53676 11.3008 2.69935C11.4634 2.86194 11.5923 3.05497 11.6803 3.2674C11.7683 3.47984 11.8136 3.70753 11.8136 3.93747C11.8136 4.16741 11.7683 4.3951 11.6803 4.60754C11.5923 4.81998 11.4634 5.013 11.3008 5.1756L9.11328 7.3631C8.95075 7.52581 8.75775 7.65488 8.5453 7.74295C8.33285 7.83102 8.10513 7.87635 7.87516 7.87635C7.64518 7.87635 7.41746 7.83102 7.20501 7.74295C6.99256 7.65488 6.79956 7.52581 6.63703 7.3631C6.51263 7.24718 6.34809 7.18407 6.17807 7.18707C6.00806 7.19007 5.84585 7.25894 5.72561 7.37918C5.60538 7.49942 5.5365 7.66163 5.5335 7.83164C5.5305 8.00165 5.59361 8.1662 5.70953 8.2906C5.99391 8.57501 6.33154 8.80062 6.70312 8.95455C7.0747 9.10847 7.47296 9.18769 7.87516 9.18769C8.27736 9.18769 8.67562 9.10847 9.0472 8.95455C9.41878 8.80062 9.7564 8.57501 10.0408 8.2906L12.2283 6.1031C12.8026 5.52874 13.1253 4.74974 13.1253 3.93747C13.1253 3.12521 12.8026 2.34621 12.2283 1.77185C11.6539 1.19749 10.8749 0.874817 10.0627 0.874817C9.25039 0.874817 8.47139 1.19749 7.89703 1.77185L6.80328 2.8656ZM2.69953 11.3006C2.53682 11.1381 2.40774 10.9451 2.31968 10.7326C2.23161 10.5202 2.18628 10.2924 2.18628 10.0625C2.18628 9.8325 2.23161 9.60477 2.31968 9.39233C2.40774 9.17988 2.53682 8.98688 2.69953 8.82435L4.88703 6.63685C5.04956 6.47414 5.24256 6.34506 5.45501 6.25699C5.66746 6.16893 5.89518 6.1236 6.12516 6.1236C6.35513 6.1236 6.58285 6.16893 6.7953 6.25699C7.00775 6.34506 7.20075 6.47414 7.36328 6.63685C7.48768 6.75277 7.65223 6.81588 7.82224 6.81288C7.99225 6.80988 8.15446 6.741 8.2747 6.62077C8.39494 6.50053 8.46381 6.33832 8.46681 6.1683C8.46981 5.99829 8.4067 5.83375 8.29078 5.70935C8.0064 5.42494 7.66878 5.19933 7.2972 5.0454C6.92562 4.89148 6.52736 4.81225 6.12516 4.81225C5.72296 4.81225 5.3247 4.89148 4.95312 5.0454C4.58154 5.19933 4.24391 5.42494 3.95953 5.70935L1.77203 7.89685C1.19767 8.47121 0.875 9.25021 0.875 10.0625C0.875 10.8747 1.19767 11.6537 1.77203 12.2281C2.34639 12.8025 3.12539 13.1251 3.93766 13.1251C4.74992 13.1251 5.52892 12.8025 6.10328 12.2281L7.19703 11.1343C7.31295 11.0099 7.37606 10.8454 7.37306 10.6754C7.37006 10.5054 7.30119 10.3432 7.18095 10.2229C7.06071 10.1027 6.8985 10.0338 6.72849 10.0308C6.55848 10.0278 6.39393 10.0909 6.26953 10.2068L5.17578 11.3006C5.01325 11.4633 4.82025 11.5924 4.6078 11.6805C4.39535 11.7685 4.16763 11.8138 3.93766 11.8138C3.70768 11.8138 3.47996 11.7685 3.26751 11.6805C3.05506 11.5924 2.86206 11.4633 2.69953 11.3006Z"
|
||||
fill="currentColor"
|
||||
/>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id="clip0_1081_1237">
|
||||
<rect width="14" height="14" fill="white" />
|
||||
</clipPath>
|
||||
</defs>
|
||||
</svg>
|
||||
</a>
|
||||
Interfaces</h2></div><div class="namespaceSection"><div id="namespace_emaillook" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailLook.html" title="EmailLook">
|
||||
<span>EmailLook</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Passed to <a href="../../.././api/mail/layout.ts/~/EmailKit.html">EmailKit</a>, made by <a href="../../.././api/mail/layout.ts/~/lookOf.html">lookOf</a>: the instance's style for
|
||||
the emails that aren't a user's own, their settings for a digest.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailLook.html#property_scheme">
|
||||
<span>scheme</span><span>: <span class="td-ref">ColorScheme</span></span></a></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/EmailLook.html#property_style">
|
||||
<span>style</span><span>: <span class="td-ref">StyleName</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_renderedemail" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../../.././api/mail/layout.ts/~/RenderedEmail.html" title="RenderedEmail">
|
||||
<span>RenderedEmail</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Returned by each template to its caller, which hands it to <code>sendEmail</code>
|
||||
with a recipient.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/RenderedEmail.html#property_html">
|
||||
<span>html</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/RenderedEmail.html#property_subject">
|
||||
<span>subject</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../../.././api/mail/layout.ts/~/RenderedEmail.html#property_text">
|
||||
<span>text</span><span>: <span class="td-kw">string</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>The plain-text part, for clients that show no HTML. It is Markdown, so it
|
||||
reads as text and renders as the email's outline.</p>
|
||||
</div></div></li></ul></div>
|
||||
</div></div>
|
||||
</section>
|
||||
<section class="section" id="api/mail/layout_ts_type-aliases"><div>
|
||||
<h2 class="anchorable mb-1"><a href="#api/mail/layout_ts_type-aliases" class="anchor" aria-label="Anchor" tabIndex="-1"><svg
|
||||
width="16"
|
||||
height="16"
|
||||
viewBox="0 0 14 14"
|
||||
fill="none"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<g clip-path="url(#clip0_1081_1237)">
|
||||
<path
|
||||
fill-rule="evenodd"
|
||||
clip-rule="evenodd"
|
||||
d="M6.80328 2.8656C6.68736 2.99 6.62425 3.15454 6.62725 3.32456C6.63025 3.49457 6.69913 3.65678 6.81936 3.77702C6.9396 3.89725 7.10181 3.96613 7.27182 3.96913C7.44184 3.97213 7.60638 3.90902 7.73078 3.7931L8.82453 2.69935C8.98712 2.53676 9.18015 2.40778 9.39259 2.31978C9.60503 2.23179 9.83272 2.1865 10.0627 2.1865C10.2926 2.1865 10.5203 2.23179 10.7327 2.31978C10.9452 2.40778 11.1382 2.53676 11.3008 2.69935C11.4634 2.86194 11.5923 3.05497 11.6803 3.2674C11.7683 3.47984 11.8136 3.70753 11.8136 3.93747C11.8136 4.16741 11.7683 4.3951 11.6803 4.60754C11.5923 4.81998 11.4634 5.013 11.3008 5.1756L9.11328 7.3631C8.95075 7.52581 8.75775 7.65488 8.5453 7.74295C8.33285 7.83102 8.10513 7.87635 7.87516 7.87635C7.64518 7.87635 7.41746 7.83102 7.20501 7.74295C6.99256 7.65488 6.79956 7.52581 6.63703 7.3631C6.51263 7.24718 6.34809 7.18407 6.17807 7.18707C6.00806 7.19007 5.84585 7.25894 5.72561 7.37918C5.60538 7.49942 5.5365 7.66163 5.5335 7.83164C5.5305 8.00165 5.59361 8.1662 5.70953 8.2906C5.99391 8.57501 6.33154 8.80062 6.70312 8.95455C7.0747 9.10847 7.47296 9.18769 7.87516 9.18769C8.27736 9.18769 8.67562 9.10847 9.0472 8.95455C9.41878 8.80062 9.7564 8.57501 10.0408 8.2906L12.2283 6.1031C12.8026 5.52874 13.1253 4.74974 13.1253 3.93747C13.1253 3.12521 12.8026 2.34621 12.2283 1.77185C11.6539 1.19749 10.8749 0.874817 10.0627 0.874817C9.25039 0.874817 8.47139 1.19749 7.89703 1.77185L6.80328 2.8656ZM2.69953 11.3006C2.53682 11.1381 2.40774 10.9451 2.31968 10.7326C2.23161 10.5202 2.18628 10.2924 2.18628 10.0625C2.18628 9.8325 2.23161 9.60477 2.31968 9.39233C2.40774 9.17988 2.53682 8.98688 2.69953 8.82435L4.88703 6.63685C5.04956 6.47414 5.24256 6.34506 5.45501 6.25699C5.66746 6.16893 5.89518 6.1236 6.12516 6.1236C6.35513 6.1236 6.58285 6.16893 6.7953 6.25699C7.00775 6.34506 7.20075 6.47414 7.36328 6.63685C7.48768 6.75277 7.65223 6.81588 7.82224 6.81288C7.99225 6.80988 8.15446 6.741 8.2747 6.62077C8.39494 6.50053 8.46381 6.33832 8.46681 6.1683C8.46981 5.99829 8.4067 5.83375 8.29078 5.70935C8.0064 5.42494 7.66878 5.19933 7.2972 5.0454C6.92562 4.89148 6.52736 4.81225 6.12516 4.81225C5.72296 4.81225 5.3247 4.89148 4.95312 5.0454C4.58154 5.19933 4.24391 5.42494 3.95953 5.70935L1.77203 7.89685C1.19767 8.47121 0.875 9.25021 0.875 10.0625C0.875 10.8747 1.19767 11.6537 1.77203 12.2281C2.34639 12.8025 3.12539 13.1251 3.93766 13.1251C4.74992 13.1251 5.52892 12.8025 6.10328 12.2281L7.19703 11.1343C7.31295 11.0099 7.37606 10.8454 7.37306 10.6754C7.37006 10.5054 7.30119 10.3432 7.18095 10.2229C7.06071 10.1027 6.8985 10.0338 6.72849 10.0308C6.55848 10.0278 6.39393 10.0909 6.26953 10.2068L5.17578 11.3006C5.01325 11.4633 4.82025 11.5924 4.6078 11.6805C4.39535 11.7685 4.16763 11.8138 3.93766 11.8138C3.70768 11.8138 3.47996 11.7685 3.26751 11.6805C3.05506 11.5924 2.86206 11.4633 2.69953 11.3006Z"
|
||||
fill="currentColor"
|
||||
/>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id="clip0_1081_1237">
|
||||
<rect width="14" height="14" fill="white" />
|
||||
</clipPath>
|
||||
</defs>
|
||||
</svg>
|
||||
</a>
|
||||
Type Aliases</h2></div><div class="namespaceSection"><div id="namespace_paletterole" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-TypeAlias bg-TypeAlias/15 dark:text-TypeAliasDark dark:bg-TypeAliasDark/15" title="Type Alias">T</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../../.././api/mail/layout.ts/~/PaletteRole.html" title="PaletteRole">
|
||||
<span>PaletteRole</span><span> = <span class="td-ref">Exclude</span><<span class="td-kw">keyof</span> <span class="td-ref">EmailPalette</span><span>, </span><span class="td-str">"gradient"</span>></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Names a color of an <a href="../../.././api/mail/styles.ts/~/EmailPalette.html">EmailPalette</a>, as EmailKit.paint takes
|
||||
it, so that the dark block can recolor the element by the same name.</p>
|
||||
</div></div></div>
|
||||
</div></div>
|
||||
</section>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</main><div class="toc">
|
||||
<div><div class="usageContent">
|
||||
<h3>Usage</h3><div class="markdown"><pre class="highlight"><code class="language-typescript">import * as mod from "api/mail/layout.ts";
|
||||
</code><button class="copyButton" data-copy="import * as mod from "api/mail/layout.ts";
|
||||
"><svg
|
||||
class="copy"
|
||||
width="15"
|
||||
height="15"
|
||||
viewBox="0 0 15 15"
|
||||
fill="none"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<rect x="2" y="2" width="7" height="7" fill="none" />
|
||||
<rect x="6" y="6" width="7" height="7" fill="none" />
|
||||
<path
|
||||
d="M1.55566 2.7C1.55566 2.03726 2.09292 1.5 2.75566 1.5H8.75566C9.41841 1.5 9.95566 2.03726 9.95566 2.7V5.1H12.3557C13.0184 5.1 13.5557 5.63726 13.5557 6.3V12.3C13.5557 12.9627 13.0184 13.5 12.3557 13.5H6.35566C5.69292 13.5 5.15566 12.9627 5.15566 12.3V9.9H2.75566C2.09292 9.9 1.55566 9.36274 1.55566 8.7V2.7ZM6.35566 9.9V12.3H12.3557V6.3H9.95566V8.7C9.95566 9.36274 9.41841 9.9 8.75566 9.9H6.35566ZM8.75566 8.7V2.7H2.75566V8.7H8.75566Z"
|
||||
fill="currentColor"
|
||||
/>
|
||||
</svg>
|
||||
<svg
|
||||
class="check"
|
||||
width="15"
|
||||
height="15"
|
||||
viewBox="0 0 24 24"
|
||||
stroke-width="2"
|
||||
stroke="currentColor"
|
||||
fill="none"
|
||||
stroke-linecap="round"
|
||||
stroke-linejoin="round"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M5 12l5 5l10 -10" />
|
||||
</svg>
|
||||
</button><code></code></pre>
|
||||
</div></div><nav class="topSymbols">
|
||||
<h3>Symbols</h3>
|
||||
<ul><li>
|
||||
<a href="../../.././api/middleware/auth.ts/~/AuthState.html" title="AuthState"><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<span class="hover:bg-Interface/15 hover:bg-InterfaceDark/15">
|
||||
AuthState
|
||||
</span>
|
||||
</a>
|
||||
</li><li>
|
||||
<a href="../../.././api/middleware/auth.ts/~/AuthContext.html" title="AuthContext"><div class="docNodeKindIcon"><div class="text-TypeAlias bg-TypeAlias/15 dark:text-TypeAliasDark dark:bg-TypeAliasDark/15" title="Type Alias">T</div></div>
|
||||
<span class="hover:bg-TypeAlias/15 hover:bg-TypeAliasDark/15">
|
||||
AuthContext
|
||||
</span>
|
||||
</a>
|
||||
</li><li>
|
||||
<a href="../../.././api/middleware/auth.ts/~/authMiddleware.html" title="authMiddleware"><div class="docNodeKindIcon"><div class="text-Function bg-Function/15 dark:text-FunctionDark dark:bg-FunctionDark/15" title="Function">f</div></div>
|
||||
<span class="hover:bg-Function/15 hover:bg-FunctionDark/15">
|
||||
authMiddleware
|
||||
</span>
|
||||
</a>
|
||||
</li><li>
|
||||
<a href="../../.././api/middleware/auth.ts/~/requirePermission.html" title="requirePermission"><div class="docNodeKindIcon"><div class="text-Function bg-Function/15 dark:text-FunctionDark dark:bg-FunctionDark/15" title="Function">f</div></div>
|
||||
<span class="hover:bg-Function/15 hover:bg-FunctionDark/15">
|
||||
requirePermission
|
||||
</span>
|
||||
</a>
|
||||
</li><li>
|
||||
<a href="../../.././api/middleware/error.ts/~/errorMiddleware.html" title="errorMiddleware"><div class="docNodeKindIcon"><div class="text-Function bg-Function/15 dark:text-FunctionDark dark:bg-FunctionDark/15" title="Function">f</div></div>
|
||||
<span class="hover:bg-Function/15 hover:bg-FunctionDark/15">
|
||||
errorMiddleware
|
||||
</span>
|
||||
</a>
|
||||
</li></ul><a class="flex items-center gap-0.5" href="../../.././all_symbols.html">
|
||||
<span class="leading-none">view all 1307 symbols</span><svg
|
||||
width="16"
|
||||
height="16"
|
||||
viewBox="0 0 16 16"
|
||||
fill="none"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
fill-rule="evenodd"
|
||||
clip-rule="evenodd"
|
||||
d="M5.76748 11.8159C5.5378 11.577 5.54525 11.1972 5.78411 10.9675L8.93431 8L5.78411 5.0325C5.54525 4.80282 5.5378 4.423 5.76748 4.18413C5.99715 3.94527 6.37698 3.93782 6.61584 4.1675L10.2158 7.5675C10.3335 7.68062 10.4 7.83679 10.4 8C10.4 8.16321 10.3335 8.31938 10.2158 8.4325L6.61584 11.8325C6.37698 12.0622 5.99715 12.0547 5.76748 11.8159Z"
|
||||
fill="currentColor"
|
||||
/>
|
||||
</svg>
|
||||
</a></nav><nav class="documentNavigation">
|
||||
<h3>Document Navigation</h3><ul><li><a href="#api/mail/layout_ts_classes" title="Classes">Classes</a></li><li><ul><li><a href="#namespace_emailkit" title="EmailKit">EmailKit</a></li></ul></li><li><a href="#api/mail/layout_ts_functions" title="Functions">Functions</a></li><li><ul><li><a href="#namespace_esc" title="esc">esc</a></li><li><a href="#namespace_escmd" title="escMd">escMd</a></li><li><a href="#namespace_lookof" title="lookOf">lookOf</a></li><li><a href="#namespace_mdlink" title="mdLink">mdLink</a></li></ul></li><li><a href="#api/mail/layout_ts_interfaces" title="Interfaces">Interfaces</a></li><li><ul><li><a href="#namespace_emaillook" title="EmailLook">EmailLook</a></li><li><a href="#namespace_renderedemail" title="RenderedEmail">RenderedEmail</a></li></ul></li><li><a href="#api/mail/layout_ts_type-aliases" title="Type Aliases">Type Aliases</a></li><li><ul><li><a href="#namespace_paletterole" title="PaletteRole">PaletteRole</a></li></ul></li></ul></nav></div>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user