profectus-docs/assets/api_interfaces_features_bars_bar.BarOptions.md.9f1017b9.js

2 lines
10 KiB
JavaScript
Raw Normal View History

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 &quot;Interface: BarOptions&quot;"></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 &quot;Properties&quot;"></a></h2><h3 id="basestyle" tabindex="-1">baseStyle <a class="header-anchor" href="#basestyle" aria-label="Permalink to &quot;baseStyle&quot;"></a></h3><p> <code>Optional</code> <strong>baseStyle</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../../modules/features/feature#stylevalue"><code>StyleValue</code></a>&gt;</p><p>CSS to apply to the bar&#39;s base.</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/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 &quot;borderStyle&quot;"></a></h3><p> <code>Optional</code> <strong>borderStyle</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../../modules/features/feature#stylevalue"><code>StyleValue</code></a>&gt;</p><p>CSS to apply to the bar&#39;s border.</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/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 &quot;classes&quot;"></a></h3><p> <code>Optional</code> <strong>classes</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<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>boolean</code>&gt;&gt;</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 &quot;Defined in&quot;"></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 &quot;direction&quot;"></a></h3><p> <strong>direction</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="../../../enums/util/common.Direction"><code>Direction</code></a>&gt;</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 &quot;Defined in&quot;"></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