profectus-docs/assets/api_interfaces_features_repeatable.RepeatableOptions.md.21bb1111.js

2 lines
8.5 KiB
JavaScript
Raw Normal View History

import{_ as e,c as a,o as t,N as r}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Interface: RepeatableOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/repeatable.RepeatableOptions.md","lastUpdated":null}'),o={name:"api/interfaces/features/repeatable.RepeatableOptions.md"},i=r('<h1 id="interface-repeatableoptions" tabindex="-1">Interface: RepeatableOptions <a class="header-anchor" href="#interface-repeatableoptions" aria-label="Permalink to &quot;Interface: RepeatableOptions&quot;"></a></h1><p><a href="./../../modules/features/repeatable">features/repeatable</a>.RepeatableOptions</p><p>An object that configures a <a href="./../../modules/features/repeatable#repeatable">Repeatable</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="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" 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/repeatable.tsx#L62" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:62</a></p><hr><h3 id="display" tabindex="-1">display <a class="header-anchor" href="#display" aria-label="Permalink to &quot;display&quot;"></a></h3><p> <code>Optional</code> <strong>display</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../modules/features/repeatable#repeatabledisplay"><code>RepeatableDisplay</code></a>&gt;</p><p>The display to use for this repeatable.</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/repeatable.tsx#L72" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:72</a></p><hr><h3 id="initialamount" tabindex="-1">initialAmount <a class="header-anchor" href="#initialamount" aria-label="Permalink to &quot;initialAmount&quot;"></a></h3><p> <code>Optional</code> <strong>initialAmount</strong>: <a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a></p><p>The initial amount this repeatable has on a new save / after reset.</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/repeatable.tsx#L60" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:60</a></p><hr><h3 id="limit" tabindex="-1">limit <a class="header-anchor" href="#limit" aria-label="Permalink to &quot;limit&quot;"></a></h3><p> <code>Optional</code> <strong>limit</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a>&gt;</p><p>The maximum amount obtainable for this repeatable.</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/repeatable.tsx#L58" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:58</a></p><hr><h3 id="mark" tabindex