<?= VV::include("modules/snippet/Snippet.php") ?>
<?php // General information ?>
<section class="md">
	<container>
		<p>(Vegvisir 2, Vegvisir 3)</p>
		<h1><code>Navigation.options</code></h1>
		<p>Override default Vegvisir navigation behavior.</p>
	</container>
</section>
<section class="md">
	<container>
		<h1>Description</h1>
		<?= Snippet::put("docs/API/JS/Navigation/options/description", Snippet::JAVASCRIPT) ?>
		<p>This object should be passed as the second argument when constructing a <a href=""><code>vegvisir.Navigation</code></a> instance.</p>
	</container>
</section>

<?php // Method parameters ?>
<section class="md">
	<container>
		<h2>Parameters</h2>
	</container>
</section>
<section class="md inset">
	<container>
		<h3><code>pushHistory</code></h3>
		<p><strong>This option has no default value:</strong></p>
		<p>The default behavior of any Vegvisir <strong>top</strong> navigation is to push the new URL to the history stack. Ie. History API entry and browser pathname changes.</p>
		<p>Any navigation that is <strong>not</strong> a top navigation will not push to the history stack.</p>
		<hr>
		<p>By setting the <code>pushHistory</code> option to:</p>
		<ul>
			<li>
				<p><code>true</code></p>
				<p>Force all navigations with <a href=""><code>.navigate()</code></a> on this instance will push to the history stack. Including non-top navigations.</p>
			</li>
			<li>
				<p><code>false</code></p>
				<p>Force no navigations with <a href=""><code>.navigate()</code></a> on this instance will push to the history stack. Including top navigations.</p>
			</li>
		</ul>
	</container>
</section>

<?php // Examples ?>
<section class="md">
	<container>
		<h1>Examples</h1>
	</container>
</section>
<section class="md inset">
	<container>
		<h2>Basic usage</h2>
		<p>Here is an example the embeds an SVG file directly on a page.</p>
		<p>This can come in handy for inlining small vector icons.</p>
		<?= Snippet::put("docs/API/PHP/VV/embed/example-1-0", Snippet::PHP) ?>
		<?= Snippet::put("docs/API/PHP/VV/embed/example-1-1", Snippet::PHP) ?>
		<p>By using <code>VV::css()</code> inside a <code class="tag">style</code>, we've enabled this stylesheet for that specific page.</p>
	</container>
</section>

<?php // Contribute ?>

<?= VV::shell("shells/docs") ?>