buffer-redux-hover's Introduction

buffer-redux-hover

Keep react component hover state in redux

Usage

Combine the reducer under the hover state tree

import { combineReducers } from 'redux';
import { reducer } from '@bufferapp/redux-hover';

const app = combineReducers({
  hover: reducer, // important to have this under the hover state tree
});

export default app;

Create a component that has a hovered, onMouseEnter and onMouseLeave prop.

import React, { PropTypes } from 'react';

const MyComponent = ({
  hovered, // managed by redux-hover
  onMouseEnter,
  onMouseLeave,
}) =>
  <div
    onMouseEnter={onMouseEnter}
    onMouseLeave={onMouseLeave}
    style={{ background: hovered ? 'green' : 'red' }}
  >
    Hover This
  </div>;

MyComponent.propTypes = {
  hovered: PropTypes.bool,
  onMouseEnter: PropTypes.func,
  onMouseLeave: PropTypes.func,
};

export default TestComponent;

Wrap MyComponent with the Hoverable component. Make sure you set and id.

import React from 'react';
import { Hoverable } from '@bufferapp/redux-hover';
import MyComponent from './MyComponent';

const App = () =>
  <div>
    <Hoverable id={'myComponent'}>
      <MyComponent />
    </Hoverable>
    <Hoverable id={'myOtherComponent'}>
      <MyComponent />
    </Hoverable>
  </div>;

export default App;

Notes

hovered prop

the hovered prop is set to true on MyComponent when the mouse is hovering it. Otherwise it's set to false.

Choosing Id's

As long as id's are different, they'll be independently hoverable. The above example sets the strings manually, but you could also use a uuid() too.

This also means that ids with the same value will all get the hover state applied when any of them are hovered.