Skip to content

Commit

Permalink
docs: update fa-modifier ng-doc with support for Particles
Browse files Browse the repository at this point in the history
  • Loading branch information
zackbrown committed Aug 1, 2014
1 parent c40af5f commit 32f296d
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 23 deletions.
23 changes: 12 additions & 11 deletions dist/famous-angular.js
Original file line number Diff line number Diff line change
Expand Up @@ -2302,19 +2302,19 @@ angular.module('famous.angular')
* @name faModifier
* @module famous.angular
* @restrict EA
* @param {Array|Function} faRotate - Array of numbers or function returning an array of numbers to which this Modifier's rotate should be bound.
* @param {Number|Function} faRotateX - Number or function returning a number to which this Modifier's rotateX should be bound
* @param {Number|Function} faRotateY - Number or function returning a number to which this Modifier's rotateY should be bound
* @param {Number|Function} faRotateZ - Number or function returning a number to which this Modifier's rotateZ should be bound
* @param {Array|Function} faScale - Array of numbers or function returning an array of numbers to which this Modifier's scale should be bound
* @param {Array|Function} faSkew - Array of numbers or function returning an array of numbers to which this Modifier's skew should be bound
* @param {Array|Function} faAboutOrigin - Array of arguments (or a function returning an array of arguments) to pass to Transform.aboutOrigin
* @param {Number|Function} faPerspective - Number or array returning a number to which this modifier's perspective (focusZ) should be bound.
* @param {Array|Function|Particle} faRotate - Array of numbers or function returning an array of numbers to which this Modifier's rotate should be bound.
* @param {Number|Function|Particle} faRotateX - Number or function returning a number to which this Modifier's rotateX should be bound
* @param {Number|Function|Particle} faRotateY - Number or function returning a number to which this Modifier's rotateY should be bound
* @param {Number|Function|Particle} faRotateZ - Number or function returning a number to which this Modifier's rotateZ should be bound
* @param {Array|Function|Particle} faScale - Array of numbers or function returning an array of numbers to which this Modifier's scale should be bound
* @param {Array|Function|Particle} faSkew - Array of numbers or function returning an array of numbers to which this Modifier's skew should be bound
* @param {Array|Function|Particle} faAboutOrigin - Array of arguments (or a function returning an array of arguments) to pass to Transform.aboutOrigin
* @param {Number|Function|Particle} faPerspective - Number or array returning a number to which this modifier's perspective (focusZ) should be bound.
* @param {Transform} faTransform - Manually created Famo.us Transform object (an array) that can be passed to the modifier. *Will override all other transform attributes.*
* @param {Number|Function|Transitionable} faOpacity - Number or function returning a number to which this Modifier's opacity should be bound
* @param {Array|Function|Transitionable} faSize - Array of numbers (e.g. [100, 500] for the x- and y-sizes) or function returning an array of numbers to which this Modifier's size should be bound
* @param {Array|Function|Transitionable} faOrigin - Array of numbers (e.g. [.5, 0] for the x- and y-origins) or function returning an array of numbers to which this Modifier's origin should be bound
* @param {Array|Function|Transitionable} faAlign - Array of numbers (e.g. [.5, 0] for the x- and y-aligns) or function returning an array of numbers to which this Modifier's align should be bound
* @param {Array|Function|Transitionable|Particle} faSize - Array of numbers (e.g. [100, 500] for the x- and y-sizes) or function returning an array of numbers to which this Modifier's size should be bound
* @param {Array|Function|Transitionable|Particle} faOrigin - Array of numbers (e.g. [.5, 0] for the x- and y-origins) or function returning an array of numbers to which this Modifier's origin should be bound
* @param {Array|Function|Transitionable|Particle} faAlign - Array of numbers (e.g. [.5, 0] for the x- and y-aligns) or function returning an array of numbers to which this Modifier's align should be bound
* @param {Array.String} faTransformOrder - Optional array of strings to specify which transforms to apply and in which order. (e.g. `fa-transform-order="['rotateZ', 'translate', 'scale']"`) Default behavior is to evaluate all supported transforms and apply them in alphabetical order.
* @description
* This directive creates a Famo.us Modifier that will affect all children render nodes. Its properties can be bound
Expand Down Expand Up @@ -2689,6 +2689,7 @@ angular.module('famous.angular')
};
}]);


/**
* @ngdoc directive
* @name faPipeFrom
Expand Down
24 changes: 12 additions & 12 deletions src/scripts/directives/fa-modifier.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@
* @name faModifier
* @module famous.angular
* @restrict EA
* @param {Array|Function} faRotate - Array of numbers or function returning an array of numbers to which this Modifier's rotate should be bound.
* @param {Number|Function} faRotateX - Number or function returning a number to which this Modifier's rotateX should be bound
* @param {Number|Function} faRotateY - Number or function returning a number to which this Modifier's rotateY should be bound
* @param {Number|Function} faRotateZ - Number or function returning a number to which this Modifier's rotateZ should be bound
* @param {Array|Function} faScale - Array of numbers or function returning an array of numbers to which this Modifier's scale should be bound
* @param {Array|Function} faSkew - Array of numbers or function returning an array of numbers to which this Modifier's skew should be bound
* @param {Array|Function} faAboutOrigin - Array of arguments (or a function returning an array of arguments) to pass to Transform.aboutOrigin
* @param {Number|Function} faPerspective - Number or array returning a number to which this modifier's perspective (focusZ) should be bound.
* @param {Array|Function|Particle} faRotate - Array of numbers or function returning an array of numbers to which this Modifier's rotate should be bound.
* @param {Number|Function|Particle} faRotateX - Number or function returning a number to which this Modifier's rotateX should be bound
* @param {Number|Function|Particle} faRotateY - Number or function returning a number to which this Modifier's rotateY should be bound
* @param {Number|Function|Particle} faRotateZ - Number or function returning a number to which this Modifier's rotateZ should be bound
* @param {Array|Function|Particle} faScale - Array of numbers or function returning an array of numbers to which this Modifier's scale should be bound
* @param {Array|Function|Particle} faSkew - Array of numbers or function returning an array of numbers to which this Modifier's skew should be bound
* @param {Array|Function|Particle} faAboutOrigin - Array of arguments (or a function returning an array of arguments) to pass to Transform.aboutOrigin
* @param {Number|Function|Particle} faPerspective - Number or array returning a number to which this modifier's perspective (focusZ) should be bound.
* @param {Transform} faTransform - Manually created Famo.us Transform object (an array) that can be passed to the modifier. *Will override all other transform attributes.*
* @param {Number|Function|Transitionable} faOpacity - Number or function returning a number to which this Modifier's opacity should be bound
* @param {Array|Function|Transitionable} faSize - Array of numbers (e.g. [100, 500] for the x- and y-sizes) or function returning an array of numbers to which this Modifier's size should be bound
* @param {Array|Function|Transitionable} faOrigin - Array of numbers (e.g. [.5, 0] for the x- and y-origins) or function returning an array of numbers to which this Modifier's origin should be bound
* @param {Array|Function|Transitionable} faAlign - Array of numbers (e.g. [.5, 0] for the x- and y-aligns) or function returning an array of numbers to which this Modifier's align should be bound
* @param {Number|Function|Transitionable|Particle} faOpacity - Number or function returning a number to which this Modifier's opacity should be bound
* @param {Array|Function|Transitionable|Particle} faSize - Array of numbers (e.g. [100, 500] for the x- and y-sizes) or function returning an array of numbers to which this Modifier's size should be bound
* @param {Array|Function|Transitionable|Particle} faOrigin - Array of numbers (e.g. [.5, 0] for the x- and y-origins) or function returning an array of numbers to which this Modifier's origin should be bound
* @param {Array|Function|Transitionable|Particle} faAlign - Array of numbers (e.g. [.5, 0] for the x- and y-aligns) or function returning an array of numbers to which this Modifier's align should be bound
* @param {Array.String} faTransformOrder - Optional array of strings to specify which transforms to apply and in which order. (e.g. `fa-transform-order="['rotateZ', 'translate', 'scale']"`) Default behavior is to evaluate all supported transforms and apply them in alphabetical order.
* @description
* This directive creates a Famo.us Modifier that will affect all children render nodes. Its properties can be bound
Expand Down

0 comments on commit 32f296d

Please sign in to comment.