1 line
8.6 KiB
JavaScript
1 line
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/8c0a0c4/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/8c0a0c4/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/8c0a0c4/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 function that returns an array of initial board nodes, without IDs.</p><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h5><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><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/boards/board.ts#L228" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:228</a></p><hr><h3 id="state" tabindex="-1">state <a class="header-anchor" href="#state" aria-label="Permalink to "state""></a></h3><p>• <code>Optional</code> <strong>state</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../../modules/features/boards/board#boarddata"><code>BoardData</code></a>></p><p>The persistent state of the board.</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/boards/board.ts#L232" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:232</a></p><hr><h3 id="style" tabindex="-1">style <a class="header-anchor" href="#style" aria-label="Permalink to "style""></a></h3><p>• <code>Optional</code> <strong>style</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../../modules/features/feature#stylevalue"><code>StyleValue</code></a>></p><p>CSS to apply to this feature.</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/boards/board.ts#L226" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:226</a></p><hr><h3 id="types" tabindex="-1">types <a class="header-anchor" href="#types" aria-label="Permalink to "types""></a></h3><p>• <strong>types</strong>: <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <a href="./board.NodeTypeOptions"><code>NodeTypeOptions</code></a>></p><p>A dictionary of node types that can appear on the board.</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/boards/board.ts#L230" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:230</a></p><hr><h3 id="visibility" tabindex="-1">visibility <a class="header-anchor" href="#visibility" aria-label="Permalink to "visibility""></a></h3><p>• <code>Optional</code> <strong>visibility</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<code>boolean</code> | <a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>></p><p>Whether this board should be visible.</p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/boards/board.ts#L218" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:218</a></p><hr><h3 id="width" tabindex="-1">width <a class="header-anchor" href="#width" aria-label="Permalink to "width""></a></h3><p>• <code>Optional</code> <strong>width</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<code>string</code>></p><p>The width of the board. Defaults to 100%</p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/boards/board.ts#L222" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:222</a></p>',61),s=[d];function i(n,c,l,h,p,f){return t(),a("div",null,s)}const g=e(o,[["render",i]]);export{u as __pageData,g as default};
|