import{_ as e,c as t,o as a,N as l}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Module: features/clickables/clickable","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/clickable.md","lastUpdated":null}'),c={name:"api/modules/features/clickable.md"},o=l('

Module: features/clickables/clickable ​

Interfaces ​

BaseClickable ​

• BaseClickable: Object

The properties that are added onto a processed ClickableOptions to create an Clickable.

NameTypeDescription
[Component]GenericComponentThe Vue component used to render this feature.
[GatherProps]() => Record<string, unknown>A function to gather the props the vue component requires for this feature.
idstringAn auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.
typetypeof ClickableTypeA symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/clickables/clickable.ts:60

ClickableOptions ​

• ClickableOptions: Object

An object that configures a Clickable.

NameTypeDescription
canClick?Computable<boolean>Whether or not the clickable may be clicked.
classes?Computable<Record<string, boolean>>Dictionary of CSS classes to apply to this feature.
display?Computable<CoercableComponent | { description: CoercableComponent ; title?: CoercableComponent }>The display to use for this clickable.
mark?Computable<string | boolean>Shows a marker on the corner of the feature.
onClick?(e?: MouseEvent | TouchEvent) => voidA function that is called when the clickable is clicked.
onHold?VoidFunctionA function that is called when the clickable is held down.
small?booleanToggles a smaller design for the feature.
style?Computable<StyleValue>CSS to apply to this feature.
visibility?Computable<boolean | Visibility>Whether this clickable should be visible.

Defined in ​

profectus/src/features/clickables/clickable.ts:28

Type Aliases ​

Clickable ​

Ƭ Clickable<T>: Replace<T & BaseClickable, { canClick: GetComputableTypeWithDefault<T["canClick"], true> ; classes: GetComputableType<T["classes"]> ; display: GetComputableType<T["display"]> ; mark: GetComputableType<T["mark"]> ; style: GetComputableType<T["style"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

An object that represents a feature that can be clicked or held down.

Type parameters ​

NameType
Textends ClickableOptions

Defined in ​

profectus/src/features/clickables/clickable.ts:72

GenericClickable ​

Ƭ GenericClickable: Replace<Clickable<ClickableOptions>, { canClick: ProcessedComputable<boolean> ; visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid Clickable object.

Defined in ​

profectus/src/features/clickables/clickable.ts:85

Variables ​

ClickableType ​

• Const ClickableType: typeof ClickableType

A symbol used to identify Clickable features.

Defined in ​

profectus/src/features/clickables/clickable.ts:23

Functions ​

createClickable ​

▸ createClickable<T>(optionsFunc?): Clickable<T>

Lazily creates a clickable with the given options.

Type parameters ​

NameType
Textends ClickableOptions

Parameters ​

NameTypeDescription
optionsFunc?OptionsFunc<T, BaseClickable, GenericClickable>Clickable options.

Returns ​

Clickable<T>

Defined in ​

profectus/src/features/clickables/clickable.ts:97

• createClickable: <T>(optionsFunc?: OptionsFunc<T, BaseClickable, GenericClickable>) => Clickable<T>

Defined in ​

profectus/src/features/clickables/clickable.ts:97

setupAutoClick ​

▸ setupAutoClick(layer, clickable, autoActive?): Unsubscribe

Utility to auto click a clickable whenever it can be.

Parameters ​

NameTypeDefault valueDescription
layerBaseLayerundefinedThe layer the clickable is apart of
clickableGenericClickableundefinedThe clicker to click automatically
autoActiveComputable<boolean>trueWhether or not the clickable should currently be auto-clicking

Returns ​

Unsubscribe

Defined in ​

profectus/src/features/clickables/clickable.ts:169

• setupAutoClick: (layer: BaseLayer, clickable: GenericClickable, autoActive: Computable<boolean>) => Unsubscribe

Defined in ​

profectus/src/features/clickables/clickable.ts:169

Components ​

Clickable Component ​

Props ​

NameType
display*processedPropType<UnwrapRef<GenericClickable["display"]>>(
Object,
String,
Function
)
visibility*processedPropType<Visibility | boolean>(Number, Boolean)
styleprocessedPropType<StyleValue>(Object, String, Array)
classesprocessedPropType<Record<string, boolean>>(Object)
onClick(e?: MouseEvent | TouchEvent) => void
onHoldVoidFunction
canClick*processedPropType<boolean>(Boolean)
smallboolean
markprocessedPropType<boolean | string>(Boolean, String)
id*string
',67),d=[o];function i(r,s,n,b,h,f){return a(),t("div",null,d)}const k=e(c,[["render",i]]);export{u as __pageData,k as default};