Skip to content
On this page

Module: game/notifications

Functions

createDismissableNotify

createDismissableNotify(element, shouldNotify): Ref<boolean>

Create a boolean ref that will automatically be set based on the given condition, but also dismissed when hovering over a given element, typically the element where acting upon the notification would take place.

Parameters

NameTypeDescription
elementVueFeatureThe element that will dismiss the notification on hover.
shouldNotifyRef<boolean> | () => booleanA function or ref that determines if the notif should be active currently or not.

Returns

Ref<boolean>


getHighNotifyStyle

getHighNotifyStyle(): Object

Utility function to call getNotifyStyle with "high importance" parameters.

Returns

Object

NameType
borderColorstring
boxShadowstring
transformstring
zIndexnumber

getNotifyStyle

getNotifyStyle(color?, strength?): Object

Gives a CSSProperties object that makes an object glow, to bring focus to it. Default values are for a "soft" white notif effect.

Parameters

NameTypeDefault valueDescription
colorstring"white"The color of the glow effect.
strengthstring"8px"The strength of the glow effect - affects its spread.

Returns

Object

NameType
borderColorstring
boxShadowstring
transformstring
zIndexnumber