Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
centau committed Aug 10, 2023
1 parent e19d337 commit 744cce0
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 5 deletions.
9 changes: 5 additions & 4 deletions docs/api/animation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand All @@ -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
Expand All @@ -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 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ hero:

features:
- title: In Development
details: Not recommended for production.
details: Not recommended for production use.
---

1 change: 1 addition & 0 deletions todo.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@
- [ ] batch
- [ ] async/resource/loading/suspense
- define order with nested properties
- review alternative to nested properties, merge function

0 comments on commit 744cce0

Please sign in to comment.