Interface: ClickableOptions ​

features/clickables/clickable.ClickableOptions

An object that configures a Clickable.

Hierarchy ​

• ClickableOptions

  ↳ ResetButtonOptions

Properties ​

canClick ​

• Optional canClick: Computable<boolean>

Whether or not the clickable may be clicked.

Defined in ​

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

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

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

display ​

• Optional display: Computable<CoercableComponent | { description: CoercableComponent ; title?: CoercableComponent }>

The display to use for this clickable.

Defined in ​

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

mark ​

• Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Defined in ​

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

onClick ​

• Optional onClick: (e?: MouseEvent | TouchEvent) => void

Type declaration ​

▸ (e?): void

A function that is called when the clickable is clicked.

Parameters ​

Returns ​

void

Defined in ​

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

onHold ​

• Optional onHold: VoidFunction

A function that is called when the clickable is held down.

Defined in ​

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

small ​

• Optional small: boolean

Toggles a smaller design for the feature.

Defined in ​

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

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

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

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this clickable should be visible.

Defined in ​

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