redux-device-type/README.md

a reducer to keep track of your current device size

# redux-device-type
A reducer to keep track of your current device size in order to react to the chages (e.g. rendering certain components only on some device sizes).

## install

```
npm install --save redux-device-type
```

## demo

https://codesandbox.io/s/l2pn2k19v9

## usage

first add the `deviceTypeReducer` to your reducer list

```javascript
import { deviceTypeReducer } from 'redux-device-type';

const reducers = combineReducers({
  ...otherReducers,
  deviceType: deviceTypeReducer
});
```

next you need to initialize the redux-device-type by passing your redux store into the `initReduxDeviceType` method

```javascript
import { initReduxDeviceType } from 'redux-device-type';

const store = createStore(reducers);

initReduxDeviceType(store);
```

now you can access the device type via the deviceType key from the store. This way you can build logic for rendering certain components according to the width of the device. You may check the device type against the constants exported by the library.

```javascript
import { EXTRA_SMALL, SMALL, MEDIUM, LARGE } from 'redux-device-type';

const Component = ({ deviceType }) =>
  <div>
    { deviceType <= SMALL && <div>SMALL AND LESS </div> }
    { deviceType < EXTRA_SMALL && <div>SMALLER THAN EXTRA_SMALL</div> }
    { deviceType === MEDIUM && <div>MEDIUM</div> }
    { deviceType >= LARGE && <div>AT LEAST LARGE</div> }
  </div>;

const ComponentWithDeviceType = connect(
  ({ deviceType }) => ({ deviceType }),
  null
)(Component);
```

## advanced usage

the default sizes are

| CONSTANT        | VALUE           | MINIMUM WIDTH  |
| ------------- |:-------------:| -----:|
| IPHONE_RETINA      | 0 | 0px |
| EXTRA_SMALL      | 1      |   480px |
| SMALL | 2     |    768px |
| MEDIUM | 3    |    992px |
| LARGE | 4    |    1200px |

you can also pass an object to the `initReduxDeviceType` method as a second parameter, in order to redefine all or some of the sizing boundaries

```javascript

const customWidths = {
  large: 1000,
  medium: 850,
  small: 600,
  extraSmall: 300
};

initReduxDeviceType(store, customWidths);
```