schlechtenburg/docs/api/interfaces/_schlechtenburg_core.IBlockProps.html

4 lines
16 KiB
HTML

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IBlockProps | schlechtenburg</title><meta name="description" content="Documentation for schlechtenburg"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">schlechtenburg</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">schlechtenburg</a></li><li><a href="../modules/_schlechtenburg_core.html">@schlechtenburg/core</a></li><li><a href="_schlechtenburg_core.IBlockProps.html">IBlockProps</a></li></ul><h1>Interface IBlockProps&lt;T&gt;</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Any Block that you create</p>
</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p>IBlockDefinition</p>
</dd></dl></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">IBlockProps</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#blockId" class="tsd-kind-icon">block<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#onActivateNext" class="tsd-kind-icon">on<wbr/>Activate<wbr/>Next</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#onActivatePrevious" class="tsd-kind-icon">on<wbr/>Activate<wbr/>Previous</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#onAppendBlock" class="tsd-kind-icon">on<wbr/>Append<wbr/>Block</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#onPrependBlock" class="tsd-kind-icon">on<wbr/>Prepend<wbr/>Block</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#onRemoveSelf" class="tsd-kind-icon">on<wbr/>Remove<wbr/>Self</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#onUpdate" class="tsd-kind-icon">on<wbr/>Update</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="blockId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> block<wbr/>Id<a href="#blockId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">block<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in core/lib/types.ts:142</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> data<a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><ul><li>Defined in core/lib/types.ts:143</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="onActivateNext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr/>Activate<wbr/>Next<a href="#onActivateNext" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">on<wbr/>Activate<wbr/>Next<span class="tsd-signature-symbol">?:</span> <a href="../modules/_schlechtenburg_core.html#OnActivateNextCb" class="tsd-signature-type" data-tsd-kind="Type alias">OnActivateNextCb</a></div><aside class="tsd-sources"><ul><li>Defined in core/lib/types.ts:148</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="onActivatePrevious" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr/>Activate<wbr/>Previous<a href="#onActivatePrevious" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">on<wbr/>Activate<wbr/>Previous<span class="tsd-signature-symbol">?:</span> <a href="../modules/_schlechtenburg_core.html#OnActivatePreviousCb" class="tsd-signature-type" data-tsd-kind="Type alias">OnActivatePreviousCb</a></div><aside class="tsd-sources"><ul><li>Defined in core/lib/types.ts:149</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="onAppendBlock" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr/>Append<wbr/>Block<a href="#onAppendBlock" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">on<wbr/>Append<wbr/>Block<span class="tsd-signature-symbol">?:</span> <a href="../modules/_schlechtenburg_core.html#OnAppendBlockCb" class="tsd-signature-type" data-tsd-kind="Type alias">OnAppendBlockCb</a></div><aside class="tsd-sources"><ul><li>Defined in core/lib/types.ts:146</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="onPrependBlock" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr/>Prepend<wbr/>Block<a href="#onPrependBlock" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">on<wbr/>Prepend<wbr/>Block<span class="tsd-signature-symbol">?:</span> <a href="../modules/_schlechtenburg_core.html#OnPrependBlockCb" class="tsd-signature-type" data-tsd-kind="Type alias">OnPrependBlockCb</a></div><aside class="tsd-sources"><ul><li>Defined in core/lib/types.ts:145</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="onRemoveSelf" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr/>Remove<wbr/>Self<a href="#onRemoveSelf" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">on<wbr/>Remove<wbr/>Self<span class="tsd-signature-symbol">?:</span> <a href="../modules/_schlechtenburg_core.html#OnRemoveSelfCb" class="tsd-signature-type" data-tsd-kind="Type alias">OnRemoveSelfCb</a></div><aside class="tsd-sources"><ul><li>Defined in core/lib/types.ts:147</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="onUpdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr/>Update<a href="#onUpdate" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">on<wbr/>Update<span class="tsd-signature-symbol">?:</span> <a href="../modules/_schlechtenburg_core.html#OnUpdateSelfCb" class="tsd-signature-type" data-tsd-kind="Type alias">OnUpdateSelfCb</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in core/lib/types.ts:144</li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Modules</a></li><li class="current tsd-kind-module"><a href="../modules/_schlechtenburg_core.html">@schlechtenburg/core</a></li><li class=" tsd-kind-module"><a href="../modules/_schlechtenburg_heading.html">@schlechtenburg/heading</a></li><li class=" tsd-kind-module"><a href="../modules/_schlechtenburg_image.html">@schlechtenburg/image</a></li><li class=" tsd-kind-module"><a href="../modules/_schlechtenburg_layout.html">@schlechtenburg/layout</a></li><li class=" tsd-kind-module"><a href="../modules/_schlechtenburg_paragraph.html">@schlechtenburg/paragraph</a></li><li class=" tsd-kind-module"><a href="../modules/_schlechtenburg_standalone.html">@schlechtenburg/standalone</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="_schlechtenburg_core.IBlockProps.html" class="tsd-kind-icon">IBlock<wbr/>Props</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#blockId" class="tsd-kind-icon">block<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#onActivateNext" class="tsd-kind-icon">on<wbr/>Activate<wbr/>Next</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#onActivatePrevious" class="tsd-kind-icon">on<wbr/>Activate<wbr/>Previous</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#onAppendBlock" class="tsd-kind-icon">on<wbr/>Append<wbr/>Block</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#onPrependBlock" class="tsd-kind-icon">on<wbr/>Prepend<wbr/>Block</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#onRemoveSelf" class="tsd-kind-icon">on<wbr/>Remove<wbr/>Self</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_schlechtenburg_core.IBlockProps.html#onUpdate" class="tsd-kind-icon">on<wbr/>Update</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>