diff --git a/docs/shape.html b/docs/shape.html index 40b6d2174..8c85944a7 100755 --- a/docs/shape.html +++ b/docs/shape.html @@ -169,95 +169,102 @@
$('.foo').shape('setting', 'moduleName', 'Godzilla');
Settings can also be read programmatically: $('.foo').shape('setting', 'moduleName');
-
Setting Name | -Default Value | -Usage | +Setting | +Default | +Description | -
---|---|---|
moduleName | -Shape | -Name used in debug logs | -
debug | -True | -Provides standard debug output to console | -
verbose | -False | -Provides ancillary debug output to console | -
namespace | -shape | -Event namespace. Makes sure module teardown does not effect other events attached to an element. | -
beforeChange | -None | -Callback before side is changed. This context is the new side. | -
onChange | -None | -Callback after side is changed. This context is new side. | -
useCSS | -True | -Not currently supported. Will allow for use of javascript requestAnimationFrame transitions instead of css3 transitions. | -
duration | -1000ms | -Duration of animation (javascript only). To modify animation duration for css simply modify the css property transition-duration. | -
easing | -easeInOutQuad | -Easing equation for animation (javascript only). To modify the easing for css simply modify the css property transition-easing | -
errors | -
-
- |
- Object containing localized error messages. | -
selector | -
-
- |
- Object containing selectors used by module. | -
className | -
-
- |
- Object containing class names used by module. | -
useCSS | +True | +Not currently supported. Will allow for use of javascript requestAnimationFrame transitions instead of css3 transitions. | +
duration | +1000ms | +Duration of animation (javascript only). To modify animation duration for css simply modify the css property transition-duration. | +
easing | +easeInOutQuad | +Easing equation for animation (javascript only). To modify the easing for css simply modify the css property transition-easing | +
selector | +
+ { + shape : '.shape', + side : '.side' +}+ |
+ Object containing selectors used by module. | +
className | +
+{ + css : 'css', + animating : 'animating', + hidden : 'hidden', + active : 'active' +}+ |
+ Object containing class names used by module. | +
Callbacks | +||
beforeChange | +None | +Callback before side is changed. This context is the new side. | +
onChange | +None | +Callback after side is changed. This context is new side. | +
Standard | +||
moduleName | +Shape | +Name used in debug logs | +
debug | +True | +Provides standard debug output to console | +
performance | +False | +Provides standard debug output to console | +
verbose | +False | +Provides ancillary debug output to console | +
namespace | +shape | +Event namespace. Makes sure module teardown does not effect other events attached to an element. | +
errors | ++ { + side : 'You tried to switch to a side that does not exist.', + method : 'The method you called is not defined' + } + | +Object containing localized error messages. | +