mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-27 17:53:07 +00:00
263 lines
17 KiB
HTML
263 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" dir="ltr">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
|
<meta name="generator" content="Hugo 0.111.3">
|
|
<meta name="generator" content="Relearn 5.13.2+tip">
|
|
<meta name="description" content="Expandable/collapsible sections of text">
|
|
<meta name="author" content="Sören Weber">
|
|
<title>Expand :: Hugo Relearn Theme</title>
|
|
<link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/expand/index.html" rel="alternate" hreflang="x-default">
|
|
<link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/expand/index.html" rel="alternate" hreflang="en">
|
|
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/expand/index.html" rel="alternate" hreflang="pir">
|
|
<link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/expand/index.html" rel="canonical" type="text/html" title="Expand :: Hugo Relearn Theme">
|
|
<link href="../../shortcodes/expand/index.xml" rel="alternate" type="application/rss+xml" title="Expand :: Hugo Relearn Theme">
|
|
<link href="../../images/logo.svg?1684529020" rel="icon" type="image/svg+xml">
|
|
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
|
<link href="../../css/fontawesome-all.min.css?1684529022" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1684529022" rel="stylesheet"></noscript>
|
|
<link href="../../css/nucleus.css?1684529022" rel="stylesheet">
|
|
<link href="../../css/auto-complete.css?1684529022" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1684529022" rel="stylesheet"></noscript>
|
|
<link href="../../css/perfect-scrollbar.min.css?1684529022" rel="stylesheet">
|
|
<link href="../../css/fonts.css?1684529022" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1684529022" rel="stylesheet"></noscript>
|
|
<link href="../../css/theme.css?1684529022" rel="stylesheet">
|
|
<link href="../../css/theme-auto.css?1684529022" rel="stylesheet" id="variant-style">
|
|
<link href="../../css/variant.css?1684529022" rel="stylesheet">
|
|
<link href="../../css/print.css?1684529022" rel="stylesheet" media="print">
|
|
<link href="../../css/format-print.css?1684529022" rel="stylesheet">
|
|
<link href="../../css/ie.css?1684529022" rel="stylesheet">
|
|
<script src="../../js/url.js?1684529022"></script>
|
|
<script src="../../js/variant.js?1684529022"></script>
|
|
<script>
|
|
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
|
|
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
|
|
window.index_js_url="../../index.search.js";
|
|
var root_url="../../";
|
|
var baseUri=root_url.replace(/\/$/, '');
|
|
// translations
|
|
window.T_Copy_to_clipboard = 'Copy to clipboard';
|
|
window.T_Copied_to_clipboard = 'Copied to clipboard!';
|
|
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
|
|
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
|
|
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
|
|
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
|
|
// some further base stuff
|
|
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
|
window.variants && variants.init( [ 'auto', 'relearn-bright', 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
|
</script>
|
|
<style>
|
|
#body img.bg-white {
|
|
background-color: white;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../../shortcodes/expand/index.html">
|
|
<div id="body" class="default-animation">
|
|
<div id="sidebar-overlay"></div>
|
|
<div id="toc-overlay"></div>
|
|
<nav id="topbar" class="highlightable">
|
|
<div>
|
|
<div id="breadcrumbs">
|
|
<span id="sidebar-toggle-span">
|
|
<a href="#" id="sidebar-toggle" class="topbar-link" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
|
|
</span>
|
|
<ol class="links" itemscope itemtype="http://schema.org/BreadcrumbList">
|
|
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../index.html"><span itemprop="name">Hugo Relearn Theme</span></a><meta itemprop="position" content="1"> > </li>
|
|
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../shortcodes/index.html"><span itemprop="name">Shortcodes</span></a><meta itemprop="position" content="2"> > </li>
|
|
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Expand</span><meta itemprop="position" content="3"></li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<main id="body-inner" class="highlightable default" tabindex="-1">
|
|
<div class="flex-block-wrapper">
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
<h1 id="expand">Expand</h1>
|
|
|
|
<p>The <code>expand</code> shortcode displays an expandable/collapsible section of text.</p>
|
|
|
|
<div class="expand">
|
|
<input type="checkbox" id="expand-974b4db8dca024b0227b804f78eab4d4" aria-controls="expandcontent-974b4db8dca024b0227b804f78eab4d4" >
|
|
<label class="expand-label" for="expand-974b4db8dca024b0227b804f78eab4d4" >
|
|
<i class="fas fa-chevron-down"></i>
|
|
<i class="fas fa-chevron-right"></i>
|
|
Expand me…
|
|
</label>
|
|
<div id="expandcontent-974b4db8dca024b0227b804f78eab4d4" class="expand-content">
|
|
Thank you!
|
|
</div>
|
|
</div>
|
|
|
|
<div class="box notices cstyle note">
|
|
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
|
<div class="box-content">
|
|
<p>This only works in modern browsers flawlessly. While Internet Explorer 11 has issues in displaying it, the functionality still works.</p>
|
|
</div>
|
|
</div>
|
|
<h2 id="usage">Usage</h2>
|
|
<p>While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.</p>
|
|
|
|
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
|
<div class="tab-nav">
|
|
<button
|
|
data-tab-item="shortcode"
|
|
class="tab-nav-button active"
|
|
onclick="switchTab('shortcode-parameter','shortcode')"
|
|
>
|
|
<span>shortcode</span></button>
|
|
<button
|
|
data-tab-item="shortcode (positional)"
|
|
class="tab-nav-button"
|
|
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
|
|
>
|
|
<span>shortcode (positional)</span></button>
|
|
<button
|
|
data-tab-item="partial"
|
|
class="tab-nav-button"
|
|
onclick="switchTab('shortcode-parameter','partial')"
|
|
>
|
|
<span>partial</span></button>
|
|
</div>
|
|
<div class="tab-content">
|
|
<div
|
|
data-tab-item="shortcode"
|
|
class="tab-content-text active"
|
|
>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Expand me..."</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Thank</span> <span class="nx">you</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span>
|
|
</span></span></code></pre></div>
|
|
</div>
|
|
<div
|
|
data-tab-item="shortcode (positional)"
|
|
class="tab-content-text"
|
|
>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="s">"Expand me..."</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Thank</span> <span class="nx">you</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span>
|
|
</span></span></code></pre></div>
|
|
</div>
|
|
<div
|
|
data-tab-item="partial"
|
|
class="tab-content-text"
|
|
>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/expand.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s">"context"</span> <span class="p">.</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"Expand me..."</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"Thank you!"</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
|
|
</span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="parameter">Parameter</h3>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th style="text-align:left">Name</th>
|
|
<th style="text-align:left">Position</th>
|
|
<th style="text-align:left">Default</th>
|
|
<th style="text-align:left">Notes</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align:left"><strong>title</strong></td>
|
|
<td style="text-align:left">1</td>
|
|
<td style="text-align:left"><code>"Expand me..."</code></td>
|
|
<td style="text-align:left">Arbitrary text to appear next to the expand/collapse icon.</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align:left"><strong>open</strong></td>
|
|
<td style="text-align:left">2</td>
|
|
<td style="text-align:left"><code>false</code></td>
|
|
<td style="text-align:left">When <code>true</code> the content text will be initially shown as expanded.</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align:left"><em><strong><content></strong></em></td>
|
|
<td style="text-align:left"></td>
|
|
<td style="text-align:left"><em><empty></em></td>
|
|
<td style="text-align:left">Arbitrary text to be displayed on expand.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="examples">Examples</h2>
|
|
<h3 id="all-defaults">All Defaults</h3>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Yes</span><span class="p">,</span> <span class="nx">you</span> <span class="nx">did</span> <span class="nx">it</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span>
|
|
</span></span></code></pre></div>
|
|
<div class="expand">
|
|
<input type="checkbox" id="expand-7f95252a04eeacf7eda2cf53c9c84837" aria-controls="expandcontent-7f95252a04eeacf7eda2cf53c9c84837" >
|
|
<label class="expand-label" for="expand-7f95252a04eeacf7eda2cf53c9c84837" >
|
|
<i class="fas fa-chevron-down"></i>
|
|
<i class="fas fa-chevron-right"></i>
|
|
Expand me…
|
|
</label>
|
|
<div id="expandcontent-7f95252a04eeacf7eda2cf53c9c84837" class="expand-content">
|
|
Yes, you did it!
|
|
</div>
|
|
</div>
|
|
<h3 id="initially-expanded">Initially Expanded</h3>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Expand me..."</span> <span class="nx">open</span><span class="p">=</span><span class="s">"true"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">No</span> <span class="nx">need</span> <span class="nx">to</span> <span class="nx">press</span> <span class="nx">you</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span>
|
|
</span></span></code></pre></div>
|
|
<div class="expand">
|
|
<input type="checkbox" id="expand-b7eed588c5df1ad46ad7bf025213cfd8" aria-controls="expandcontent-b7eed588c5df1ad46ad7bf025213cfd8" checked>
|
|
<label class="expand-label" for="expand-b7eed588c5df1ad46ad7bf025213cfd8" >
|
|
<i class="fas fa-chevron-down"></i>
|
|
<i class="fas fa-chevron-right"></i>
|
|
Expand me…
|
|
</label>
|
|
<div id="expandcontent-b7eed588c5df1ad46ad7bf025213cfd8" class="expand-content">
|
|
No need to press you!
|
|
</div>
|
|
</div>
|
|
<h3 id="arbitrary-text">Arbitrary Text</h3>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Show me almost **endless** possibilities"</span> <span class="o">%</span><span class="p">}}</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">You</span> <span class="nx">can</span> <span class="nx">add</span> <span class="nx">standard</span> <span class="nx">markdown</span> <span class="nx">syntax</span><span class="p">:</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">multiple</span> <span class="nx">paragraphs</span>
|
|
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">bullet</span> <span class="nx">point</span> <span class="nx">lists</span>
|
|
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">_emphasized_</span><span class="p">,</span> <span class="o">**</span><span class="nx">bold</span><span class="o">**</span> <span class="nx">and</span> <span class="nx">even</span> <span class="o">**</span><span class="nx">_bold</span> <span class="nx">emphasized_</span><span class="o">**</span> <span class="nx">text</span>
|
|
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="p">[</span><span class="nx">links</span><span class="p">](</span><span class="nx">https</span><span class="p">:</span><span class="c1">//example.com)
|
|
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="o">-</span> <span class="nx">etc</span><span class="p">.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="s">```plaintext
|
|
</span></span></span><span class="line"><span class="cl"><span class="s">...and even source code
|
|
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="p">></span> <span class="nx">the</span> <span class="nx">possibilities</span> <span class="nx">are</span> <span class="nf">endless</span> <span class="p">(</span><span class="nx">almost</span> <span class="o">-</span> <span class="nx">including</span> <span class="nx">other</span> <span class="nx">shortcodes</span> <span class="nx">may</span> <span class="nx">or</span> <span class="nx">may</span> <span class="nx">not</span> <span class="nx">work</span><span class="p">)</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span>
|
|
</span></span></code></pre></div>
|
|
<div class="expand">
|
|
<input type="checkbox" id="expand-630dd229486c4e484e3a9ed629a70f6a" aria-controls="expandcontent-630dd229486c4e484e3a9ed629a70f6a" >
|
|
<label class="expand-label" for="expand-630dd229486c4e484e3a9ed629a70f6a" >
|
|
<i class="fas fa-chevron-down"></i>
|
|
<i class="fas fa-chevron-right"></i>
|
|
Show me almost <strong>endless</strong> possibilities
|
|
</label>
|
|
<div id="expandcontent-630dd229486c4e484e3a9ed629a70f6a" class="expand-content">
|
|
<p>You can add standard markdown syntax:</p>
|
|
<ul>
|
|
<li>multiple paragraphs</li>
|
|
<li>bullet point lists</li>
|
|
<li><em>emphasized</em>, <strong>bold</strong> and even <strong><em>bold emphasized</em></strong> text</li>
|
|
<li><a href="https://example.com" target="_blank">links</a></li>
|
|
<li>etc.</li>
|
|
</ul>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">...and even source code
|
|
</span></span></code></pre></div><blockquote>
|
|
<p>the possibilities are endless (almost - including other shortcodes may or may not work)</p>
|
|
</blockquote>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="../../js/clipboard.min.js?1684529022" defer></script>
|
|
<script src="../../js/perfect-scrollbar.min.js?1684529022" defer></script>
|
|
<script src="../../js/theme.js?1684529022" defer></script>
|
|
</body>
|
|
</html>
|