schlechtenburg/docs/api/@schlechtenburg/core.html

21 lines
28 KiB
HTML

<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>@schlechtenburg/core | Schlechtenburg</title>
<meta name="description" content="Experimental WYSIWYG block editor">
<link rel="stylesheet" href="/schlechtenburg/assets/style.a7ab32f9.css">
<link rel="modulepreload" href="/schlechtenburg/assets/app.d1307649.js">
<link rel="modulepreload" href="/schlechtenburg/assets/api_@schlechtenburg_core.md.4063a713.lean.js">
<meta name="twitter:title" content="@schlechtenburg/core | Schlechtenburg">
<meta property="og:title" content="@schlechtenburg/core | Schlechtenburg">
</head>
<body>
<div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-675d8756><div class="sidebar-button" data-v-675d8756><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/schlechtenburg/" aria-label="Schlechtenburg, back to home" data-v-675d8756 data-v-cc01ef16><!----> Schlechtenburg</a><div class="flex-grow" data-v-675d8756></div><div class="nav" data-v-675d8756><nav class="nav-links" data-v-675d8756 data-v-eab3edfe><!--[--><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item" href="/schlechtenburg/guide/why" data-v-b8818f8c>Guide <!----></a></div></div><div class="item" data-v-eab3edfe><div class="nav-dropdown-link" data-v-eab3edfe data-v-56bf3a3f><button class="button" data-v-56bf3a3f><span class="button-text" data-v-56bf3a3f>API</span><span class="right button-arrow" data-v-56bf3a3f></span></button><ul class="dialog" data-v-56bf3a3f><!--[--><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item" href="/schlechtenburg/api/@schlechtenburg/standalone" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>@schlechtenburg/standalone</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item active" href="/schlechtenburg/api/@schlechtenburg/core" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>@schlechtenburg/core</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item" href="/schlechtenburg/api/@schlechtenburg/layout" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>@schlechtenburg/layout</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item" href="/schlechtenburg/api/@schlechtenburg/heading" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>@schlechtenburg/heading</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item" href="/schlechtenburg/api/@schlechtenburg/paragraph" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>@schlechtenburg/paragraph</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item" href="/schlechtenburg/api/@schlechtenburg/image" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>@schlechtenburg/image</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><!--]--></ul></div></div><!--]--><!----><!----></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-83e92a68><nav class="nav-links nav" data-v-83e92a68 data-v-eab3edfe><!--[--><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item" href="/schlechtenburg/guide/why" data-v-b8818f8c>Guide <!----></a></div></div><div class="item" data-v-eab3edfe><div class="nav-dropdown-link" data-v-eab3edfe data-v-56bf3a3f><button class="button" data-v-56bf3a3f><span class="button-text" data-v-56bf3a3f>API</span><span class="right button-arrow" data-v-56bf3a3f></span></button><ul class="dialog" data-v-56bf3a3f><!--[--><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item" href="/schlechtenburg/api/@schlechtenburg/standalone" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>@schlechtenburg/standalone</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item active" href="/schlechtenburg/api/@schlechtenburg/core" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>@schlechtenburg/core</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item" href="/schlechtenburg/api/@schlechtenburg/layout" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>@schlechtenburg/layout</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item" href="/schlechtenburg/api/@schlechtenburg/heading" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>@schlechtenburg/heading</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item" href="/schlechtenburg/api/@schlechtenburg/paragraph" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>@schlechtenburg/paragraph</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item" href="/schlechtenburg/api/@schlechtenburg/image" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>@schlechtenburg/image</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><!--]--></ul></div></div><!--]--><!----><!----></nav><!--[--><!--]--><ul class="sidebar-links" data-v-83e92a68><!--[--><li class="sidebar-link"><p class="sidebar-link-item">API</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/schlechtenburg/api/@schlechtenburg/standalone">@schlechtenburg/standalone</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item active" href="/schlechtenburg/api/@schlechtenburg/core">@schlechtenburg/core</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#sbmode">SbMode</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#iblockdata-t">IBlockData&lt;T&gt;</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#iblockdefinition-t">IBlockDefinition&lt;T&gt;</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#iblocklibrary">IBlockLibrary</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#iblockprops-t">IBlockProps&lt;T&gt;</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#isbmainprops">ISbMainProps</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#itreenode">ITreeNode</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#onactivatenextcb">OnActivateNextCb</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#onactivatepreviouscb">OnActivatePreviousCb</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#onappendblockcb">OnAppendBlockCb</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#onprependblockcb">OnPrependBlockCb</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#onremoveselfcb">OnRemoveSelfCb</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#onupdateblockcb">OnUpdateBlockCb</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#onupdateselfcb-t">OnUpdateSelfCb&lt;T&gt;</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#sbblock">SbBlock</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#props">Props</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="#sbblockordering">SbBlockOrdering</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#props-1">Props</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="#sbblockpicker">SbBlockPicker</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#props-2">Props</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="#sbblockplaceholder">SbBlockPlaceholder</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#props-3">Props</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="#sbbutton">SbButton</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#props-4">Props</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="#sbmain">SbMain</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#sbselect">SbSelect</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#props-5">Props</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="#sbtoolbar">SbToolbar</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#props-6">Props</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="#symactiveblock">SymActiveBlock</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#symblockdimensions">SymBlockDimensions</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#symblocklibrary">SymBlockLibrary</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#symeditordimensions">SymEditorDimensions</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#symmode">SymMode</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#blockprops">blockProps</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#model">model</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#generateblockid">generateBlockId</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#useactivation">useActivation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#useblocksizing">useBlockSizing</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#usedynamicblocks">useDynamicBlocks</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#useresizeobserver">useResizeObserver</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="/schlechtenburg/api/@schlechtenburg/layout">@schlechtenburg/layout</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/schlechtenburg/api/@schlechtenburg/heading">@schlechtenburg/heading</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/schlechtenburg/api/@schlechtenburg/paragraph">@schlechtenburg/paragraph</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/schlechtenburg/api/@schlechtenburg/image">@schlechtenburg/image</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-7eddb2c4><div class="container" data-v-7eddb2c4><!--[--><!--]--><div style="position:relative;" class="content" data-v-7eddb2c4><div><h1 id="schlechtenburg-core" tabindex="-1">@schlechtenburg/core <a class="header-anchor" href="#schlechtenburg-core" aria-hidden="true">#</a></h1><h2 id="sbmode" tabindex="-1">SbMode <a class="header-anchor" href="#sbmode" aria-hidden="true">#</a></h2><p>The mode the Schlechtenburg editor is currently in</p><ul><li><p><strong>Type</strong> <code>Enumeration</code></p></li><li><p><strong>Members</strong></p><ul><li><strong>Edit</strong>: <code>undefined</code></li><li><strong>View</strong>: <code>undefined</code></li></ul></li></ul><h2 id="iblockdata-t" tabindex="-1">IBlockData&lt;T&gt; <a class="header-anchor" href="#iblockdata-t" aria-hidden="true">#</a></h2><p>Schlechtenburg inputs and outputs a plain JS Object that can be JSON stringified. This is the interface type for that data structure. <code>T</code> will be the data type of the specific block being</p><ul><li><p><strong>Type</strong> <code>Interface</code></p></li><li><p><strong>Members</strong></p><ul><li><strong>data</strong>: <code>T</code></li><li><strong>id</strong>: <code>string</code></li><li><strong>name</strong>: <code>string</code></li></ul></li></ul><h2 id="iblockdefinition-t" tabindex="-1">IBlockDefinition&lt;T&gt; <a class="header-anchor" href="#iblockdefinition-t" aria-hidden="true">#</a></h2><p>Any Block that you create</p><ul><li><p><strong>Type</strong> <code>Interface</code></p></li><li><p><strong>Members</strong></p><ul><li><strong>edit</strong>: <code>Component</code></li><li><strong>getDefaultData</strong>: <code>T</code></li><li><strong>icon</strong>: <code>string</code></li><li><strong>name</strong>: <code>string</code></li><li><strong>view</strong>: <code>Component</code></li></ul></li></ul><h2 id="iblocklibrary" tabindex="-1">IBlockLibrary <a class="header-anchor" href="#iblocklibrary" aria-hidden="true">#</a></h2><p>Schlechtenburg maintains a library of blocks that are available</p><ul><li><strong>Type</strong> <code>Interface</code></li></ul><h2 id="iblockprops-t" tabindex="-1">IBlockProps&lt;T&gt; <a class="header-anchor" href="#iblockprops-t" aria-hidden="true">#</a></h2><p>Any Block that you create</p><ul><li><p><strong>Type</strong> <code>Interface</code></p></li><li><p><strong>Members</strong></p><ul><li><strong>blockId</strong>: <code>string</code></li><li><strong>data</strong>: <code>T</code></li><li><strong>onActivateNext</strong>: <code>OnActivateNextCb</code></li><li><strong>onActivatePrevious</strong>: <code>OnActivatePreviousCb</code></li><li><strong>onAppendBlock</strong>: <code>OnAppendBlockCb</code></li><li><strong>onPrependBlock</strong>: <code>OnPrependBlockCb</code></li><li><strong>onRemoveSelf</strong>: <code>OnRemoveSelfCb</code></li><li><strong>onUpdate</strong>: <code>OnUpdateSelfCb</code></li></ul></li></ul><h2 id="isbmainprops" tabindex="-1">ISbMainProps <a class="header-anchor" href="#isbmainprops" aria-hidden="true">#</a></h2><ul><li><p><strong>Type</strong> <code>Interface</code></p></li><li><p><strong>Members</strong></p><ul><li><strong>availableBlocks</strong>: <code>undefined</code></li><li><strong>block</strong>: <code>IBlockData</code></li><li><strong>mode</strong>: <code>SbMode</code></li><li><strong>onUpdate</strong>: <code>OnUpdateBlockCb</code></li></ul></li></ul><h2 id="itreenode" tabindex="-1">ITreeNode <a class="header-anchor" href="#itreenode" aria-hidden="true">#</a></h2><p>Schlechtenburg keeps track of the rendered block tree. This is useful for e.g. the tree select component in the editor header.</p><ul><li><p><strong>Type</strong> <code>Interface</code></p></li><li><p><strong>Members</strong></p><ul><li><strong>children</strong>: <code>undefined</code></li><li><strong>icon</strong>: <code>string</code></li><li><strong>id</strong>: <code>string</code></li><li><strong>name</strong>: <code>string</code></li></ul></li></ul><h2 id="onactivatenextcb" tabindex="-1">OnActivateNextCb <a class="header-anchor" href="#onactivatenextcb" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Type alias</code></li></ul><h2 id="onactivatepreviouscb" tabindex="-1">OnActivatePreviousCb <a class="header-anchor" href="#onactivatepreviouscb" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Type alias</code></li></ul><h2 id="onappendblockcb" tabindex="-1">OnAppendBlockCb <a class="header-anchor" href="#onappendblockcb" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Type alias</code></li></ul><h2 id="onprependblockcb" tabindex="-1">OnPrependBlockCb <a class="header-anchor" href="#onprependblockcb" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Type alias</code></li></ul><h2 id="onremoveselfcb" tabindex="-1">OnRemoveSelfCb <a class="header-anchor" href="#onremoveselfcb" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Type alias</code></li></ul><h2 id="onupdateblockcb" tabindex="-1">OnUpdateBlockCb <a class="header-anchor" href="#onupdateblockcb" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Type alias</code></li></ul><h2 id="onupdateselfcb-t" tabindex="-1">OnUpdateSelfCb&lt;T&gt; <a class="header-anchor" href="#onupdateselfcb-t" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Type alias</code></li></ul><h2 id="sbblock" tabindex="-1">SbBlock <a class="header-anchor" href="#sbblock" aria-hidden="true">#</a></h2><p>Displays a Schlechtenburg block either the mode of the schlechtenburg instance. You can use this to display child blocks inside your own blocks.</p><ul><li><strong>Type</strong>: <code>Component</code></li></ul><h3 id="props" tabindex="-1">Props <a class="header-anchor" href="#props" aria-hidden="true">#</a></h3><h4 id="block" tabindex="-1">block <a class="header-anchor" href="#block" aria-hidden="true">#</a></h4><p>The state for the block.</p><ul><li><strong>Type</strong> <code>IBlockData&lt;any&gt;</code></li></ul><h4 id="onupdate" tabindex="-1">onUpdate <a class="header-anchor" href="#onupdate" aria-hidden="true">#</a></h4><p>Called when the block should be updated.</p><ul><li><p><strong>Type</strong> <code>OnUpdateBlockCb</code></p></li><li><p><strong>Default value</strong> <code>() =&gt; {}</code></p></li></ul><h4 id="onprependblock" tabindex="-1">onPrependBlock <a class="header-anchor" href="#onprependblock" aria-hidden="true">#</a></h4><p>Called when a sibling block should be inserted before the block</p><ul><li><p><strong>Type</strong> <code>OnPrependBlockCb</code></p></li><li><p><strong>Default value</strong> <code>() =&gt; {}</code></p></li></ul><h4 id="onappendblock" tabindex="-1">onAppendBlock <a class="header-anchor" href="#onappendblock" aria-hidden="true">#</a></h4><p>Called when a sibling block should be inserted after the block</p><ul><li><p><strong>Type</strong> <code>OnAppendBlockCb</code></p></li><li><p><strong>Default value</strong> <code>() =&gt; {}</code></p></li></ul><h4 id="onremoveself" tabindex="-1">onRemoveSelf <a class="header-anchor" href="#onremoveself" aria-hidden="true">#</a></h4><p>Called when the block should be removed</p><ul><li><p><strong>Type</strong> <code>OnRemoveSelfCb</code></p></li><li><p><strong>Default value</strong> <code>() =&gt; {}</code></p></li></ul><h4 id="onactivateprevious" tabindex="-1">onActivatePrevious <a class="header-anchor" href="#onactivateprevious" aria-hidden="true">#</a></h4><p>Called when the previous sibling block should be activated</p><ul><li><p><strong>Type</strong> <code>OnActivatePreviousCb</code></p></li><li><p><strong>Default value</strong> <code>() =&gt; {}</code></p></li></ul><h4 id="onactivatenext" tabindex="-1">onActivateNext <a class="header-anchor" href="#onactivatenext" aria-hidden="true">#</a></h4><p>Called when the next sibling block should be activated</p><ul><li><p><strong>Type</strong> <code>OnActivateNextCb</code></p></li><li><p><strong>Default value</strong> <code>() =&gt; {}</code></p></li></ul><h2 id="sbblockordering" tabindex="-1">SbBlockOrdering <a class="header-anchor" href="#sbblockordering" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong>: <code>Component</code></li></ul><h3 id="props-1" tabindex="-1">Props <a class="header-anchor" href="#props-1" aria-hidden="true">#</a></h3><h4 id="orientation" tabindex="-1">orientation <a class="header-anchor" href="#orientation" aria-hidden="true">#</a></h4><ul><li><p><strong>Type</strong> <code>string</code></p></li><li><p><strong>Default value</strong> <code>null</code></p></li></ul><h4 id="onremove" tabindex="-1">onRemove <a class="header-anchor" href="#onremove" aria-hidden="true">#</a></h4><ul><li><p><strong>Type</strong> <code>func</code></p></li><li><p><strong>Default value</strong> <code>() =&gt; {}</code></p></li></ul><h4 id="onmovebackward" tabindex="-1">onMoveBackward <a class="header-anchor" href="#onmovebackward" aria-hidden="true">#</a></h4><ul><li><p><strong>Type</strong> <code>func</code></p></li><li><p><strong>Default value</strong> <code>() =&gt; {}</code></p></li></ul><h4 id="onmoveforward" tabindex="-1">onMoveForward <a class="header-anchor" href="#onmoveforward" aria-hidden="true">#</a></h4><ul><li><p><strong>Type</strong> <code>func</code></p></li><li><p><strong>Default value</strong> <code>() =&gt; {}</code></p></li></ul><h2 id="sbblockpicker" tabindex="-1">SbBlockPicker <a class="header-anchor" href="#sbblockpicker" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong>: <code>Component</code></li></ul><h3 id="props-2" tabindex="-1">Props <a class="header-anchor" href="#props-2" aria-hidden="true">#</a></h3><h4 id="onpickedblock" tabindex="-1">onPickedBlock <a class="header-anchor" href="#onpickedblock" aria-hidden="true">#</a></h4><ul><li><p><strong>Type</strong> <code>func</code></p></li><li><p><strong>Default value</strong> <code>() =&gt; {}</code></p></li></ul><h2 id="sbblockplaceholder" tabindex="-1">SbBlockPlaceholder <a class="header-anchor" href="#sbblockplaceholder" aria-hidden="true">#</a></h2><p>A placeholder for a block. Displays a placeholder for a block, allowing the user to select a block to insert.</p><ul><li><strong>Type</strong>: <code>Component</code></li></ul><h3 id="props-3" tabindex="-1">Props <a class="header-anchor" href="#props-3" aria-hidden="true">#</a></h3><h4 id="oninsertblock" tabindex="-1">onInsertBlock <a class="header-anchor" href="#oninsertblock" aria-hidden="true">#</a></h4><p>Called when the user picked a block that should be inserted here.</p><ul><li><p><strong>Type</strong> <code>func</code></p></li><li><p><strong>Default value</strong> <code>() =&gt; {}</code></p></li></ul><h2 id="sbbutton" tabindex="-1">SbButton <a class="header-anchor" href="#sbbutton" aria-hidden="true">#</a></h2><p>A button in the schlechtenburg theme</p><ul><li><strong>Type</strong>: <code>Component</code></li></ul><h3 id="props-4" tabindex="-1">Props <a class="header-anchor" href="#props-4" aria-hidden="true">#</a></h3><h2 id="sbmain" tabindex="-1">SbMain <a class="header-anchor" href="#sbmain" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Variable</code></li></ul><h2 id="sbselect" tabindex="-1">SbSelect <a class="header-anchor" href="#sbselect" aria-hidden="true">#</a></h2><p>A select input in the schlechtenburg theme</p><ul><li><strong>Type</strong>: <code>Component</code></li></ul><h3 id="props-5" tabindex="-1">Props <a class="header-anchor" href="#props-5" aria-hidden="true">#</a></h3><h2 id="sbtoolbar" tabindex="-1">SbToolbar <a class="header-anchor" href="#sbtoolbar" aria-hidden="true">#</a></h2><p>Toolbar in the schlechtenburg theme</p><ul><li><strong>Type</strong>: <code>Component</code></li></ul><h3 id="props-6" tabindex="-1">Props <a class="header-anchor" href="#props-6" aria-hidden="true">#</a></h3><h2 id="symactiveblock" tabindex="-1">SymActiveBlock <a class="header-anchor" href="#symactiveblock" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Variable</code></li></ul><h2 id="symblockdimensions" tabindex="-1">SymBlockDimensions <a class="header-anchor" href="#symblockdimensions" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Variable</code></li></ul><h2 id="symblocklibrary" tabindex="-1">SymBlockLibrary <a class="header-anchor" href="#symblocklibrary" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Variable</code></li></ul><h2 id="symeditordimensions" tabindex="-1">SymEditorDimensions <a class="header-anchor" href="#symeditordimensions" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Variable</code></li></ul><h2 id="symmode" tabindex="-1">SymMode <a class="header-anchor" href="#symmode" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Variable</code></li></ul><h2 id="blockprops" tabindex="-1">blockProps <a class="header-anchor" href="#blockprops" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Variable</code></li></ul><h2 id="model" tabindex="-1">model <a class="header-anchor" href="#model" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Variable</code></li></ul><h2 id="generateblockid" tabindex="-1">generateBlockId <a class="header-anchor" href="#generateblockid" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Function</code></li></ul><h2 id="useactivation" tabindex="-1">useActivation <a class="header-anchor" href="#useactivation" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Function</code></li></ul><h2 id="useblocksizing" tabindex="-1">useBlockSizing <a class="header-anchor" href="#useblocksizing" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Function</code></li></ul><h2 id="usedynamicblocks" tabindex="-1">useDynamicBlocks <a class="header-anchor" href="#usedynamicblocks" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Function</code></li></ul><h2 id="useresizeobserver" tabindex="-1">useResizeObserver <a class="header-anchor" href="#useresizeobserver" aria-hidden="true">#</a></h2><ul><li><strong>Type</strong> <code>Function</code></li></ul></div></div><footer class="page-footer" data-v-7eddb2c4 data-v-07c132fc><div class="edit" data-v-07c132fc><div class="edit-link" data-v-07c132fc data-v-1ed99556><!----></div></div><div class="updated" data-v-07c132fc><!----></div></footer><div class="next-and-prev-link" data-v-7eddb2c4 data-v-38ede35f><div class="container" data-v-38ede35f><div class="prev" data-v-38ede35f><a class="link" href="/schlechtenburg/api/@schlechtenburg/standalone" data-v-38ede35f><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-38ede35f><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-38ede35f>@schlechtenburg/standalone</span></a></div><div class="next" data-v-38ede35f><a class="link" href="/schlechtenburg/api/@schlechtenburg/layout" data-v-38ede35f><span class="text" data-v-38ede35f>@schlechtenburg/layout</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-38ede35f><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
<script>__VP_HASH_MAP__ = JSON.parse("{\"api_@schlechtenburg_core.md\":\"4063a713\",\"api_@schlechtenburg_heading.md\":\"ed89ddd1\",\"api_@schlechtenburg_image.md\":\"8d0d9fd9\",\"api_@schlechtenburg_layout.md\":\"1da56817\",\"api_@schlechtenburg_paragraph.md\":\"8709c1d7\",\"api_@schlechtenburg_standalone.md\":\"230a9366\",\"guide_examples.md\":\"f568382d\",\"guide_installation.md\":\"491f5af1\",\"guide_why.md\":\"1cac0594\",\"index.md\":\"3edeae7e\"}")</script>
<script type="module" async src="/schlechtenburg/assets/app.d1307649.js"></script>
</body>
</html>