npm

Share private packages across your team with npm Orgs, now with simplified billing via the aws marketplace!Learn more »

react-change-highlight

1.1.2 • Public • Published

react-change-highlight

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 UseCase

You can play around with it on this sandbox codesandbox.io/react-change-highlight

Install

yarn add react-change-highlight

or

npm install react-change-highlight

Usage

Basically you need to wrap the components you want to highlight on change inside HighlightChange element then add ref attribute to each child in this component to be used to be highlighted.

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

import ChangeHighlight from 'react-change-highlight';
 
export default () => {
  const [count, setCount] = useState(0);
 
  return (
    <ChangeHighlight>
      <div ref={React.createRef()}>{count}</div>
    </ChangeHighlight>
  );
}

Default styling for highlighting in case the user didn't use a custom styling using the highlightStyle property:

.react-highlight {
    background-color: #f8ffb4;
    transition: all 0.5s ease-in-out;
  }

Props

Property Type Default Description
showAfter number 500 number of milli seconds before start highlighting
hideAfter number 2500 number of milli seconds before ending highlighting
containerClassName string className for component container
highlightStyle string className for highlighing content
disabled boolean false weather you need to disable highlighting

Author

install

npm i react-change-highlight

Downloadsweekly downloads

17

version

1.1.2

license

MIT

last publish

collaborators

  • avatar
Report a vulnerability