Skip to content

Adding docs for uiRoute directive #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 13, 2013
Merged

Adding docs for uiRoute directive #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c33cad
adding docs for route matching directive. refs #39
joseym Feb 4, 2013
1b70439
making scrolto work in firefox. closes #42
joseym Feb 12, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 88 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@
<li><a scrollto href="#directives-showhide">Show / Hide / Toggle</a></li>
<li><a scrollto href="#directives-tinymce">TinyMCE</a></li>
<li><a scrollto href="#directives-currency">Currency</a></li>
<li><a scrollto href="#directives-routing">Route Matching</a></li>
</ul>
</li>
<li class="dropdown">
Expand Down Expand Up @@ -1027,6 +1028,93 @@ <h3>How?</h3>


</section>

<section id="directives-routing" ng-controller="RouteCtrl">
<div class="page-header">
<h1>Route Checking</h1>
</div>

<div class="row">
<div class="span6">
<h3>What?</h3>
<p>Route Matching Magic. It matches your routes ... magically!</p>
<div class="well">
<p class="alert alert-info">Clicking <strong>"Make Active"</strong> will reload the page. Pay attention to the routes.</p>
<ul>
<li ui-route="#/directives-routing">uiRoute Info
<strong ui-if="$uiRoute">IS</strong>
<strong ui-if="!$uiRoute">is NOT</strong> active.
</li>
<li ng-repeat="route in routes" ui-route="#/route-{{ route }}">
Route {{ route }}
<strong ui-if="$uiRoute">IS</strong>
<strong ui-if="!$uiRoute">is NOT</strong> active.
<a ui-if="!$uiRoute" ng-click="reload($event, route)" href="#route-{{ route }}">Make Active</a>
</li>
</ul>
</div>
</div>

<div class="span6">
<h3>Why?</h3>
<p>It would be nice if your app knew what the address path was and acted accordingly, right? Right.</p>
</div>

<div class="span6">
<h3>Options</h3>
<ul>
<li>Out of the box this directive ships with a boolean to determine if the route matches or not: <code>$uiRoute</code>.
<ul>
<li>Example Usage: <code>&lt;a ui-route="/page" ng-class="{active: $uiRoute}"&gt;link&lt;/a&gt;</code></li>
</ul>
</li>
<li>Using <code>ui-route</code> as an attribute with value supports the following:
<ul style="margin-top: 5px;">
<li>Static: <code>&lt;a ui-route="/page"&gt;</code></li>
<li>Regular Expression: <code>&lt;a ui-route="/page/[0-9]*"&gt;</code></li>
<li>Template Vars: <code>&lt;a ui-route="/page/{{ sample }}"&gt;</code></li>
<li>Template Vars && RegEx: <code>&lt;a ui-route="/page/{{ sample }}/[0-9]*"&gt;</code></li>
</ul>
</li>
<li>Using <code>ui-route</code> with <code>ng-href</code> attribute:
<ul style="margin-top: 5px;">
<li>Static: <code>&lt;a ui-route ng-href="/page"&gt;</code></li>
<li>Template Vars: <code>&lt;a ui-route ng-href="/page/{{ sample }}"&gt;</code></li>
</ul>
</li>
<li>Using <code>ui-route</code> with <code>href</code> attribute:
<ul style="margin-top: 5px;">
<li>Static Only: <code>&lt;a ui-route ng-href="/page"&gt;</code></li>
</ul>
</li>
</ul>
</div>

</div>

<div class="row">
<div class="row span12">
<h3>How?</h3>
<pre class="prettyprint linenums" ng-non-bindable>
&lt;ul&gt;
&lt;li ui-route=&quot;#/route-1&quot;&gt;Route 1
&lt;strong ui-if=&quot;$uiRoute&quot;&gt;IS&lt;/strong&gt;
&lt;strong ui-if=&quot;!$uiRoute&quot;&gt;is NOT&lt;/strong&gt; active.
&lt;/li&gt;
&lt;li ui-route=&quot;#/route-2&quot;&gt;Route 2
&lt;strong ui-if=&quot;$uiRoute&quot;&gt;IS&lt;/strong&gt;
&lt;strong ui-if=&quot;!$uiRoute&quot;&gt;is NOT&lt;/strong&gt; active.
&lt;/li&gt;
&lt;li ui-route=&quot;#/route-3&quot;&gt;Route 3
&lt;strong ui-if=&quot;$uiRoute&quot;&gt;IS&lt;/strong&gt;
&lt;strong ui-if=&quot;!$uiRoute&quot;&gt;is NOT&lt;/strong&gt; active.
&lt;/li&gt;
&lt;/ul&gt;
</pre>
</div>

</div>
</section>

<section id="filters-highlight">
<div class="page-header">
Expand Down
12 changes: 11 additions & 1 deletion js/app.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ angular.module('demoApp', ['ui'], function($locationProvider) {
attrs.scrollto = attrs.href;
}
var top = $(attrs.scrollto).offset().top;
$('body').animate({ scrollTop: top }, 800);
$('body,html').animate({ scrollTop: top }, 800);
});
};
}]);
Expand Down Expand Up @@ -159,6 +159,16 @@ function CurrencyCtrl($scope) {
};
}

function RouteCtrl($scope, $window){
$scope.sample = "{{ var }}"
$scope.reload = function($event, route){
$event.preventDefault();
$window.location.href = '#route-' + route;
document.location.reload();
}
$scope.routes = [1,2,3];
}

function FormatCtrl($scope) {
$scope.sentence = 'Hello :name, how is the :subject? Are you on the $0, $1 or $2?';
$scope.mode = 'string';
Expand Down