website/public/docs/v3.1.4/Reference/JavaScript/EVENTS.php

30 lines
No EOL
2.2 KiB
PHP

<?= VV::include("public/docs/v3.1.4/Reference/layout") ?>
<main>
<section>
<h1>Navigation.EVENTS</h1>
<p>A set of <a href="https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent"><code class="mtk17">CustomEvent</code></a> instances dispatched when various Vegvisir navigations are performed.</p>
</section>
<section>
<?= VV::include("snippets/HTMLCodeDemoElement/HTMLCodeDemoElement?id=docs/v3.1.4/JS/events/description") ?>
</section>
<section>
<h1>Properties</h1>
</section>
<section class="md param">
<h2 class="default"><code class="mtk19">STARTED</code></h2>
<p>An event dispatched with the <a href="https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent/CustomEvent#type"><code>type</code></a> of <code class="mtk12">"navstarted"</code> on the <a href="/docs/v3.1.4/Reference/JavaScript/navigate#target"><code>target</code></a> element when a navigation has started. This event is also dispatched on <code>document.body</code>.</p>
<p>The <a href="https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent/detail"><code>detail</code></a> property of this event returns the <a href="/docs/v3.1.4/Reference/JavaScript/constructor"><code class="mtk17">Navigation</code></a> instance that initiated the navigation.</p>
</section>
<section class="md param">
<h2 class="default"><code class="mtk19">FINISHED</code></h2>
<p>An event dispatched with the <a href="https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent/CustomEvent#type"><code>type</code></a> of <code class="mtk12">"navfinished"</code> on the <a href="/docs/v3.1.4/Reference/JavaScript/navigate#target"><code>target</code></a> element when a navigation has finished loading completely (content has been injected). This event is also dispatched on <code>document.body</code>.</p>
<p>The <a href="https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent/detail"><code>detail</code></a> property of this event returns the <a href="/docs/v3.1.4/Reference/JavaScript/constructor"><code class="mtk17">Navigation</code></a> instance that initiated the navigation.</p>
</section>
<hr>
<section>
<h1>Examples</h1>
</section>
<section>
<p>No examples available.</p>
</section>
</main>