Profectus / features/clickables/clickable / Clickable
Interface: Clickable ​
An object that represents a feature that can be clicked or held down.
Extends ​
Extended by ​
Properties ​
[VueFeature] ​
[VueFeature]:
true
Used to identify Vue Features
Inherited from ​
Defined in ​
canClick ​
canClick:
MaybeRef<boolean>
Whether or not the clickable may be clicked.
Defined in ​
profectus/src/features/clickables/clickable.tsx:47
classes? ​
Dictionary of CSS classes to apply to this feature.
Inherited from ​
Defined in ​
components ​
components:
MaybeGetter<Renderable>[]
The components to render inside the vue feature
Inherited from ​
Defined in ​
display? ​
optionaldisplay:MaybeGetter<Renderable>
The display to use for this clickable.
Defined in ​
profectus/src/features/clickables/clickable.tsx:49
id ​
id:
string
An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.
Inherited from ​
Defined in ​
onClick()? ​
optionalonClick: (e?) =>void
A function that is called when the clickable is clicked.
Parameters ​
e? ​
Returns ​
void
Defined in ​
profectus/src/features/clickables/clickable.tsx:43
onHold? ​
optionalonHold:VoidFunction
A function that is called when the clickable is held down.
Defined in ​
profectus/src/features/clickables/clickable.tsx:45
style? ​
optionalstyle:MaybeRef<CSSProperties>
CSS to apply to this feature.
Inherited from ​
Defined in ​
type ​
type: typeof
ClickableType
A symbol that helps identify features of the same type.
Defined in ​
profectus/src/features/clickables/clickable.tsx:51
visibility? ​
optionalvisibility:MaybeRef<boolean | Visibility>
Whether this feature should be visible.
Inherited from ​
Defined in ​
wrappers ​
wrappers:
Wrapper[]
The components to render wrapped around the vue feature