profectus-docs/assets/api_interfaces_features_clickables_clickable.ClickableOptions.md.38b89983.js

import{_ as e,c as a,o as t,N as o}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Interface: ClickableOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/clickables/clickable.ClickableOptions.md","lastUpdated":null}'),r={name:"api/interfaces/features/clickables/clickable.ClickableOptions.md"},l=o('<h1 id="interface-clickableoptions" tabindex="-1">Interface: ClickableOptions <a class="header-anchor" href="#interface-clickableoptions" aria-label="Permalink to &quot;Interface: ClickableOptions&quot;">​</a></h1><p><a href="./../../../modules/features/clickables/clickable">features/clickables/clickable</a>.ClickableOptions</p><p>An object that configures a <a href="./../../../modules/features/clickables/clickable#clickable">Clickable</a>.</p><h2 id="hierarchy" tabindex="-1">Hierarchy <a class="header-anchor" href="#hierarchy" aria-label="Permalink to &quot;Hierarchy&quot;">​</a></h2><ul><li><p><strong><code>ClickableOptions</code></strong></p><p>↳ <a href="../../data/common.ResetButtonOptions"><code>ResetButtonOptions</code></a></p></li></ul><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to &quot;Properties&quot;">​</a></h2><h3 id="canclick" tabindex="-1">canClick <a class="header-anchor" href="#canclick" aria-label="Permalink to &quot;canClick&quot;">​</a></h3><p>• <code>Optional</code> <strong>canClick</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>boolean</code>&gt;</p><p>Whether or not the clickable may be clicked.</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/clickables/clickable.ts#L32" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:32</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-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/clickables/clickable.ts#L34" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:34</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/feature#coercablecomponent"><code>CoercableComponent</code></a> | { <code>description</code>: <a href="./../../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a> ; <code>title?</code>: <a href="./../../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a> }&gt;</p><p>The display to use for this clickable.</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/clickables/clickable.ts#L40" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:40</a></p><hr><h3 id="mark" tabindex="-1">mark <a class="header-anchor" href="#mark" aria-label="Permalink to &quot;mark&quot;">​</a></h3><p>• <code>Optional</code> <strong>mark</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>string</code> | <code>boolean</code>&gt;</p><p>Shows a marker on the corner of the feature.</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/clickables/clickable.ts#L38" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:38</a></p><hr><h3 id="onclick" tabindex="-1">onClick <a class="header-anchor" href="#onclick" aria-label="Permalink to &quot;onClick&quot;">​</a></h3><p>• <code>Optional</code> <strong>onClick</strong>: (<code>e?</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent" target="_blank" rel="noreferrer"><code>MouseEvent</code></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent" target="_blank" rel="noreferrer"><code>TouchEvent</code></a>) =&gt; <code>void</code></p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to &quot;Type declaration&quot;">​</a></h4><p>▸ (<code>e?</code>): <code>void</code></p><p>A function that is called when the clickable is clicked.</p><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;">​</a></h5><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>e?</code></td><td style="text-align:left;"><a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent" target="_blank" rel="noreferrer"><code>MouseEvent</code></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent" target="_blank" rel="noreferrer"><code>TouchEvent</code></a></td></tr></tbody></table><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;">​</a></h5><p><code>void</code></p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/clickables/clickable.ts#L52" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:52</a></p><hr><h3 id="onhold" tabindex="-1">onHold <a class="header-anchor" href="#onhold" aria-label="Permalink to &quot;onHold&quot;">​</a></h3><p>• <code>Optional</code> <strong>onHold</strong>: <code>VoidFunction</code></p><p>A function that is called when the clickable is held down.</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/clickables/clickable.ts#L54" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:54</a></p><hr><h3 id="small" tabindex="-1">small <a class="header-anchor" href="#small" aria-label="Permalink to &quot;small&quot;">​</a></h3><p>• <code>Optional</code> <strong>small</strong>: <code>boolean</code></p><p>Toggles a smaller design for the feature.</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/clickables/clickable.ts#L50" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:50</a></p><hr><h3 id="style" tabindex="-1">style <a class="header-anchor" href="#style" aria-label="Permalink to &quot;style&quot;">​</a></h3><p>• <code>Optional</code> <strong>style</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 this feature.</p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/clickables/clickable.ts#L36" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:36</a></p><hr><h3 id="visibility" tabindex="-1">visibility <a class="header-anchor" href="#visibility" aria-label="Permalink to &quot;visibility&quot;">​</a></h3><p>• <code>Optional</code> <strong>visibility</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>boolean</code> | <a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt;</p><p>Whether this clickable should be visible.</p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/clickables/clickable.ts#L30" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:30</a></p>',65),c=[l];function i(n,s,d,h,f,b){return t(),a("div",null,c)}const k=e(r,[["render",i]]);export{u as __pageData,k as default};