Skip to content

Commit

Permalink
docs: add documentation for fa-animate-leave, fa-animate-halt, fa-ani…
Browse files Browse the repository at this point in the history
…mate-move
  • Loading branch information
zackbrown committed Oct 10, 2014
1 parent a3b438b commit f74ef7b
Show file tree
Hide file tree
Showing 8 changed files with 258 additions and 7 deletions.
46 changes: 43 additions & 3 deletions dist/famous-angular.js
Original file line number Diff line number Diff line change
Expand Up @@ -1009,7 +1009,21 @@ angular.module('famous.angular')
};
}]);

//TODO: DOCUMENT
/**
* @ngdoc directive
* @name faAnimateHalt
* @module famous.angular
* @restrict EA
* @description Will execute the passed function/expression when an ngAnimate event on the given element is halted before finishing.
* Useful when you want to manage clean-up (e.g. Transitionable `.halt()`ing).
*
* @usage
* ```html
* <fa-view ng-repeat="view in views" fa-animate-halt="cleanupFunction()">
* </fa-view>
* ```
*/


angular.module('famous.angular')
.directive('faAnimateHalt', ["$parse", "$famousDecorator", function ($parse, $famousDecorator) {
Expand All @@ -1032,7 +1046,20 @@ angular.module('famous.angular')
};
}]);

//TODO: DOCUMENT
/**
* @ngdoc directive
* @name faAnimateLeave
* @module famous.angular
* @restrict EA
* @description Attaches the passed function/expression to Angular ngAnimate "leave" events on the given element.
* Useful when you want to manage animations in Famo.us that are tied into Angular's data-driven events, e.g. on directives like ng-repeat, ui-view, and ng-if.
*
* @usage
* ```html
* <fa-view ng-repeat="view in views" fa-animate-leave="myAnimationFunction($done)">
* </fa-view>
* ```
*/

angular.module('famous.angular')
.directive('faAnimateLeave', ["$parse", "$famousDecorator", function ($parse, $famousDecorator) {
Expand All @@ -1055,7 +1082,20 @@ angular.module('famous.angular')
};
}]);

//TODO: DOCUMENT
/**
* @ngdoc directive
* @name faAnimateMove
* @module famous.angular
* @restrict EA
* @description Attaches the passed function/expression to Angular ngAnimate "move" events on the given element.
* Useful when you want to manage animations in Famo.us that are tied into Angular's data-driven events, e.g. on directives like ng-repeat, ui-view, and ng-if.
*
* @usage
* ```html
* <fa-view ng-repeat="view in views" fa-animate-move="myAnimationFunction($done)">
* </fa-view>
* ```
*/

angular.module('famous.angular')
.directive('faAnimateMove', ["$parse", "$famousDecorator", function ($parse, $famousDecorator) {
Expand Down
57 changes: 57 additions & 0 deletions docs/unstable/directive/faAnimateHalt/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
layout: "docs_api"
version: "unstable"
versionHref: "/docs/unstable"
path: "api/directive/faAnimateHalt/"
title: "fa-animate-halt"
header_sub_title: "Directive in module famous.angular"
doc: "faAnimateHalt"
docType: "directive"
---

<div class="improve-docs">
<a href='https://github.com/Famous/famous-angular/edit/master/src/scripts/directives/fa-animate-halt.js#L2'>
Improve this doc
</a>
</div>





<h1 class="api-title">

fa-animate-halt



</h1>





Will execute the passed function/expression when an ngAnimate event on the given element is halted before finishing.
Useful when you want to manage clean-up (e.g. Transitionable `.halt()`ing).







<h2 id="usage">Usage</h2>

```html
<fa-view ng-repeat="view in views" fa-animate-halt="cleanupFunction()">
</fa-view>
```









57 changes: 57 additions & 0 deletions docs/unstable/directive/faAnimateLeave/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
layout: "docs_api"
version: "unstable"
versionHref: "/docs/unstable"
path: "api/directive/faAnimateLeave/"
title: "fa-animate-leave"
header_sub_title: "Directive in module famous.angular"
doc: "faAnimateLeave"
docType: "directive"
---

<div class="improve-docs">
<a href='https://github.com/Famous/famous-angular/edit/master/src/scripts/directives/fa-animate-leave.js#L2'>
Improve this doc
</a>
</div>





<h1 class="api-title">

fa-animate-leave



</h1>





Attaches the passed function/expression to Angular ngAnimate "leave" events on the given element.
Useful when you want to manage animations in Famo.us that are tied into Angular's data-driven events, e.g. on directives like ng-repeat, ui-view, and ng-if.







<h2 id="usage">Usage</h2>

```html
<fa-view ng-repeat="view in views" fa-animate-leave="myAnimationFunction($done)">
</fa-view>
```









57 changes: 57 additions & 0 deletions docs/unstable/directive/faAnimateMove/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
layout: "docs_api"
version: "unstable"
versionHref: "/docs/unstable"
path: "api/directive/faAnimateMove/"
title: "fa-animate-move"
header_sub_title: "Directive in module famous.angular"
doc: "faAnimateMove"
docType: "directive"
---

<div class="improve-docs">
<a href='https://github.com/Famous/famous-angular/edit/master/src/scripts/directives/fa-animate-move.js#L2'>
Improve this doc
</a>
</div>





<h1 class="api-title">

fa-animate-move



</h1>





Attaches the passed function/expression to Angular ngAnimate "move" events on the given element.
Useful when you want to manage animations in Famo.us that are tied into Angular's data-driven events, e.g. on directives like ng-repeat, ui-view, and ng-if.







<h2 id="usage">Usage</h2>

```html
<fa-view ng-repeat="view in views" fa-animate-move="myAnimationFunction($done)">
</fa-view>
```









16 changes: 15 additions & 1 deletion src/scripts/directives/fa-animate-halt.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@

//TODO: DOCUMENT
/**
* @ngdoc directive
* @name faAnimateHalt
* @module famous.angular
* @restrict EA
* @description Will execute the passed function/expression when an ngAnimate event on the given element is halted before finishing.
* Useful when you want to manage clean-up (e.g. Transitionable `.halt()`ing).
*
* @usage
* ```html
* <fa-view ng-repeat="view in views" fa-animate-halt="cleanupFunction()">
* </fa-view>
* ```
*/


angular.module('famous.angular')
.directive('faAnimateHalt', ["$parse", "$famousDecorator", function ($parse, $famousDecorator) {
Expand Down
15 changes: 14 additions & 1 deletion src/scripts/directives/fa-animate-leave.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@

//TODO: DOCUMENT
/**
* @ngdoc directive
* @name faAnimateLeave
* @module famous.angular
* @restrict EA
* @description Attaches the passed function/expression to Angular ngAnimate "leave" events on the given element.
* Useful when you want to manage animations in Famo.us that are tied into Angular's data-driven events, e.g. on directives like ng-repeat, ui-view, and ng-if.
*
* @usage
* ```html
* <fa-view ng-repeat="view in views" fa-animate-leave="myAnimationFunction($done)">
* </fa-view>
* ```
*/

angular.module('famous.angular')
.directive('faAnimateLeave', ["$parse", "$famousDecorator", function ($parse, $famousDecorator) {
Expand Down
15 changes: 14 additions & 1 deletion src/scripts/directives/fa-animate-move.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@

//TODO: DOCUMENT
/**
* @ngdoc directive
* @name faAnimateMove
* @module famous.angular
* @restrict EA
* @description Attaches the passed function/expression to Angular ngAnimate "move" events on the given element.
* Useful when you want to manage animations in Famo.us that are tied into Angular's data-driven events, e.g. on directives like ng-repeat, ui-view, and ng-if.
*
* @usage
* ```html
* <fa-view ng-repeat="view in views" fa-animate-move="myAnimationFunction($done)">
* </fa-view>
* ```
*/

angular.module('famous.angular')
.directive('faAnimateMove', ["$parse", "$famousDecorator", function ($parse, $famousDecorator) {
Expand Down

0 comments on commit f74ef7b

Please sign in to comment.