2 lines
8.6 KiB
JavaScript
2 lines
8.6 KiB
JavaScript
|
import{_ as e,c as a,o as t,N as r}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Interface: BoardOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/boards/board.BoardOptions.md","lastUpdated":null}'),o={name:"api/interfaces/features/boards/board.BoardOptions.md"},d=r('<h1 id="interface-boardoptions" tabindex="-1">Interface: BoardOptions <a class="header-anchor" href="#interface-boardoptions" aria-label="Permalink to "Interface: BoardOptions""></a></h1><p><a href="./../../../modules/features/boards/board">features/boards/board</a>.BoardOptions</p><p>An object that configures a <a href="./../../../modules/features/boards/board#board">Board</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="classes" tabindex="-1">classes <a class="header-anchor" href="#classes" aria-label="Permalink to "classes""></a></h3><p>• <code>Optional</code> <strong>classes</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>boolean</code>>></p><p>Dictionary of CSS classes to apply to this feature.</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/boards/board.ts#L224" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:224</a></p><hr><h3 id="height" tabindex="-1">height <a class="header-anchor" href="#height" aria-label="Permalink to "height""></a></h3><p>• <code>Optional</code> <strong>height</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<code>string</code>></p><p>The height of the board. Defaults to 100%</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/boards/board.ts#L220" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:220</a></p><hr><h3 id="links" tabindex="-1">links <a class="header-anchor" href="#links" aria-label="Permalink to "links""></a></h3><p>• <code>Optional</code> <strong>links</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<code>null</code> | <a href="./board.BoardNodeLink"><code>BoardNodeLink</code></a>[]></p><p>An array of board node links to display.</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/boards/board.ts#L234" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:234</a></p><hr><h3 id="startnodes" tabindex="-1">startNodes <a class="header-anchor" href="#startnodes" aria-label="Permalink to "startNodes""></a></h3><p>• <strong>startNodes</strong>: () => <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a><<a href="./board.BoardNode"><code>BoardNode</code></a>, <code>"id"</code>>[]</p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to "Type declaration""></a></h4><p>▸ (): <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a><<a href="./board.BoardNode"><code>BoardNode</code></a>, <code>"id"</code>>[]</p><p>A fu
|