Skip to content

Commit

Permalink
Improve the Spring API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
obetomuniz committed Jun 18, 2018
1 parent d990736 commit 2d2b79c
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion API.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,20 @@ class Spring extends React.PureComponent {
immediate: PropTypes.oneOfType([PropTypes.bool, PropTypes.func]),
// Won't start animations, so they can be controlled from outside
hold: PropTypes.oneOfType([PropTypes.bool, PropTypes.func]),
// Spring config ({ tension, friction } or a function receiving a name)
// Spring configuration
// Can be a object with the fields tension, friction, velocity, overshootClamping, restDisplacementThreshold, and restSpeedThreshold
// Can be a function receiving a name
config: PropTypes.oneOfType([PropTypes.object, PropTypes.func]),
// Animation start delay, optional
delay: PropTypes.number,
// When true it literally resets: from -> to
reset: PropTypes.bool,
}
static defaultProps = {
from: {},
to: {},
config: config.default,
delay: 0,
native: false,
immediate: false,
hold: false,
Expand Down

0 comments on commit 2d2b79c

Please sign in to comment.