React Change Highlight is a react component to highlight changes in the wrapped component to enhance the UX and grap the focus of the user into the changed value of some parts like the cart in an e-commerce application for example.
This is a real use case we are using in our company
You can play around with it on this sandbox codesandbox.io/react-change-highlight
yarn add react-change-highlight
npm install react-change-highlight
Basically you need to wrap the components you want to highlight on change inside
ChangeHighlight element (default import) then add
ref attribute to each child in this component which you want to highlight when they got their content changed.
In the following example the
count variable comes from state, so when ever that function
setCount() is called with any different value the background of that wrapped div will be changed as a default action, but actually it can be any kind of animation you make into the class you will pass to
import ChangeHighlight from "react-change-highlight";const count setCount = ;return<ChangeHighlight><div =>count</div></ChangeHighlight>;;
Default styling for highlighting in case the user didn't use a custom styling using the
highlightStyle property is
rc-highlight class and it is as follow:
SSR (server-side rendering)
In case of using this module in a server-side rengering app, you should make sure to create and pass your own className to the
highlightStyle attribute, and to make some hint for you, add
ssr attribute to the
ChangeHighlight element, so it can give you a hint to add a class in your console as a warning like this.
⚠️ "react-change-highlight", As you're using server-side rendering, it's a must to create and pass your css class to the highlightStyle attribute for "ChangeHighlight" component
||number||500||number of milli seconds before start highlighting|
||number||2500||number of milli seconds before ending highlighting|
||string||className for component container|
||string||className for highlighing content (a must in case of SSR)|
||boolean||false||weather you need to disable highlighting|
||boolean||false||you need to pass this in case of using it with server-side rendering. (gives a hint for adding style)|
Thanks goes to these wonderful people (emoji key):
💻 📝 📖
This project follows the all-contributors specification. Contributions of any kind welcome!