From e25addc863a3ecb2bf06421e7a5eaa9fbf20f3be Mon Sep 17 00:00:00 2001 From: Beto Muniz Date: Sun, 17 Jun 2018 23:52:38 -0300 Subject: [PATCH] Improve the docs updates to use the current doc standard. --- API.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/API.md b/API.md index 6d4c4e6cc4..fac9be74fa 100644 --- a/API.md +++ b/API.md @@ -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) @@ -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,