Skip to content

Commit

Permalink
docs(navClear): clarify how it works
Browse files Browse the repository at this point in the history
Closes #1194
  • Loading branch information
ajoslin committed May 2, 2014
1 parent cbf0172 commit ae3ae34
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions js/angular/directive/navClear.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,16 @@
* @restrict AC
*
* @description
* Disables any transition animations between views, along with removing the back
* button which would normally show on the next view. This directive is useful for
* links within a sideMenu.
* nav-clear is an attribute directive which should be used with an element that changes
* the view on click, for example an `<a href>` or a `<button ui-sref>`.
*
* nav-clear will cause the given element, when clicked, to disable the next view transition.
* This directive is useful, for example, for links within a sideMenu.
*
* @usage
* Below is an example of a link within a side menu. Tapping this link would disable
* any animations which would normally occur between views.
* Below is a link in a side menu, with the nav-clear directive added to it.
* Tapping this link will disable any animations that would normally occur
* between views.
*
* ```html
* <a nav-clear menu-close href="#/home" class="item">Home</a>
Expand Down

0 comments on commit ae3ae34

Please sign in to comment.