profectus-docs/assets/api_game_notifications_functions_createDismissableNotify.md.BgJyB7y-.lean.js

import{_ as t,c as a,a0 as o,o as i}from"./chunks/framework.P9qPzDnn.js";const u=JSON.parse('{"title":"Function: createDismissableNotify()","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/game/notifications/functions/createDismissableNotify.md","filePath":"api/game/notifications/functions/createDismissableNotify.md","lastUpdated":null}'),r={name:"api/game/notifications/functions/createDismissableNotify.md"};function n(s,e,c,l,d,f){return i(),a("div",null,e[0]||(e[0]=[o('<p><a href="./../../../">Profectus</a> / <a href="./../">game/notifications</a> / createDismissableNotify</p><h1 id="function-createdismissablenotify" tabindex="-1">Function: createDismissableNotify() <a class="header-anchor" href="#function-createdismissablenotify" aria-label="Permalink to &quot;Function: createDismissableNotify()&quot;">​</a></h1><blockquote><p><strong>createDismissableNotify</strong>(<code>element</code>, <code>shouldNotify</code>): <a href="https://vuejs.org/guide/typescript/composition-api.html#typing-ref" target="_blank" rel="noreferrer"><code>Ref</code></a>&lt;<code>boolean</code>&gt;</p></blockquote><p>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.</p><h2 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;">​</a></h2><h3 id="element" tabindex="-1">element <a class="header-anchor" href="#element" aria-label="Permalink to &quot;element&quot;">​</a></h3><p><a href="./../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a></p><p>The element that will dismiss the notification on hover.</p><h3 id="shouldnotify" tabindex="-1">shouldNotify <a class="header-anchor" href="#shouldnotify" aria-label="Permalink to &quot;shouldNotify&quot;">​</a></h3><p>A function or ref that determines if the notif should be active currently or not.</p><p><a href="https://vuejs.org/guide/typescript/composition-api.html#typing-ref" target="_blank" rel="noreferrer"><code>Ref</code></a>&lt;<code>boolean</code>, <code>boolean</code>&gt; | () =&gt; <code>boolean</code></p><h2 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;">​</a></h2><p><a href="https://vuejs.org/guide/typescript/composition-api.html#typing-ref" target="_blank" rel="noreferrer"><code>Ref</code></a>&lt;<code>boolean</code>&gt;</p><h2 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;">​</a></h2><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/game/notifications.ts#L35" target="_blank" rel="noreferrer">profectus/src/game/notifications.ts:35</a></p>',15)]))}const p=t(r,[["render",n]]);export{u as __pageData,p as default};