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

2 lines
9.4 KiB
JavaScript
Raw Normal View History

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