Files
liquidjs/api/classes/drop_block_drop_.blockdrop.html
T

221 lines
23 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html lang="en">
<head prefix="og: http://ogp.me/ns#">
<meta charset="utf-8">
<title>Class: BlockDrop | LiquidJS</title>
<meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="LiquidJS is a simple, expressive and safe Shopify / Github Pages compatible template engine in pure JavaScript.">
<link rel="dns-prefetch" href="https://cdn.jsdelivr.net/">
<link rel="manifest" href="/manifest.json">
<!-- Canonical links -->
<link rel="canonical" href="https://liquidjs.com/api/classes/drop_block_drop_.blockdrop.html">
<!-- Alternative links -->
<link rel="alternative" hreflang="en" href="https://liquidjs.com/api/classes/drop_block_drop_.blockdrop">
<link rel="alternative" hreflang="zh-cn" href="https://liquidjs.com/zh-cn/api/classes/drop_block_drop_.blockdrop">
<!-- Icon -->
<link rel="apple-touch-icon" sizes="57x57" href="../../icon/apple-touch-icon-57x57.png">
<link rel="apple-touch-icon" sizes="114x114" href="../../icon/apple-touch-icon-114x114.png">
<link rel="apple-touch-icon" sizes="72x72" href="../../icon/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="144x144" href="../../icon/apple-touch-icon-144x144.png">
<link rel="apple-touch-icon" sizes="60x60" href="../../icon/apple-touch-icon-60x60.png">
<link rel="apple-touch-icon" sizes="120x120" href="../../icon/apple-touch-icon-120x120.png">
<link rel="apple-touch-icon" sizes="76x76" href="../../icon/apple-touch-icon-76x76.png">
<link rel="apple-touch-icon" sizes="152x152" href="../../icon/apple-touch-icon-152x152.png">
<link rel="icon" type="image/png" href="../../icon/favicon-196x196.png" sizes="196x196">
<link rel="icon" type="image/png" href="../../icon/favicon-160x160.png" sizes="160x160">
<link rel="icon" type="image/png" href="../../icon/favicon-96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="../../icon/favicon-16x16.png" sizes="16x16">
<link rel="icon" type="image/png" href="../../icon/favicon-32x32.png" sizes="32x32">
<meta name="msapplication-TileColor" content="#2f83cd">
<meta name="msapplication-TileImage" content="../../icon/mstile-144x144.png">
<link rel="stylesheet" href="../../css/navy.css">
<link rel="alternate" href="../../atom.xml" title="LiquidJS" type="application/atom+xml">
<meta name="generator" content="Hexo 5.4.0"></head>
<body>
<div id="container">
<header id="header" class="wrapper">
<div id="header-inner" class="inner">
<h1 id="logo-wrap">
<a href="../../index.html" id="logo">LiquidJS</a>
</h1>
<nav id="main-nav">
<a href="../../tutorials/intro-to-liquid.html" class="main-nav-link">Tutorials</a><a href="../../tags/overview.html" class="main-nav-link">Tags</a><a href="../../filters/overview.html" class="main-nav-link">Filters</a><a href="../../playground.html" class="main-nav-link">Playground</a><a href="../../api/classes/liquid_.liquid.html" class="main-nav-link">API</a>
<div id="search-input-wrap">
<i id="search-input-icon" class="icon-search"></i>
<input type="search" id="search-input" placeholder="Search...">
</div>
</nav>
<div id="lang-select-wrap" class="main-nav-link">
<label><i class="icon-network"></i>English</label>
<select id="lang-select" data-canonical="api/classes/drop_block_drop_.blockdrop.html">
<option value="en" selected>English</option>
<option value="zh-cn">简体中文</option>
</select>
</div>
<a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs" id="github-link-wrap" class="main-nav-link"><i class="icon-github"></i>Github</a>
<a target="_blank" rel="noopener external nofollow noreferrer" href="https://opencollective.com/liquidjs" class="main-nav-link"><i class="icon-opencollective"></i>Support</a>
<a id="mobile-nav-toggle">
<span class="mobile-nav-toggle-bar"></span>
<span class="mobile-nav-toggle-bar"></span>
<span class="mobile-nav-toggle-bar"></span>
</a>
</div>
</header>
<div id="content-wrap">
<div id="content" class="wrapper">
<div id="content-inner">
<aside id="sidebar" role="navigation">
<div class="inner">
<strong class="sidebar-title">Quick Entry</strong><a href="../classes/liquid_.liquid.html" class="sidebar-link">Liquid</a><a href="../interfaces/liquid_options_.liquidoptions.html" class="sidebar-link">LiquidOptions</a><a href="../interfaces/fs_fs_.fs.html" class="sidebar-link">FS</a><a href="../interfaces/cache_cache_.cache.html" class="sidebar-link">Cache</a><strong class="sidebar-title">Classes</strong><a href="../classes/drop_blank_drop_.blankdrop.html" class="sidebar-link">BlankDrop</a><a href="../classes/context_context_.context.html" class="sidebar-link">Context</a><a href="../classes/tokens_delimited_token_.delimitedtoken.html" class="sidebar-link">DelimitedToken</a><a href="../classes/drop_drop_.drop.html" class="sidebar-link">Drop</a><a href="../classes/drop_empty_drop_.emptydrop.html" class="sidebar-link">EmptyDrop</a><a href="../classes/render_expression_.expression.html" class="sidebar-link">Expression</a><a href="../classes/tokens_filter_token_.filtertoken.html" class="sidebar-link">FilterToken</a><a href="../classes/drop_forloop_drop_.forloopdrop.html" class="sidebar-link">ForloopDrop</a><a href="../classes/tokens_html_token_.htmltoken.html" class="sidebar-link">HTMLToken</a><a href="../classes/tokens_hash_token_.hashtoken.html" class="sidebar-link">HashToken</a><a href="../classes/cache_lru_.lru.html" class="sidebar-link">LRU</a><a href="../classes/liquid_.liquid.html" class="sidebar-link">Liquid</a><a href="../classes/tokens_literal_token_.literaltoken.html" class="sidebar-link">LiteralToken</a><a href="../classes/drop_null_drop_.nulldrop.html" class="sidebar-link">NullDrop</a><a href="../classes/tokens_number_token_.numbertoken.html" class="sidebar-link">NumberToken</a><a href="../classes/tokens_operator_token_.operatortoken.html" class="sidebar-link">OperatorToken</a><a href="../classes/tokens_output_token_.outputtoken.html" class="sidebar-link">OutputToken</a><a href="../classes/util_error_.parseerror.html" class="sidebar-link">ParseError</a><a href="../classes/parser_parse_stream_.parsestream.html" class="sidebar-link">ParseStream</a><a href="../classes/parser_parser_.parser.html" class="sidebar-link">Parser</a><a href="../classes/tokens_property_access_token_.propertyaccesstoken.html" class="sidebar-link">PropertyaccessToken</a><a href="../classes/tokens_quoted_token_.quotedtoken.html" class="sidebar-link">QuotedToken</a><a href="../classes/tokens_range_token_.rangetoken.html" class="sidebar-link">RangeToken</a><a href="../classes/render_render_.render.html" class="sidebar-link">Render</a><a href="../classes/util_error_.rendererror.html" class="sidebar-link">RenderError</a><a href="../classes/drop_tablerowloop_drop_.tablerowloopdrop.html" class="sidebar-link">TablerowloopDrop</a><a href="../classes/tokens_tag_token_.tagtoken.html" class="sidebar-link">TagToken</a><a href="../classes/tokens_token_.token.html" class="sidebar-link">Token</a><a href="../classes/util_error_.tokenizationerror.html" class="sidebar-link">TokenizationError</a><a href="../classes/parser_tokenizer_.tokenizer.html" class="sidebar-link">Tokenizer</a><a href="../classes/tokens_word_token_.wordtoken.html" class="sidebar-link">WordToken</a><strong class="sidebar-title">Enums</strong><a href="../enums/context_block_mode_.blockmode.html" class="sidebar-link">BlockMode</a><a href="../enums/parser_token_kind_.tokenkind.html" class="sidebar-link">TokenKind</a><strong class="sidebar-title">Interfaces</strong><a href="../interfaces/cache_cache_.cache.html" class="sidebar-link">Cache</a><a href="../interfaces/template_filter_filter_impl_options_.filterimploptions.html" class="sidebar-link">FilterImplOptions</a><a href="../interfaces/fs_fs_.fs.html" class="sidebar-link">FS</a><a href="../interfaces/liquid_options_.liquidoptions.html" class="sidebar-link">LiquidOptions</a><a href="../interfaces/liquid_options_.normalizedfulloptions.html" class="sidebar-link">NormalizedFullOptions</a><a href="../interfaces/context_scope_.plainobject.html" class="sidebar-link">PlainObject</a><a href="../interfaces/template_tag_tag_impl_options_.tagimploptions.html" class="sidebar-link">TagImplOptions</a>
</div>
</aside>
<article class="article-container" itemscope itemtype="http://schema.org/Article">
<div class="article-inner">
<div class="article">
<div class="inner">
<header class="article-header">
<h1 class="article-title" itemprop="name">Class: BlockDrop</h1>
<a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/issues/new?title=docs:&body=URL: https%3A%2F%2Fliquidjs.com%2Fapi%2Fclasses%2Fdrop_block_drop_.blockdrop.html&labels=docs" class="article-edit-link" title="Report problems"><i class="icon-chat-bubble-dots"></i></a>
</header>
<div class="article-content" itemprop="articleBody">
<h2 id="Hierarchy" class="article-heading"><a href="#Hierarchy" class="headerlink" title="Hierarchy"></a>Hierarchy<a class="article-anchor" href="#Hierarchy" aria-hidden="true"></a></h2><ul>
<li><p><a href="drop_drop_.drop.html">Drop</a></p>
<p><strong>BlockDrop</strong></p>
</li>
</ul>
<h2 id="Constructors" class="article-heading"><a href="#Constructors" class="headerlink" title="Constructors"></a>Constructors<a class="article-anchor" href="#Constructors" aria-hidden="true"></a></h2><h3 id="constructor-NaN" class="article-heading"><a href="#constructor-NaN" class="headerlink" title="constructor"></a>constructor<a class="article-anchor" href="#constructor-NaN" aria-hidden="true"></a></h3><p>+ <strong>new BlockDrop</strong>(<code>superBlockRender</code>: function): <em><a href="drop_block_drop_.blockdrop.html">BlockDrop</a></em></p>
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/drop/block-drop.ts#L3">src/drop/block-drop.ts:3</a></em></p>
<p><strong>Parameters:</strong></p>
<p><code>Default value</code> <strong>superBlockRender</strong>: <em>function</em>= () =&gt; ‘’</p>
<p>▸ (): <em>Iterableany</em></p>
<p><strong>Returns:</strong> <em><a href="drop_block_drop_.blockdrop.html">BlockDrop</a></em></p>
<h2 id="Properties" class="article-heading"><a href="#Properties" class="headerlink" title="Properties"></a>Properties<a class="article-anchor" href="#Properties" aria-hidden="true"></a></h2><h3 id="Private-superBlockRender" class="article-heading"><a href="#Private-superBlockRender" class="headerlink" title="Private superBlockRender"></a><code>Private</code> superBlockRender<a class="article-anchor" href="#Private-superBlockRender" aria-hidden="true"></a></h3><p><strong>superBlockRender</strong>: <em>function</em></p>
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/drop/block-drop.ts#L6">src/drop/block-drop.ts:6</a></em></p>
<h4 id="Type-declaration" class="article-heading"><a href="#Type-declaration" class="headerlink" title="Type declaration:"></a>Type declaration:<a class="article-anchor" href="#Type-declaration" aria-hidden="true"></a></h4><p>▸ (): <em>Iterableany</em></p>
<h2 id="Methods" class="article-heading"><a href="#Methods" class="headerlink" title="Methods"></a>Methods<a class="article-anchor" href="#Methods" aria-hidden="true"></a></h2><h3 id="liquidMethodMissing" class="article-heading"><a href="#liquidMethodMissing" class="headerlink" title="liquidMethodMissing"></a>liquidMethodMissing<a class="article-anchor" href="#liquidMethodMissing" aria-hidden="true"></a></h3><p><strong>liquidMethodMissing</strong>(<code>key</code>: string): <em>Promisestring | undefined | string | undefined</em></p>
<p><em>Inherited from <a href="drop_drop_.drop.html">Drop</a>.<a href="drop_drop_.drop.html#liquidmethodmissing">liquidMethodMissing</a></em></p>
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/drop/drop.ts#L6">src/drop/drop.ts:6</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
</tr>
</thead>
<tbody><tr>
<td><code>key</code></td>
<td>string</td>
</tr>
</tbody></table>
<p><strong>Returns:</strong> <em>Promisestring | undefined | string | undefined</em></p>
<hr>
<h3 id="super" class="article-heading"><a href="#super" class="headerlink" title="super"></a>super<a class="article-anchor" href="#super" aria-hidden="true"></a></h3><p><strong>super</strong>(): <em>Iterableany</em></p>
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/drop/block-drop.ts#L14">src/drop/block-drop.ts:14</a></em></p>
<p>Provide parent access in child block by</p>
{{ block.super }}
<p><strong>Returns:</strong> <em>Iterableany</em></p>
<hr>
<h3 id="valueOf-NaN" class="article-heading"><a href="#valueOf-NaN" class="headerlink" title="valueOf"></a>valueOf<a class="article-anchor" href="#valueOf-NaN" aria-hidden="true"></a></h3><p><strong>valueOf</strong>(): <em>any</em></p>
<p><em>Inherited from <a href="drop_drop_.drop.html">Drop</a>.<a href="drop_drop_.drop.html#valueof">valueOf</a></em></p>
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/drop/drop.ts#L2">src/drop/drop.ts:2</a></em></p>
<p><strong>Returns:</strong> <em>any</em></p>
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-02-16T09:57:51.070Z" itemprop="dateModified">Last updated: 2022-02-16</time>
<a href="../classes/liquid_.liquid.html" class="article-footer-next" title="sidebar.api.Liquid"><span>Next</span><i class="icon-chevron-right"></i></a>
</footer>
</div>
</div>
<aside id="article-toc" role="navigation">
<div id="article-toc-inner">
<div id="article-toc-inner-list">
<strong class="sidebar-title">Contents</strong>
<ol class="toc"><li class="toc-item toc-level-2"><a class="toc-link" href="#Hierarchy"><span class="toc-text">Hierarchy</span></a></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Constructors"><span class="toc-text">Constructors</span></a><ol class="toc-child"><li class="toc-item toc-level-3"><a class="toc-link" href="#constructor-NaN"><span class="toc-text">constructor</span></a></li></ol></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Properties"><span class="toc-text">Properties</span></a><ol class="toc-child"><li class="toc-item toc-level-3"><a class="toc-link" href="#Private-superBlockRender"><span class="toc-text">Private superBlockRender</span></a><ol class="toc-child"><li class="toc-item toc-level-4"><a class="toc-link" href="#Type-declaration"><span class="toc-text">Type declaration:</span></a></li></ol></li></ol></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Methods"><span class="toc-text">Methods</span></a><ol class="toc-child"><li class="toc-item toc-level-3"><a class="toc-link" href="#liquidMethodMissing"><span class="toc-text">liquidMethodMissing</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#super"><span class="toc-text">super</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#valueOf-NaN"><span class="toc-text">valueOf</span></a></li></ol></li></ol>
</div>
<a href="#" id="article-toc-top">Back to Top</a>
</div>
</aside>
</div>
</article>
</div>
</div>
</div>
<footer id="footer" class="wrapper">
<div class="inner">
<div id="footer-copyright">
&copy; 2022 <a href="https://github.com/harttle/liquidjs/graphs/contributors" rel="external nofollow noreferrer" target="_blank">Harttle</a><br>
Documentation licensed under <a href="http://creativecommons.org/licenses/by/4.0/" rel="external nofollow noreferrer" target="_blank">CC BY 4.0</a>.
</div>
<div id="footer-links">
<a href="https://twitter.com/harttleharttle" rel="external nofollow noreferrer" class="footer-link" target="_blank"><i class="icon-twitter"></i></a>
<a href="https://www.patreon.com/harttle" rel="external nofollow noreferrer" class="footer-link" target="_blank"><i class="icon-patreon"></i></a>
<a href="https://opencollective.com/liquidjs" rel="external nofollow noreferrer" class="footer-link" target="_blank"><i class="icon-opencollective"></i></a>
<a href="https://github.com/harttle/liquidjs" rel="external nofollow noreferrer" class="footer-link" target="_blank"><i class="icon-github"></i></a>
</div>
</div>
</footer>
</div>
<div id="mobile-nav-dimmer"></div>
<nav id="mobile-nav">
<div id="mobile-nav-inner">
<ul id="mobile-nav-list">
<a href="../../tutorials/intro-to-liquid.html" class="mobile-nav-link">Tutorials</a><a href="../../tags/overview.html" class="mobile-nav-link">Tags</a><a href="../../filters/overview.html" class="mobile-nav-link">Filters</a><a href="../../playground.html" class="mobile-nav-link">Playground</a><a href="../../api/classes/liquid_.liquid.html" class="mobile-nav-link">API</a>
<li class="mobile-nav-item">
<a href="https://github.com/harttle/liquidjs" class="mobile-nav-link" rel="external" target="_blank">GitHub</a>
</li>
</ul>
<div class="mobile-sidebar-list">
<strong class="mobile-nav-title">Quick Entry</strong><a href="../classes/liquid_.liquid.html" class="mobile-nav-link">Liquid</a><a href="../interfaces/liquid_options_.liquidoptions.html" class="mobile-nav-link">LiquidOptions</a><a href="../interfaces/fs_fs_.fs.html" class="mobile-nav-link">FS</a><a href="../interfaces/cache_cache_.cache.html" class="mobile-nav-link">Cache</a><strong class="mobile-nav-title">Classes</strong><a href="../classes/drop_blank_drop_.blankdrop.html" class="mobile-nav-link">BlankDrop</a><a href="../classes/context_context_.context.html" class="mobile-nav-link">Context</a><a href="../classes/tokens_delimited_token_.delimitedtoken.html" class="mobile-nav-link">DelimitedToken</a><a href="../classes/drop_drop_.drop.html" class="mobile-nav-link">Drop</a><a href="../classes/drop_empty_drop_.emptydrop.html" class="mobile-nav-link">EmptyDrop</a><a href="../classes/render_expression_.expression.html" class="mobile-nav-link">Expression</a><a href="../classes/tokens_filter_token_.filtertoken.html" class="mobile-nav-link">FilterToken</a><a href="../classes/drop_forloop_drop_.forloopdrop.html" class="mobile-nav-link">ForloopDrop</a><a href="../classes/tokens_html_token_.htmltoken.html" class="mobile-nav-link">HTMLToken</a><a href="../classes/tokens_hash_token_.hashtoken.html" class="mobile-nav-link">HashToken</a><a href="../classes/cache_lru_.lru.html" class="mobile-nav-link">LRU</a><a href="../classes/liquid_.liquid.html" class="mobile-nav-link">Liquid</a><a href="../classes/tokens_literal_token_.literaltoken.html" class="mobile-nav-link">LiteralToken</a><a href="../classes/drop_null_drop_.nulldrop.html" class="mobile-nav-link">NullDrop</a><a href="../classes/tokens_number_token_.numbertoken.html" class="mobile-nav-link">NumberToken</a><a href="../classes/tokens_operator_token_.operatortoken.html" class="mobile-nav-link">OperatorToken</a><a href="../classes/tokens_output_token_.outputtoken.html" class="mobile-nav-link">OutputToken</a><a href="../classes/util_error_.parseerror.html" class="mobile-nav-link">ParseError</a><a href="../classes/parser_parse_stream_.parsestream.html" class="mobile-nav-link">ParseStream</a><a href="../classes/parser_parser_.parser.html" class="mobile-nav-link">Parser</a><a href="../classes/tokens_property_access_token_.propertyaccesstoken.html" class="mobile-nav-link">PropertyaccessToken</a><a href="../classes/tokens_quoted_token_.quotedtoken.html" class="mobile-nav-link">QuotedToken</a><a href="../classes/tokens_range_token_.rangetoken.html" class="mobile-nav-link">RangeToken</a><a href="../classes/render_render_.render.html" class="mobile-nav-link">Render</a><a href="../classes/util_error_.rendererror.html" class="mobile-nav-link">RenderError</a><a href="../classes/drop_tablerowloop_drop_.tablerowloopdrop.html" class="mobile-nav-link">TablerowloopDrop</a><a href="../classes/tokens_tag_token_.tagtoken.html" class="mobile-nav-link">TagToken</a><a href="../classes/tokens_token_.token.html" class="mobile-nav-link">Token</a><a href="../classes/util_error_.tokenizationerror.html" class="mobile-nav-link">TokenizationError</a><a href="../classes/parser_tokenizer_.tokenizer.html" class="mobile-nav-link">Tokenizer</a><a href="../classes/tokens_word_token_.wordtoken.html" class="mobile-nav-link">WordToken</a><strong class="mobile-nav-title">Enums</strong><a href="../enums/context_block_mode_.blockmode.html" class="mobile-nav-link">BlockMode</a><a href="../enums/parser_token_kind_.tokenkind.html" class="mobile-nav-link">TokenKind</a><strong class="mobile-nav-title">Interfaces</strong><a href="../interfaces/cache_cache_.cache.html" class="mobile-nav-link">Cache</a><a href="../interfaces/template_filter_filter_impl_options_.filterimploptions.html" class="mobile-nav-link">FilterImplOptions</a><a href="../interfaces/fs_fs_.fs.html" class="mobile-nav-link">FS</a><a href="../interfaces/liquid_options_.liquidoptions.html" class="mobile-nav-link">LiquidOptions</a><a href="../interfaces/liquid_options_.normalizedfulloptions.html" class="mobile-nav-link">NormalizedFullOptions</a><a href="../interfaces/context_scope_.plainobject.html" class="mobile-nav-link">PlainObject</a><a href="../interfaces/template_tag_tag_impl_options_.tagimploptions.html" class="mobile-nav-link">TagImplOptions</a>
</div>
</div>
<div id="mobile-lang-select-wrap">
<span id="mobile-lang-select-label"><i class="icon-network"></i><span>English</span></span>
<select id="mobile-lang-select" data-canonical="api/classes/drop_block_drop_.blockdrop.html">
<option value="en" selected>English</option>
<option value="zh-cn">简体中文</option>
</select>
</div>
</nav>
<script src="../../js/main.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
<script>
document.getElementById('search-input-wrap').classList.add('on');
docsearch({
apiKey: '01f36cc168657a26a385308b9e721bc6',
indexName: 'liquidjs',
inputSelector: '#search-input',
debug: false
});
</script>
</body>
</html>