profectus-docs/assets/api_modules_features_links_links.md.5de1a01a.js

2 lines
6.9 KiB
JavaScript
Raw Normal View History

import{_ as e,c as t,o as a,N as n}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Module: features/links/links","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/links/links.md","lastUpdated":null}'),s={name:"api/modules/features/links/links.md"},i=n('<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="components" tabindex="-1">Components <a class="header-anchor" href="#components" aria-label="Permalink to &quot;Components&quot;"></a></h2><ul><li><a href="./LinkComponent">Link</a></li><li><a href="./LinksComponent">Links</a></li></ul><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to &quot;Interfaces&quot;"></a></h2><ul><li><a href="../../../interfaces/features/links/links.BaseLinks">BaseLinks</a></li><li><a href="../../../interfaces/features/links/links.Link">Link</a></li><li><a href="../../../interfaces/features/links/links.LinksOptions">LinksOptions</a></li></ul><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-label="Permalink to &quot;Type Aliases&quot;"></a></h2><h3 id="genericlinks" tabindex="-1">GenericLinks <a class="header-anchor" href="#genericlinks" aria-label="Permalink to &quot;GenericLinks&quot;"></a></h3><p>Ƭ <strong>GenericLinks</strong>: <a href="./../feature#replace"><code>Replace</code></a>&lt;<a href="./links#links"><code>Links</code></a>&lt;<a href="../../../interfaces/features/links/links.LinksOptions"><code>LinksOptions</code></a>&gt;, { <code>links</code>: <a href="./../../util/computed#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="../../../interfaces/features/links/links.Link"><code>Link</code></a>[]&gt; }&gt;</p><p>A type that matches any valid <a href="./links#links">Links</a> object.</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/links/links.ts#L48" target="_blank" rel="noreferrer">profectus/src/features/links/links.ts:48</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>Ƭ <strong>Links</strong>&lt;<code>T</code>&gt;: <a href="./../feature#replace"><code>Replace</code></a>&lt;<code>T</code> &amp; <a href="../../../interfaces/features/links/links.BaseLinks"><code>BaseLinks</code></a>, { <code>links</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;links&quot;</code>]&gt; }&gt;</p><p>An object that represents a list of links between nodes, which are the elements in the DOM for any renderable feature.</p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to &quot;Type parameters&quot;"></a></h4><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>T</code></td><td style="text-align:left;">extends <a href="../../../interfaces/features/links/links.LinksOptions"><code>LinksOptions</code></a></td></tr></tbody></table><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/links/links.ts#L40" target="_blank" rel="noreferrer">profectus/src/features/links/links.ts:40</a></p><h2 id="variables" tabindex="-1">Variables <a class="header-anchor" href="#variables" aria-label="Permalink to &quot;Variables&quot;"></a></h2><h3 id="linkstype" tabindex="-1">LinksType <a class="header-anchor" href="#linkstype" aria-lab