hakowork/vide
3
0
Fork 0
mirror of https://github.com/centau/vide.git synced 2026-08-20 14:41:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update docs

Browse source
This commit is contained in:
Aaron Smith 2023-08-10 17:56:14 +01:00
parent e19d3377e1
commit 744cce0fb6
3 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/api/animation.md
View file

@ -2,7 +2,7 @@
## spring()
Returns a new state with a dynamically animated value of the source.
Returns a new source with a dynamically animated value of the input source.
- **Type**
@ -18,9 +18,10 @@ Returns a new state with a dynamically animated value of the source.
- **Details**
The output state value is updated every frame based on the source value.
The output source value is updated every frame based on the input source
value.
The change is physically simulated according to a
The output is physically simulated according to a
[spring](https://en.wikipedia.org/wiki/Simple_harmonic_motion).
`period` is the amount of time in seconds it takes for the spring to
@ -33,4 +34,4 @@ Returns a new state with a dynamically animated value of the source.
- <1 = Underdamped - reaches target with some overshoot.
- 0 = Undamped - never stabilizes, oscillates forever.
Velocity is conserved between source state updates for smooth animation.
Velocity is conserved between source updates for smooth animation.

2
docs/index.md
View file

@ -19,6 +19,6 @@ hero:
features:
- title: In Development
details: Not recommended for production.
details: Not recommended for production use.
---