react-change-highlight/README.md

React component to highlight the changed content immediately and bring focus of the user into the changed part

# react-change-highlight

[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg)](#contributors)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/medhatdawoud/react-change-highlight/blob/master/LICENSE) 
[![npm version](https://img.shields.io/npm/v/react-change-highlight.svg?style=flat)](https://www.npmjs.com/package/react-change-highlight)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/medhatdawoud/react-change-highlight/blob/master/CONTRIBUTING.md)

> React Change Highlight is a react component to highlight changes in the wrapped component to enhance the UX and grab 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 I'm using in a project
![UseCase](https://i.imgur.com/vHxyHrN.gif)

You can play around with it on this sandbox [codesandbox.io/react-change-highlight](https://codesandbox.io/s/react-change-highlight-example-fcwh9) .. or clone the repo and play around with the all examples in the examples folder

## 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 `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 `highlightStyle` attribute.

```jsx
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 is `rc-highlight` class and it is as follow:

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

## SSR (server-side rendering)

In case of using this module in a server-side rendering 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.

```text
⚠️ "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
```

## Props

| Property             | Type    | Default | Descriptio|
| -------------------- | ------- | ------- | --------------------------------------------------------- |
| `showAfter`          | number  | 500     | number of milli seconds before start highlighting|
| `hideAfter`          | number  | 2500    | number of milli seconds before ending highlighting|
| `mode`     | change or newOnly  |`change`| mode of the detection, either `change` which is the default one to detect the changes in the parsed elements or `newOnly` which is useful in case of newly added element highlight (check todo example) |
| `disabled`           | boolean | false   | whether you need to disable highlighting |
| `ssr`                | boolean | false   | you need to pass this in case of using it with server-side rendering. (gives a hint for adding style) |
| `highlightClassName` | string  |         | className for highlighing content (a must in case of SSR)|
| `containerClassName` | string  |         | className for component container |

---

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
<table>
  <tr>
    <td align="center"><a href="http://medhatdawoud.net"><img src="https://avatars3.githubusercontent.com/u/337888?v=4" width="100px;" alt="Medhat Dawoud"/><br /><sub><b>Medhat Dawoud</b></sub></a><br /><a href="https://github.com/medhatdawoud/react-change-highlight/commits?author=medhatdawoud" title="Code">💻</a> <a href="#blog-medhatdawoud" title="Blogposts">📝</a> <a href="https://github.com/medhatdawoud/react-change-highlight/commits?author=medhatdawoud" title="Documentation">📖</a></td>
    <td align="center"><a href="https://github.com/EslamHiko"><img src="https://avatars1.githubusercontent.com/u/18349358?v=4" width="100px;" alt="Islam ElHakmi"/><br /><sub><b>Islam ElHakmi</b></sub></a><br /><a href="https://github.com/medhatdawoud/react-change-highlight/commits?author=EslamHiko" title="Code">💻</a></td>
    <td align="center"><a href="https://www.linkedin.com/in/mohamedabugalala/"><img src="https://avatars2.githubusercontent.com/u/14947957?v=4" width="100px;" alt="Mohamed Gamal"/><br /><sub><b>Mohamed Gamal</b></sub></a><br /><a href="https://github.com/medhatdawoud/react-change-highlight/issues?q=author%3AmohamedGamalAbuGalala" title="Bug reports">🐛</a> <a href="https://github.com/medhatdawoud/react-change-highlight/commits?author=mohamedGamalAbuGalala" title="Code">💻</a></td>
  </tr>
</table>

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!