321 lines
18 KiB
HTML
321 lines
18 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>"components/general/Tooltip" | lightcordapi</title>
|
|
<meta name="description" content="Documentation for lightcordapi">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">lightcordapi</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../globals.html">Globals</a>
|
|
</li>
|
|
<li>
|
|
<a href="_components_general_tooltip_.html">"components/general/Tooltip"</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Module "components/general/Tooltip"</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Classes</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/_components_general_tooltip_.tooltip.html" class="tsd-kind-icon">Tooltip</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Type aliases</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_components_general_tooltip_.html#tooltipcolor" class="tsd-kind-icon">Tooltip<wbr>Color</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_components_general_tooltip_.html#tooltipdata" class="tsd-kind-icon">Tooltip<wbr>Data</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_components_general_tooltip_.html#tooltipposition" class="tsd-kind-icon">Tooltip<wbr>Position</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_components_general_tooltip_.html#tooltipprops" class="tsd-kind-icon">Tooltip<wbr>Props</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-not-exported">
|
|
<h3>Variables</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_components_general_tooltip_.html#allpreviews" class="tsd-kind-icon">All<wbr>Previews</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_components_general_tooltip_.html#tooltipmodules" class="tsd-kind-icon">Tooltip<wbr>Modules</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Type aliases</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="tooltipcolor" class="tsd-anchor"></a>
|
|
<h3>Tooltip<wbr>Color</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Tooltip<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"black"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"grey"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"brand"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"green"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"yellow"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"red"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in lightcordapi/src/components/general/Tooltip.ts:100</li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a name="tooltipdata" class="tsd-anchor"></a>
|
|
<h3>Tooltip<wbr>Data</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Tooltip<wbr>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>aria-label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>onClick<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>onContextMenu<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>onMouseEnter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>onMouseLeave<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in lightcordapi/src/components/general/Tooltip.ts:5</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>aria-<wbr>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>on<wbr>Click<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Click<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in lightcordapi/src/components/general/Tooltip.ts:6</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>on<wbr>Context<wbr>Menu<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Context<wbr>Menu<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in lightcordapi/src/components/general/Tooltip.ts:9</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>on<wbr>Mouse<wbr>Enter<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Mouse<wbr>Enter<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in lightcordapi/src/components/general/Tooltip.ts:7</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>on<wbr>Mouse<wbr>Leave<span class="tsd-signature-symbol">: </span>function</h5>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Mouse<wbr>Leave<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in lightcordapi/src/components/general/Tooltip.ts:8</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="tooltipposition" class="tsd-anchor"></a>
|
|
<h3>Tooltip<wbr>Position</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Tooltip<wbr>Position<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"top"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"left"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"right"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"bottom"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in lightcordapi/src/components/general/Tooltip.ts:99</li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a name="tooltipprops" class="tsd-anchor"></a>
|
|
<h3>Tooltip<wbr>Props</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Tooltip<wbr>Props<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>children<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactNode</span><span class="tsd-signature-symbol">; </span>color<span class="tsd-signature-symbol">?: </span><a href="_components_general_tooltip_.html#tooltipcolor" class="tsd-signature-type">TooltipColor</a><span class="tsd-signature-symbol">; </span>position<span class="tsd-signature-symbol">?: </span><a href="_components_general_tooltip_.html#tooltipposition" class="tsd-signature-type">TooltipPosition</a><span class="tsd-signature-symbol">; </span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in lightcordapi/src/components/general/Tooltip.ts:12</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>children<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactNode</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> color<span class="tsd-signature-symbol">?: </span><a href="_components_general_tooltip_.html#tooltipcolor" class="tsd-signature-type">TooltipColor</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> position<span class="tsd-signature-symbol">?: </span><a href="_components_general_tooltip_.html#tooltipposition" class="tsd-signature-type">TooltipPosition</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
|
<h2>Variables</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
|
<a name="allpreviews" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> All<wbr>Previews</h3>
|
|
<div class="tsd-signature tsd-kind-icon">All<wbr>Previews<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in lightcordapi/src/components/general/Tooltip.ts:97</li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
|
<a name="tooltipmodules" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> Tooltip<wbr>Modules</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Tooltip<wbr>Modules<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in lightcordapi/src/components/general/Tooltip.ts:19</li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class="globals ">
|
|
<a href="../globals.html"><em>Globals</em></a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="_components_general_tooltip_.html">"components/general/<wbr>Tooltip"</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
|
|
<a href="../classes/_components_general_tooltip_.tooltip.html" class="tsd-kind-icon">Tooltip</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="_components_general_tooltip_.html#tooltipcolor" class="tsd-kind-icon">Tooltip<wbr>Color</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="_components_general_tooltip_.html#tooltipdata" class="tsd-kind-icon">Tooltip<wbr>Data</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="_components_general_tooltip_.html#tooltipposition" class="tsd-kind-icon">Tooltip<wbr>Position</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="_components_general_tooltip_.html#tooltipprops" class="tsd-kind-icon">Tooltip<wbr>Props</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="_components_general_tooltip_.html#allpreviews" class="tsd-kind-icon">All<wbr>Previews</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="_components_general_tooltip_.html#tooltipmodules" class="tsd-kind-icon">Tooltip<wbr>Modules</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
|
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |