1 line
5.3 KiB
JavaScript
1 line
5.3 KiB
JavaScript
import{_ as a,c as t,a0 as o,o as r}from"./chunks/framework.P9qPzDnn.js";const f=JSON.parse('{"title":"Interface: SetupActionsOptions<T>","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/game/boards/board/interfaces/SetupActionsOptions.md","filePath":"api/game/boards/board/interfaces/SetupActionsOptions.md","lastUpdated":null}'),n={name:"api/game/boards/board/interfaces/SetupActionsOptions.md"};function s(i,e,d,c,l,h){return r(),t("div",null,e[0]||(e[0]=[o('<p><a href="./../../../../">Profectus</a> / <a href="./../">game/boards/board</a> / SetupActionsOptions</p><h1 id="interface-setupactionsoptions-t" tabindex="-1">Interface: SetupActionsOptions<T> <a class="header-anchor" href="#interface-setupactionsoptions-t" aria-label="Permalink to "Interface: SetupActionsOptions\\<T\\>""></a></h1><p>An object that configures how to setup a list of actions using <a href="./../functions/setupActions">setupActions</a>.</p><h2 id="type-parameters" tabindex="-1">Type Parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to "Type Parameters""></a></h2><p>• <strong>T</strong> <em>extends</em> <a href="./../type-aliases/NodePosition"><code>NodePosition</code></a></p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="actions" tabindex="-1">actions <a class="header-anchor" href="#actions" aria-label="Permalink to "actions""></a></h3><blockquote><p><strong>actions</strong>: <a href="./../type-aliases/NodeMaybeRefOrGetter"><code>NodeMaybeRefOrGetter</code></a><<code>T</code>, (<code>position</code>) => <a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>[], []></p></blockquote><p>The list of actions to display. Actions are arbitrary JSX elements.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/boards/board.tsx#L357" target="_blank" rel="noreferrer">profectus/src/game/boards/board.tsx:357</a></p><hr><h3 id="arclength" tabindex="-1">arcLength? <a class="header-anchor" href="#arclength" aria-label="Permalink to "arcLength?""></a></h3><blockquote><p><code>optional</code> <strong>arcLength</strong>: <a href="./../type-aliases/NodeMaybeRefOrGetter"><code>NodeMaybeRefOrGetter</code></a><<code>T</code>, <code>number</code>, []></p></blockquote><p>The arc length to place between actions, in radians.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/boards/board.tsx#L361" target="_blank" rel="noreferrer">profectus/src/game/boards/board.tsx:361</a></p><hr><h3 id="distance" tabindex="-1">distance <a class="header-anchor" href="#distance" aria-label="Permalink to "distance""></a></h3><blockquote><p><strong>distance</strong>: <a href="./../type-aliases/NodeMaybeRefOrGetter"><code>NodeMaybeRefOrGetter</code></a><<code>T</code>, <code>number</code>, []></p></blockquote><p>The distance from the node to place the actions.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/boards/board.tsx#L359" target="_blank" rel="noreferrer">profectus/src/game/boards/board.tsx:359</a></p><hr><h3 id="node" tabindex="-1">node <a class="header-anchor" href="#node" aria-label="Permalink to "node""></a></h3><blockquote><p><strong>node</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>undefined</code> | <code>T</code>></p></blockquote><p>The node to display actions upon, or undefined when the actions should be hidden.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/boards/board.tsx#L353" target="_blank" rel="noreferrer">profectus/src/game/boards/board.tsx:353</a></p><hr><h3 id="shouldshowactions" tabindex="-1">shouldShowActions? <a class="header-anchor" href="#shouldshowactions" aria-label="Permalink to "shouldShowActions?""></a></h3><blockquote><p><code>optional</code> <strong>shouldShowActions</strong>: <a href="./../type-aliases/NodeMaybeRefOrGetter"><code>NodeMaybeRefOrGetter</code></a><<code>T</code>, <code>boolean</code>, []></p></blockquote><p>Whether or not to currently display the actions.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/boards/board.tsx#L355" target="_blank" rel="noreferrer">profectus/src/game/boards/board.tsx:355</a></p>',35)]))}const b=a(n,[["render",s]]);export{f as __pageData,b as default};
|