profectus-docs/assets/api_interfaces_features_links_links.BaseLinks.md.eebfe209.js

1 line
3.9 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const k=JSON.parse('{"title":"Interface: BaseLinks","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/links/links.BaseLinks.md","lastUpdated":null}'),n={name:"api/interfaces/features/links/links.BaseLinks.md"},s=r('<h1 id="interface-baselinks" tabindex="-1">Interface: BaseLinks <a class="header-anchor" href="#interface-baselinks" aria-label="Permalink to &quot;Interface: BaseLinks&quot;"></a></h1><p><a href="./../../../modules/features/links/links">features/links/links</a>.BaseLinks</p><p>The properties that are added onto a processed <a href="./links.LinksOptions">LinksOptions</a> to create an <a href="./../../../modules/features/links/links#links">Links</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="component" tabindex="-1">[Component] <a class="header-anchor" href="#component" aria-label="Permalink to &quot;[Component]&quot;"></a></h3><p>• <strong>[Component]</strong>: <a href="./../../../modules/features/feature#genericcomponent"><code>GenericComponent</code></a></p><p>The Vue component used to render this feature.</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#L34" target="_blank" rel="noreferrer">profectus/src/features/links/links.ts:34</a></p><hr><h3 id="gatherprops" tabindex="-1">[GatherProps] <a class="header-anchor" href="#gatherprops" aria-label="Permalink to &quot;[GatherProps]&quot;"></a></h3><p>• <strong>[GatherProps]</strong>: () =&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;</p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to &quot;Type declaration&quot;"></a></h4><p>▸ (): <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;</p><p>A function to gather the props the vue component requires for this feature.</p><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;"></a></h5><p><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;</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/links/links.ts#L36" target="_blank" rel="noreferrer">profectus/src/features/links/links.ts:36</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-label="Permalink to &quot;type&quot;"></a></h3><p>• <strong>type</strong>: typeof <a href="./../../../modules/features/links/links#linkstype"><code>LinksType</code></a></p><p>A symbol that helps identify features of the same type.</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/links/links.ts#L32" target="_blank" rel="noreferrer">profectus/src/features/links/links.ts:32</a></p>',25),o=[s];function i(l,c,d,p,h,f){return a(),t("div",null,o)}const b=e(n,[["render",i]]);export{k as __pageData,b as default};