1 line
12 KiB
JavaScript
1 line
12 KiB
JavaScript
import{_ as r,c as t,a0 as a,o}from"./chunks/framework.P9qPzDnn.js";const p=JSON.parse('{"title":"Interface: BarOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/bars/bar/interfaces/BarOptions.md","filePath":"api/features/bars/bar/interfaces/BarOptions.md","lastUpdated":null}'),i={name:"api/features/bars/bar/interfaces/BarOptions.md"};function s(n,e,l,c,h,d){return o(),t("div",null,e[0]||(e[0]=[a('<p><a href="./../../../../">Profectus</a> / <a href="./../">features/bars/bar</a> / BarOptions</p><h1 id="interface-baroptions" tabindex="-1">Interface: BarOptions <a class="header-anchor" href="#interface-baroptions" aria-label="Permalink to "Interface: BarOptions""></a></h1><p>An object that configures a <a href="./Bar">Bar</a>.</p><h2 id="extends" tabindex="-1">Extends <a class="header-anchor" href="#extends" aria-label="Permalink to "Extends""></a></h2><ul><li><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a></li></ul><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><blockquote><p><code>optional</code> <strong>baseStyle</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="https://vuejs.org/api/utility-types.html#cssproperties" target="_blank" rel="noreferrer"><code>CSSProperties</code></a>></p></blockquote><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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/bars/bar.tsx#L25" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.tsx:25</a></p><hr><h3 id="borderstyle" tabindex="-1">borderStyle? <a class="header-anchor" href="#borderstyle" aria-label="Permalink to "borderStyle?""></a></h3><blockquote><p><code>optional</code> <strong>borderStyle</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="https://vuejs.org/api/utility-types.html#cssproperties" target="_blank" rel="noreferrer"><code>CSSProperties</code></a>></p></blockquote><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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/bars/bar.tsx#L23" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.tsx:23</a></p><hr><h3 id="classes" tabindex="-1">classes? <a class="header-anchor" href="#classes" aria-label="Permalink to "classes?""></a></h3><blockquote><p><code>optional</code> <strong>classes</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</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></blockquote><p>Dictionary of CSS classes to apply to this feature.</p><h4 id="inherited-from" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#classes"><code>classes</code></a></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://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L24" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:24</a></p><hr><h3 id="direction" tabindex="-1">direction <a class="header-anchor" href="#direction" aria-label="Permalink to "direction""></a></h3><blockquote><p><strong>direction</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="./../../../../util/common/enumerations/Direction"><code>Direction</code></a>></p></blockquote><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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/bars/bar.tsx#L21" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.tsx:21</a></p><hr><h3 id="display" tabindex="-1">display? <a class="header-anchor" href="#display" aria-label="Permalink to "display?""></a></h3><blockquote><p><code>optional</code> <strong>display</strong>: <a href="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>></p></blockquote><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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/bars/bar.tsx#L33" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.tsx:33</a></p><hr><h3 id="fillstyle" tabindex="-1">fillStyle? <a class="header-anchor" href="#fillstyle" aria-label="Permalink to "fillStyle?""></a></h3><blockquote><p><code>optional</code> <strong>fillStyle</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="https://vuejs.org/api/utility-types.html#cssproperties" target="_blank" rel="noreferrer"><code>CSSProperties</code></a>></p></blockquote><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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/bars/bar.tsx#L29" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.tsx:29</a></p><hr><h3 id="height" tabindex="-1">height <a class="header-anchor" href="#height" aria-label="Permalink to "height""></a></h3><blockquote><p><strong>height</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>number</code>></p></blockquote><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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/bars/bar.tsx#L19" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.tsx:19</a></p><hr><h3 id="progress" tabindex="-1">progress <a class="header-anchor" href="#progress" aria-label="Permalink to "progress""></a></h3><blockquote><p><strong>progress</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="./../../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a>></p></blockquote><p>The progress value of the bar, from 0 to 1.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/bars/bar.tsx#L31" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.tsx:31</a></p><hr><h3 id="style" tabindex="-1">style? <a class="header-anchor" href="#style" aria-label="Permalink to "style?""></a></h3><blockquote><p><code>optional</code> <strong>style</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="https://vuejs.org/api/utility-types.html#cssproperties" target="_blank" rel="noreferrer"><code>CSSProperties</code></a>></p></blockquote><p>CSS to apply to this feature.</p><h4 id="inherited-from-1" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-1" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#style"><code>style</code></a></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://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L26" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:26</a></p><hr><h3 id="textstyle" tabindex="-1">textStyle? <a class="header-anchor" href="#textstyle" aria-label="Permalink to "textStyle?""></a></h3><blockquote><p><code>optional</code> <strong>textStyle</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="https://vuejs.org/api/utility-types.html#cssproperties" target="_blank" rel="noreferrer"><code>CSSProperties</code></a>></p></blockquote><p>CSS to apply to the bar's text.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/bars/bar.tsx#L27" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.tsx:27</a></p><hr><h3 id="visibility" tabindex="-1">visibility? <a class="header-anchor" href="#visibility" aria-label="Permalink to "visibility?""></a></h3><blockquote><p><code>optional</code> <strong>visibility</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><boolean | Visibility></p></blockquote><p>Whether this feature should be visible.</p><h4 id="inherited-from-2" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-2" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#visibility"><code>visibility</code></a></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://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L22" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:22</a></p><hr><h3 id="width" tabindex="-1">width <a class="header-anchor" href="#width" aria-label="Permalink to "width""></a></h3><blockquote><p><strong>width</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>number</code>></p></blockquote><p>The width of the bar.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/bars/bar.tsx#L17" target="_blank" rel="noreferrer">profectus/src/features/bars/bar.tsx:17</a></p>',83)]))}const u=r(i,[["render",s]]);export{p as __pageData,u as default};
|