README.md

include-media-redux

An adaptation of include-media-exports for redux.

Introduction

This library is intended to make JS and CSS speak the same language when it comes to media queries. It is heavily inspired by include-media-export. Using this library assumes that you are:

• already using include-media to declare your breakpoints
• writing your CSS in Sass
• using redux to manage the state of your React application

Usage

// Content.jsx
import React from 'react';
import { connect } from 'react-redux';
import { media } from 'include-media-redux';

function Content({ lessThanMd }) {
  if (lessThanMd) {
    return 'Hello world from BELOW the `md` breakpoint.';
  }

  return 'Hello world from ABOVE the `md` breakpoint.';
}

export default connect(state => ({
  lessThanMd: media.is.lessThan('md')(state),
}))(Content);

// App.jsx
import React from 'react';
import { withMedia } from 'include-media-redux';
import Content from './Content.jsx';

function App() {
  return <div><Content /></div>;
}

// `withMedia` registers the `resize` listeners on `window` and updates the redux store.
// Needs to be nested within a `react-redux` `Provider`.
export default withMedia(App);

// Root.jsx
import React from 'react';
import { Provider } from 'react-redux';
import { createStore } from 'redux';
import { media, reducer } from 'include-media-redux';
import App from './App.jsx';

// Configure your breakpoints. Should be the same breakpoints used for
// the `include-media` Sass library.
media({
  breakpoints: {
    sm: 300,
    md: 800,
  },
});

const store = createStore(reducer);

export default function Root() {
  return (
    <Provider store={store}>
      <App />
    </Provider>
  );
}

Development

In lieu of a formal style guide, please ensure PRs follow the conventions present, and have been properly linted and tested. Feel free to open issues to discuss.

Be aware this module is tested in both browser and node runtimes.

Available tasks

Build and test

Runs all tests, static analysis, and bundle for distribution

$ yarn start

Test

Runs browser and node tests

$ yarn test

Runs browser tests via PhantomJS only

$ yarn test:browser:once

Runs browser tests via SauceLabs only

$ SAUCELABS=true yarn test:browser:once

Runs node tests only

$ yarn test:node:once

TDD

Runs browser and node tests in watch mode, re-bundles on src file change

$ yarn tdd

Bundle

Packages client and node bundles for distribution, output to /dist

$ yarn bundle

Distribute

Lints, cleans, and bundles for distribution

$ yarn dist

Release

We're using np to simplify publishing to git + npm. A changelog and docs are generated as part of this script.

$ yarn release <semver level/version>
$ yarn release patch # patch release
$ yarn release 100.10.1 # release specific version