profectus-docs/assets/api_modules_features_board.md.daf85c69.js

import{_ as t,c as e,o as d,N as o}from"./chunks/framework.0799945b.js";const x=JSON.parse('{"title":"Module: features/boards/board","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/board.md","lastUpdated":null}'),l={name:"api/modules/features/board.md"},a=o('<h1 id="module-features-boards-board" tabindex="-1">Module: features/boards/board <a class="header-anchor" href="#module-features-boards-board" aria-label="Permalink to &quot;Module: features/boards/board&quot;">​</a></h1><h2 id="enumerations" tabindex="-1">Enumerations <a class="header-anchor" href="#enumerations" aria-label="Permalink to &quot;Enumerations&quot;">​</a></h2><h3 id="progressdisplay" tabindex="-1">ProgressDisplay <a class="header-anchor" href="#progressdisplay" aria-label="Permalink to &quot;ProgressDisplay&quot;">​</a></h3><p>• <strong>ProgressDisplay</strong>: <code>Object</code></p><p>Ways to display progress of an action with a duration.</p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>Fill</code></td><td style="text-align:left;"><code>&quot;Fill&quot;</code></td></tr><tr><td style="text-align:left;"><code>Outline</code></td><td style="text-align:left;"><code>&quot;Outline&quot;</code></td></tr></tbody></table><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/b666e0c/src/features/boards/board.ts#L39" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:39</a></p><hr><h3 id="shape" tabindex="-1">Shape <a class="header-anchor" href="#shape" aria-label="Permalink to &quot;Shape&quot;">​</a></h3><p>• <strong>Shape</strong>: <code>Object</code></p><p>Node shapes.</p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>Circle</code></td><td style="text-align:left;"><code>&quot;Circle&quot;</code></td></tr><tr><td style="text-align:left;"><code>Diamond</code></td><td style="text-align:left;"><code>&quot;Triangle&quot;</code></td></tr></tbody></table><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/b666e0c/src/features/boards/board.ts#L45" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:45</a></p><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to &quot;Interfaces&quot;">​</a></h2><h3 id="baseboard" tabindex="-1">BaseBoard <a class="header-anchor" href="#baseboard" aria-label="Permalink to &quot;BaseBoard&quot;">​</a></h3><p>• <strong>BaseBoard</strong>: <code>Object</code></p><p>The properties that are added onto a processed <a href="./board#boardoptions">BoardOptions</a> to create a <a href="./board#board">Board</a>.</p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>[Component]</code></td><td style="text-align:left;"><a href="./feature#genericcomponent"><code>GenericComponent</code></a></td><td style="text-align:left;">The Vue component used to render this feature.</td></tr><tr><td style="text-align:left;"><code>[GatherProps]</code></td><td style="text-align:left;">() =&gt; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a>&lt;<code>string</code>, <code>unknown</code>&gt;</td><td style="text-align:left;">A function to gather the props the vue component requires for this feature.</td></tr><tr><td style="text-align:left;"><code>id</code></td><td style="text-align:left;"><code>string</code></td><td style="text-ali