1 line
10 KiB
JavaScript
1 line
10 KiB
JavaScript
import{_ as e,c as a,o as r,N as t}from"./chunks/framework.0799945b.js";const p=JSON.parse('{"title":"Interface: BarOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/bars/bar.BarOptions.md","lastUpdated":null}'),o={name:"api/interfaces/features/bars/bar.BarOptions.md"},s=t('<h1 id="interface-baroptions" tabindex="-1">Interface: BarOptions <a class="header-anchor" href="#interface-baroptions" aria-label="Permalink to "Interface: BarOptions""></a></h1><p><a href="./../../../modules/features/bars/bar">features/bars/bar</a>.BarOptions</p><p>An object that configures a <a href="./../../../modules/features/bars/bar#bar">Bar</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="basestyle" tabindex="-1">baseStyle <a class="header-anchor" href="#basestyle" aria-label="Permalink to "baseStyle""></a></h3><p>• <code>Optional</code> <strong>baseStyle</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../../modules/features/feature#stylevalue"><code>StyleValue</code></a>></p><p>CSS to apply to the bar's base.</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/bars/bar.ts#L44" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.ts:44</a></p><hr><h3 id="borderstyle" tabindex="-1">borderStyle <a class="header-anchor" href="#borderstyle" aria-label="Permalink to "borderStyle""></a></h3><p>• <code>Optional</code> <strong>borderStyle</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../../modules/features/feature#stylevalue"><code>StyleValue</code></a>></p><p>CSS to apply to the bar's border.</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/bars/bar.ts#L42" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.ts:42</a></p><hr><h3 id="classes" tabindex="-1">classes <a class="header-anchor" href="#classes" aria-label="Permalink to "classes""></a></h3><p>• <code>Optional</code> <strong>classes</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>boolean</code>>></p><p>Dictionary of CSS classes to apply to this feature.</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/bars/bar.ts#L40" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.ts:40</a></p><hr><h3 id="direction" tabindex="-1">direction <a class="header-anchor" href="#direction" aria-label="Permalink to "direction""></a></h3><p>• <strong>direction</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<a href="../../../enums/util/common.Direction"><code>Direction</code></a>></p><p>The direction in which the bar progresses.</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/bars/bar.ts#L36" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.ts:36</a></p><hr><h3 id="display" tabindex="-1">display <a class="header-anchor" href="#display" aria-label="Permalink to "display""></a></h3><p>• <code>Optional</code> <strong>display</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a>></p><p>The display to use for this bar.</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/bars/bar.ts#L52" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.ts:52</a></p><hr><h3 id="fillstyle" tabindex="-1">fillStyle <a class="header-anchor" href="#fillstyle" aria-label="Permalink to "fillStyle""></a></h3><p>• <code>Optional</code> <strong>fillStyle</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../../modules/features/feature#stylevalue"><code>StyleValue</code></a>></p><p>CSS to apply to the bar's fill.</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/bars/bar.ts#L48" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.ts:48</a></p><hr><h3 id="height" tabindex="-1">height <a class="header-anchor" href="#height" aria-label="Permalink to "height""></a></h3><p>• <strong>height</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<code>number</code>></p><p>The height of the bar.</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/bars/bar.ts#L34" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.ts:34</a></p><hr><h3 id="mark" tabindex="-1">mark <a class="header-anchor" href="#mark" aria-label="Permalink to "mark""></a></h3><p>• <code>Optional</code> <strong>mark</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<code>string</code> | <code>boolean</code>></p><p>Shows a marker on the corner of the feature.</p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/bars/bar.ts#L54" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.ts:54</a></p><hr><h3 id="progress" tabindex="-1">progress <a class="header-anchor" href="#progress" aria-label="Permalink to "progress""></a></h3><p>• <strong>progress</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a>></p><p>The progress value of the bar, from 0 to 1.</p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/bars/bar.ts#L50" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.ts:50</a></p><hr><h3 id="style" tabindex="-1">style <a class="header-anchor" href="#style" aria-label="Permalink to "style""></a></h3><p>• <code>Optional</code> <strong>style</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../../modules/features/feature#stylevalue"><code>StyleValue</code></a>></p><p>CSS to apply to this feature.</p><h4 id="defined-in-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/bars/bar.ts#L38" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.ts:38</a></p><hr><h3 id="textstyle" tabindex="-1">textStyle <a class="header-anchor" href="#textstyle" aria-label="Permalink to "textStyle""></a></h3><p>• <code>Optional</code> <strong>textStyle</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../../modules/features/feature#stylevalue"><code>StyleValue</code></a>></p><p>CSS to apply to the bar's text.</p><h4 id="defined-in-10" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-10" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/bars/bar.ts#L46" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.ts:46</a></p><hr><h3 id="visibility" tabindex="-1">visibility <a class="header-anchor" href="#visibility" aria-label="Permalink to "visibility""></a></h3><p>• <code>Optional</code> <strong>visibility</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<code>boolean</code> | <a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>></p><p>Whether this bar should be visible.</p><h4 id="defined-in-11" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-11" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/bars/bar.ts#L30" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.ts:30</a></p><hr><h3 id="width" tabindex="-1">width <a class="header-anchor" href="#width" aria-label="Permalink to "width""></a></h3><p>• <strong>width</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<code>number</code>></p><p>The width of the bar.</p><h4 id="defined-in-12" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-12" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/bars/bar.ts#L32" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.ts:32</a></p>',81),i=[s];function l(n,d,c,h,f,u){return r(),a("div",null,i)}const m=e(o,[["render",l]]);export{p as __pageData,m as default};
|