profectus-docs/assets/api_modules_features_links.md.5299fc5a.js

import{_ as t,c as e,o as d,N as l}from"./chunks/framework.0799945b.js";const h=JSON.parse('{"title":"Module: features/links/links","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/links.md","lastUpdated":null}'),o={name:"api/modules/features/links.md"},a=l('<h1 id="module-features-links-links" tabindex="-1">Module: features/links/links <a class="header-anchor" href="#module-features-links-links" aria-label="Permalink to &quot;Module: features/links/links&quot;">​</a></h1><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to &quot;Interfaces&quot;">​</a></h2><h3 id="baselinks" tabindex="-1">BaseLinks <a class="header-anchor" href="#baselinks" aria-label="Permalink to &quot;BaseLinks&quot;">​</a></h3><p>• <strong>BaseLinks</strong>: <code>Object</code></p><p>The properties that are added onto a processed <a href="./links#linksoptions">LinksOptions</a> to create an <a href="./links#links">Links</a>.</p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>[Component]</code></td><td style="text-align:left;"><a href="./feature#genericcomponent"><code>GenericComponent</code></a></td><td style="text-align:left;">The Vue component used to render this feature.</td></tr><tr><td style="text-align:left;"><code>[GatherProps]</code></td><td style="text-align:left;">() =&gt; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a>&lt;<code>string</code>, <code>unknown</code>&gt;</td><td style="text-align:left;">A function to gather the props the vue component requires for this feature.</td></tr><tr><td style="text-align:left;"><code>type</code></td><td style="text-align:left;">typeof <a href="./links#linkstype"><code>LinksType</code></a></td><td style="text-align:left;">A symbol that helps identify features of the same type.</td></tr></tbody></table><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/c386ace/src/features/links/links.ts#L30" target="_blank" rel="noreferrer">profectus/src/features/links/links.ts:30</a></p><hr><h3 id="link" tabindex="-1">Link <a class="header-anchor" href="#link" aria-label="Permalink to &quot;Link&quot;">​</a></h3><p>• <strong>Link</strong>: <code>Object</code></p><p>Represents a link between two nodes. It will be displayed as an SVG line, and can take any appropriate properties for an SVG line element.</p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>accent-height?</code></td><td style="text-align:left;"><code>Numberish</code></td><td style="text-align:left;">-</td></tr><tr><td style="text-align:left;"><code>accumulate?</code></td><td style="text-align:left;"><code>&quot;none&quot;</code> | <code>&quot;sum&quot;</code></td><td style="text-align:left;">-</td></tr><tr><td style="text-align:left;"><code>additive?</code></td><td style="text-align:left;"><code>&quot;sum&quot;</code> | <code>&quot;replace&quot;</code></td><td style="text-align:left;">-</td></tr><tr><td style="text-align:left;"><code>alignment-baseline?</code></td><td style="text-align:left;"><code>&quot;alphabetic&quot;</code> | <code>&quot;hanging&quot;</code> | <code>&quot;ideographic&quot;</code> | <code>&quot;mathematical&quot;</code> | <code>&quot;auto&quot;</code> | <code>&quot;baseline&quot;</code> | <code>&quot;before-edge&quot;</code> | <code>&quot;text-before-edge&quot;</code> | <code>&quot;middle&quot;</code> | <code>&quot;central&quot;</code> | <code>&quot;after-edge&quot;</code> | <code>&quot;text-after-edge&quot;</code> | <code>&quot;inherit&quot;</code></td><td style="