chenglou/react-motion

Add section to the README about generic usage of interpolated value

Open

#494 opened on Sep 25, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (21,646 stars) (1,160 forks)batch import
docshelp wanted

Description

Put is somewhere at the top.

Make sure it is clear that styles prop is not working with, well, actually styles, but gives you ability to use value to derive all other values of your styles.

See https://github.com/chenglou/react-motion/issues/304#issuecomment-331750756

React motion does not operate "style" (I agree that is a misleading name for prop). It only applies function over any number you pass. This way it can stay minimal and you have all power to interpolate any number-related values.

<Motion defaultStyle={{whatever: 0}} style={{whatever: spring(1)}}>
  {({whatever}) => (
    <div style={{color: `rgb(${255 * whatever}, ${255 * whatever}, ${255 * whatever})`}}>
      Hey, I'm transitioning color!
    </div>
  )}
</Motion>

Related:

Contributor guide

Tech stack
javascriptreact
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Reactreact motion basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Add a new section near the top of the README explaining that the `styles` prop is not for static styles but for interpolated values. Use the example from the issue to demonstrate transitioning color. Reference the linked comment for further clarification. Ensure the section highlights the library's core concept of applying functions over numbers.