diff --git a/dist/famous-angular.js b/dist/famous-angular.js index 5c696951..54a036c6 100644 --- a/dist/famous-angular.js +++ b/dist/famous-angular.js @@ -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 + * + * + * ``` + */ + angular.module('famous.angular') .directive('faAnimateHalt', ["$parse", "$famousDecorator", function ($parse, $famousDecorator) { @@ -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 + * + * + * ``` + */ angular.module('famous.angular') .directive('faAnimateLeave', ["$parse", "$famousDecorator", function ($parse, $famousDecorator) { @@ -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 + * + * + * ``` + */ angular.module('famous.angular') .directive('faAnimateMove', ["$parse", "$famousDecorator", function ($parse, $famousDecorator) { diff --git a/docs/unstable/directive/faAnimateHalt/index.md b/docs/unstable/directive/faAnimateHalt/index.md new file mode 100644 index 00000000..8c9cabcf --- /dev/null +++ b/docs/unstable/directive/faAnimateHalt/index.md @@ -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" +--- + +
+ + Improve this doc + +
+ + + + + +

+ + fa-animate-halt + + + +

+ + + + + +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 + + +``` + + + + + + + + + diff --git a/docs/unstable/directive/faAnimateLeave/index.md b/docs/unstable/directive/faAnimateLeave/index.md new file mode 100644 index 00000000..c6976404 --- /dev/null +++ b/docs/unstable/directive/faAnimateLeave/index.md @@ -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" +--- + +
+ + Improve this doc + +
+ + + + + +

+ + fa-animate-leave + + + +

+ + + + + +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 + + +``` + + + + + + + + + diff --git a/docs/unstable/directive/faAnimateMove/index.md b/docs/unstable/directive/faAnimateMove/index.md new file mode 100644 index 00000000..855ece0f --- /dev/null +++ b/docs/unstable/directive/faAnimateMove/index.md @@ -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" +--- + +
+ + Improve this doc + +
+ + + + + +

+ + fa-animate-move + + + +

+ + + + + +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 + + +``` + + + + + + + + + diff --git a/famous-angular-docs b/famous-angular-docs index 705594cf..ca62e44f 160000 --- a/famous-angular-docs +++ b/famous-angular-docs @@ -1 +1 @@ -Subproject commit 705594cfd9f973cea2c2e76806ab8f6743d479f4 +Subproject commit ca62e44f25b94fa09537b30e1567eb90f9c5199d diff --git a/src/scripts/directives/fa-animate-halt.js b/src/scripts/directives/fa-animate-halt.js index 93a1ef37..cf2584b7 100644 --- a/src/scripts/directives/fa-animate-halt.js +++ b/src/scripts/directives/fa-animate-halt.js @@ -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 + * + * + * ``` + */ + angular.module('famous.angular') .directive('faAnimateHalt', ["$parse", "$famousDecorator", function ($parse, $famousDecorator) { diff --git a/src/scripts/directives/fa-animate-leave.js b/src/scripts/directives/fa-animate-leave.js index d3f8b3dc..86d9079b 100644 --- a/src/scripts/directives/fa-animate-leave.js +++ b/src/scripts/directives/fa-animate-leave.js @@ -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 + * + * + * ``` + */ angular.module('famous.angular') .directive('faAnimateLeave', ["$parse", "$famousDecorator", function ($parse, $famousDecorator) { diff --git a/src/scripts/directives/fa-animate-move.js b/src/scripts/directives/fa-animate-move.js index 50e1b988..da0c7d70 100644 --- a/src/scripts/directives/fa-animate-move.js +++ b/src/scripts/directives/fa-animate-move.js @@ -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 + * + * + * ``` + */ angular.module('famous.angular') .directive('faAnimateMove', ["$parse", "$famousDecorator", function ($parse, $famousDecorator) {