From eb3576abbec6ed22a2a0ab12418829a0ef4f24b0 Mon Sep 17 00:00:00 2001 From: jlukic Date: Wed, 25 Sep 2013 12:44:40 -0400 Subject: [PATCH] adds behavior/settings documentation to transition --- build/less/modules/transition.js | 2 +- build/minified/modules/transition.js | 2 +- build/uncompressed/modules/transition.js | 2 +- node/src/documents/modules/form.html.eco | 38 +++- node/src/documents/modules/sidebar.html.eco | 2 - .../src/documents/modules/transition.html.eco | 202 ++++++++++++++++++ .../files/build/less/modules/transition.js | 2 +- .../build/minified/modules/transition.js | 2 +- .../build/uncompressed/modules/transition.js | 2 +- src/modules/transition.js | 2 +- 10 files changed, 246 insertions(+), 10 deletions(-) diff --git a/build/less/modules/transition.js b/build/less/modules/transition.js index 325c4273d..d1e7a6dba 100644 --- a/build/less/modules/transition.js +++ b/build/less/modules/transition.js @@ -621,7 +621,7 @@ $.fn.transition.settings = { // animation complete event complete : function() {}, - // animation duration (useful only with future js animations) + // animation duration animation : 'fade', duration : '700ms', diff --git a/build/minified/modules/transition.js b/build/minified/modules/transition.js index 325c4273d..d1e7a6dba 100644 --- a/build/minified/modules/transition.js +++ b/build/minified/modules/transition.js @@ -621,7 +621,7 @@ $.fn.transition.settings = { // animation complete event complete : function() {}, - // animation duration (useful only with future js animations) + // animation duration animation : 'fade', duration : '700ms', diff --git a/build/uncompressed/modules/transition.js b/build/uncompressed/modules/transition.js index 325c4273d..d1e7a6dba 100644 --- a/build/uncompressed/modules/transition.js +++ b/build/uncompressed/modules/transition.js @@ -621,7 +621,7 @@ $.fn.transition.settings = { // animation complete event complete : function() {}, - // animation duration (useful only with future js animations) + // animation duration animation : 'fade', duration : '700ms', diff --git a/node/src/documents/modules/form.html.eco b/node/src/documents/modules/form.html.eco index 0098feece..87079ed3a 100755 --- a/node/src/documents/modules/form.html.eco +++ b/node/src/documents/modules/form.html.eco @@ -16,7 +16,8 @@ type : 'UI Behavior'
- Usage + Usage + Behavior Settings
@@ -231,6 +232,41 @@ type : 'UI Behavior' +

Behavior

+ + All the following behaviors can be called using the syntax $('.foo').form('behavior name', argumentOne, argumentTwo) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
submitSubmits selected form
validate formValidates form and calls onSuccess or onFailure
get change eventgets browser property change event
get field(id)Returns element with maching name, id, or data-validate metadata to ID
get validation(element)Returns validation rules for a given field
has field(identifier)Returns whether a field exists
add errors(errors)Adds errors to form, given an array errors
+

Settings

diff --git a/node/src/documents/modules/sidebar.html.eco b/node/src/documents/modules/sidebar.html.eco index c05b5e7a1..07c36a6db 100755 --- a/node/src/documents/modules/sidebar.html.eco +++ b/node/src/documents/modules/sidebar.html.eco @@ -244,8 +244,6 @@ type : 'UI Module' add body css Adds stylesheet to page head to trigger sidebar animations - - diff --git a/node/src/documents/modules/transition.html.eco b/node/src/documents/modules/transition.html.eco index ec1011806..3ab8eb708 100755 --- a/node/src/documents/modules/transition.html.eco +++ b/node/src/documents/modules/transition.html.eco @@ -212,7 +212,209 @@ type : 'UI Module'

Behavior

+ All the following behaviors can be called using the syntax $('.foo').transition('behavior name', argumentOne, argumentTwo) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
repaintTriggers reflow on element
loopingEnables animation looping
remove loopingRemoves looping state from element
stopStops current transition
startRestarts a stopped transition
toggleToggles current transition on/off
duration(duration)Modifies element animation duration
save conditionsSaves all class names and styles to cache to be retrieved after animation
restore conditionsAdds back cached names and styles to element
get animation nameReturns vendor prefixed animation property for animationname
get animation eventReturns vendor prefixed animation property for animationend
is animatingReturns whether transition is currently occurring
is loopingReturns whether animation looping is set
is visibleReturns whether element is visible
+

Settings

+ +

+ Transition Settings +
Form settings modify the transition behavior
+

+ + + + + + + + + + + + + + + + + + + + + + + +
SettingDefaultDescription
animationfadeNamed animation event to used. Must be defined in css.
duration700msDuration of the css transition animation
queuetrueWhether to automatically queue animation if another is occurring
+ +
+ +

+ Callbacks +
Callback settings specify a function to occur after a specific behavior.
+

+ + + + + + + + + + + + + + +
SettingContextDescription
completetransitioned elementCallback on each transition complete
+ +
+ +

+ DOM Settings +
DOM settings specify how this module should interface with the DOM
+

+ + + + + + + + + + + + + + + + + + +
SettingDefaultDescription
namespacetransitionEvent namespace. Makes sure module teardown does not effect other events attached to an element.
className +
+ className : { + animating : 'animating', + disabled : 'disabled', + hidden : 'hidden', + inward : 'in', + loading : 'loading', + looping : 'looping', + outward : 'out', + transition : 'ui transition', + visible : 'visible' + } +
+ 		Class names used to attach style to state
+ +
+ +

+ Debug Settings +
Debug settings controls debug output to the console
+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SettingDefaultDescription
nameTransitionName used in debug logs
debugTrueProvides standard debug output to console
performanceTrueProvides standard debug output to console
verboseTrueProvides ancillary debug output to console
errors +
+ errors : { + noAnimation : 'There is no css animation matching the one you specified.', + method : 'The method you called is not defined' + } +
+
+ +
diff --git a/node/src/files/build/less/modules/transition.js b/node/src/files/build/less/modules/transition.js index 325c4273d..d1e7a6dba 100644 --- a/node/src/files/build/less/modules/transition.js +++ b/node/src/files/build/less/modules/transition.js @@ -621,7 +621,7 @@ $.fn.transition.settings = { // animation complete event complete : function() {}, - // animation duration (useful only with future js animations) + // animation duration animation : 'fade', duration : '700ms', diff --git a/node/src/files/build/minified/modules/transition.js b/node/src/files/build/minified/modules/transition.js index 325c4273d..d1e7a6dba 100644 --- a/node/src/files/build/minified/modules/transition.js +++ b/node/src/files/build/minified/modules/transition.js @@ -621,7 +621,7 @@ $.fn.transition.settings = { // animation complete event complete : function() {}, - // animation duration (useful only with future js animations) + // animation duration animation : 'fade', duration : '700ms', diff --git a/node/src/files/build/uncompressed/modules/transition.js b/node/src/files/build/uncompressed/modules/transition.js index 325c4273d..d1e7a6dba 100644 --- a/node/src/files/build/uncompressed/modules/transition.js +++ b/node/src/files/build/uncompressed/modules/transition.js @@ -621,7 +621,7 @@ $.fn.transition.settings = { // animation complete event complete : function() {}, - // animation duration (useful only with future js animations) + // animation duration animation : 'fade', duration : '700ms', diff --git a/src/modules/transition.js b/src/modules/transition.js index 325c4273d..d1e7a6dba 100755 --- a/src/modules/transition.js +++ b/src/modules/transition.js @@ -621,7 +621,7 @@ $.fn.transition.settings = { // animation complete event complete : function() {}, - // animation duration (useful only with future js animations) + // animation duration animation : 'fade', duration : '700ms',