1 line
6.8 KiB
JavaScript
1 line
6.8 KiB
JavaScript
import{_ as e,c as a,o,N as r}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Interface: BoardNodeActionOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/boards/board.BoardNodeActionOptions.md","lastUpdated":null}'),t={name:"api/interfaces/features/boards/board.BoardNodeActionOptions.md"},d=r('<h1 id="interface-boardnodeactionoptions" tabindex="-1">Interface: BoardNodeActionOptions <a class="header-anchor" href="#interface-boardnodeactionoptions" aria-label="Permalink to "Interface: BoardNodeActionOptions""></a></h1><p><a href="./../../../modules/features/boards/board">features/boards/board</a>.BoardNodeActionOptions</p><p>An object that configures a <a href="./../../../modules/features/boards/board#boardnodeaction">BoardNodeAction</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="fillcolor" tabindex="-1">fillColor <a class="header-anchor" href="#fillcolor" aria-label="Permalink to "fillColor""></a></h3><p>• <code>Optional</code> <strong>fillColor</strong>: <a href="./../../../modules/features/boards/board#nodecomputable"><code>NodeComputable</code></a><<code>string</code>></p><p>The fill color of the action.</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#L177" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:177</a></p><hr><h3 id="icon" tabindex="-1">icon <a class="header-anchor" href="#icon" aria-label="Permalink to "icon""></a></h3><p>• <strong>icon</strong>: <a href="./../../../modules/features/boards/board#nodecomputable"><code>NodeComputable</code></a><<code>string</code>></p><p>The icon to display for the action.</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#L175" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:175</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to "id""></a></h3><p>• <strong>id</strong>: <code>string</code></p><p>A unique identifier for the action.</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#L171" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:171</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/features/boards/board#nodecomputable"><code>NodeComputable</code></a><<a href="./board.BoardNodeLink"><code>BoardNodeLink</code></a>[]></p><p>An array of board node links associated with the action. They appear when the action is focused.</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/70cda5f/src/features/boards/board.ts#L181" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:181</a></p><hr><h3 id="onclick" tabindex="-1">onClick <a class="header-anchor" href="#onclick" aria-label="Permalink to "onClick""></a></h3><p>• <strong>onClick</strong>: (<code>node</code>: <a href="./board.BoardNode"><code>BoardNode</code></a>) => <code>undefined</code> | <code>boolean</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>▸ (<code>node</code>): <code>undefined</code> | <code>boolean</code></p><p>A function that is called when the action is clicked.</p><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></a></h5><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>node</code></td><td style="text-align:left;"><a href="./board.BoardNode"><code>BoardNode</code></a></td></tr></tbody></table><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h5><p><code>undefined</code> | <code>boolean</code></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/70cda5f/src/features/boards/board.ts#L183" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:183</a></p><hr><h3 id="tooltip" tabindex="-1">tooltip <a class="header-anchor" href="#tooltip" aria-label="Permalink to "tooltip""></a></h3><p>• <strong>tooltip</strong>: <a href="./../../../modules/features/boards/board#nodecomputable"><code>NodeComputable</code></a><<code>string</code>></p><p>The tooltip text to display for the action.</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/70cda5f/src/features/boards/board.ts#L179" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:179</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/features/boards/board#nodecomputable"><code>NodeComputable</code></a><<code>boolean</code> | <a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>></p><p>Whether this action should be visible.</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/70cda5f/src/features/boards/board.ts#L173" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:173</a></p>',51),i=[d];function n(s,c,l,h,f,b){return o(),a("div",null,i)}const m=e(t,[["render",n]]);export{u as __pageData,m as default};
|