profectus-docs/assets/api_modules_features_tooltips_tooltip.md.25104fdf.js

2 lines
8 KiB
JavaScript
Raw Normal View History

import{_ as e,c as t,o,N as a}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Module: features/tooltips/tooltip","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/tooltips/tooltip.md","lastUpdated":null}'),l={name:"api/modules/features/tooltips/tooltip.md"},d=a('<h1 id="module-features-tooltips-tooltip" tabindex="-1">Module: features/tooltips/tooltip <a class="header-anchor" href="#module-features-tooltips-tooltip" aria-label="Permalink to &quot;Module: features/tooltips/tooltip&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="./TooltipComponent">Tooltip</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/tooltips/tooltip.BaseTooltip">BaseTooltip</a></li><li><a href="../../../interfaces/features/tooltips/tooltip.TooltipOptions">TooltipOptions</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="generictooltip" tabindex="-1">GenericTooltip <a class="header-anchor" href="#generictooltip" aria-label="Permalink to &quot;GenericTooltip&quot;"></a></h3><p>Ƭ <strong>GenericTooltip</strong>: <a href="./../feature#replace"><code>Replace</code></a>&lt;<a href="./tooltip#tooltip"><code>Tooltip</code></a>&lt;<a href="../../../interfaces/features/tooltips/tooltip.TooltipOptions"><code>TooltipOptions</code></a>&gt;, { <code>direction</code>: <a href="./../../util/computed#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="../../../enums/util/common.Direction"><code>Direction</code></a>&gt; ; <code>pinnable</code>: <code>boolean</code> ; <code>pinned</code>: <code>Ref</code>&lt;<code>boolean</code>&gt; | <code>undefined</code> }&gt;</p><p>A type that matches any valid <a href="./tooltip#tooltip">Tooltip</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/tooltips/tooltip.ts#L67" target="_blank" rel="noreferrer">profectus/src/features/tooltips/tooltip.ts:67</a></p><hr><h3 id="tooltip" tabindex="-1">Tooltip <a class="header-anchor" href="#tooltip" aria-label="Permalink to &quot;Tooltip&quot;"></a></h3><p>Ƭ <strong>Tooltip</strong>&lt;<code>T</code>&gt;: <a href="./../feature#replace"><code>Replace</code></a>&lt;<code>T</code> &amp; <a href="../../../interfaces/features/tooltips/tooltip.BaseTooltip"><code>BaseTooltip</code></a>, { <code>classes</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;classes&quot;</code>]&gt; ; <code>direction</code>: <a href="./../../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;direction&quot;</code>], <a href="./../../../enums/util/common.Direction#up"><code>Up</code></a>&gt; ; <code>display</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;display&quot;</code>]&gt; ; <code>pinnable</code>: <code>T</code>[<code>&quot;pinnable&quot;</code>] extends <code>undefined</code> ? <code>false</code> : <code>T</code>[<code>&quot;pinnable&quot;</code>] ; <code>pinned</code>: <code>T</code>[<code>&quot;pinnable&quot;</code>] extends <code>true</code> ? <code>Ref</code>&lt;<code>boolean</code>&gt; : <code>undefined</code> ; <code>style</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;style&quot;</code>]&gt; ; <code>xoffset</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<