profectus-docs/assets/api_interfaces_features_boards_board.BoardNodeActionOptions.md.339fab10.js

2 lines
6.8 KiB
JavaScript
Raw Normal View History

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 &quot;Interface: BoardNodeActionOptions&quot;"></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 &quot;Properties&quot;"></a></h2><h3 id="fillcolor" tabindex="-1">fillColor <a class="header-anchor" href="#fillcolor" aria-label="Permalink to &quot;fillColor&quot;"></a></h3><p> <code>Optional</code> <strong>fillColor</strong>: <a href="./../../../modules/features/boards/board#nodecomputable"><code>NodeComputable</code></a>&lt;<code>string</code>&gt;</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 &quot;Defined in&quot;"></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 &quot;icon&quot;"></a></h3><p> <strong>icon</strong>: <a href="./../../../modules/features/boards/board#nodecomputable"><code>NodeComputable</code></a>&lt;<code>string</code>&gt;</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 &quot;Defined in&quot;"></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 &quot;id&quot;"></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 &quot;Defined in&quot;"></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 &quot;links&quot;"></a></h3><p> <code>Optional</code> <strong>links</strong>: <a href="./../../../modules/features/boards/board#nodecomputable"><code>NodeComputable</code></a>&lt;<a href="./board.BoardNodeLink"><code>BoardNodeLink</code></a>[]&gt;</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 &quot;Defined in&quot;"></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 &quot;onClick&quot;"></a></h3><p> <strong>onClick</strong>: (<code>node</code>: <a href="./board.BoardNode"><code>BoardNode</code></a>) =&gt; <code>undefined</code> | <code>boolean</code></p><h4 id="type-declaration" tabindex="-1">Type declara