profectus-docs/assets/api_modules_data_themes.md.f4379a66.js

2 lines
7.6 KiB
JavaScript
Raw Normal View History

import{_ as t,c as e,o as a,N as d}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Module: data/themes","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/data/themes.md","lastUpdated":null}'),l={name:"api/modules/data/themes.md"},o=d('<h1 id="module-data-themes" tabindex="-1">Module: data/themes <a class="header-anchor" href="#module-data-themes" aria-label="Permalink to &quot;Module: data/themes&quot;"></a></h1><h2 id="enumerations" tabindex="-1">Enumerations <a class="header-anchor" href="#enumerations" aria-label="Permalink to &quot;Enumerations&quot;"></a></h2><h3 id="themes" tabindex="-1">Themes <a class="header-anchor" href="#themes" aria-label="Permalink to &quot;Themes&quot;"></a></h3><p> <strong>Themes</strong>: <code>Object</code></p><p>An enum of all available themes and their internal IDs. The keys are their display names.</p><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>Aqua</code></td><td style="text-align:left;"><code>&quot;aqua&quot;</code></td></tr><tr><td style="text-align:left;"><code>Classic</code></td><td style="text-align:left;"><code>&quot;classic&quot;</code></td></tr><tr><td style="text-align:left;"><code>Nordic</code></td><td style="text-align:left;"><code>&quot;nordic&quot;</code></td></tr><tr><td style="text-align:left;"><code>Paper</code></td><td style="text-align:left;"><code>&quot;paper&quot;</code></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/c9ca859/src/data/themes.ts#L73" target="_blank" rel="noreferrer">profectus/src/data/themes.ts:73</a></p><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to &quot;Interfaces&quot;"></a></h2><h3 id="theme" tabindex="-1">Theme <a class="header-anchor" href="#theme" aria-label="Permalink to &quot;Theme&quot;"></a></h3><p> <strong>Theme</strong>: <code>Object</code></p><p>An object representing a theme the player can use to change the look of the game.</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>floatingTabs</code></td><td style="text-align:left;"><code>boolean</code></td><td style="text-align:left;">Whether or not tabs should &quot;float&quot; in the center of their container.</td></tr><tr><td style="text-align:left;"><code>mergeAdjacent</code></td><td style="text-align:left;"><code>boolean</code></td><td style="text-align:left;">Whether or not adjacent features should merge together - removing the margin between them, and only applying the border radius to the first and last elements in the row or column.</td></tr><tr><td style="text-align:left;"><code>showPin</code></td><td style="text-align:left;"><code>boolean</code></td><td style="text-align:left;">Whether or not to show a pin icon on pinned tooltips.</td></tr><tr><td style="text-align:left;"><code>variables</code></td><td style="text-align:left;"><a href="./themes#themevars"><code>ThemeVars</code></a></td><td style="text-align:left;">The values of the theme&#39;s CSS variables.</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/c9ca859/src/data/themes.ts#L24" target="_blank" rel="noreferrer">profectus/src/data/themes.ts:24</a></p><hr><h3 id="themevars" tabindex="-1">ThemeVars <a class="header-anchor" href="#themevars" aria-label="Permalink to &quot;ThemeVars&quot;"></a></h3><p> <strong>ThemeVars</strong>: <code>Object</code></p><p>A object of all CSS variables determined by the current theme.</p><table><thead><tr><th