Skip to content

Commit

Permalink
Improve the docs updates to use the current doc standard.
Browse files Browse the repository at this point in the history
  • Loading branch information
obetomuniz committed Jun 18, 2018
1 parent ed0c8aa commit e25addc
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ import { config } from 'react-spring'

- tension, controls the initial plus force of the spring when let loose (default: 170)
- friction, controls the opposition or antagonistic minus force (default: 26)
- velocity, controls the initial velocity of the object attached to the spring (default: 0)
- overshootClamping, controls if the spring should be clamped and not bounce (default: false)
- restSpeedThreshold, precision (default: 0.0001)
- restDisplacementThreshold, displacement precision (default: 0.0001)

Expand Down Expand Up @@ -51,9 +53,7 @@ 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 configuration
// Can be a object with the fields tension, friction, velocity, overshootClamping, restDisplacementThreshold, and restSpeedThreshold
// Can be a function receiving a name
// Spring config ({ tension, friction, ... } or a function receiving a name)
config: PropTypes.oneOfType([PropTypes.object, PropTypes.func]),
// Animation start delay, optional
delay: PropTypes.number,
Expand Down

0 comments on commit e25addc

Please sign in to comment.